From 637206b5e05910cc3bdd64bbd35d296ce282524c Mon Sep 17 00:00:00 2001 From: ilanap Date: Sun, 4 Feb 2018 17:06:22 +0200 Subject: Adding BDD cucumber testing component Change-Id: I4fd7eb798cbc7cad85562453fb0a6f74fd12ff5b Issue-ID: SDC-990 Signed-off-by: ilanap --- openecomp-bdd/plugins/README.md | 23 ++++++++++++ openecomp-bdd/plugins/jsdoc_config.json | 15 ++++++++ openecomp-bdd/plugins/reporter.js | 31 ++++++++++++++++ openecomp-bdd/plugins/steps.js | 65 +++++++++++++++++++++++++++++++++ 4 files changed, 134 insertions(+) create mode 100644 openecomp-bdd/plugins/README.md create mode 100644 openecomp-bdd/plugins/jsdoc_config.json create mode 100644 openecomp-bdd/plugins/reporter.js create mode 100644 openecomp-bdd/plugins/steps.js (limited to 'openecomp-bdd/plugins') diff --git a/openecomp-bdd/plugins/README.md b/openecomp-bdd/plugins/README.md new file mode 100644 index 0000000000..50d4758042 --- /dev/null +++ b/openecomp-bdd/plugins/README.md @@ -0,0 +1,23 @@ +
+

Welcome!

+This is the documentation for using the BDD testing framework for SDC.
+The Modules on the left contains all steps for particalar aress and/or explanations of what they do.
+

+

How to set the server

+
  • Either update the config.json file and set the server +
  • Or set the SERVER environment variable and it will override the configuration file +

    How to run with Maven

    +
  • "mvn install" will install npm if needed, download all modules and create the documentation under the "docs" folder +
  • "mvn test-and-report" will run all tests in the features folder and create an HTML report under the "reports" folder +

    How to develop tests

    +You can open the project in IntelliJ and Webstorm to run and develop scenarios.
    +
  • You will need to install the Cucumber.Js plugin In order to install, go to "Settings/Plugins". If cucumber.js in not on the list, go to "Browse repositories.." and install . +
  • First time only: Right click on feature file and try to run. Now go to "Run/edit configurations" and set the "executable path" to the "node_modules\.bin\cucumber-js.cmd" under your current project. +
  • Now you can run the feature files by right clicking on the file and selecting "Run" from IDEA.
    +
  • Add to existing scenarios or create new files under the "features" directory for additional tests +
    +
  • You can also run a specific test from the command line by running "npm run test -- [features/path to file] +

    More Information

    +
  • More on Cucumber +
  • More on Gherkin +
  • More on Cucumber-js diff --git a/openecomp-bdd/plugins/jsdoc_config.json b/openecomp-bdd/plugins/jsdoc_config.json new file mode 100644 index 0000000000..a5a608e805 --- /dev/null +++ b/openecomp-bdd/plugins/jsdoc_config.json @@ -0,0 +1,15 @@ +{ + "tags": { + "allowUnknownTags": true + }, + "templates": { + "default": { + "outputSourceFiles": false + } + }, + "plugins": ["plugins/steps"], + "opts": { + "template": "node_modules/jsdoc-one-page", + "destination": "docs/" + } +} \ No newline at end of file diff --git a/openecomp-bdd/plugins/reporter.js b/openecomp-bdd/plugins/reporter.js new file mode 100644 index 0000000000..8913789c95 --- /dev/null +++ b/openecomp-bdd/plugins/reporter.js @@ -0,0 +1,31 @@ +/* + * Copyright © 2016-2017 European Support Limited + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +var reporter = require('cucumber-html-reporter'); + +var options = { + theme: 'bootstrap', + jsonFile: 'report/report.json', + output: 'report/report.html', + reportSuiteAsScenarios: true, + launchReport: false, + metadata: { + "ONAP" : "Some build", + "Executed": "Local" + } +}; + +reporter.generate(options); + diff --git a/openecomp-bdd/plugins/steps.js b/openecomp-bdd/plugins/steps.js new file mode 100644 index 0000000000..2faa7efbd8 --- /dev/null +++ b/openecomp-bdd/plugins/steps.js @@ -0,0 +1,65 @@ +/* + * Copyright © 2016-2017 European Support Limited + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * @module plugins/steptag + */ +'use strict'; + + +exports.handlers = { + /** + * Support @step tag. + * + * @step description + */ + newDoclet: function(e) { + var tags = e.doclet.tags; + var tag; + var value; + + // any user-defined tags in this doclet? + if (typeof tags !== 'undefined') { + + tags = tags.filter(function($) { + return $.title === 'step' || $.title === 'examplefile'; + }); + + if (tags.length) { + // take the first one + tag = tags[0]; + let step = null; + let exampleFile = null; + for (tag in tags) { + if (tags[tag].title === "step") { + step = "" + tags[tag].value + "
    "; + } + if (tags[tag].title === "examplefile") { + exampleFile = " Example Features File: " + tags[tag].value + "
    "; + } + } + if (exampleFile !== null) { + step += exampleFile; + } + e.doclet.meta = e.doclet.meta || {}; + if (e.doclet.description !== undefined) { + e.doclet.description = step + e.doclet.description; + } else { + e.doclet.description = step; + } + } + } + } +}; \ No newline at end of file -- cgit 1.2.3-korg