nyanoz / playwright_cucumber_ts

Playwright + Cucumber BDD + Typescript, simple & easiest way to learn and implement

Playwright (TS binding) + Cucumber (BDD)

Cucumber is a popular behavior-driven development (BDD) tool that allows developers and stakeholders to collaborate on defining and testing application requirements in a human-readable format. TypeScript is a powerful superset of JavaScript that adds optional static typing, making it easier to catch errors before runtime. By combining these two tools, we can create more reliable and maintainable tests.

Features

1. Awesome report with screenshots, videos & logs
2. Execute tests on multiple environments
3. Parallel execution
4. Rerun only failed features
5. Retry failed tests on CI
6. Github Actions integrated with downloadable report
7. Page object model

Sample report

Project structure

• .github -> yml file to execute the tests in GitHub Actions
• src -> Contains all the features & Typescript code
• test-results -> Contains all the reports related file

Reports

1. Mutilple Cucumber Report
2. Default Cucumber report
3. Logs
4. Screenshots of failure
5. Test videos of failure
6. Trace of failure

Get Started

Setup:

1. Clone or download the project
2. Extract and open in the VS-Code
3. npm i to install the dependencies
4. npx playwright install to install the browsers
5. npm run test to execute the tests
6. To run a particular test change

  paths: [
            "src/test/features/featurename.feature"
         ] 

7. Use tags to run a specific or collection of specs

npm run test --TAGS="@test or @add"

Folder structure

0. src\pages -> All the page (UI screen)
1. src\test\features -> write your features here
2. src\test\steps -> Your step definitions goes here
3. src\hooks\hooks.ts -> Browser setup and teardown logic
4. src\hooks\pageFixture.ts -> Simple way to share the page objects to steps
5. src\helper\env -> Multiple environments are handled
6. src\helper\types -> To get environment code suggestions
7. src\helper\report -> To generate the report
8. config/cucumber.js -> One file to do all the magic
9. package.json -> Contains all the dependencies
10. src\helper\auth -> Storage state (Auth file)
11. src\helper\util -> Read test data from json & logger

Tutorials

1. Learn Playwright - Playwright - TS
2. BDD in detail - TS binding