SBVT-2390 SCM tracking (#240)

* SBVT-2390 SCM tracking * SBVT-2390 SCM tracking
SmartBear · May 15, 2024 · 7e352da · 7e352da
1 parent 27f7ba9
commit 7e352da
Show file tree

Hide file tree

Showing 10 changed files with 32 additions and 4 deletions.
diff --git a/.github/workflows/browser_test.yml b/.github/workflows/browser_test.yml
@@ -3,7 +3,7 @@ name: browser-type-check
 on: [pull_request]
 jobs:
   cypress-run:
-    runs-on: ubuntu-latest
+    runs-on: self-hosted
     strategy:
       fail-fast: false
       matrix:
@@ -47,4 +47,6 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PROJECT_TOKEN: ${{ secrets.DEV_EXAMPLE_7 }}
           TEST_RUN_NAME: ${{ steps.set-test-run-name.outputs.TEST_RUN_NAME }}
+          SBVT_SCM_BRANCH: ${{ github.head_ref || github.ref_name }}
+          SBVT_SCM_COMMIT_ID: ${{ github.sha }}
           DEBUG: TRUE
diff --git a/.github/workflows/cypress_version-test.yml b/.github/workflows/cypress_version-test.yml
@@ -3,7 +3,7 @@ name: cypress-version-check
 on: [pull_request]
 jobs:
   cypress-run:
-    runs-on: ubuntu-latest
+    runs-on: self-hosted
     strategy:
       fail-fast: false
       matrix:
@@ -69,6 +69,8 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PROJECT_TOKEN: ${{ secrets.DEV_EXAMPLE_7 }}
           TEST_RUN_NAME: ${{ steps.set-test-run-name.outputs.TEST_RUN_NAME }}
+          SBVT_SCM_BRANCH: ${{ github.head_ref || github.ref_name }}
+          SBVT_SCM_COMMIT_ID: ${{ github.sha }}
           DEBUG: TRUE
 
 
@@ -114,4 +116,6 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PROJECT_TOKEN: ${{ secrets.DEV_EXAMPLE_7 }}
           TEST_RUN_NAME: ${{ steps.set-test-run-name.outputs.TEST_RUN_NAME }}
+          SBVT_SCM_BRANCH: ${{ github.head_ref || github.ref_name }}
+          SBVT_SCM_COMMIT_ID: ${{ github.sha }}
           DEBUG: TRUE
diff --git a/.github/workflows/linux_quick-test.yaml b/.github/workflows/linux_quick-test.yaml
@@ -3,7 +3,7 @@ on: [push]
 #on: [pull_request]
 jobs:
   cypress-run:
-    runs-on: ubuntu-latest
+    runs-on: self-hosted
     strategy:
       fail-fast: true
 
@@ -35,6 +35,8 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PROJECT_TOKEN: ${{ secrets.DEV_EXAMPLE_7 }}
           TEST_RUN_NAME: ${{ steps.set-test-run-name.outputs.TEST_RUN_NAME }}
+          SBVT_SCM_BRANCH: ${{ github.head_ref || github.ref_name }}
+          SBVT_SCM_COMMIT_ID: ${{ github.sha }}
           DEBUG: TRUE
 
 
diff --git a/.github/workflows/mac_windows_quick-tests.yml b/.github/workflows/mac_windows_quick-tests.yml
@@ -31,6 +31,8 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PROJECT_TOKEN: ${{ secrets.DEV_EXAMPLE_7 }}
           TEST_RUN_NAME: "${{ github.workflow }}—${{ runner.os }}—${{ github.ref }}"
+          SBVT_SCM_BRANCH: ${{ github.head_ref || github.ref_name }}
+          SBVT_SCM_COMMIT_ID: ${{ github.sha }}
           DEBUG: TRUE
 
 

diff --git a/.github/workflows/npm-package_test.yml b/.github/workflows/npm-package_test.yml
@@ -38,6 +38,8 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PROJECT_TOKEN: ${{ secrets.DEV_EXAMPLE_7 }}
           TEST_RUN_NAME: ${{ steps.set-test-run-name.outputs.TEST_RUN_NAME }}
+          SBVT_SCM_BRANCH: ${{ github.head_ref || github.ref_name }}
+          SBVT_SCM_COMMIT_ID: ${{ github.sha }}
           DEBUG: TRUE
 
 
diff --git a/.github/workflows/print_report-test.yml b/.github/workflows/print_report-test.yml
@@ -34,6 +34,8 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PROJECT_TOKEN: ${{ secrets.DEV_EXAMPLE_7 }}
           TEST_RUN_NAME: "${{ github.workflow }}—${{ runner.os }}—${{ github.ref }}"
+          SBVT_SCM_BRANCH: ${{ github.head_ref || github.ref_name }}
+          SBVT_SCM_COMMIT_ID: ${{ github.sha }}
           DEBUG: TRUE
 
 
diff --git a/.github/workflows/typescript-test.yml b/.github/workflows/typescript-test.yml
@@ -51,6 +51,8 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PROJECT_TOKEN: ${{ secrets.DEV_EXAMPLE_7 }}
           TEST_RUN_NAME: ${{ steps.set-test-run-name.outputs.TEST_RUN_NAME }}
+          SBVT_SCM_BRANCH: ${{ github.head_ref || github.ref_name }}
+          SBVT_SCM_COMMIT_ID: ${{ github.sha }}
           DEBUG: TRUE
 
 
diff --git a/.github/workflows/webkit-browser_test.yml b/.github/workflows/webkit-browser_test.yml
@@ -37,4 +37,6 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PROJECT_TOKEN: ${{ secrets.DEV_EXAMPLE_7 }}
           TEST_RUN_NAME: "${{ github.workflow }}—${{ runner.os }}—${{ github.ref }}"
+          SBVT_SCM_BRANCH: ${{ github.head_ref || github.ref_name }}
+          SBVT_SCM_COMMIT_ID: ${{ github.sha }}
           DEBUG: TRUE
diff --git a/README.md b/README.md
@@ -125,6 +125,13 @@ module.exports = {
 // OR save on the environment variable 
 // SBVT_TEST_GROUP_NAME = 'test group name'
 ```
+## Assigning SCM data to a test run
+
+Save Source Control Manager data on the environment variable
+```bash
+SBVT_SCM_BRANCH=branch-name 
+SBVT_SCM_COMMIT_ID=commit-hash
+```
 
 ## Manual Setup
 

diff --git a/plugin.js b/plugin.js
@@ -306,7 +306,10 @@ function makeGlobalRunHooks() {
                         const postResponse = await apiRequest('post', `${configFile.url}/api/v1/projects/${configFile.projectId}/testruns`, {
                             testRunName: configFile.testRunName,
                             sdk: 'cypress',
-                            sdkVersion: `${package_json.version}/c${usersCypress.version}`, ...(!!process.env.SBVT_TEST_GROUP_ID ? {testGroupId: process.env.SBVT_TEST_GROUP_ID} : !!configFile.testGroupName ? {testGroupId: await getCreateTestGroupId(getUsersTestGroupName(configFile.testGroupName), configFile.projectToken)} : {}),
+                            sdkVersion: `${package_json.version}/c${usersCypress.version}`,
+                            ...(!!process.env.SBVT_TEST_GROUP_ID ? {testGroupId: process.env.SBVT_TEST_GROUP_ID} : !!configFile.testGroupName ? {testGroupId: await getCreateTestGroupId(getUsersTestGroupName(configFile.testGroupName), configFile.projectToken)} : {}),
+                            ...(!!process.env.SBVT_SCM_COMMIT_ID ? {scmCommitId: process.env.SBVT_SCM_COMMIT_ID} : {}),
+                            ...(!!process.env.SBVT_SCM_BRANCH ? {scmBranch: process.env.SBVT_SCM_BRANCH} : {}),
                         });
                         configFile.testRunId = postResponse.data.testRunId;
                         logger.debug('config.testRunId: ' + configFile.testRunId);