@hedia/test 1.2.1 → 1.3.0-alpha.0

package/README.md

@@ -1 +1,11 @@
-# test
+# Custom Test Reporter
+
+Format and send test output to the `test-service`.
+
+## Usage
+
+```
+node --test --experimental-test-coverage --test-reporter @hedia/test/reporter
+```
+
+Tip: Save the following command as a script in `package.json`

package/package.json

@@ -1,21 +1,31 @@
 {
   "name": "@hedia/test",
-  "version": "1.2.1",
-  "description": "",
+  "version": "1.3.0-alpha.0",
+  "description": "Custom Test Reporter",
   "type": "module",
   "exports": {
-    "./reporter": "./src/reporter.js"
-  },  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "./reporter": "./src/reporter.js",
+    "./sonarcloud": "./src/sonarcloud.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prettier:check": "prettier --check .",
+    "prettier:write": "prettier --write ."
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/hedia-team/test.git"
   },
-  "author": "",
+  "author": "Mathieu Veber <mathieu@hedia.com>",
   "license": "UNLICENSED",
   "bugs": {
     "url": "https://github.com/hedia-team/test/issues"
   },
-  "homepage": "https://github.com/hedia-team/test#readme"
-}
+  "homepage": "https://github.com/hedia-team/test#readme",
+  "devDependencies": {
+    "prettier": "^3.0.3"
+  },
+  "dependencies": {
+    "@hedia/html": "2.0.1"
+  }
+}

package/src/reporter.js

@@ -1,88 +1,93 @@
 import { readFileSync } from "fs";
 
 export default async function* testReporter(source) {
-	try {
-		let title = ''
-		const tests = [];
-		let nestedTitles = [];
-		let nestingLevel = -1;
+  try {
+    let title = "";
+    const tests = [];
+    let nestedTitles = [];
+    let nestingLevel = -1;
 
-		for await (const event of source) {
-			switch (event.type) {
-				case "test:start":
-					if (nestingLevel < event.data.nesting) {
-						nestedTitles.push(event.data.name);
-						nestingLevel += 1;
-					}
-					if (nestingLevel === event.data.nesting) {
-						nestedTitles[nestedTitles.length - 1] = event.data.name;
-					}
-					break;
-				case "test:pass":
-					if (nestingLevel > event.data.nesting) {
-						nestedTitles = nestedTitles.slice(0, -1);
-						nestingLevel -= 1;
-					}
-					if (event.data?.details?.type === "suite") {
-						break;
-					}
+    for await (const event of source) {
+      switch (event.type) {
+        case "test:start":
+          if (nestingLevel < event.data.nesting) {
+            nestedTitles.push(event.data.name);
+            nestingLevel += 1;
+          }
+          if (nestingLevel === event.data.nesting) {
+            nestedTitles[nestedTitles.length - 1] = event.data.name;
+          }
+          break;
+        case "test:pass":
+          if (nestingLevel > event.data.nesting) {
+            nestedTitles = nestedTitles.slice(0, -1);
+            nestingLevel -= 1;
+          }
+          if (event.data?.details?.type === "suite") {
+            break;
+          }
 
-					yield `test ${nestedTitles.join(" - ")}: pass (${event.data.details.duration_ms}ms)\n`;
+          yield `test ${nestedTitles.join(" - ")}: pass (${
+            event.data.details.duration_ms
+          }ms)\n`;
 
-					tests.push({
-						name: nestedTitles.join(" - "),
-						number: tests.length + 1,
-						duration: event.data.details.duration_ms,
-						status: "pass",
-					});
+          tests.push({
+            name: nestedTitles.join(" - "),
+            number: tests.length + 1,
+            duration: event.data.details.duration_ms,
+            status: "pass",
+          });
 
-					break;
-				case "test:fail":
-					if (nestingLevel > event.data.nesting) {
-						nestedTitles = nestedTitles.slice(0, -1);
-						nestingLevel -= 1;
-					}
-					if (event.data?.details?.type === "suite") {
-						break;
-					}
+          break;
+        case "test:fail":
+          if (nestingLevel > event.data.nesting) {
+            nestedTitles = nestedTitles.slice(0, -1);
+            nestingLevel -= 1;
+          }
+          if (event.data?.details?.type === "suite") {
+            break;
+          }
 
-					yield `test ${nestedTitles.join(" - ")}: fail (${event.data.details.duration_ms}ms)\n`;
-					tests.push({
-						name: nestedTitles.join(" - "),
-						number: tests.length + 1,
-						duration: event.data.details.duration_ms,
-						status: "fail",
-					});
+          yield `test ${nestedTitles.join(" - ")}: fail (${
+            event.data.details.duration_ms
+          }ms)\n`;
+          tests.push({
+            name: nestedTitles.join(" - "),
+            number: tests.length + 1,
+            duration: event.data.details.duration_ms,
+            status: "fail",
+          });
 
-					break;
-				case "test:coverage":
-					const location = event.data.summary.workingDirectory + "/package.json"
-					const { name, version } = JSON.parse(readFileSync(location, 'utf8'))
-					title = `${name}@${version}`
-			}
-		}
+          break;
+        case "test:coverage":
+          const location =
+            event.data.summary.workingDirectory + "/package.json";
+          const { name, version } = JSON.parse(readFileSync(location, "utf8"));
+          title = `${name}@${version}`;
+      }
+    }
 
-		const input = "https://test.hedia.dev/api/v1/reports";
-		const init = {
-			method: "POST",
-			headers: {
-				"Content-Type": "application/json",
-			},
-			body: JSON.stringify(
-				{
-					title,
-					tests,
-				},
-				null,
-				4,
-			),
-		};
+    const input = "https://test.hedia.dev/api/v1/reports";
+    const init = {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+      },
+      body: JSON.stringify(
+        {
+          title,
+          tests,
+        },
+        null,
+        4,
+      ),
+    };
 
-		const response = await fetch(input, init);
+    const response = await fetch(input, init);
 
-		console.log(response.ok ? "OK" : "NOT OK");
-		yield true;
-	} catch (err) {
-		console.error(err.message);
-	}
+    console.log(response.ok ? "OK" : "NOT OK");
+    yield true;
+  } catch (err) {
+    console.error(err.message);
+  }
 }

