cucumber-js-test-apis-ci/cucumber-common/plugins/README.md

   1 <br>
   2 <h1>Welcome!</h1>
   3 This is the documentation for using the BDD testing framework for SDC.<br>
   4 The Modules on the left contains all steps for particalar aress and/or explanations of what they do.<br>
   5 <br><br>
   6 <h3>How to set the server configuration</h3>
   7 <li> Copy the config.json to devConfig.json
   8 <li> Replace the server and user values with the correct values
   9 <h3>How to run with Maven</h3>
  10 <li>"mvn clean install" will install npm if needed, download all modules
  11 <li> run "mvn install -DskipTests=true -P dev" to create the documentation under the "docs" folder
  12 <li>"mvn test -P dev" will run all tests in the features folder and create an HTML report under the "reports" folder
  13 <h3>How to develop tests</h3>
  14 You can open the project in IntelliJ and Webstorm to run and develop scenarios.<br>
  15 <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 .
  16 <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.
  17 <li>Now you can run the feature files by right clicking on the file and selecting "Run" from IDEA.<br>
  18 <li>Add to existing scenarios or create new files under the "features" directory for additional tests
  19 <br>
  20 <li>You can also run a specific test from the command line by running "npm run test -- [features/path to file]
  21 <h3>More Information</h3>
  22 <li> More on <a href="https://cucumber.io/docs/reference">Cucumber</a>
  23 <li> More on <a herf="https://github.com/cucumber/cucumber/wiki/Gherkin">Gherkin</a>
  24 <li> More on <a href="https://github.com/cucumber/cucumber-js">Cucumber-js</a>
  25 <br>
  26 <h3>How to run the docker</h3>
  27 <li>"mvn clean install -P docker" will create the docker images
  28 <li>the "docker_run.sh" script will start all ONAP images and run the cucumber docker against them
  29 <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)
  30