adding additional params for test case base grouping to snapshot and …

…comparison (#1547) * adding thTestCaseExecutionId params to snapshot and comparison * revert test.js * test update
percy · Mar 15, 2024 · 7daeb74 · 7daeb74
1 parent 7c2bdcc
commit 7daeb74
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 8 deletions.
diff --git a/packages/cli-upload/test/upload.test.js b/packages/cli-upload/test/upload.test.js
@@ -91,7 +91,8 @@ describe('percy upload', () => {
           'scope-options': {},
           'minimum-height': 10,
           'enable-javascript': null,
-          'enable-layout': false
+          'enable-layout': false,
+          'th-test-case-execution-id': null
         },
         relationships: {
           resources: {

diff --git a/packages/client/src/client.js b/packages/client/src/client.js
@@ -359,6 +359,7 @@ export class PercyClient {
     environmentInfo,
     sync,
     testCase,
+    thTestCaseExecutionId,
     resources = []
   } = {}) {
     validateId('build', buildId);
@@ -388,7 +389,8 @@ export class PercyClient {
           'scope-options': scopeOptions || {},
           'minimum-height': minHeight || null,
           'enable-javascript': enableJavaScript || null,
-          'enable-layout': enableLayout || false
+          'enable-layout': enableLayout || false,
+          'th-test-case-execution-id': thTestCaseExecutionId || null
         },
         relationships: {
           resources: {

diff --git a/packages/client/test/client.test.js b/packages/client/test/client.test.js
@@ -661,6 +661,7 @@ describe('PercyClient', () => {
         enableLayout: true,
         clientInfo: 'sdk/info',
         environmentInfo: 'sdk/env',
+        thTestCaseExecutionId: 'random-uuid',
         resources: [{
           url: '/foo',
           content: 'foo',
@@ -694,7 +695,8 @@ describe('PercyClient', () => {
             'minimum-height': 1000,
             'scope-options': { scroll: true },
             'enable-javascript': true,
-            'enable-layout': true
+            'enable-layout': true,
+            'th-test-case-execution-id': 'random-uuid'
           },
           relationships: {
             resources: {
@@ -740,7 +742,8 @@ describe('PercyClient', () => {
             'scope-options': {},
             'minimum-height': null,
             'enable-javascript': null,
-            'enable-layout': false
+            'enable-layout': false,
+            'th-test-case-execution-id': null
           },
           relationships: {
             resources: {
@@ -809,7 +812,8 @@ describe('PercyClient', () => {
             'enable-javascript': null,
             'minimum-height': null,
             widths: null,
-            'enable-layout': false
+            'enable-layout': false,
+            'th-test-case-execution-id': null
           },
           relationships: {
             resources: {
@@ -1318,7 +1322,8 @@ describe('PercyClient', () => {
               'minimum-height': null,
               widths: null,
               sync: false,
-              'enable-layout': false
+              'enable-layout': false,
+              'th-test-case-execution-id': null
             },
             relationships: {
               resources: {

diff --git a/packages/core/src/config.js b/packages/core/src/config.js
@@ -74,6 +74,9 @@ export const configSchema = {
       testCase: {
         type: 'string'
       },
+      thTestCaseExecutionId: {
+        type: 'string'
+      },
       fullPage: {
         type: 'boolean',
         onlyAutomate: true
@@ -271,6 +274,7 @@ export const snapshotSchema = {
         enableLayout: { $ref: '/config/snapshot#/properties/enableLayout' },
         sync: { $ref: '/config/snapshot#/properties/sync' },
         testCase: { $ref: '/config/snapshot#/properties/testCase' },
+        thTestCaseExecutionId: { $ref: '/config/snapshot#/properties/thTestCaseExecutionId' },
         reshuffleInvalidTags: { $ref: '/config/snapshot#/properties/reshuffleInvalidTags' },
         scopeOptions: { $ref: '/config/snapshot#/properties/scopeOptions' },
         discovery: {
@@ -558,6 +562,12 @@ export const comparisonSchema = {
     externalDebugUrl: { type: 'string' },
     domInfoSha: { type: 'string' },
     sync: { type: 'boolean' },
+    testCase: {
+      type: 'string'
+    },
+    thTestCaseExecutionId: {
+      type: 'string'
+    },
     metadata: {
       type: 'object',
       additionalProperties: false,

diff --git a/packages/core/test/api.test.js b/packages/core/test/api.test.js
@@ -355,7 +355,9 @@ describe('API Server', () => {
           freeze_animated_image: true,
           freezeImageBySelectors: ['.selector-per-screenshot'],
           ignore_region_xpaths: ['/xpath-per-screenshot'],
-          consider_region_xpaths: ['/xpath-per-screenshot']
+          consider_region_xpaths: ['/xpath-per-screenshot'],
+          testCase: 'random test case',
+          thTestCaseExecutionId: 'random uuid'
         }
       },
       method: 'post'
@@ -374,7 +376,9 @@ describe('API Server', () => {
         ignoreRegionSelectors: ['.selector-global'],
         ignoreRegionXpaths: ['/xpath-per-screenshot'],
         considerRegionXpaths: ['/xpath-global', '/xpath-per-screenshot'],
-        version: 'v2'
+        version: 'v2',
+        testCase: 'random test case',
+        thTestCaseExecutionId: 'random uuid'
       }
     }));
 

diff --git a/packages/webdriver-utils/src/index.js b/packages/webdriver-utils/src/index.js
@@ -25,6 +25,8 @@ export default class WebdriverUtils {
       comparisonData.metadata.cliScreenshotStartTime = startTime;
       comparisonData.metadata.cliScreenshotEndTime = Date.now();
       comparisonData.sync = options.sync;
+      comparisonData.testCase = options.testCase;
+      comparisonData.thTestCaseExecutionId = options.thTestCaseExecutionId;
       log.debug(`[${snapshotName}] : Comparison Data: ${JSON.stringify(comparisonData)}`);
       return comparisonData;
     } catch (e) {