Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BC-8433 Update e2e cypress setup doc #45

Merged
merged 4 commits into from
Dec 9, 2024
Merged

BC-8433 Update e2e cypress setup doc #45

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
33a9fa0
Update 0_GettingStarted.md
atlldwp Dec 9, 2024
060403f
Update 0_GettingStarted.md
atlldwp Dec 9, 2024
e9ad33d
Update 0_GettingStarted.md
atlldwp Dec 9, 2024
3f1228d
Update 0_GettingStarted.md
atlldwp Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions docs/e2e-system-tests/0_GettingStarted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,24 @@ Make sure you have access to the repository using your organization's credential

---

## 3. Setting Up Environment Configuration
## 3. Setting Up Environment Variables for the Testing User Credentials and URLs

1. Duplicate the `template.env.json` file located in the `env_variables` directory:
1. Setting Up Environment Variables for Dev Environment/Cluster:

- Rename the duplicated file to `local.env.json`.
- Update `local.env.json` with your credentials and environment-specific variables from 1Password.
- Ensure that the credentials match the correct namespace vault (staging, dev, etc.) in 1Password.
- Duplicate the file [devTemplate.env.json](https://github.com/hpi-schul-cloud/e2e-system-tests/blob/main/env_variables/devTemplate.env.json) and rename the duplicated file to `local.env.json` inside the `env_variables` folder.
- Include the required development namespace URLs for BRB/DBC/NBC.
- Test user data on development clusters are created using the school API.
- To retrieve the API keys for all three namespaces, navigate to 1Password (1PW).
- Contact QA team for the necessary 1Password links.
atlldwp marked this conversation as resolved.
Show resolved Hide resolved

2. This configuration is required for accessing APIs, authentication, and other environment-specific services.
2. Setting Up Environment Variables for Staging Environment/Cluster:

- Duplicate the file [stagingTemplate.env.json](https://github.com/hpi-schul-cloud/e2e-system-tests/blob/main/env_variables/stagingTemplate.env.json) and rename the duplicated file to `staging.env.json` in the `env_variables` folder.
- Include the required staging namespace URLs for BRB/DBC/NBC.
- Test data on the staging environment are fetched from the seed data on the server.
- Add the environment-specific credentials to `staging.env.json` from 1Password (1PW).
- Ensure all instances are included, as 1Password contains different vaults for each namespace with testing credentials.
- Contact QA team for the necessary 1Password links.
atlldwp marked this conversation as resolved.
Show resolved Hide resolved

---

Expand Down Expand Up @@ -75,4 +84,4 @@ Once the setup is complete, you can run the tests:
npm run cy:gui:stable:regression:staging:local
```

For more details on additional configurations and test options, refer to the [`Running Tests Guide`](https://github.com/hpi-schul-cloud/e2e-system-tests/blob/main/docs/running_tests_guide.md) section in README.
For more details on additional configurations and test options, refer to the [`Executing Tests Guide`](https://github.com/hpi-schul-cloud/e2e-system-tests/blob/main/docs/executing_tests_guide.md) section in README.
Loading