Use this template repository to get started with acceptance testing your REST/HTTP APIs using Serenity/JS and Cucumber.
Learn more:
This repository is a GitHub template. You can use it to create a new GitHub repository, clone it to your computer.
You can also launch it in a virtual Gitpod workspace without having to install anything on your machine:
To use this project, you'll need:
- Node.js, a Long-Term Support (LTS) release version 16 or later - download
- Java Runtime Environment (JRE) or a Java Development Kit (JDK) version 11 or later - download
Follow the installation instructions to help you verify your setup.
Once you have the code on your computer, use your computer terminal to run the following command in the directory where you've cloned the project:
npm ci
Running npm ci downloads the Node modules this project depends on, as well as the latest version of chromedriver and the Serenity BDD CLI reporter jar.
If your network administrators require you to use proxy servers or an internal artifact registry (Artifactory, Nexus, etc.), your development environment might require some additional configuration.
The easiest way to do it is to create an .npmrc file in your home directory:
proxy=http://user:password@host.mycompany.com:8080/
https-proxy=http://user:password@host.mycompany.com:8080/
strict-ssl=false
registry=https://artifactory.mycompany.com/artifactory/
If you encounter issues downloading the Serenity BDD CLI jar, please follow the detailed instructions in the Serenity/JS Handbook.
Similar instructions are available for the chromedriver module.
The project provides several NPM scripts defined in package.json:
npm run lint # runs code linter
npm run lint:fix # attempts to automatically fix linting issues
npm run clean # removes reports from any previous test run
npm test # executes the example test suite
# and generates the report under ./target/site/serenity
npm start # starts a mini HTTP server and serves the test reports
# at http://localhost:8080
To execute only those scenarios which names match a given pattern, run:
npx cucumber-js --name="Multiple expressions"
Note that this technique works with partial matches, i.e. specifying --name="expressions" would match all the scenarios in the example .feature file.
You can limit the number of scenarios to execute using Cucumber tags and tag expressions, for example:
npx cucumber-js --tags="@smoke-test and @fast"
You can also run a single scenario by specifying its exact file:line location, for example
npx cucumber-js features/mathjs-api/expressions.feature:12
Do you find Serenity/JS useful? Give it a ⭐ star on GitHub!
Found a bug? Need a feature? Raise an issue or submit a pull request.
Have feedback? Let me know on LinkedIn or leave a comment in Serenity/JS discussions on GitHub.
And if you have any questions about the framework, or simply want to say hello to other Serenity/JS developers, join us on Serenity/JS Community Chat.
Serenity/JS is a free open-source framework, so we rely on our wonderful GitHub sponsors to keep the lights on.
If you appreciate all the effort that goes into making sophisticated tools easy to work with, please support our work and become a Serenity/JS GitHub Sponsor today!
