[test-optimization] [SDTEST-2290] Fix support for Cucumber 12+ (#6087)

Author: Mariovido

.github/workflows/test-optimization.yml

@@ -75,9 +75,8 @@ jobs:
   integration-ci:
     strategy:
       matrix:
-        # TODO: Add cucumber and selenium once cucumber+12 is fixed
         version: [oldest, latest]
-        framework: [jest, mocha]
+        framework: [cucumber, selenium, jest, mocha]
     runs-on: ubuntu-latest
     env:
       DD_SERVICE: dd-trace-js-integration-tests
@@ -161,14 +160,13 @@ jobs:
         env:
           NODE_OPTIONS: '-r ./ci/init'
 
-  # TODO: Remove comment once cucumber+12 is fixed
-  # plugin-cucumber:
-  #   runs-on: ubuntu-latest
-  #   env:
-  #     PLUGINS: cucumber
-  #   steps:
-  #     - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-  #     - uses: ./.github/actions/plugins/test
+  plugin-cucumber:
+    runs-on: ubuntu-latest
+    env:
+      PLUGINS: cucumber
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: ./.github/actions/plugins/test
 
   # TODO: fix performance issues and test more Node versions
   plugin-cypress:

integration-tests/ci-visibility/automatic-log-submission.spec.js

@@ -11,6 +11,7 @@ const {
 } = require('../helpers')
 const { FakeCiVisIntake } = require('../ci-visibility-intake')
 const webAppServer = require('./web-app-server')
+const { NODE_MAJOR } = require('../../version')
 
 describe('test visibility automatic log submission', () => {
   let sandbox, cwd, receiver, childProcess, webAppPort
@@ -59,11 +60,10 @@ describe('test visibility automatic log submission', () => {
       name: 'jest',
       command: 'node ./node_modules/jest/bin/jest --config ./ci-visibility/automatic-log-submission/config-jest.js'
     },
-    // TODO: Uncomment once cucumber+12 is fixed
-    // {
-    //   name: 'cucumber',
-    //   command: './node_modules/.bin/cucumber-js ci-visibility/automatic-log-submission-cucumber/*.feature'
-    // },
+    {
+      name: 'cucumber',
+      command: './node_modules/.bin/cucumber-js ci-visibility/automatic-log-submission-cucumber/*.feature'
+    },
     {
       name: 'playwright',
       command: './node_modules/.bin/playwright test -c playwright.config.js',
@@ -76,6 +76,8 @@ describe('test visibility automatic log submission', () => {
   ]
 
   testFrameworks.forEach(({ name, command, getExtraEnvVars = () => ({}) }) => {
+    if ((NODE_MAJOR === 18 || NODE_MAJOR === 23) && name === 'cucumber') return
+
     context(`with ${name}`, () => {
       it('can automatically submit logs', (done) => {
         let logIds, testIds

integration-tests/cucumber/cucumber.spec.js

@@ -63,6 +63,7 @@ const {
   DD_CAPABILITIES_IMPACTED_TESTS
 } = require('../../packages/dd-trace/src/plugins/util/test')
 const { DD_HOST_CPU_COUNT } = require('../../packages/dd-trace/src/plugins/util/env')
+const { NODE_MAJOR } = require('../../version')
 
 const versions = ['7.0.0', 'latest']
 
@@ -74,6 +75,8 @@ const featuresPath = 'ci-visibility/features/'
 const fileExtension = 'js'
 
 versions.forEach(version => {
+  if ((NODE_MAJOR === 18 || NODE_MAJOR === 23) && version === 'latest') return
+
   // TODO: add esm tests
   describe(`cucumber@${version} commonJS`, () => {
     let sandbox, cwd, receiver, childProcess, testOutput

integration-tests/selenium/selenium.spec.js

@@ -17,6 +17,7 @@ const {
   TEST_IS_RUM_ACTIVE,
   TEST_TYPE
 } = require('../../packages/dd-trace/src/plugins/util/test')
+const { NODE_MAJOR } = require('../../version')
 
 const webAppServer = require('../ci-visibility/web-app-server')
 
@@ -74,6 +75,7 @@ versionRange.forEach(version => {
       }
     ]
     testFrameworks.forEach(({ name, command }) => {
+      if ((NODE_MAJOR === 18 || NODE_MAJOR === 23) && name === 'cucumber') return
       context(`with ${name}`, () => {
         it('identifies tests using selenium as browser tests', (done) => {
           const assertionPromise = receiver

packages/datadog-instrumentations/src/cucumber.js

@@ -43,6 +43,7 @@ const {
   CUCUMBER_WORKER_TRACE_PAYLOAD_CODE,
   getIsFaultyEarlyFlakeDetection
 } = require('../../dd-trace/src/plugins/util/test')
+const satisfies = require('semifies')
 
 const isMarkedAsUnskippable = (pickle) => {
   return pickle.tags.some(tag => tag.name === '@datadog:unskippable')
@@ -224,7 +225,7 @@ function getPickleByFile (runtimeOrCoodinator) {
   }, {})
 }
 
-function wrapRun (pl, isLatestVersion) {
+function wrapRun (pl, isLatestVersion, version) {
   if (patched.has(pl)) return
 
   patched.add(pl)
@@ -398,9 +399,10 @@ function wrapRun (pl, isLatestVersion) {
         const promise = runStep.apply(this, arguments)
 
         promise.then((result) => {
-          const { status, skipReason, errorMessage } = isLatestVersion
-            ? getStatusFromResultLatest(result)
-            : getStatusFromResult(result)
+          const finalResult = satisfies(version, '>=12.0.0') ? result.result : result
+          const getStatus = satisfies(version, '>=7.3.0') ? getStatusFromResultLatest : getStatusFromResult
+
+          const { status, skipReason, errorMessage } = getStatus(finalResult)
 
           testFinishCh.publish({ isStep: true, status, skipReason, errorMessage, ...ctx.currentStore })
         })
@@ -415,18 +417,18 @@ function wrapRun (pl, isLatestVersion) {
   })
 }
 
-function pickleHook (PickleRunner) {
+function pickleHook (PickleRunner, version) {
   const pl = PickleRunner.default
 
-  wrapRun(pl, false)
+  wrapRun(pl, false, version)
 
   return PickleRunner
 }
 
-function testCaseHook (TestCaseRunner) {
+function testCaseHook (TestCaseRunner, version) {
   const pl = TestCaseRunner.default
 
-  wrapRun(pl, true)
+  wrapRun(pl, true, version)
 
   return TestCaseRunner
 }

scripts/verify-ci-config.js

@@ -150,8 +150,7 @@ checkPlugins(path.join(__dirname, '..', '.github', 'workflows', 'test-optimizati
     .filter(file => fs.existsSync(path.join(__dirname, '..', 'packages', file, 'test')))
     .map(file => file.replace('datadog-plugin-', ''))
   for (const plugin of allPlugins) {
-    // TODO: Remove check of cucumber once cucumber+12 is fixed
-    if (!allTestedPlugins.has(plugin) && plugin !== 'cucumber') {
+    if (!allTestedPlugins.has(plugin)) {
       pluginErrorMsg(plugin, 'ERROR', 'Plugin is tested but not in at least one GitHub workflow')
     }
   }