test: Test script improvements (#932)

Author: jespertheend

scripts/test.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env -S deno run --unstable --no-check --allow-run --allow-read --allow-write --allow-env --allow-net
 
-import { join } from "std/path/mod.ts";
+import { join, resolve } from "std/path/mod.ts";
 import { setCwd } from "chdir-anywhere";
 import { dev } from "./dev.js";
 import { parseArgs } from "../test/shared/testArgs.js";
@@ -9,6 +9,7 @@ setCwd();
 Deno.chdir("..");
 
 const DENO_COVERAGE_DIR = ".coverage/denoCoverage";
+const DENO_HTML_COVERAGE_DIR = ".coverage/html";
 const FAKE_IMPORTS_COVERAGE_DIR = ".coverage/fakeImportsCoverageMap";
 
 /**
@@ -29,7 +30,7 @@ async function removeMaybeDirectory(path) {
  * @type {string?}
  */
 let filteredTests = null;
-if (Deno.args.length > 0 && !Deno.args[0].startsWith("--")) {
+if (Deno.args.length > 0 && !Deno.args[0].startsWith("-")) {
 	filteredTests = Deno.args[0];
 }
 
@@ -42,11 +43,7 @@ await dev({
 
 const { inspect } = parseArgs();
 
-let needsCoverage = Deno.args.includes("--coverage") || Deno.args.includes("-c");
-const needsHtmlCoverageReport = Deno.args.includes("--html");
-if (needsHtmlCoverageReport) {
-	needsCoverage = true;
-}
+const needsCoverage = Deno.args.includes("--coverage") || Deno.args.includes("-c");
 
 /** @type {string[][]} */
 const testCommands = [];
@@ -116,41 +113,36 @@ if (needsCoverage) {
 
 	console.log("Generating cov.lcov...");
 	const includeRegex = `^file://${Deno.cwd()}/(src|studio/src|studio/devSocket/src)`;
-	const coverageProcess = new Deno.Command(Deno.execPath(), {
+	const lcovCommand = new Deno.Command(Deno.execPath(), {
 		args: ["coverage", DENO_COVERAGE_DIR, "--lcov", `--include=${includeRegex}`],
 		stdout: "piped",
+		stderr: "piped",
 	});
-	const coverageOutput = await coverageProcess.output();
-	if (!coverageOutput.success) {
-		Deno.exit(coverageOutput.code);
+	const lcovOutput = await lcovCommand.output();
+	if (!lcovOutput.success) {
+		Deno.exit(lcovOutput.code);
 	}
-	await Deno.writeFile(".coverage/cov.lcov", coverageOutput.stdout);
-
-	if (needsHtmlCoverageReport) {
-		console.log("Generating HTML coverage report...");
-		let genHtmlCommand = null;
-		try {
-			genHtmlCommand = new Deno.Command("genhtml", {
-				args: ["-o", ".coverage/html", ".coverage/cov.lcov"],
-				stdout: "inherit",
-				stderr: "inherit",
-			});
-		} catch {
-			console.error("%cERROR%c Failed to generate html report, is lcov not installed?", "color: red", "");
-			let installCmd = null;
-			if (Deno.build.os == "darwin") {
-				installCmd = "brew install lcov";
-			}
-			// I'm not sure how to install it on other platforms, feel free to add more here.
-			if (installCmd) {
-				console.log(`Try installing it with: %c${installCmd}`, "color: black; background-color: grey");
-			}
-		}
-		if (genHtmlCommand) {
-			const genHtmlOutput = await genHtmlCommand.output();
-			if (!genHtmlOutput.success) {
-				Deno.exit(genHtmlOutput.code);
-			}
+	await Deno.writeFile(".coverage/cov.lcov", lcovOutput.stdout);
+
+	console.log("Generating HTML coverage report...");
+	const htmlCoverageCommand = new Deno.Command(Deno.execPath(), {
+		args: ["coverage", DENO_COVERAGE_DIR, "--html", `--include=${includeRegex}`],
+		stdout: "piped",
+		stderr: "piped",
+	});
+	const htmlOutput = await htmlCoverageCommand.output();
+	if (!htmlOutput.success) {
+		Deno.exit(htmlOutput.code);
+	}
+
+	try {
+		await Deno.remove(DENO_HTML_COVERAGE_DIR, { recursive: true });
+	} catch (e) {
+		if (e instanceof Deno.errors.NotFound) {
+			// Already removed
+		} else {
+			throw e;
 		}
 	}
+	await Deno.rename(resolve(DENO_COVERAGE_DIR, "html"), DENO_HTML_COVERAGE_DIR);
 }

test/readme.md

@@ -14,7 +14,6 @@ The test script takes some optional parameters:
 - `-i`, `--inspect` to wait for a debugger to connect, this also automatically disables headless mode for e2e tests, disables e2e test timeouts, and forces e2e tests to run only once.
 - `-h`, `--headless` toggles the default headless behaviour. Headless mode is disabled by default unless `-i` or `--inspect` have been specified.
 - `-c`, `--coverage` generates a coverage file in `.lcov` format. This is useful if your IDE supports it.
-- `--html` generates a coverage file in `.html` format. `genhtml` needs to be installed for this to work. The generated html can be found at `.coverage/html`.
 
 ## Unit tests