feat(TAP runner): add support for the node TAP runner

Add support for the [node-tap](https://github.com/tapjs/node-tap) test runner with the `@stryker-mutator/tap-runner`.

Co-authored-by: Nico Jansen <[email protected]>

Author: danny12321

e2e/package-lock.json

@@ -14,8 +14,9 @@
     "@types/chai-jest-snapshot": "1.3.6",
     "@types/node": "18.15.11",
     "@types/semver": "7.3.13",
+    "@types/tap": "^15.0.7",
     "ajv": "8.12.0",
-    "axios": "1.3.5",
+    "axios": "1.3.4",
     "chai": "4.3.7",
     "chai-as-promised": "7.1.1",
     "chai-jest-snapshot": "2.0.0",
@@ -39,7 +40,8 @@
     "mutation-testing-report-schema": "1.7.14",
     "rxjs": "7.8.0",
     "semver": "7.3.8",
-    "ts-jest": "29.1.0",
+    "tap": "^16.3.2",
+    "ts-jest": "29.0.5",
     "ts-loader": "9.4.2",
     "ts-node": "10.9.1",
     "typescript": "5.0.4",
@@ -65,6 +67,7 @@
     "@stryker-mutator/mocha-runner": "../packages/mocha-runner",
     "@stryker-mutator/cucumber-runner": "../packages/cucumber-runner",
     "@stryker-mutator/util": "../packages/util",
+    "@stryker-mutator/tap-runner": "../packages/tap-runner",
     "@stryker-mutator/typescript-checker": "../packages/typescript-checker"
   }
 }

e2e/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "node-tap-javascript",
+  "version": "0.0.0",
+  "private": true,
+  "description": "A module to perform an integration test",
+  "type": "module",
+  "scripts": {
+    "pretest": "rimraf \"reports\"",
+    "test": "stryker run",
+    "test:unit": "tap",
+    "posttest": "mocha --no-config --no-package --timeout 0 verify/verify.js"
+  },
+  "author": "",
+  "license": "ISC"
+}

e2e/test/node-tap-javascript/package.json

@@ -0,0 +1,7 @@
+export function getCircumference(radius) {
+  return 2 * Math.PI * radius;
+}
+
+export function untestedFunction() {
+  var i = (5 / 2) * 3;
+}

e2e/test/node-tap-javascript/src/circle.js

@@ -0,0 +1,24 @@
+export function add(num1, num2) {
+  return num1 + num2;
+}
+
+export function addOne(number) {
+  number++;
+  return number;
+}
+
+export function negate(number) {
+  return -number;
+}
+
+export function notCovered(number) {
+  return number > 10;
+}
+
+export function isNegativeNumber(number) {
+  let isNegative = false;
+  if (number < 0) {
+    isNegative = true;
+  }
+  return isNegative;
+}

e2e/test/node-tap-javascript/src/math.js

@@ -0,0 +1,9 @@
+{
+  "$schema": "../../node_modules/@stryker-mutator/core/schema/stryker-schema.json",
+  "packageManager": "npm",
+  "testRunner": "tap",
+  "tempDirName": "stryker-tmp",
+  "concurrency": 2,
+  "coverageAnalysis": "off",
+  "reporters": ["json", "event-recorder", "progress", "html"]
+}

e2e/test/node-tap-javascript/stryker.conf.json

@@ -0,0 +1,12 @@
+// @ts-check
+import tap from 'tap';
+import { negate, addOne, isNegativeNumber, add } from '../src/math.js';
+
+tap.test('math', (t) => {
+  t.equal(add(2, 5), 7);
+  t.equal(addOne(2), 3);
+  t.equal(negate(2), -2);
+  t.ok(isNegativeNumber(-2));
+  t.notOk(isNegativeNumber(0));
+  t.end();
+});

e2e/test/node-tap-javascript/test/add.spec.js

@@ -0,0 +1,7 @@
+import tap from 'tap';
+import { getCircumference } from '../src/circle.js';
+
+tap.test('circle', (t) => {
+  t.equal(getCircumference(1), 2 * Math.PI);
+  t.end();
+});

e2e/test/node-tap-javascript/test/circle.test.js

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

e2e/test/node-tap-javascript/verify/package.json

@@ -0,0 +1,7 @@
+import { expectMetricsJsonToMatchSnapshot } from '../../../helpers.js';
+
+describe('After running stryker with the tap test runner', () => {
+  it('should report 64% mutation score', async () => {
+    await expectMetricsJsonToMatchSnapshot();
+  });
+});

e2e/test/node-tap-javascript/verify/verify.js

@@ -0,0 +1,21 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`After running stryker with the tap test runner should report 64% mutation score 1`] = `
+Object {
+  "compileErrors": 0,
+  "ignored": 0,
+  "killed": 16,
+  "mutationScore": 64,
+  "mutationScoreBasedOnCoveredCode": 94.11764705882352,
+  "noCoverage": 8,
+  "runtimeErrors": 0,
+  "survived": 1,
+  "timeout": 0,
+  "totalCovered": 17,
+  "totalDetected": 16,
+  "totalInvalid": 0,
+  "totalMutants": 25,
+  "totalUndetected": 9,
+  "totalValid": 25,
+}
+`;

e2e/test/node-tap-javascript/verify/verify.js.snap

@@ -0,0 +1,5 @@
+module.exports = {
+  "require": "dist/test/setup.js",
+  "timeout": 10000,
+  "forbidOnly": Boolean(process.env.CI)
+}

packages/tap-runner/.mocharc.cjs

@@ -0,0 +1,16 @@
+stryker.conf.js
+test
+dist/test
+/schema
+/reports
+/coverage
+/testResources
+/typings
+/.nyc_output
+.vscode
+.nycrc.json
+*.tsbuildinfo
+tsconfig?(.*).json
+.mocharc.jsonc
+.nyc_output
+.gitattributes

packages/tap-runner/.npmignore

@@ -0,0 +1 @@
+legacy-peer-deps=true

packages/tap-runner/.npmrc

@@ -0,0 +1,11 @@
+{
+  "exclude-after-remap": false,
+  "check-coverage": true,
+  "reporter": ["text", "html"],
+  "report-dir": "reports/coverage",
+  "lines": 80,
+  "functions": 80,
+  "statements": 80,
+  "branches": 75,
+  "include": "dist/src/**/*.js"
+}

packages/tap-runner/.nycrc.json

@@ -0,0 +1,48 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "📼 Unit tests",
+      "program": "${workspaceFolder}/../../node_modules/mocha/bin/_mocha",
+      "args": [
+        "--timeout",
+        "0",
+        "--colors",
+        "${workspaceFolder}/dist/test/unit/**/*.js",
+      ],
+      "internalConsoleOptions": "openOnSessionStart",
+      "outFiles": [
+        "${workspaceRoot}/dist/**/*.js",
+        "${workspaceFolder}/../test-helpers/dist/**/*.js"
+      ],
+      "skipFiles": [
+        "<node_internals>/**"
+      ]
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "📼 Integration tests",
+      "program": "${workspaceFolder}/../../node_modules/mocha/bin/_mocha",
+      "args": [
+        "--timeout",
+        "0",
+        "--colors",
+        "${workspaceFolder}/dist/test/integration/**/*.js",
+      ],
+      "internalConsoleOptions": "openOnSessionStart",
+      "outFiles": [
+        "${workspaceRoot}/dist/**/*.js",
+        "${workspaceFolder}/../test-helpers/dist/**/*.js"
+      ],
+      "skipFiles": [
+        "<node_internals>/**"
+      ]
+    }
+  ]
+}