From 33a9fa0117accc4e2e54e3a7247a7db63df20700 Mon Sep 17 00:00:00 2001 From: atlldwp Date: Mon, 9 Dec 2024 12:35:01 +0100 Subject: [PATCH 1/4] Update 0_GettingStarted.md --- docs/e2e-system-tests/0_GettingStarted.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/docs/e2e-system-tests/0_GettingStarted.md b/docs/e2e-system-tests/0_GettingStarted.md index 871d8ae..8988201 100644 --- a/docs/e2e-system-tests/0_GettingStarted.md +++ b/docs/e2e-system-tests/0_GettingStarted.md @@ -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](../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. -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](../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. --- @@ -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. From 060403f0532235e4499a50d5e82d7c124bfbd1fa Mon Sep 17 00:00:00 2001 From: atlldwp Date: Mon, 9 Dec 2024 12:40:29 +0100 Subject: [PATCH 2/4] Update 0_GettingStarted.md --- docs/e2e-system-tests/0_GettingStarted.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/e2e-system-tests/0_GettingStarted.md b/docs/e2e-system-tests/0_GettingStarted.md index 8988201..e893494 100644 --- a/docs/e2e-system-tests/0_GettingStarted.md +++ b/docs/e2e-system-tests/0_GettingStarted.md @@ -41,7 +41,7 @@ Make sure you have access to the repository using your organization's credential 1. Setting Up Environment Variables for Dev Environment/Cluster: - - Duplicate the file [devTemplate.env.json](../env_variables/devTemplate.env.json) and rename the duplicated file to `local.env.json` inside the `env_variables` folder. + - Duplicate the file [devTemplate.env.json](https://github.com/hpi-schul-cloud/e2e-system-tests/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). @@ -49,7 +49,7 @@ Make sure you have access to the repository using your organization's credential 2. Setting Up Environment Variables for Staging Environment/Cluster: - - Duplicate the file [stagingTemplate.env.json](../env_variables/stagingTemplate.env.json) and rename the duplicated file to `staging.env.json` in the `env_variables` folder. + - Duplicate the file [stagingTemplate.env.json](https://github.com/hpi-schul-cloud/e2e-system-tests/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). From e9ad33d0328b37dbf1e12da51cd4a65ba7ed9be4 Mon Sep 17 00:00:00 2001 From: atlldwp Date: Mon, 9 Dec 2024 12:43:48 +0100 Subject: [PATCH 3/4] Update 0_GettingStarted.md --- docs/e2e-system-tests/0_GettingStarted.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/e2e-system-tests/0_GettingStarted.md b/docs/e2e-system-tests/0_GettingStarted.md index e893494..83c2df8 100644 --- a/docs/e2e-system-tests/0_GettingStarted.md +++ b/docs/e2e-system-tests/0_GettingStarted.md @@ -41,7 +41,7 @@ Make sure you have access to the repository using your organization's credential 1. Setting Up Environment Variables for Dev Environment/Cluster: - - Duplicate the file [devTemplate.env.json](https://github.com/hpi-schul-cloud/e2e-system-tests/env_variables/devTemplate.env.json) and rename the duplicated file to `local.env.json` inside the `env_variables` folder. + - 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). @@ -49,7 +49,7 @@ Make sure you have access to the repository using your organization's credential 2. Setting Up Environment Variables for Staging Environment/Cluster: - - Duplicate the file [stagingTemplate.env.json](https://github.com/hpi-schul-cloud/e2e-system-tests/env_variables/stagingTemplate.env.json) and rename the duplicated file to `staging.env.json` in the `env_variables` folder. + - 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). From 3f1228d48905da01f34c06478d3795ec828e5f48 Mon Sep 17 00:00:00 2001 From: atlldwp Date: Mon, 9 Dec 2024 12:44:36 +0100 Subject: [PATCH 4/4] Update 0_GettingStarted.md