TRACEFOSS-901: Trace-X Test Pipeline integration with Cypress + CuCumber and Xray (#3)

fbedarf · ds-ext-dskrzypczak · web-flow · commit 7c27353dd5e3 · 2023-02-15T17:22:58.000+01:00
* tst: cypress with xray integration

TRACEFOSS-901

---------

Co-authored-by: Darek Skrzypczak &lt;darek.skrzypczak@partner.doubleslash.de&gt;
diff --git a/.github/workflows/e2e-tests-xray.yml b/.github/workflows/e2e-tests-xray.yml
@@ -1,19 +1,26 @@
-name: E2E Tests
+# Require to set secrets:
+#  - ORG_IRS_JIRA_USERNAME
+#  - ORG_IRS_JIRA_PASSWORD
+name: E2E Tests - Xray
 
 on:
+  # triggered manually by Test Manager
+  workflow_dispatch:
+    inputs:
+      jira_filter_id:
+        description: 'Jira filter ID to fetch test scenarios'
+        required: false
+        # by default, we use this filter: https://jira.catena-x.net/issues/?filter=11645
+        default: 11645
+  # or automatically by merge to main
   push:
     branches: [ main ]
+  # or in PR
   pull_request:
 
 jobs:
   install:
     runs-on: ubuntu-latest
-    container:
-      # if you need to change image please make sure use the same version in all places
-      # (here and in cypress/Dockerfile)
-      image: cypress/browsers:node16.16.0-chrome107-ff107-edge
-      options: --user 1001
-
     # Install YARN dependencies, cache them correctly
     steps:
       - name: Checkout
@@ -29,10 +36,28 @@ jobs:
         with:
           cmd: install # will run `yarn install` command
 
+    # Fetch feature files
+      - name: Fetch .feature files from Jira Xray
+        env:
+          JIRA_USERNAME: ${{ secrets.ORG_IRS_JIRA_USERNAME }}
+          JIRA_PASSWORD: ${{ secrets.ORG_IRS_JIRA_PASSWORD }}
+          JIRA_FILTER_ID: ${{ github.event.inputs.jira_filter_id }}
+        run: |
+          ./scripts/xray-download-feature-files.sh
+
+      - name: Save cypress/e2e folder
+        uses: actions/upload-artifact@v3
+        with:
+          name: cypress - e2e
+          if-no-files-found: error
+          path: cypress/e2e
+
   cypress-run-chrome:
     timeout-minutes: 15
     runs-on: ubuntu-latest
     container:
+      # if you need to change image please make sure use the same version in all places
+      # (here and in cypress/Dockerfile)
       image: cypress/browsers:node16.16.0-chrome107-ff107-edge
       options: --user 1001
     needs: install
@@ -41,6 +66,12 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
+      - name: Download the cypress/e2e folder
+        uses: actions/download-artifact@v3
+        with:
+          name: cypress - e2e
+          path: cypress/e2e
+
       - name: Use Node.js 18.x
         uses: actions/setup-node@v3
         with:
@@ -54,6 +85,15 @@ jobs:
           wait-on-timeout: 120
           browser: chrome
 
+      - name: Submit results to Xray
+        # we don't want to submit results to xray when it was run by PR
+        if: github.event_name != 'pull_request' && (success() || failure())
+        env:
+          JIRA_USERNAME: ${{ secrets.ORG_IRS_JIRA_USERNAME }}
+          JIRA_PASSWORD: ${{ secrets.ORG_IRS_JIRA_PASSWORD }}
+        run: |
+          ./scripts/xray-push-test-results.sh
+
       - name: Archive cypress artifacts
         if: success() || failure()
         uses: actions/upload-artifact@v3
@@ -67,6 +107,8 @@ jobs:
     timeout-minutes: 15
     runs-on: ubuntu-latest
     container:
+      # if you need to change image please make sure use the same version in all places
+      # (here and in cypress/Dockerfile)
       image: cypress/browsers:node16.16.0-chrome107-ff107-edge
       options: --user 1001
     needs: install
@@ -75,6 +117,12 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
+      - name: Download the cypress/e2e folder
+        uses: actions/download-artifact@v3
+        with:
+          name: cypress - e2e
+          path: cypress/e2e
+
       - name: Use Node.js 18.x
         uses: actions/setup-node@v3
         with:
@@ -88,6 +136,15 @@ jobs:
           wait-on-timeout: 120
           browser: firefox
 
+      - name: Submit results to Xray
+        # we don't want to submit results to xray when it was run by PR
+        if: github.event_name != 'pull_request' && (success() || failure())
+        env:
+          JIRA_USERNAME: ${{ secrets.ORG_IRS_JIRA_USERNAME }}
+          JIRA_PASSWORD: ${{ secrets.ORG_IRS_JIRA_PASSWORD }}
+        run: |
+          ./scripts/xray-push-test-results.sh
+
       - name: Archive cypress artifacts
         if: success() || failure()
         uses: actions/upload-artifact@v3
@@ -106,6 +163,12 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
+      - name: Download the cypress/e2e folder
+        uses: actions/download-artifact@v3
+        with:
+          name: cypress - e2e
+          path: cypress/e2e
+
 # commented because if we use it here, we face with that problem:
 # "http://localhost:4200 timed out on retry 151 of 5, elapsed 150449ms, limit 150000ms
 #  Error: connect ECONNREFUSED 127.0.0.1:4200"
@@ -132,6 +195,15 @@ jobs:
           wait-on-timeout: 120
           browser: webkit
 
+      - name: Submit results to Xray
+        # we don't want to submit results to xray when it was run by PR
+        if: github.event_name != 'pull_request' && (success() || failure())
+        env:
+          JIRA_USERNAME: ${{ secrets.ORG_IRS_JIRA_USERNAME }}
+          JIRA_PASSWORD: ${{ secrets.ORG_IRS_JIRA_PASSWORD }}
+        run: |
+          ./scripts/xray-push-test-results.sh
+
       - name: Archive cypress artifacts
         if: success() || failure()
         uses: actions/upload-artifact@v3
diff --git a/.gitignore b/.gitignore
@@ -36,12 +36,12 @@ testem.log
 /typings
 /audit-reports
 src/tests/test-report.xml
-cypress/videos
-cypress/screenshots
 
 # e2e
-/e2e/*.js
-/e2e/*.map
+cypress/videos
+cypress/screenshots
+cypress/reports/*
+cucumber-messages.ndjson
 
 # System Files
 .DS_Store
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -16,5 +16,3 @@ The following people have contributed to this repository:
 - Nobert Geczi,msg Systems Romania SRL,https://github.com/norbertgeczi
 - Markus Kreuz,FEV Consulting GmbH,https://github.com/CXkreuz
 - Thomas Braun,ZF Friedrichshafen AG,https://github.com/tbraun-zf
-
-
diff --git a/cypress/cucumber-json-formatter b/cypress/cucumber-json-formatter
diff --git a/cypress/e2e/dashboard.feature b/cypress/e2e/dashboard.feature
diff --git a/docs/e2e.md b/docs/e2e.md
@@ -24,21 +24,45 @@ To be able to use Behavior-driven development (BDD) approach we have configured
 
 ### Using docker browsers
 
-- local env - docker image (use the same browser engine versions as github CI/CD)
+- local env - docker image (use the same browser engine versions as GitHub CI/CD)
   - run this command first to build docker image with cypress browsers: `docker compose -f cypress/docker-compose.yml build `
   - then make sure you have running frontend app: `yarn start` because docker image uses localhost url to connect run tests
   - then we can run E2E cypress tests on these browsers:
     - chrome - `docker compose -f cypress/docker-compose.yml run cypress --browser=chrome`
     - firefox - `docker compose -f cypress/docker-compose.yml run cypress --browser=firefox`
     - webkit (safari's engine) - `docker compose -f cypress/docker-compose.yml run cypress --browser=webkit`
 
-## How it works on github actions (CI/CD)
+## How it works on GitHub actions (CI/CD)
+
+### Overview
 
 - configuration file is here: `.github/workflows/e2e-tests.yml`
+- this job is triggered by 3 ways:
+  - automatically - for every PR or on push to main
+  - manually - by Test Manager
 - we run in parallel e2e tests for 3 browser engines: chrome, firefox and webkit (used by Safari)
 - we use one common pre-stage named 'install'
 - then base on 'install' stage cache result it runs 3 separated threads for every browser
   - cypress-run-chrome
   - cypress-run-firefox
   - cypress-run-webkit
 - every thread as a part of result has an Artifact section with cypress generated files like videos or screenshots. we can download zip file with those files and open video/screenshot to check what happened.
+
+### Xray (Jira) integration
+
+### Configuration
+
+By default, to fetch .feature files with Cucumber scenarios we use this jira filter: https://jira.catena-x.net/issues/?filter=11645.
+But when we run GitHub job manually, we can set different value in parameter "jira_filter_id".
+
+#### Cucumber scenarios in Xray
+
+- in first initial step "install" we fetch .feature files from Xray by scripts/xray-download-feature-files.sh
+- then every cypress browser execution use these scenarios
+- we keep a package with downloaded scenarios as artifact in GitHub job (named: cypress - e2e)
+
+#### Xray Test Execution Reports
+
+- after every cypress browser execution we generate test results in cucumber format (we use cypress/cucumber-json-formatter: https://github.com/badeball/cypress-cucumber-preprocessor/blob/master/docs/json-report.md)
+- those test executions results are imported to Xray by this script: scripts/xray-push-test-results.sh
+- IMPORTANT! - we don't send reports if the job was triggered by PR event
diff --git a/package.json b/package.json
@@ -121,5 +121,12 @@
   },
   "msw": {
     "workerDirectory": "src"
+  },
+  "cypress-cucumber-preprocessor": {
+    "json": {
+      "enabled": true,
+      "formatter": "cypress/cucumber-json-formatter",
+      "output": "cypress/reports/cucumber-report.json"
+    }
   }
 }
diff --git a/scripts/xray-download-feature-files.sh b/scripts/xray-download-feature-files.sh
@@ -0,0 +1,4 @@
+# https://docs.getxray.app/display/XRAY/Exporting+Cucumber+Tests+-+REST
+curl -u $JIRA_USERNAME:$JIRA_PASSWORD "https://jira.catena-x.net/rest/raven/1.0/export/test?filter=${JIRA_FILTER_ID:-11645}&fz=true" -o features.zip
+unzip -o features.zip -d cypress/e2e
+rm -f features.zip
diff --git a/scripts/xray-push-test-results.sh b/scripts/xray-push-test-results.sh
@@ -0,0 +1,5 @@
+curl --request POST \
+          -u $JIRA_USERNAME:$JIRA_PASSWORD \
+          --header 'Content-Type: application/json' \
+          --data-binary '@cypress/reports/cucumber-report.json' \
+          "https://jira.catena-x.net/rest/raven/1.0/import/execution/cucumber"

Original file line number	Diff line number	Diff line change
`@@ -121,5 +121,12 @@`
`121`	`121`	`},`
`122`	`122`	`"msw": {`
`123`	`123`	`"workerDirectory": "src"`
	`124`	`+ },`
	`125`	`+ "cypress-cucumber-preprocessor": {`
	`126`	`+ "json": {`
	`127`	`+ "enabled": true,`
	`128`	`+ "formatter": "cypress/cucumber-json-formatter",`
	`129`	`+ "output": "cypress/reports/cucumber-report.json"`
	`130`	`+ }`
`124`	`131`	`}`
`125`	`132`	`}`