as-test 0.5.1 → 0.5.3

package/bin/init.js

@@ -148,11 +148,9 @@ function printPlan(root, target, example) {
     if (example != "none") {
         console.log(chalk.dim("    assembly/__tests__/example.spec.ts"));
     }
-    if (target == "wasi") {
+    if (target == "wasi" || target == "bindings") {
         console.log(chalk.dim("    .as-test/runners/default.wasi.js"));
-    }
-    if (target == "bindings") {
-        console.log(chalk.dim("    .as-test/runners/default.run.js"));
+        console.log(chalk.dim("    .as-test/runners/default.bindings.js"));
     }
     console.log(chalk.dim("    package.json"));
     console.log("");
@@ -171,15 +169,17 @@ function applyInit(root, target, example, force) {
     if (target == "wasi" || target == "bindings") {
         ensureDir(root, ".as-test/runners", summary);
     }
+    ensureGitignoreIncludesAsTestDirs(root, summary);
     const configPath = path.join(root, "as-test.config.json");
     const config = loadConfig(configPath, false);
     config.$schema = "./node_modules/as-test/as-test.config.schema.json";
     config.buildOptions.target = target;
+    config.runOptions.reporter = "default";
     if (target == "wasi") {
         config.runOptions.runtime.cmd = "node ./.as-test/runners/default.wasi.js <file>";
     }
     else {
-        config.runOptions.runtime.cmd = "node ./.as-test/runners/default.run.js <file>";
+        config.runOptions.runtime.cmd = "node ./.as-test/runners/default.bindings.js <file>";
     }
     writeJson(configPath, config, summary, "as-test.config.json");
     if (example != "none") {
@@ -187,13 +187,13 @@ function applyInit(root, target, example, force) {
         const content = example == "minimal" ? buildMinimalExampleSpec() : buildFullExampleSpec();
         writeManagedFile(examplePath, content, force, summary, "assembly/__tests__/example.spec.ts");
     }
-    if (target == "wasi") {
+    if (target == "wasi" || target == "bindings") {
         const runnerPath = path.join(root, ".as-test/runners/default.wasi.js");
         writeManagedFile(runnerPath, buildWasiRunner(), force, summary, ".as-test/runners/default.wasi.js");
     }
-    if (target == "bindings") {
-        const runnerPath = path.join(root, ".as-test/runners/default.run.js");
-        writeManagedFile(runnerPath, buildBindingsRunner(), force, summary, ".as-test/runners/default.run.js");
+    if (target == "wasi" || target == "bindings") {
+        const runnerPath = path.join(root, ".as-test/runners/default.bindings.js");
+        writeManagedFile(runnerPath, buildBindingsRunner(), force, summary, ".as-test/runners/default.bindings.js");
     }
     const pkgPath = path.join(root, "package.json");
     const pkg = existsSync(pkgPath)
@@ -232,6 +232,31 @@ function ensureDir(root, rel, summary) {
     mkdirSync(full, { recursive: true });
     summary.created.push(rel + "/");
 }
+function ensureGitignoreIncludesAsTestDirs(root, summary) {
+    const rel = ".gitignore";
+    const fullPath = path.join(root, rel);
+    const entries = ["!.as-test/runners/", "!.as-test/snapshots/"];
+    const existed = existsSync(fullPath);
+    const source = existed ? readFileSync(fullPath, "utf8") : "";
+    const lines = source.split(/\r?\n/);
+    const missing = entries.filter((entry) => !lines.some((line) => line.trim() == entry));
+    if (!missing.length) {
+        return;
+    }
+    const eol = source.includes("\r\n") ? "\r\n" : "\n";
+    let output = source;
+    if (output.length &&
+        !output.endsWith("\n") &&
+        !output.endsWith("\r\n")) {
+        output += eol;
+    }
+    output += missing.join(eol) + eol;
+    writeFileSync(fullPath, output);
+    if (existed)
+        summary.updated.push(rel);
+    else
+        summary.created.push(rel);
+}
 function writeJson(fullPath, value, summary, displayPath) {
     const rel = displayPath ??
         path.relative(process.cwd(), fullPath) ??
@@ -449,7 +474,7 @@ function withNodeIo(imports = {}) {
 
 const wasmPathArg = process.argv[2];
 if (!wasmPathArg) {
-  process.stderr.write("usage: node ./.as-test/runners/default.run.js <file.wasm>\\n");
+  process.stderr.write("usage: node ./.as-test/runners/default.bindings.js <file.wasm>\\n");
   process.exit(1);
 }
 

package/bin/reporters/default.js

@@ -13,9 +13,11 @@ class DefaultReporter {
         this.renderedLines = 0;
         this.fileHasWarning = false;
         this.verboseMode = false;
+        this.cleanMode = false;
     }
     canRewriteLine() {
-        return Boolean(this.context.stdout.isTTY);
+        return (!this.cleanMode &&
+            Boolean(this.context.stdout.isTTY));
     }
     badgeRunning() {
         return chalk.bgBlackBright.white(" .... ");
@@ -115,18 +117,15 @@ class DefaultReporter {
     }
     onRunStart(event) {
         this.verboseMode = Boolean(event.verbose);
-        if (event.clean)
-            return;
-        if (event.snapshotEnabled) {
-            this.context.stdout.write(chalk.bgBlue(" SNAPSHOT ") +
-                ` ${chalk.dim(event.updateSnapshots ? "update mode enabled" : "read-only mode")}\n\n`);
-        }
+        this.cleanMode = Boolean(event.clean);
     }
     onFileStart(event) {
         this.currentFile = event.file;
         this.openSuites = [];
         this.verboseSuites = [];
         this.fileHasWarning = false;
+        if (this.cleanMode)
+            return;
         if (this.verboseMode && this.canRewriteLine()) {
             this.renderVerboseState();
             return;
@@ -157,6 +156,8 @@ class DefaultReporter {
         this.fileHasWarning = false;
     }
     onSuiteStart(event) {
+        if (this.cleanMode)
+            return;
         const depth = Math.max(event.depth, 0);
         if (this.verboseMode && this.canRewriteLine()) {
             if (this.currentFile !== event.file)
@@ -180,6 +181,8 @@ class DefaultReporter {
         this.renderLiveState();
     }
     onSuiteEnd(event) {
+        if (this.cleanMode)
+            return;
         const depth = Math.max(event.depth, 0);
         const verdict = String(event.verdict ?? "none");
         if (this.verboseMode && this.canRewriteLine()) {
@@ -239,7 +242,7 @@ class DefaultReporter {
                 renderCoveragePoints(event.coverageSummary.files);
             }
         }
-        renderTotals(event.stats);
+        renderTotals(event.stats, event);
     }
 }
 function renderFailedSuites(failedEntries) {
@@ -311,7 +314,7 @@ function renderSnapshotSummary(snapshotSummary) {
     console.log("");
     console.log(`${chalk.bold("Snapshots:")} ${chalk.greenBright(snapshotSummary.matched)} matched, ${chalk.blueBright(snapshotSummary.created)} created, ${chalk.blueBright(snapshotSummary.updated)} updated, ${snapshotSummary.failed ? chalk.red(snapshotSummary.failed) : chalk.greenBright("0")} failed`);
 }
-function renderTotals(stats) {
+function renderTotals(stats, event) {
     console.log("");
     process.stdout.write(chalk.bold("Files:  "));
     process.stdout.write(stats.failedFiles
@@ -344,8 +347,22 @@ function renderTotals(stats) {
             ? chalk.gray(stats.skippedTests + " skipped")
             : chalk.gray("0 skipped")));
     process.stdout.write(", " + (stats.failedTests + stats.passedTests + stats.skippedTests) + " total\n");
+    if (event.modeSummary) {
+        renderModeSummary(event.modeSummary);
+    }
     process.stdout.write(chalk.bold("Time:   ") + formatTime(stats.time) + "\n");
 }
+function renderModeSummary(summary) {
+    process.stdout.write(chalk.bold("Modes:  "));
+    process.stdout.write(summary.failed
+        ? chalk.bold.red(summary.failed + " failed")
+        : chalk.bold.greenBright("0 failed"));
+    process.stdout.write(", " +
+        (summary.skipped
+            ? chalk.gray(summary.skipped + " skipped")
+            : chalk.gray("0 skipped")));
+    process.stdout.write(", " + summary.total + " total\n");
+}
 function renderCoverageSummary(summary) {
     const pct = summary.total
         ? ((summary.covered * 100) / summary.total).toFixed(2)

package/bin/reporters/tap.js

@@ -0,0 +1,294 @@
+import * as path from "path";
+import { mkdirSync, writeFileSync } from "fs";
+export function createTapReporter(context, config = {}) {
+    return new TapReporter(context, normalizeTapConfig(config));
+}
+export const createReporter = (context) => {
+    return createTapReporter(context);
+};
+class TapReporter {
+    constructor(context, config) {
+        this.context = context;
+        this.config = config;
+    }
+    onRunComplete(event) {
+        const points = collectTapPoints(event.reports);
+        const output = buildTapDocument(points);
+        this.context.stdout.write(output);
+        for (const point of points) {
+            if (point.status != "fail")
+                continue;
+            emitGitHubAnnotation(this.context, point);
+        }
+        this.writeArtifacts(points, output);
+    }
+    writeArtifacts(points, output) {
+        if (this.config.mode == "per-file") {
+            this.writePerFileArtifacts(points);
+            return;
+        }
+        const outFile = path.resolve(process.cwd(), this.config.outFile);
+        mkdirSync(path.dirname(outFile), { recursive: true });
+        writeFileSync(outFile, output);
+    }
+    writePerFileArtifacts(points) {
+        const groups = new Map();
+        for (const point of points) {
+            const key = point.file?.length ? point.file : "unknown";
+            if (!groups.has(key))
+                groups.set(key, []);
+            groups.get(key).push(point);
+        }
+        let unknownIndex = 0;
+        const outDir = path.resolve(process.cwd(), this.config.outDir);
+        mkdirSync(outDir, { recursive: true });
+        for (const [fileKey, filePoints] of groups) {
+            const fileName = fileKey == "unknown"
+                ? `unknown-${++unknownIndex}.tap`
+                : toTapFileName(fileKey);
+            const outFile = path.join(outDir, fileName);
+            writeFileSync(outFile, buildTapDocument(filePoints));
+        }
+    }
+}
+function normalizeTapConfig(config) {
+    const mode = config.mode == "per-file" ? "per-file" : "single-file";
+    const outDir = typeof config.outDir == "string" && config.outDir.trim().length
+        ? config.outDir.trim()
+        : "./.as-test/reports";
+    const outFile = typeof config.outFile == "string" && config.outFile.trim().length
+        ? config.outFile.trim()
+        : path.join(outDir, "report.tap");
+    return {
+        mode,
+        outDir,
+        outFile,
+    };
+}
+function toTapFileName(file) {
+    const normalized = file
+        .replace(/^[.\\/]+/, "")
+        .replace(/[\\/]/g, "__")
+        .replace(/\.[^.]+$/, "");
+    return `${normalized}.tap`;
+}
+function buildTapDocument(points) {
+    const totals = {
+        pass: 0,
+        fail: 0,
+        skip: 0,
+    };
+    const lines = [];
+    lines.push("TAP version 13");
+    lines.push(`1..${points.length}`);
+    for (let i = 0; i < points.length; i++) {
+        const point = points[i];
+        const id = i + 1;
+        const name = sanitizeTap(point.name.length ? point.name : `test ${id}`);
+        if (point.status == "fail") {
+            totals.fail++;
+            lines.push(`not ok ${id} - ${name}`);
+            lines.push(...buildFailDetails(point));
+            continue;
+        }
+        if (point.status == "skip") {
+            totals.skip++;
+            lines.push(`ok ${id} - ${name} # SKIP`);
+            continue;
+        }
+        totals.pass++;
+        lines.push(`ok ${id} - ${name}`);
+    }
+    lines.push(`# tests ${points.length}`);
+    lines.push(`# pass ${totals.pass}`);
+    if (totals.skip) {
+        lines.push(`# skip ${totals.skip}`);
+    }
+    lines.push(`# fail ${totals.fail}`);
+    return lines.join("\n") + "\n";
+}
+function buildFailDetails(point) {
+    const lines = ["  ---", `  message: ${JSON.stringify(point.message ?? "assertion failed")}`];
+    if (point.file) {
+        lines.push(`  file: ${JSON.stringify(point.file)}`);
+    }
+    if (point.line) {
+        lines.push(`  line: ${point.line}`);
+    }
+    if (point.column) {
+        lines.push(`  column: ${point.column}`);
+    }
+    if (point.matcher) {
+        lines.push(`  matcher: ${JSON.stringify(point.matcher)}`);
+    }
+    if (point.expected != null) {
+        lines.push(`  expected: ${JSON.stringify(point.expected)}`);
+    }
+    if (point.actual != null) {
+        lines.push(`  actual: ${JSON.stringify(point.actual)}`);
+    }
+    if (point.durationMs != null) {
+        lines.push(`  duration_ms: ${Math.round(point.durationMs * 1000) / 1000}`);
+    }
+    lines.push("  ...");
+    return lines;
+}
+function collectTapPoints(reports) {
+    const points = [];
+    if (!Array.isArray(reports))
+        return points;
+    for (const report of reports) {
+        const reportAny = report;
+        const file = String(reportAny.file ?? "");
+        const suites = Array.isArray(reportAny.suites)
+            ? reportAny.suites
+            : [];
+        for (const suite of suites) {
+            collectTapPointsFromSuite(suite, file, [], points);
+        }
+    }
+    return points;
+}
+function collectTapPointsFromSuite(suite, file, pathStack, points) {
+    const suiteAny = suite;
+    const description = String(suiteAny.description ?? "suite");
+    const fullPath = [...pathStack, description];
+    const localFile = suiteAny.file ? String(suiteAny.file) : file;
+    const childSuites = Array.isArray(suiteAny.suites)
+        ? suiteAny.suites
+        : [];
+    const tests = Array.isArray(suiteAny.tests)
+        ? suiteAny.tests
+        : [];
+    const suiteKind = String(suiteAny.kind ?? "");
+    const durationMs = suiteDuration(suiteAny.time);
+    if (tests.length > 0) {
+        for (let i = 0; i < tests.length; i++) {
+            const test = tests[i];
+            const location = parseLocation(test.location);
+            const name = tests.length > 1
+                ? `${fullPath.join(" > ")} #${i + 1}`
+                : fullPath.join(" > ");
+            const status = normalizeStatus(test.verdict);
+            const matcher = stringifyValue(test.instr);
+            const expected = stringifyValue(test.right);
+            const actual = stringifyValue(test.left);
+            const message = buildFailureMessage(stringifyValue(test.message), matcher, expected, actual);
+            points.push({
+                name,
+                status,
+                file: localFile,
+                line: location.line,
+                column: location.column,
+                matcher,
+                expected,
+                actual,
+                message,
+                durationMs,
+            });
+        }
+    }
+    else if (childSuites.length == 0 &&
+        (suiteKind == "test" ||
+            suiteKind == "it" ||
+            suiteKind == "xtest" ||
+            suiteKind == "xit")) {
+        points.push({
+            name: fullPath.join(" > "),
+            status: normalizeStatus(suiteAny.verdict),
+            file: localFile,
+            durationMs,
+        });
+    }
+    for (const child of childSuites) {
+        collectTapPointsFromSuite(child, localFile, fullPath, points);
+    }
+}
+function suiteDuration(value) {
+    const time = value;
+    if (!time)
+        return undefined;
+    const start = Number(time.start ?? 0);
+    const end = Number(time.end ?? 0);
+    if (!Number.isFinite(start) || !Number.isFinite(end) || end < start) {
+        return undefined;
+    }
+    return end - start;
+}
+function parseLocation(value) {
+    const text = String(value ?? "").trim();
+    if (!text.length)
+        return {};
+    const match = /^(\d+)(?::(\d+))?$/.exec(text);
+    if (!match)
+        return {};
+    const line = Number(match[1]);
+    const column = match[2] ? Number(match[2]) : undefined;
+    return {
+        line: Number.isFinite(line) && line > 0 ? line : undefined,
+        column: typeof column == "number" && Number.isFinite(column) && column > 0
+            ? column
+            : undefined,
+    };
+}
+function normalizeStatus(verdict) {
+    const value = String(verdict ?? "none");
+    if (value == "fail")
+        return "fail";
+    if (value == "ok")
+        return "ok";
+    return "skip";
+}
+function stringifyValue(value) {
+    if (value == null)
+        return "";
+    if (typeof value == "string")
+        return value;
+    try {
+        return JSON.stringify(value);
+    }
+    catch {
+        return String(value);
+    }
+}
+function buildFailureMessage(message, matcher, expected, actual) {
+    if (message.length)
+        return message;
+    if (matcher.length && expected.length && actual.length) {
+        return `${matcher} expected ${expected} but received ${actual}`;
+    }
+    if (matcher.length)
+        return `${matcher} failed`;
+    return "assertion failed";
+}
+function sanitizeTap(name) {
+    return name.replace(/\s+/g, " ").replace(/#/g, "\\#").trim();
+}
+function emitGitHubAnnotation(context, point) {
+    if (process.env.GITHUB_ACTIONS != "true" || point.status != "fail")
+        return;
+    const properties = [];
+    if (point.file) {
+        properties.push(`file=${escapeGithubValue(point.file, true)}`);
+    }
+    if (point.line) {
+        properties.push(`line=${point.line}`);
+    }
+    if (point.column) {
+        properties.push(`col=${point.column}`);
+    }
+    properties.push(`title=${escapeGithubValue("as-test", true)}`);
+    const message = point.message?.length ? point.message : "assertion failed";
+    const detail = `${message} | test=${point.name}`;
+    context.stdout.write(`::error ${properties.join(",")}::${escapeGithubValue(detail)}\n`);
+}
+function escapeGithubValue(value, property = false) {
+    let output = value
+        .replace(/%/g, "%25")
+        .replace(/\r/g, "%0D")
+        .replace(/\n/g, "%0A");
+    if (property) {
+        output = output.replace(/:/g, "%3A").replace(/,/g, "%2C");
+    }
+    return output;
+}