package/src/sonarcloud.js

@@ -0,0 +1,78 @@
+import { attr, element, render } from "@hedia/html";
+import { readFileSync } from "fs";
+import { SourceMap } from "module";
+import { relative, resolve } from "path";
+
+export default async function* testReporter(source) {
+  try {
+    let xml;
+
+    for await (const event of source) {
+      switch (event.type) {
+        case "test:coverage":
+          xml = generic(event);
+          break;
+      }
+    }
+
+    yield xml;
+  } catch (err) {
+    console.error(err);
+  }
+}
+
+function generic(event) {
+  const originalFiles = {};
+
+  for (const file of event.data.summary.files) {
+    const sourceMap = loadSourceMapForFile(file.path);
+
+    for (let lineOffset = 1; lineOffset <= file.totalLineCount; lineOffset++) {
+      const entry = sourceMap.findEntry(lineOffset, 1);
+
+      if (entry) {
+        originalFiles[entry.originalSource] =
+          originalFiles[entry.originalSource] || new Set();
+
+        originalFiles[entry.originalSource].add(entry.originalLine);
+      }
+    }
+  }
+
+  return render(
+    element(
+      "coverage",
+      attr("version", "1"),
+      ...Object.entries(originalFiles).map(([fileName, lines]) =>
+        element(
+          "file",
+          attr("path", fileName),
+          ...Array.from(lines).map((line) =>
+            element(
+              "lineToCover",
+              attr("lineNumber", line.toString()),
+              attr("covered", "true")
+            )
+          )
+        )
+      )
+    )
+  );
+}
+
+function loadSourceMapForFile(path) {
+  const rel = resolve(process.cwd(), path);
+
+  const file = path + ".map";
+
+  const json = readFileSync(file, "utf8");
+  const payload = JSON.parse(json);
+
+  payload.sources = payload.sources.map((source) =>
+    relative(process.cwd(), resolve(path, "..", source))
+  );
+
+  const sourceMap = new SourceMap(payload);
+
+  return sourceMap;
+}