diff options
Diffstat (limited to 'cucumber-js-test-apis-ci/cucumber-common/plugins/README.md')
| -rw-r--r-- | cucumber-js-test-apis-ci/cucumber-common/plugins/README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/cucumber-js-test-apis-ci/cucumber-common/plugins/README.md b/cucumber-js-test-apis-ci/cucumber-common/plugins/README.md new file mode 100644 index 0000000000..9eaeb8f3a6 --- /dev/null +++ b/cucumber-js-test-apis-ci/cucumber-common/plugins/README.md @@ -0,0 +1,30 @@ +<br> +<h1>Welcome!</h1> +This is the documentation for using the BDD testing framework for SDC.<br> +The Modules on the left contains all steps for particalar aress and/or explanations of what they do.<br> +<br><br> +<h3>How to set the server configuration</h3> +<li> Copy the config.json to devConfig.json +<li> Replace the server and user values with the correct values +<h3>How to run with Maven</h3> +<li>"mvn clean install" will install npm if needed, download all modules +<li> run "mvn install -DskipTests=true -P dev" to create the documentation under the "docs" folder +<li>"mvn test -P dev" will run all tests in the features folder and create an HTML report under the "reports" folder +<h3>How to develop tests</h3> +You can open the project in IntelliJ and Webstorm to run and develop scenarios.<br> +<li><b>You will need to install the Cucumber.Js plugin</b> In order to install, go to "Settings/Plugins". If cucumber.js in not on the list, go to "Browse repositories.." and install . +<li>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. +<li>Now you can run the feature files by right clicking on the file and selecting "Run" from IDEA.<br> +<li>Add to existing scenarios or create new files under the "features" directory for additional tests +<br> +<li>You can also run a specific test from the command line by running "npm run test -- [features/path to file] +<h3>More Information</h3> +<li> More on <a href="https://cucumber.io/docs/reference">Cucumber</a> +<li> More on <a herf="https://github.com/cucumber/cucumber/wiki/Gherkin">Gherkin</a> +<li> More on <a href="https://github.com/cucumber/cucumber-js">Cucumber-js</a> +<br> +<h3>How to run the docker</h3> +<li>"mvn clean install -P docker" will create the docker images +<li>the "docker_run.sh" script will start all ONAP images and run the cucumber docker against them +<li> environment variables that can be set to change the server/version: IMAGES_TAG (default 1.4-STAGING-latest), TEST_CI_BE_HOST (deafult - machine IP), TEST_CI_CATALOG_PORT (default 8080) + |