BDD Testing for "Schulcloud-Verbund-Software" using Cypress & Cucumber

Frameworks:

• Cypress v13.2.0

• Cypress cucumber pre-processor v18.0.6

Prepare development environment

Install or make sure Chrome browser (at least) have it in your development machine

1. Install Node v18
2. Install Git
3. Install Github Desktop App (Optional)
4. Install IDE of your choice e.g. VS code
5. Install VS code extensions:
   • Cucumber (Gherkin) Full Support
   • EditorConfig

How to setup/run Cypress tests locally

1. Clone the project
2. Duplicate template.env.json file and rename the duplicated file to local.env.json in the env_variables folder with credentials available in 1Password including api keys. (Remember add all instances as in 1Password we have different vaults available)
3. Execute the following command in terminal npm install or npm i for installing the required packages
4. Execute the following command in terminal to run all stable tests in Cypress runner (UI): npm run cy:open:local
5. Execute the following command in terminal to run all stable tests in headless mode: npm run tag:stable:local
6. For running tests which are stable and running in PR's: Run npm run tag:stable:pr:local
7. For running tests which are stable and running in releases: Run npm run tag:stable:release:local
8. For running specific scenario: Run npm run tag:only:local and set tag @only above the scenario you want to run
9. For running all unstable tests: Run npm run tag:unstable:local

Framework Structure

(root)
|
|---- .github (containing github workflows)
|   |____ automatic-trigger.yml
|   |____ manual-trigger.yml
|   |____ scheduled-trigger.yml
|---- .vscode (setting for VS code extensions)
|---- env_variables
|   |____ template.env.json (credentials & environment variables - rename the file as mentioned above)
|---- cypress
|   |___ downloads
|   |___ fixtures
|   |___ e2e (containing feature files)
|   |___ screenshots
|   |___ support
|   |    |___ custom_commands (used in our tests)
|   |    |___ pages (containing methods)
|   |    |___ step_definitions (step hooks for feature files)
|   |    |___ command.js
|   |    |___ e2e.js
|   |___ videos
|---- reports (containing html report & assets)
|---- logs(contains logs of the test run)
|---- node_modules
|---- scripts
|   |____ aggregate-json-files.sh (Aggregate all json files into one json file in CI)
|---- .editorconfig
|---- .gitattributes
|---- .prettierignore
|---- .prettierrc
|---- .gitignore
|---- reporter.js (for generating html reports)
|---- cypress.config.json (cypress related settings)
|---- LICENSE
|---- package-lock.json
|---- package.json
|---- README.md