https://github.com/serenity-js/serenity-js-cucumber-protractor-template
https://github.com/serenity-js/serenity-js-cucumber-protractor-template
cucumber protractor serenity-js template
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/serenity-js/serenity-js-cucumber-protractor-template
- Owner: serenity-js
- Created: 2019-10-03T20:41:39.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-10-03T21:04:42.000Z (2 months ago)
- Last Synced: 2025-10-03T23:17:32.493Z (2 months ago)
- Topics: cucumber, protractor, serenity-js, template
- Language: JavaScript
- Homepage: https://serenity-js.org
- Size: 42 MB
- Stars: 8
- Watchers: 2
- Forks: 10
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/funding.yml
Awesome Lists containing this project
README
# Serenity/JS Cucumber Protractor Template
[](https://github.com/serenity-js/serenity-js-cucumber-protractor-template/actions)
[](https://github.com/serenity-js/serenity-js)
[](https://stackoverflow.com/questions/tagged/serenity-js)
[](https://gitpod.io/from-referrer/)
[](https://www.linkedin.com/company/serenity-js)
[](https://www.youtube.com/@serenity-js)
[](https://matrix.to/#/#serenity-js:gitter.im)
[](https://github.com/sponsors/serenity-js)
Use this [template repository](https://help.github.com/en/articles/creating-a-repository-from-a-template)
to get started with acceptance testing your web applications using [Serenity/JS](https://serenity-js.org), [Cucumber](https://github.com/cucumber/cucumber-js) and [Protractor](http://www.protractortest.org/).
Learn more:
- [Serenity BDD reports for this project](https://serenity-js.github.io/serenity-js-cucumber-protractor-template/)
- [Serenity/JS website, tutorials, and API docs](https://serenity-js.org/)
## Usage
This repository is a GitHub template. You can use it to [create a new GitHub repository](https://help.github.com/en/articles/creating-a-repository-from-a-template), [clone it to your computer](https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/cloning-a-repository).
You can also launch it in a virtual Gitpod workspace without having to install anything on your machine:
[](https://gitpod.io/from-referrer/)
### Installation
To use this project, you'll need:
- Node.js, a Long-Term Support (LTS) release version 16 or later - [download](https://nodejs.org/en/)
- Java Runtime Environment (JRE) or a Java Development Kit (JDK) version 11 or later - [download](https://adoptopenjdk.net/)
- Chrome web browser - [download](https://www.google.co.uk/chrome/)
Follow the [installation instructions](https://serenity-js.org/handbook/about/installation/) 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`](https://docs.npmjs.com/cli/v6/commands/npm-ci) downloads the [Node modules](https://docs.npmjs.com/about-packages-and-modules) this project depends on, as well as the latest version of [`chromedriver`](https://www.npmjs.com/package/chromedriver) and the [Serenity BDD CLI](https://github.com/serenity-bdd/serenity-cli) reporter jar.
### Corporate networks
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](https://docs.npmjs.com/cli/v6/configuring-npm/npmrc) 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](https://serenity-js.org/api/serenity-bdd/#downloading-the-serenity-bdd-reporting-cli).
Similar instructions are available for the [`chromedriver` module](https://www.npmjs.com/package/chromedriver).
### Execution
The project provides several [NPM scripts](https://docs.npmjs.com/cli/v6/using-npm/scripts) defined in [`package.json`](package.json):
```
npm run lint # runs the code linter
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
```
#### Running individual scenarios by name
To execute only those scenarios which names match a given pattern, run:
```
npm run test:execute -- --cucumberOpts.name="Adding numbers"
```
Note that this technique works with partial matches, i.e. specifying `--cucumberOpts.name="numbers"` would match both scenarios in the [example `.feature` file](features/super_calculator.feature).
#### Running scenarios by tag
You can limit the number of scenarios to execute using [Cucumber tags](https://cucumber.io/docs/cucumber/api/#tags) and [tag expressions](https://cucumber.io/docs/cucumber/api/#tag-expressions), for example:
```
npm run test:execute -- --cucumberOpts.tags="@smoke-test and @fast"
```
#### Running scenarios by file name and line number
You can also run a single scenario by specifying its exact `file:line` location, for example
```
npm run test:execute -- --specs=features/super_calculator.feature:24
```
## Your feedback matters!
Do you find Serenity/JS useful? Give it a ⭐ star on GitHub!
[](https://github.com/serenity-js/serenity-js)
Found a bug? Need a feature? Raise [an issue](https://github.com/serenity-js/serenity-js/issues?state=open)
or submit a pull request.
Have feedback? Let me know on [LinkedIn](https://www.linkedin.com/in/janmolak/) or leave a comment in [Serenity/JS discussions on GitHub](/serenity-js/serenity-js/discussions/categories/comments).
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](https://matrix.to/#/#serenity-js:gitter.im).
## Support Serenity/JS
Serenity/JS is a free open-source framework, so we rely on our [wonderful GitHub sponsors](https://github.com/sponsors/serenity-js) 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](https://github.com/sponsors/serenity-js) today!
[](https://www.linkedin.com/company/serenity-js)
[](https://www.youtube.com/@serenity-js)
[](https://github.com/sponsors/serenity-js)