test: migrate tap to mocha (#7135)

* test: migrate tap to mocha

This tries to align with the former behavior as close as possible.
This is for example the case by using more parallel threads, even
if the CPU has less cores.

* test: run mocha tests in parallel per file

This is adding a script to run multiple mocha test files in parallel
in their own child process instead of using mocha's own parallel
mode that is using a pool instead of child processes.

---------

Co-authored-by: Thomas Watson <thomas.watson@datadoghq.com>

Author: BridgeAR

.github/dependabot.yml

@@ -73,9 +73,6 @@ updates:
         # Thus, we ignore them and update them manually.
       - dependency-name: "@opentelemetry/api"
       - dependency-name: "@opentelemetry/api-logs"
-      - dependency-name: "tap"
-        # Contain breaking changes that are incompatible with our test usage
-        update-types: ["version-update:semver-major"]
     groups:
       dev-minor-and-patch-dependencies:
         dependency-type: "development"

.taprc

@@ -10,7 +10,7 @@
 
 - Install dependencies: `yarn install`
 
-**Note:** This project uses yarn, not npm. Always use `yarn` commands instead of `npm` commands.
+**This project uses yarn, not npm. Always use `yarn` commands instead of `npm` commands.**
 
 ## Project Overview
 
@@ -44,18 +44,13 @@ When developing a feature or fixing a bug:
 
 ### Running Individual Tests
 
-**IMPORTANT**: Never run `yarn test` directly. Use `mocha` or `tap` directly on test files.
+**IMPORTANT**: Never run `yarn test` directly. Use `mocha` directly on test files.
 
 **Mocha unit tests:**
 ```bash
 ./node_modules/.bin/mocha -r "packages/dd-trace/test/setup/mocha.js" path/to/test.spec.js
 ```
 
-**Tap unit tests:**
-```bash
-./node_modules/.bin/tap path/to/test.spec.js
-```
-
 **Integration tests:**
 ```bash
 ./node_modules/.bin/mocha --timeout 60000 -r "packages/dd-trace/test/setup/core.js" path/to/test.spec.js
@@ -67,8 +62,6 @@ When developing a feature or fixing a bug:
 **Enable debug logging:**
 - Prefix with `DD_TRACE_DEBUG=true`
 
-**Note**: New tests should be written using mocha, not tap. Existing tap tests use mocha-style `describe` and `it` blocks.
-
 ### Plugin Tests
 
 **Use `PLUGINS` env var:**

AGENTS.md

@@ -290,14 +290,14 @@ Please refer to [the "Install" section](https://github.com/brianc/node-postgres/
 
 When developing, it's often faster to run individual test files rather than entire test suites. **Never run `yarn test` directly** as it requires too much setup and takes too long.
 
-To target specific tests, use the `--grep` flag with mocha or tap to match test names:
+To target specific tests, use the `--grep` flag with mocha to match test names:
 
 ```sh
 yarn test:debugger --grep "test name pattern"
 yarn test:appsec --grep "specific test"
 ```
 
-**Note:** This project uses a mix of tap and mocha for testing. However, new tests should be written using mocha, not tap.
+**This project uses mocha for testing.**
 
 ### Test Assertions
 

CONTRIBUTING.md

@@ -68,7 +68,6 @@ if (Number(process.env.EVERYTHING)) {
     'shell-quote',
     'sinon',
     'source-map',
-    'tap',
     'tiktoken',
     'tlhunter-sorted-set',
     'ttl-set',

benchmark/sirun/startup/startup-test.js

@@ -406,24 +406,32 @@ export default [
       'n/no-restricted-require': ['error', [
         {
           name: 'diagnostics_channel',
-          message: 'Please use dc-polyfill instead.'
+          message: 'Please use `dc-polyfill` instead.'
         },
         {
           name: 'semver',
-          message: 'Please use semifies instead.'
+          message: 'Please use `semifies` instead.'
         },
         {
           name: 'get-port',
           message: 'Please listen on port 0 instead.'
         },
         {
           name: 'rimraf',
-          message: 'Please use fs.rm(path, { recursive: true, force: true }) instead.'
+          message: 'Please use `fs.rm(path, { recursive: true, force: true })` instead.'
         },
         {
           name: 'koalas',
           message: 'Please use nullish coalescing operator (??) instead.'
-        }
+        },
+        {
+          name: 'chai',
+          message: 'Please use `node:assert/strict` instead.'
+        },
+        {
+          name: 'tap',
+          message: 'Please use `mocha` instead.'
+        },
       ]],
 
       'no-await-in-loop': 'error',

eslint.config.mjs

@@ -28,8 +28,8 @@
     "test:debugger": "mocha -r 'packages/dd-trace/test/setup/mocha.js' 'packages/dd-trace/test/debugger/**/*.spec.js'",
     "test:debugger:ci": "nyc --no-clean --include 'packages/dd-trace/src/debugger/**/*.js' -- npm run test:debugger",
     "test:eslint-rules": "node eslint-rules/*.test.mjs",
-    "test:trace:core": "tap packages/dd-trace/test/*.spec.js \"packages/dd-trace/test/{ci-visibility,datastreams,encode,exporters,opentelemetry,opentracing,plugins,remote_config,service-naming,standalone,telemetry,external-logger}/**/*.spec.js\"",
-    "test:trace:core:ci": "npm run test:trace:core -- --coverage --nyc-arg=--include=\"packages/dd-trace/src/**/*.js\"",
+    "test:trace:core": "node scripts/mocha-parallel-files.js --expose-gc --timeout 30000 --require packages/dd-trace/test/setup/mocha.js -- \"packages/dd-trace/test/*.spec.js\" \"packages/dd-trace/test/{ci-visibility,datastreams,encode,exporters,opentelemetry,opentracing,plugins,remote_config,service-naming,standalone,telemetry,external-logger}/**/*.spec.js\"",
+    "test:trace:core:ci": "nyc --no-clean --include \"packages/dd-trace/src/**/*.js\" -- npm run test:trace:core",
     "test:trace:guardrails": "mocha -r \"packages/dd-trace/test/setup/mocha.js\" \"packages/dd-trace/test/guardrails/**/*.spec.js\"",
     "test:trace:guardrails:ci": "nyc --no-clean --include \"packages/dd-trace/src/guardrails/**/*.js\" -- npm run test:trace:guardrails",
     "test:esbuild": "mocha -r \"packages/dd-trace/test/setup/mocha.js\" \"packages/datadog-esbuild/test/**/*.spec.js\"",
@@ -38,8 +38,8 @@
     "test:instrumentations:ci": "yarn services && nyc --no-clean --include \"packages/datadog-instrumentations/src/@($(echo $PLUGINS)).js\" --include \"packages/datadog-instrumentations/src/@($(echo $PLUGINS))/**/*.js\" -- npm run test:instrumentations",
     "test:instrumentations:misc": "mocha -r 'packages/dd-trace/test/setup/mocha.js' 'packages/datadog-instrumentations/test/*/**/*.spec.js'",
     "test:instrumentations:misc:ci": "nyc --no-clean --include 'packages/datadog-instrumentations/src/**/*.js' -- npm run test:instrumentations:misc",
-    "test:core": "tap \"packages/datadog-core/test/**/*.spec.js\"",
-    "test:core:ci": "npm run test:core -- --coverage --nyc-arg=--include=\"packages/datadog-core/src/**/*.js\"",
+    "test:core": "node scripts/mocha-parallel-files.js --expose-gc --timeout 30000 -- \"packages/datadog-core/test/**/*.spec.js\"",
+    "test:core:ci": "nyc --no-clean --include \"packages/datadog-core/src/**/*.js\" -- npm run test:core",
     "test:lambda": "mocha -r \"packages/dd-trace/test/setup/mocha.js\" \"packages/dd-trace/test/lambda/**/*.spec.js\"",
     "test:lambda:ci": "nyc --no-clean --include \"packages/dd-trace/src/lambda/**/*.js\" -- npm run test:lambda",
     "test:llmobs:sdk": "mocha -r \"packages/dd-trace/test/setup/mocha.js\" --exclude \"packages/dd-trace/test/llmobs/plugins/**/*.spec.js\" \"packages/dd-trace/test/llmobs/**/*.spec.js\" ",
@@ -52,8 +52,8 @@
     "test:plugins:ci": "yarn services && nyc --no-clean --include \"packages/datadog-plugin-@($(echo $PLUGINS))/src/**/*.js\" -- npm run test:plugins",
     "test:plugins:ci:flaky": "yarn services && nyc --no-clean --include \"packages/datadog-plugin-@($(echo $PLUGINS))/src/**/*.js\" -- npm run test:plugins -- --bail --retries 2",
     "test:plugins:upstream": "node ./packages/dd-trace/test/plugins/suite.js",
-    "test:profiler": "tap \"packages/dd-trace/test/profiling/**/*.spec.js\"",
-    "test:profiler:ci": "npm run test:profiler -- --coverage --nyc-arg=--include=\"packages/dd-trace/src/profiling/**/*.js\"",
+    "test:profiler": "node scripts/mocha-parallel-files.js --expose-gc --timeout 30000 --require packages/dd-trace/test/setup/mocha.js -- \"packages/dd-trace/test/profiling/**/*.spec.js\"",
+    "test:profiler:ci": "nyc --no-clean --include \"packages/dd-trace/src/profiling/**/*.js\" -- npm run test:profiler",
     "test:integration": "mocha --timeout 60000 -r \"packages/dd-trace/test/setup/core.js\" \"integration-tests/*.spec.js\"",
     "test:integration:aiguard": "mocha --timeout 60000 -r \"packages/dd-trace/test/setup/core.js\" \"integration-tests/aiguard/*.spec.js\"",
     "test:integration:appsec": "mocha --timeout 60000 -r \"packages/dd-trace/test/setup/core.js\" \"integration-tests/appsec/*.spec.js\"",
@@ -151,7 +151,6 @@
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.106",
     "@types/sinon": "^21.0.0",
-    "@types/tap": "^15.0.12",
     "axios": "^1.12.2",
     "benchmark": "^2.1.4",
     "body-parser": "^2.2.0",
@@ -182,7 +181,6 @@
     "semifies": "^1.0.0",
     "semver": "^7.7.2",
     "sinon": "^21.0.0",
-    "tap": "^16.3.10",
     "tiktoken": "^1.0.21",
     "typescript": "^5.9.2",
     "workerpool": "^10.0.0",

package.json

@@ -1,11 +1,11 @@
 'use strict'
 
-const { describe, it, afterEach } = require('tap').mocha
 const { resolve } = require('node:path')
 const assert = require('node:assert')
 
-require('../../dd-trace/test/setup/core')
+const { describe, it, afterEach } = require('mocha')
 
+require('../../dd-trace/test/setup/core')
 const { entryTags, exitTags } = require('../index')
 const { getNextLineNumber } = require('../../dd-trace/test/plugins/helpers')
 

packages/datadog-code-origin/test/index.spec.js

@@ -1,11 +1,11 @@
 'use strict'
 
 const assert = require('node:assert/strict')
-const { describe, it, beforeEach, afterEach } = require('tap').mocha
 const { executionAsyncResource } = require('async_hooks')
 
-require('../../dd-trace/test/setup/core')
+const { describe, it, beforeEach, afterEach } = require('mocha')
 
+require('../../dd-trace/test/setup/core')
 const { storage } = require('../src/storage')
 
 describe('storage', () => {

packages/datadog-core/test/storage.spec.js

@@ -1,10 +1,10 @@
 'use strict'
 
 const assert = require('node:assert/strict')
-const { describe, it } = require('tap').mocha
 
-require('../../../../dd-trace/test/setup/core')
+const { describe, it } = require('mocha')
 
+require('../../../../dd-trace/test/setup/core')
 const parseTags = require('../../../src/utils/src/parse-tags')
 
 describe('parseTags', () => {