Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anoopsimon/pw-ui-bdd-framework
https://github.com/anoopsimon/pw-ui-bdd-framework
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/anoopsimon/pw-ui-bdd-framework
- Owner: anoopsimon
- License: mit
- Created: 2021-06-07T03:47:35.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T14:57:07.000Z (over 1 year ago)
- Last Synced: 2023-03-05T21:08:07.259Z (over 1 year ago)
- Language: TypeScript
- Size: 224 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# cucumber-playwright
E2E tests framework based on Cucumber(7) with Playwright using Typescript.
## Kudos
This repository is based on the [Cucumber-typescript-starter](https://github.com/hdorgeval/cucumber7-ts-starter/blob/main/package.json) repo.
## What's inside
- Typescript setup for writing steps with eslint/typescript and prettier
- Launching of Playwright browser before running all tests
- Launching new context and page for each scenario
- Running feature with video recording option
- Report generated with last good image attached
- Utilities function to help you with writing steps
- VScode configuration to debug a single feature or an only scenario (run when located on the feature file)
- Page object model with a page factory for modularization
## Usage
Create a repo based on this template and start writing your tests.
## To run your tests
`npm run test` or `npx cucumber-js` runs all tests
`npm run test ` or `npx cucumber-js ` run the single feature
## Browser selection
By default we will use chromium. You can define an envrionment variable called BROWSER and
set the name of the browser. Available options: chromium, firefox, webkit
On Linux and Mac you can write:
`BROWSER=firefox npm run test` or `BROWSER=firefox npx cucumber-js` runs all tests using Firefox
One Windows you need to write
```
set BROWSER=firefox
npm run test
```
## Debugging Features
### From CLI
- `npm run debug` - headful mode with APIs enables both APIs and debug options
- `npm run api` - headless mode with debug apis
- `npm run video` - headless mode vith video
## In Visual Studio Code
- Open the feature
- Select the debug options in the VSCode debugger
- Set breakpoints in the code
To stop the feature, you can add the `Then debug` step inside your feature. It will stop your debugger.
## To choose a reporter
The last reporter/formatter found on the cucumber-js command-line wins:
```text
--format summary --format @cucumber/pretty-formatter --format cucumber-console-formatter
```
In [cucumber.js](cucumber.js) file, modify the options.
## To ignore a scenario
- tag the scenario with `@ignore`
## To check for typescript, linting and gherkin errors
- run the command `npm run build`.
## To view the steps usage
- run the command `npm run steps-usage`.
## To view the html report of the last run
- run the command `npm run report`.