Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patheard/cucumber-puppeteer
A Node.js template for end-to-end testing your app with Cucumber.js and Puppeteer.
https://github.com/patheard/cucumber-puppeteer
cucumber-js puppeteer
Last synced: about 2 months ago
JSON representation
A Node.js template for end-to-end testing your app with Cucumber.js and Puppeteer.
- Host: GitHub
- URL: https://github.com/patheard/cucumber-puppeteer
- Owner: patheard
- License: mit
- Archived: true
- Created: 2019-02-19T03:00:31.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-04-28T19:06:23.000Z (over 2 years ago)
- Last Synced: 2024-04-23T20:54:40.982Z (5 months ago)
- Topics: cucumber-js, puppeteer
- Language: JavaScript
- Homepage:
- Size: 2.75 MB
- Stars: 67
- Watchers: 3
- Forks: 27
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://circleci.com/gh/patheard/cucumber-puppeteer)
[](https://codecov.io/gh/patheard/cucumber-puppeteer)
A Node.js behavioural test framework made using [Cucumber.js](https://github.com/cucumber/cucumber-js) and [Puppeteer](https://github.com/GoogleChrome/puppeteer). The test steps are generic so you can quickly create your test suite:
```gherkin
Scenario: Open the search page and find products
When I open the url "https://someurl.com/search"
And I set the element "input[name='search']" value to "plumbus"
And I click the button ".search-button"
Then I expect the element "#results > .result-count" contains text "3 products found"
```
# Test steps
Look at the [`*.feature`](https://github.com/patheard/cucumber-puppeteer/tree/master/features) files in the project to see the available test steps. You can run them all with:
```bash
npm start # after running `npm run test-server`
```
Configuration and hooks are loaded from [`/features/support/config.js`](https://github.com/patheard/cucumber-puppeteer/blob/master/features/support/config.js). You can override behaviour with the following environment variables:
```bash
ENV # Appended to screenshot names (default: '')
REPORT_PATH # Path where Axe accessibility reports will be saved (default: './test/reports')
ROOT_URL # Prepended to URLs that don't start with 'http' (default: '')
SCREENSHOT_PATH # Path to save screenshots (default: './test/screenshots'
```
In addition to the above, environment variables are available to the deleteCookie, openUrl and setElementValue actions. Environment variables are not output to the test results and use the following syntax:
```gherkin
When I open the url "$TEST_URL"
And I set the element "[type='password']" value to "$TEST_PASSWORD"
```
# Puppeteer launch options
You can customize [Puppeteer's launch options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions) by adding a `puppeteerOptions` object to your package.json:
```javascript
// package.json
"puppeteerOptions" : {
"headless": false,
"sloMo": 250,
"defaultViewport": {
"width": 1000,
"height": 1000
}
}
```
Or by using the Cucumber.js [`--world-parameters`](https://github.com/cucumber/cucumber-js/blob/master/docs/cli.md#world-parameters) command line arg:
```javascript
// package.json
"scripts": {
"test:headful": "npx cucumber-js --world-parameters \"{\\\"headless\\\": false}\""
}
```
:warning: Note that `--world-parameters` will take precedence.
# Use in your project
To use this in your own project as a dependency, check out the [test-cuke](https://github.com/patheard/test-cuke) example.
# Unit tests
```bash
npm test # after running `npm run test-server`
```
# License and credits
This code is licensed under the MIT license.
* Initial template from [anephenix/cucumber-and-puppeteer](https://github.com/anephenix/cucumber-and-puppeteer)
* Generic step definition idea from [webdriverio/cucumber-boilerplate](https://github.com/webdriverio/cucumber-boilerplate)