feat(tap-runner): support "nodeArgs" (#4235)

Add support for the `tap.nodeArgs` config option. Here you can specify additional node arguments to be passed to every test runner.

With this, it is now possible to JIT compile typescript code using:

```json
{
  "tap": {
    "nodeArgs": ["--loader", "ts-node/esm"]
  }
}
```

Or (when using commonjs)

```json
{
  "tap": {
    "nodeArgs": ["-r", "ts-node/register"]
  }
}
```

Also add a test for typescript using the tap runner.

e2e/test/incremental/verify/verify.js

@@ -20,14 +20,14 @@ describe('incremental', () => {
 
   beforeEach(async () => {
     await fsPromises.rm(incrementalFile, { force: true });
-    /**
-     * @type {import('@stryker-mutator/api/core').LogLevel}
-     */
     strykerOptions = {
       incremental: true,
       concurrency: 1,
       plugins: ['./verify/mutation-run-plan-reporter.js'],
       reporters: ['mutation-run-plan', 'html'],
+      tap: {
+        testFiles: 'spec/*.tap.js',
+      },
     };
     await changeFiles('original'); // change the files back to there original state
   });
@@ -42,7 +42,7 @@ describe('incremental', () => {
     // We know which test files are changed and assume each test in that file changed
     withoutTestLocations: 2,
     // We know which test file the test originated from, but we can't differentiate between tests in the file (TAP runner)
-    withoutTestDeviation: 6,
+    withoutTestDeviation: 2,
     // Don't know from which test files the tests originated
     withoutTestFiles: 7,
   });

e2e/test/incremental/verify/verify.js.snap

@@ -1920,8 +1920,10 @@ Array [
   Object {
     "fileName": "src/concat.js",
     "mutant": Object {
-      "coveredBy": Array [],
-      "killedBy": Array [],
+      "coveredBy": Array [
+        "spec/concat.tap.js",
+      ],
+      "killedBy": undefined,
       "location": Object {
         "end": Object {
           "column": 1,
@@ -1935,16 +1937,17 @@ Array [
       "mutatorName": "BlockStatement",
       "replacement": "{}",
       "static": false,
-      "status": "NoCoverage",
-      "testsCompleted": undefined,
+      "status": undefined,
     },
-    "plan": "EarlyResult",
+    "plan": "Run",
   },
   Object {
     "fileName": "src/concat.js",
     "mutant": Object {
-      "coveredBy": Array [],
-      "killedBy": Array [],
+      "coveredBy": Array [
+        "spec/concat.tap.js",
+      ],
+      "killedBy": undefined,
       "location": Object {
         "end": Object {
           "column": 19,
@@ -1958,16 +1961,15 @@ Array [
       "mutatorName": "StringLiteral",
       "replacement": "\`\`",
       "static": false,
-      "status": "NoCoverage",
-      "testsCompleted": undefined,
+      "status": undefined,
     },
-    "plan": "EarlyResult",
+    "plan": "Run",
   },
   Object {
     "fileName": "src/concat.js",
     "mutant": Object {
       "coveredBy": Array [
-        "spec/concat.spec.js",
+        "spec/concat.tap.js",
       ],
       "killedBy": undefined,
       "location": Object {
@@ -1990,7 +1992,9 @@ Array [
   Object {
     "fileName": "src/concat.js",
     "mutant": Object {
-      "coveredBy": Array [],
+      "coveredBy": Array [
+        "spec/concat.tap.js",
+      ],
       "killedBy": undefined,
       "location": Object {
         "end": Object {
@@ -2012,7 +2016,9 @@ Array [
   Object {
     "fileName": "src/concat.js",
     "mutant": Object {
-      "coveredBy": Array [],
+      "coveredBy": Array [
+        "spec/concat.tap.js",
+      ],
       "killedBy": undefined,
       "location": Object {
         "end": Object {
@@ -2078,7 +2084,9 @@ Array [
   Object {
     "fileName": "src/math.js",
     "mutant": Object {
-      "coveredBy": Array [],
+      "coveredBy": Array [
+        "spec/math.tap.js",
+      ],
       "killedBy": undefined,
       "location": Object {
         "end": Object {
@@ -2100,7 +2108,9 @@ Array [
   Object {
     "fileName": "src/math.js",
     "mutant": Object {
-      "coveredBy": Array [],
+      "coveredBy": Array [
+        "spec/math.tap.js",
+      ],
       "killedBy": undefined,
       "location": Object {
         "end": Object {
@@ -2122,8 +2132,10 @@ Array [
   Object {
     "fileName": "src/math.js",
     "mutant": Object {
-      "coveredBy": Array [],
-      "killedBy": Array [],
+      "coveredBy": Array [
+        "spec/math.tap.js",
+      ],
+      "killedBy": undefined,
       "location": Object {
         "end": Object {
           "column": 1,
@@ -2137,16 +2149,17 @@ Array [
       "mutatorName": "BlockStatement",
       "replacement": "{}",
       "static": false,
-      "status": "NoCoverage",
-      "testsCompleted": undefined,
+      "status": undefined,
     },
-    "plan": "EarlyResult",
+    "plan": "Run",
   },
   Object {
     "fileName": "src/math.js",
     "mutant": Object {
-      "coveredBy": Array [],
-      "killedBy": Array [],
+      "coveredBy": Array [
+        "spec/math.tap.js",
+      ],
+      "killedBy": undefined,
       "location": Object {
         "end": Object {
           "column": 14,
@@ -2160,10 +2173,9 @@ Array [
       "mutatorName": "ArithmeticOperator",
       "replacement": "a / b",
       "static": false,
-      "status": "NoCoverage",
-      "testsCompleted": undefined,
+      "status": undefined,
     },
-    "plan": "EarlyResult",
+    "plan": "Run",
   },
   Object {
     "fileName": "src/math.js",

e2e/test/mono-schema/test/valid.json

@@ -33,6 +33,7 @@
     "configFile": "vitest.config.js"
   },
   "tap": {
-    "testFiles": "{**/@(test|tests|__test__|__tests__)/**,**/*.@(test|tests|spec)}.@(cjs|mjs|js|jsx|ts|tsx)"
+    "testFiles": "{**/@(test|tests|__test__|__tests__)/**,**/*.@(test|tests|spec)}.@(cjs|mjs|js|jsx|ts|tsx)",
+    "nodeArgs": ["--loader", "ts-node/esm"]
   }
 }

e2e/test/tap-typescript/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "tap-typescript",
+  "version": "0.0.0",
+  "private": true,
+  "description": "A project using node-tap and typescript",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "pretest": "rimraf \"reports\"",
+    "test": "stryker run",
+    "posttest": "mocha --no-config --no-package --timeout 0 verify/verify.js",
+    "test:unit": "NODE_OPTIONS=\"--loader ts-node/esm\" tap --ts"
+  },
+  "author": "",
+  "license": "ISC"
+}

e2e/test/tap-typescript/src/add.ts

@@ -0,0 +1,3 @@
+export function add(num1: number, num2: number): number {
+  return num1 + num2;
+}

e2e/test/tap-typescript/src/increment.ts

@@ -0,0 +1,6 @@
+
+export function increment(n: number) {
+  n++;
+  return n;
+}
+

e2e/test/tap-typescript/src/is-negative.ts

@@ -0,0 +1,7 @@
+export function isNegativeNumber(n: number) {
+  var isNegative = false;
+  if (n < 0) {
+    isNegative = true;
+  }
+  return isNegative;
+}

e2e/test/tap-typescript/src/negate.ts

@@ -0,0 +1,3 @@
+export function negate(n: number) {
+  return -n;
+}

e2e/test/tap-typescript/stryker.conf.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "../../node_modules/@stryker-mutator/core/schema/stryker-schema.json",
+  "testRunner": "tap",
+  "concurrency": 1,
+  "reporters": ["json", "clear-text", "html", "event-recorder"],
+  "testRunnerNodeArgs_comment": ["--inspect-brk"],
+  "tap": {
+    "nodeArgs": ["--loader", "ts-node/esm"]
+  },
+  "plugins": [
+    "@stryker-mutator/tap-runner"
+  ]
+}

e2e/test/tap-typescript/test/add.spec.ts

@@ -0,0 +1,12 @@
+import { test } from 'tap';
+import { add } from '../src/add.js';
+
+test('add', (t) => {
+  t.test('should be able to add two numbers', (t) => {
+    const actual = add(5, 2);
+    t.equal(actual, 7);
+    t.end();
+  });
+
+  t.end();
+});

e2e/test/tap-typescript/test/increment.spec.ts

@@ -0,0 +1,16 @@
+import { test } from 'tap';
+import { increment } from '../src/increment.js';
+
+test('increment', (t) => {
+  t.test('should be able to add one to a number', (t) => {
+    const number = 2;
+    const expected = 3;
+
+    const actual = increment(number);
+
+    t.equal(actual, expected);
+    t.end();
+  });
+
+  t.end();
+});

e2e/test/tap-typescript/test/is-negative.spec.ts

@@ -0,0 +1,9 @@
+import { test } from 'tap';
+import { isNegativeNumber } from '../src/is-negative.js';
+
+test('math - should be able to recognize a negative number', (t) => {
+  const number = -2;
+  const result = isNegativeNumber(number);
+  t.equal(result, true);
+  t.end();
+});

e2e/test/tap-typescript/test/negate.spec.ts

@@ -0,0 +1,12 @@
+import { test } from 'tap';
+import { negate } from '../src/negate.js';
+
+test('negate', (t) => {
+  t.test('should be able to negate a number', (t) => {
+    const actual = negate(2);
+    t.equal(actual, -2);
+    t.end();
+  });
+
+  t.end();
+});

e2e/test/tap-typescript/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "lib": ["es2022"],
+    "module": "Node16",
+    "moduleResolution": "node16",
+    "outDir": "dist",
+    // "noEmit": true,
+    "isolatedModules": true,
+    "verbatimModuleSyntax": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true
+  }
+}

e2e/test/tap-typescript/verify/verify.js

@@ -0,0 +1,7 @@
+import { expectMetricsJsonToMatchSnapshot } from '../../../helpers.js';
+
+describe('Verify stryker has ran correctly', () => {
+  it('should report correct score', async () => {
+    await expectMetricsJsonToMatchSnapshot();
+  });
+});

e2e/test/tap-typescript/verify/verify.js.snap

@@ -0,0 +1,22 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Verify stryker has ran correctly should report correct score 1`] = `
+Object {
+  "compileErrors": 0,
+  "ignored": 0,
+  "killed": 11,
+  "mutationScore": 78.57142857142857,
+  "mutationScoreBasedOnCoveredCode": 78.57142857142857,
+  "noCoverage": 0,
+  "pending": 0,
+  "runtimeErrors": 0,
+  "survived": 3,
+  "timeout": 0,
+  "totalCovered": 14,
+  "totalDetected": 11,
+  "totalInvalid": 0,
+  "totalMutants": 14,
+  "totalUndetected": 3,
+  "totalValid": 14,
+}
+`;