[RFR] Add exception note to jira export tests (#787)

* add exception note to jira export tests Signed-off-by: Alejandro Brugarolas <[email protected]> * fix pr Signed-off-by: Alejandro Brugarolas <[email protected]> * fix pr Signed-off-by: Alejandro Brugarolas <[email protected]> --------- Signed-off-by: Alejandro Brugarolas <[email protected]>
konveyor · Nov 3, 2023 · 55ddf83 · 55ddf83
1 parent 00a8919
commit 55ddf83
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -37,6 +37,26 @@
 
     `npx cypress open`
 
+#### Required Parameters for Tests
+
+Some tests require certain configuration parameters to be correctly defined in the `cypress.config.ts` file.
+Below is a list of tests and the parameters they require.
+
+`export_to_jira_datacenter.test.ts`
+ - `jira_stage_datacenter_project_id`
+ - `jira_stage_bearer_token`
+ - `jira_stage_datacenter_url`
+
+`export_to_jira_cloud.test.ts`
+- `jira_atlassian_cloud_project`
+- `jira_atlassian_cloud_email`
+- `jira_atlassian_cloud_token`
+- `jira_atlassian_cloud_url`
+
+`source_analysis.test.ts` & `binary_analysis.test.ts`
+- `git_user`
+- `git_password`
+
 #### Code formatting using Prettier tool
 
 1. Format code

diff --git a/cypress/e2e/tests/migration/migration-waves/export_to_jira_cloud.test.ts b/cypress/e2e/tests/migration/migration-waves/export_to_jira_cloud.test.ts
@@ -44,6 +44,20 @@ let projectName = "";
  */
 describe(["@tier1", "@interop"], "Export Migration Wave to Jira Cloud", function () {
     before("Create test data", function () {
+        if (
+            !Cypress.env("jira_atlassian_cloud_project") ||
+            !Cypress.env("jira_atlassian_cloud_email") ||
+            !Cypress.env("jira_atlassian_cloud_token") ||
+            !Cypress.env("jira_atlassian_cloud_url")
+        ) {
+            expect(
+                true,
+                `
+                    Some configurations required for this test are missing, please ensure that you've properly configured the following parameters in the cypress.config.ts file:\n
+                    jira_atlassian_cloud_project\njira_atlassian_cloud_email\njira_atlassian_cloud_token\njira_atlassian_cloud_url
+                `
+            ).to.eq(false);
+        }
         login();
 
         jiraCloudCredentials = new JiraCredentials(

diff --git a/cypress/e2e/tests/migration/migration-waves/export_to_jira_datacenter.test.ts b/cypress/e2e/tests/migration/migration-waves/export_to_jira_datacenter.test.ts
@@ -44,6 +44,19 @@ let projectName = "";
  */
 describe(["@tier1"], "Export Migration Wave to Jira Datacenter", function () {
     before("Create test data", function () {
+        if (
+            !Cypress.env("jira_stage_datacenter_project_id") ||
+            !Cypress.env("jira_stage_bearer_token") ||
+            !Cypress.env("jira_stage_datacenter_url")
+        ) {
+            expect(
+                true,
+                `
+                    Some configurations required for this test are missing, please ensure that you've properly configured the following parameters in the cypress.config.ts file:\n
+                    jira_stage_datacenter_project_id\njira_stage_bearer_token\njira_stage_datacenter_url
+                `
+            ).to.eq(false);
+        }
         login();
 
         jiraCredentials = new JiraCredentials(