[ci-visibility] Fix calculation of test suites to skip based on ITR response (#3130)

Author: juan-fernandez

packages/datadog-instrumentations/src/jest.js

@@ -9,8 +9,15 @@ const {
   getCoveredFilenamesFromCoverage,
   JEST_WORKER_TRACE_PAYLOAD_CODE,
   JEST_WORKER_COVERAGE_PAYLOAD_CODE,
-  getTestLineStart
+  getTestLineStart,
+  getTestSuitePath,
+  getTestParametersString
 } = require('../../dd-trace/src/plugins/util/test')
+const {
+  getFormattedJestTestParameters,
+  getJestTestName,
+  getJestSuitesToRun
+} = require('../../datadog-plugin-jest/src/util')
 
 const testSessionStartCh = channel('ci:jest:session:start')
 const testSessionFinishCh = channel('ci:jest:session:finish')
@@ -37,13 +44,6 @@ let skippableSuites = []
 let isCodeCoverageEnabled = false
 let isSuitesSkippingEnabled = false
 
-const {
-  getTestSuitePath,
-  getTestParametersString
-} = require('../../dd-trace/src/plugins/util/test')
-
-const { getFormattedJestTestParameters, getJestTestName } = require('../../datadog-plugin-jest/src/util')
-
 const sessionAsyncResource = new AsyncResource('bound-anonymous-fn')
 
 const specStatusToTestStatus = {
@@ -429,10 +429,7 @@ addHook({
     const testPaths = await getTestPaths.apply(this, arguments)
     const { tests } = testPaths
 
-    const filteredTests = tests.filter(({ path: testPath }) => {
-      const relativePath = testPath.replace(`${rootDir}/`, '')
-      return !skippableSuites.includes(relativePath)
-    })
+    const filteredTests = getJestSuitesToRun(skippableSuites, tests, rootDir)
 
     skippableSuites = []
 

packages/datadog-plugin-jest/src/util.js

@@ -1,3 +1,5 @@
+const { getTestSuitePath } = require('../../dd-trace/src/plugins/util/test')
+
 /**
  * There are two ways to call `test.each` in `jest`:
  * 1. With an array of arrays: https://jestjs.io/docs/api#1-testeachtablename-fn-timeout
@@ -45,4 +47,11 @@ function getJestTestName (test) {
   return titles.join(' ')
 }
 
-module.exports = { getFormattedJestTestParameters, getJestTestName }
+function getJestSuitesToRun (skippableSuites, originalTests, rootDir) {
+  return originalTests.filter(({ path: testPath }) => {
+    const relativePath = getTestSuitePath(testPath, rootDir)
+    return !skippableSuites.includes(relativePath)
+  })
+}
+
+module.exports = { getFormattedJestTestParameters, getJestTestName, getJestSuitesToRun }

packages/datadog-plugin-jest/test/util.spec.js

@@ -1,4 +1,5 @@
-const { getFormattedJestTestParameters } = require('../src/util')
+const path = require('path')
+const { getFormattedJestTestParameters, getJestSuitesToRun } = require('../src/util')
 
 describe('getFormattedJestTestParameters', () => {
   it('returns formatted parameters for arrays', () => {
@@ -18,3 +19,57 @@ describe('getFormattedJestTestParameters', () => {
     expect(resultObject).to.eql(undefined)
   })
 })
+
+describe('getJestSuitesToRun', () => {
+  it('returns filtered suites', () => {
+    const skippableSuites = [
+      'src/unit.spec.js',
+      'src/integration.spec.js'
+    ]
+    const tests = [
+      { path: '/workspace/dd-trace-js/src/unit.spec.js' },
+      { path: '/workspace/dd-trace-js/src/integration.spec.js' },
+      { path: '/workspace/dd-trace-js/src/e2e.spec.js' }
+    ]
+    const rootDir = '/workspace/dd-trace-js'
+
+    const filteredSuites = getJestSuitesToRun(skippableSuites, tests, rootDir)
+    expect(filteredSuites).to.eql([{ path: '/workspace/dd-trace-js/src/e2e.spec.js' }])
+  })
+
+  it('returns filtered suites when paths are windows like', () => {
+    const skippableSuites = [
+      'src/unit.spec.js',
+      'src/integration.spec.js'
+    ]
+    const tests = [
+      { path: `C:${path.sep}temp${path.sep}dd-trace-js${path.sep}src${path.sep}unit.spec.js` },
+      { path: `C:${path.sep}temp${path.sep}dd-trace-js${path.sep}src${path.sep}integration.spec.js` },
+      { path: `C:${path.sep}temp${path.sep}dd-trace-js${path.sep}src${path.sep}e2e.spec.js` }
+    ]
+    const rootDir = `C:${path.sep}temp${path.sep}dd-trace-js`
+
+    const filteredSuites = getJestSuitesToRun(skippableSuites, tests, rootDir)
+    expect(filteredSuites).to.eql([
+      { path: `C:${path.sep}temp${path.sep}dd-trace-js${path.sep}src${path.sep}e2e.spec.js` }
+    ])
+  })
+
+  it('returns filtered suites when paths are relative', () => {
+    const skippableSuites = [
+      '../../src/unit.spec.js',
+      '../../src/integration.spec.js'
+    ]
+    const tests = [
+      { path: '/workspace/dd-trace-js/src/unit.spec.js' },
+      { path: '/workspace/dd-trace-js/src/integration.spec.js' },
+      { path: '/workspace/dd-trace-js/src/e2e.spec.js' }
+    ]
+    const rootDir = '/workspace/dd-trace-js/config/root-config'
+
+    const filteredSuites = getJestSuitesToRun(skippableSuites, tests, rootDir)
+    expect(filteredSuites).to.eql([
+      { path: '/workspace/dd-trace-js/src/e2e.spec.js' }
+    ])
+  })
+})