- Install Node.js (LTS)
- Clone repository:
git clone https://github.com/HannaTarasevich/cypress-cucumber-gitactions-html-report.gitThe repository can be forked as well.
- Install project dependencies:
npm install- To run tests using Cypress UI:
npm run cypress:open- To run tests in headless mode:
npm run cypress:run- To run tests in parallel mode (number of threads can be changed inside the script,
2threads are by default):
npm run cypress:parallel- To run tests by tag (
@smokeis by default):
npm run cypress:execution-tags- To generate report (it will be shown right after generating, path to report is
cypress/reports/index.html):
npm run report:generate.
├── ...
├── cypress # Test files (alternatively `spec` or `tests`)
│ └── e2e # End-to-end tests
│ ├── data # Test data (user credentials, URLs)
│ ├── features # Files with test scenarios written in Gherkin
│ ├── step_definitions # Step definitions with Given, When, Then
│ └── pages # Page object models (locators, interactions)
│ └── support # Files for supporting automation tests
└── ...
To make a commit to the project, eslint and gherkin-lint syntax checks need to be passed. Otherwise, commit fails with listed errors in the console.
Rules can be found in .eslintrc.json and .gherkin-lintrc files.
GitHub Actions workflow goal is to check whether incoming changes corresponds eslint and gherkin-lint rules, check if tests are passed.
The workflow is setup to be run for each Pull Request to the main branch.
It is described in github/workflows folder in actions.yml file.
It triggers the following steps:
1. Use Node.js LTS
2. Use stable Chrome
3. Install dependencies: npm Install
4. Check JavaScript syntax by eslint
5. Check Gherkin syntax by gherkin-lint
6. Run Cypress tests in parallel: npm run cypress:parallel
The result can be found on Actions tab of the repository.