as-test 1.0.0 → 1.0.3

package/bin/commands/init-core.js

@@ -4,7 +4,8 @@ import { existsSync, mkdirSync, readFileSync, writeFileSync } from "fs";
 import * as path from "path";
 import { createInterface } from "readline";
 import { getCliVersion } from "../util.js";
-const TARGETS = ["wasi", "bindings"];
+import { buildWebRunnerSource } from "./web-runner-source.js";
+const TARGETS = ["wasi", "bindings", "web"];
 const EXAMPLE_MODES = ["minimal", "full", "none"];
 export async function init(rawArgs) {
     const options = parseInitArgs(rawArgs);
@@ -21,6 +22,7 @@ export async function init(rawArgs) {
                 root: path.resolve(process.cwd(), options.dir),
                 target: options.target ?? "wasi",
                 example: options.example ?? "minimal",
+                fuzzExample: options.fuzzExample ?? false,
                 installDependenciesNow: options.install ?? false,
             }
             : await runInteractiveOnboarding(options, rl);
@@ -28,7 +30,7 @@ export async function init(rawArgs) {
             console.log(chalk.bold.red("◆  Cancelled"));
             return;
         }
-        printPlan(answers.root, answers.target, answers.example, answers.installDependenciesNow);
+        printPlan(answers.root, answers.target, answers.example, answers.fuzzExample, answers.installDependenciesNow);
         if (!options.yes) {
             const cont = await askYesNo("Continue with these changes?", rl, true);
             if (!cont) {
@@ -36,7 +38,7 @@ export async function init(rawArgs) {
                 return;
             }
         }
-        const summary = applyInit(answers.root, answers.target, answers.example, options.force);
+        const summary = applyInit(answers.root, answers.target, answers.example, answers.fuzzExample, options.force);
         printSummary(summary);
         console.log(chalk.bold.green("◆  Finished!"));
         if (answers.installDependenciesNow) {
@@ -73,6 +75,14 @@ function parseInitArgs(rawArgs) {
             options.install = true;
             continue;
         }
+        if (arg == "--fuzz-example") {
+            options.fuzzExample = true;
+            continue;
+        }
+        if (arg == "--no-fuzz-example") {
+            options.fuzzExample = false;
+            continue;
+        }
         if (arg == "--target") {
             const next = rawArgs[i + 1];
             if (next && !next.startsWith("-")) {
@@ -80,7 +90,7 @@ function parseInitArgs(rawArgs) {
                 i++;
                 continue;
             }
-            throw new Error("--target requires a value: wasi|bindings");
+            throw new Error("--target requires a value: wasi|bindings|web");
         }
         if (arg.startsWith("--target=")) {
             options.target = parseTarget(arg.slice("--target=".length));
@@ -133,7 +143,7 @@ function parseInitArgs(rawArgs) {
         options.example = positional.shift();
     }
     if (positional.length > 0) {
-        throw new Error(`Unknown init argument(s): ${positional.join(", ")}. Usage: init [dir] [--target wasi|bindings] [--example minimal|full|none] [--install] [--yes] [--force] [--dir <path>]`);
+        throw new Error(`Unknown init argument(s): ${positional.join(", ")}. Usage: init [dir] [--target wasi|bindings|web] [--example minimal|full|none] [--fuzz-example|--no-fuzz-example] [--install] [--yes] [--force] [--dir <path>]`);
     }
     return options;
 }
@@ -176,6 +186,10 @@ async function runInteractiveOnboarding(options, face) {
                     value: "bindings",
                     label: "bindings (default runner: node .as-test/runners/default.bindings.js)",
                 },
+                {
+                    value: "web",
+                    label: "web (default runner: node .as-test/runners/default.web.js <file>)",
+                },
             ], face, "wasi"));
     if (options.target || onboardingMode == "quick") {
         printPromptAndSelectionLine("Build target", target);
@@ -191,6 +205,13 @@ async function runInteractiveOnboarding(options, face) {
     if (options.example || onboardingMode == "quick") {
         printPromptAndSelectionLine("Example template", example);
     }
+    const fuzzExample = options.fuzzExample ??
+        (onboardingMode == "quick"
+            ? false
+            : await askYesNo("Add a basic fuzzer example?", face, false));
+    if (options.fuzzExample !== undefined || onboardingMode == "quick") {
+        printPromptAndSelectionLine("Add a basic fuzzer example?", fuzzExample ? "Yes" : "No");
+    }
     const installDependenciesNow = options.install ??
         (onboardingMode == "quick"
             ? false
@@ -202,6 +223,7 @@ async function runInteractiveOnboarding(options, face) {
         root: resolvedRoot,
         target,
         example,
+        fuzzExample,
         installDependenciesNow,
     };
 }
@@ -213,9 +235,9 @@ function printOnboardingHeader() {
     // );
 }
 function printOnboardingIntro() {
-    console.log(chalk.cyan("╔═╗ ╔═╗    ╔═╗ ╔═╗ ╔═╗ ╔═╗"));
-    console.log(chalk.cyan("╠═╣ ╚═╗ ══  ║  ╠═  ╚═╗  ║ "));
-    console.log(chalk.cyan("╩ ╩ ╚═╝     ╩  ╚═╝ ╚═╝  ╩ "));
+    console.log(chalk.bold.blue("╔═╗ ╔═╗    ╔═╗ ╔═╗ ╔═╗ ╔═╗"));
+    console.log(chalk.bold.blue("╠═╣ ╚═╗ ══  ║  ╠═  ╚═╗  ║ "));
+    console.log(chalk.bold.blue("╩ ╩ ╚═╝     ╩  ╚═╝ ╚═╝  ╩ "));
     console.log("");
     // console.log(chalk.bold("┌") + " " + chalk.bold.blueBright(""));
     // console.log("│");
@@ -284,7 +306,7 @@ function printSelectionLine(answer) {
 }
 function parseTarget(value) {
     if (!isTarget(value)) {
-        throw new Error(`Invalid target "${value}". Expected wasi|bindings`);
+        throw new Error(`Invalid target "${value}". Expected wasi|bindings|web`);
     }
     return value;
 }
@@ -300,7 +322,7 @@ function isTarget(value) {
 function isExampleMode(value) {
     return EXAMPLE_MODES.includes(value);
 }
-function printPlan(root, target, example, install) {
+function printPlan(root, target, example, fuzzExample, install) {
     const displayRoot = () => {
         const rel = path.relative(process.cwd(), root).split(path.sep).join("/");
         if (!rel || rel == ".")
@@ -363,11 +385,12 @@ function printPlan(root, target, example, install) {
         { path: ".as-test/coverage", isDir: true },
         { path: ".as-test/snapshots", isDir: true },
         { path: "assembly", isDir: true },
+        { path: "assembly/tsconfig.json", isDir: false },
         { path: "assembly/__tests__", isDir: true },
         { path: "as-test.config.json", isDir: false },
         { path: "package.json", isDir: false },
     ];
-    if (target == "wasi" || target == "bindings") {
+    if (target == "wasi" || target == "bindings" || target == "web") {
         fileEntries.push({ path: ".as-test/runners", isDir: true });
         fileEntries.push({
             path: ".as-test/runners/default.bindings.js",
@@ -377,6 +400,10 @@ function printPlan(root, target, example, install) {
             path: ".as-test/runners/default.wasi.js",
             isDir: false,
         });
+        fileEntries.push({
+            path: ".as-test/runners/default.web.js",
+            isDir: false,
+        });
     }
     if (example != "none") {
         fileEntries.push({
@@ -384,10 +411,18 @@ function printPlan(root, target, example, install) {
             isDir: false,
         });
     }
+    if (fuzzExample) {
+        fileEntries.push({ path: "assembly/__fuzz__", isDir: true });
+        fileEntries.push({
+            path: "assembly/__fuzz__/example.fuzz.ts",
+            isDir: false,
+        });
+    }
     const treeRoot = buildTree(fileEntries);
     console.log(chalk.bold.blue("◇  Planned Changes"));
     console.log("│" + chalk.dim(`  - Target: ${target}`));
     console.log("│" + chalk.dim(`  - Example: ${example}`));
+    console.log("│" + chalk.dim(`  - Fuzzer example: ${fuzzExample ? "yes" : "no"}`));
     console.log("│" + chalk.dim(`  - Directory: ${displayRoot()}`));
     console.log("│" + chalk.dim(`  - Install dependencies: ${install ? "yes" : "no"}`));
     console.log("│" + chalk.bold.blue("  File Changes"));
@@ -397,7 +432,7 @@ function printPlan(root, target, example, install) {
     }
     console.log("│");
 }
-function applyInit(root, target, example, force) {
+function applyInit(root, target, example, fuzzExample, force) {
     const summary = {
         created: [],
         updated: [],
@@ -408,18 +443,34 @@ function applyInit(root, target, example, force) {
     ensureDir(root, ".as-test/coverage", summary);
     ensureDir(root, ".as-test/snapshots", summary);
     ensureDir(root, "assembly/__tests__", summary);
-    if (target == "wasi" || target == "bindings") {
+    if (fuzzExample) {
+        ensureDir(root, "assembly/__fuzz__", summary);
+    }
+    if (target == "wasi" || target == "bindings" || target == "web") {
         ensureDir(root, ".as-test/runners", summary);
     }
     ensureGitignoreIncludesAsTestDirs(root, summary);
+    writeJson(path.join(root, "assembly/tsconfig.json"), buildAssemblyTsconfig(), summary, "assembly/tsconfig.json");
     const configPath = path.join(root, "as-test.config.json");
     const config = {
         $schema: "node_modules/as-test/as-test.config.schema.json",
         input: ["assembly/__tests__/*.spec.ts"],
         output: ".as-test/",
         config: "none",
-        coverage: true,
+        coverage: false,
         env: {},
+        ...(fuzzExample
+            ? {
+                fuzz: {
+                    input: ["assembly/__fuzz__/*.fuzz.ts"],
+                    runs: 1000,
+                    seed: 1337,
+                    target: "bindings",
+                    corpusDir: ".as-test/corpus",
+                    crashDir: ".as-test/crashes",
+                },
+            }
+            : {}),
         buildOptions: {
             target,
         },
@@ -427,11 +478,23 @@ function applyInit(root, target, example, force) {
             runtime: {
                 cmd: target == "wasi"
                     ? "node .as-test/runners/default.wasi.js <file>"
-                    : "node .as-test/runners/default.bindings.js <file>",
+                    : target == "bindings"
+                        ? "node .as-test/runners/default.bindings.js <file>"
+                        : "node .as-test/runners/default.web.js <file>",
             },
             reporter: "default",
         },
-        modes: {},
+        modes: target == "web"
+            ? {
+                "web-headless": {
+                    runOptions: {
+                        runtime: {
+                            cmd: "node .as-test/runners/default.web.js --headless <file>",
+                        },
+                    },
+                },
+            }
+            : {},
     };
     writeJson(configPath, config, summary, "as-test.config.json");
     if (example != "none") {
@@ -439,14 +502,22 @@ 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" || target == "bindings") {
+    if (fuzzExample) {
+        const fuzzPath = path.join(root, "assembly/__fuzz__/example.fuzz.ts");
+        writeManagedFile(fuzzPath, buildBasicFuzzerExample(), force, summary, "assembly/__fuzz__/example.fuzz.ts");
+    }
+    if (target == "wasi" || target == "bindings" || target == "web") {
         const runnerPath = path.join(root, ".as-test/runners/default.wasi.js");
         writeManagedFile(runnerPath, buildWasiRunner(), force, summary, ".as-test/runners/default.wasi.js");
     }
-    if (target == "wasi" || target == "bindings") {
+    if (target == "wasi" || target == "bindings" || target == "web") {
         const runnerPath = path.join(root, ".as-test/runners/default.bindings.js");
         writeManagedFile(runnerPath, buildBindingsRunner(), force, summary, ".as-test/runners/default.bindings.js");
     }
+    if (target == "wasi" || target == "bindings" || target == "web") {
+        const runnerPath = path.join(root, ".as-test/runners/default.web.js");
+        writeManagedFile(runnerPath, buildWebRunnerSource(), force, summary, ".as-test/runners/default.web.js");
+    }
     const pkgPath = path.join(root, "package.json");
     const pkg = existsSync(pkgPath)
         ? JSON.parse(readFileSync(pkgPath, "utf8"))
@@ -458,6 +529,9 @@ function applyInit(root, target, example, force) {
     if (!scripts.test) {
         scripts.test = "ast test";
     }
+    if (fuzzExample && !scripts.fuzz) {
+        scripts.fuzz = "ast fuzz";
+    }
     if (!pkg.type) {
         pkg.type = "module";
     }
@@ -501,7 +575,13 @@ function ensureDir(root, rel, summary) {
 function ensureGitignoreIncludesAsTestDirs(root, summary) {
     const rel = ".gitignore";
     const fullPath = path.join(root, rel);
-    const entries = ["!.as-test/runners/", "!.as-test/snapshots/"];
+    const entries = [
+        "# Include essential as-test artifacts",
+        "!.as-test/",
+        ".as-test/*",
+        "!.as-test/runners/",
+        "!.as-test/snapshots/",
+    ];
     const existed = existsSync(fullPath);
     const source = existed ? readFileSync(fullPath, "utf8") : "";
     const lines = source.split(/\r?\n/);
@@ -521,6 +601,12 @@ function ensureGitignoreIncludesAsTestDirs(root, summary) {
     else
         summary.created.push(rel);
 }
+function buildAssemblyTsconfig() {
+    return {
+        extends: "assemblyscript/std/assembly.json",
+        include: ["./**/*.ts"],
+    };
+}
 function writeJson(fullPath, value, summary, displayPath) {
     const rel = displayPath ??
         path.relative(process.cwd(), fullPath) ??
@@ -827,19 +913,17 @@ function resolveInstallCommand(root) {
     return { command: "npm", args: ["install"] };
 }
 function buildMinimalExampleSpec() {
-    return `import { describe, expect, test, run } from "as-test";
+    return `import { describe, expect, test } from "as-test";
 
 describe("example", () => {
   test("adds numbers", () => {
     expect(1 + 2).toBe(3);
   });
 });
-
-run();
 `;
 }
 function buildFullExampleSpec() {
-    return `import { afterAll, beforeAll, describe, expect, it, log, run, test } from "as-test";
+    return `import { afterAll, beforeAll, describe, expect, it, log, test } from "as-test";
 
 beforeAll(() => {
   log("setup");
@@ -869,8 +953,24 @@ describe("strings", () => {
     expect("as-test").toStartWith("as");
   });
 });
+`;
+}
+function buildBasicFuzzerExample() {
+    return `import { expect, fuzz, FuzzSeed } from "as-test";
 
-run();
+fuzz("basic string fuzzer", (value: string): bool => {
+  expect(value.length >= 0).toBe(true);
+  return value.length <= 24;
+}).generate((seed: FuzzSeed, run: (value: string) => bool): void => {
+  run(
+    seed.string({
+      charset: "ascii",
+      min: 0,
+      max: 24,
+      exclude: [0x00, 0x0a, 0x0d],
+    }),
+  );
+});
 `;
 }
 function buildWasiRunner() {
@@ -909,6 +1009,11 @@ try {
   const binary = readFileSync(wasmPath);
   const module = new WebAssembly.Module(binary);
   const instance = new WebAssembly.Instance(module, {
+    env: {
+      __as_test_request_fuzz_config() {
+        return 0;
+      },
+    },
     wasi_snapshot_preview1: wasi.wasiImport,
   });
   wasi.start(instance);