as-test 0.3.1 → 0.3.3

package/CHANGELOG.md

@@ -25,3 +25,5 @@ v0.2.1 - Remove accidental logging
 
 v0.3.0 - Pass metadata through terminal - Support for multiple files - Better reporting - Timing for suites - Terminal utilities
 v0.3.1 - Add screenshot of completed tests to readme
+v0.3.2 - Add `mockImport` to override imported functions
+v0.3.3 - Allow `mockImport`'s return type to be any

package/README.md

@@ -3,7 +3,7 @@
 |  _  ||   __| ___|_   _||   __||   __||_   _|
 |     ||__   ||___| | |  |   __||__   |  | |  
 |__|__||_____|      |_|  |_____||_____|  |_|  
-v0.3.1
+v0.3.3
 </pre>
 </h5>
 
@@ -59,6 +59,8 @@ mockFn<void>("console.log", (data: string): void => {
     console.log("[MOCKED]: " + data + "\n");
 });
 
+// Or override an imported function with mockImport
+
 describe("Should sleep", () => {
     test("1ms", () => {
         const start = Date.now();
@@ -133,21 +135,12 @@ Build and run it using as-test
 npm run test
 ```
 
-<img src="https://raw.githubusercontent.com/JairusSW/as-test/main/assets/img/screenshot.png">
-
-<h6>
-
 ## Running
 
 To add `as-test` to your CI/CD workflow, check out [The provided example](https://github.com/JairusSW/as-test/blob/main/.github/workflows/nodejs.yml)
 
 If you use this project in your codebase, consider dropping a [⭐ HERE](https://github.com/JairusSW/as-test). I would really appreciate it!
 
-## Notes
-
-This library is in the EARLY STAGES OF DEVELOPMENT!
-If you want a feature, drop an issue (and again, maybe a star). I'll likely add it in less than 7 days.
-
 ## Issues
 
 Please submit an issue to https://github.com/JairusSW/as-test/issues if you find anything wrong with this library

package/assembly/__tests__/mock.spec.ts

@@ -0,0 +1,22 @@
+import { expect, it, log, mockFn, mockImport, run } from "..";
+import { foo, getFoo } from "./mock";
+
+// function foo(): string {
+//     return "bar";
+// }
+
+mockFn(foo, (): string => {
+  return "baz " + foo();
+});
+
+mockImport("mock.foo", (): string => {
+  return "biz";
+});
+
+it("should mock functions", () => {
+  log(foo());
+  expect(foo()).toBe("baz biz");
+  expect(getFoo()).toBe("biz");
+});
+
+run();

package/assembly/__tests__/mock.ts

@@ -0,0 +1,7 @@
+
+@external("mock", "foo")
+export declare function foo(): string;
+
+export function getFoo(): string {
+  return foo();
+}

package/assembly/index.ts

@@ -4,7 +4,7 @@ import { Expectation } from "./src/expectation";
 import { stringify } from "as-console/stringify";
 import { __COVER, __HASHES, __POINTS } from "as-test/assembly/coverage";
 import { JSON } from "json-as";
-import { term, TermLine } from "./util/term";
+import { term } from "./util/term";
 import { Log } from "./src/log";
 
 let entrySuites: Suite[] = [];
@@ -13,6 +13,10 @@ let entrySuites: Suite[] = [];
 const FILE = isDefined(ENTRY_FILE) ? ENTRY_FILE : "unknown";
 // Globals
 // @ts-ignore
+@global let __mock_global: Map<string, u32> = new Map<string, u32>();
+// @ts-ignore
+@global let __mock_import: Map<string, u32> = new Map<string, u32>();
+// @ts-ignore
 @global let suites: Suite[] = [];
 // @ts-ignore
 @global let depth: i32 = -1;
@@ -215,26 +219,16 @@ export function afterEach(callback: () => void): void {
 }
 
 /**
- * Overrides all references to an existing function in local scope to instead point to new function
- * @param {string} fn - name of function to override
- * @param {() => returnType} callback - the function to substitute it with
- */
-export function mockFn<returnType>(
-  fn: string,
-  callback: (...args: any[]) => returnType,
-): void {}
-
-/**
- * Unmock all references to an existing function to instead point to the original function
- * @param {string} fn - name of function to override
+ * Replace all references to an existing function to new function
+ * @param {Function} oldFn - name of function to mock
+ * @param {Function} newFn - the function to substitute it with
  */
-export function unmockFn(fn: string): void {}
+export function mockFn(oldFn: Function, newFn: Function): void {}
 
-/**
- * Re-mock all references to an existing function to instead point to the declared function
- * @param {string} fn - name of function to override
- */
-export function remockFn(fn: string): void {}
+export function mockImport<T extends Function>(oldFn: string, newFn: T): void {
+  __mock_import.set(oldFn, newFn.index);
+  // mocks.set(oldFn, new MockFn(oldFn, newFn).enable());
+}
 
 /**
  * Class defining options that can be passed to the `run` function.

package/bin/build.js

@@ -7,80 +7,92 @@ import { loadConfig } from "./util.js";
 const CONFIG_PATH = path.join(process.cwd(), "./as-test.config.json");
 const PKG_PATH = path.join(process.cwd(), "./package.json");
 export async function build() {
-    let config = loadConfig(CONFIG_PATH, true);
-    const ASCONFIG_PATH = path.join(process.cwd(), config.config);
-    if (config.config && config.config !== "none" && !existsSync(ASCONFIG_PATH)) {
-        console.log(`${chalk.bgMagentaBright(" WARN ")}${chalk.dim(":")} Could not locate asconfig.json file! If you do not want to provide a config, set "config": "none"`);
-    }
-    ensureDeps(config);
-    let pkgRunner = getPkgRunner();
-    const inputFiles = await glob(config.input);
-    let buildArgs = getBuildArgs(config);
-    for (const file of inputFiles) {
-        let cmd = `${pkgRunner} asc ${file}${buildArgs}`;
-        const outFile = `${config.outDir}/${file.slice(file.lastIndexOf("/") + 1).replace(".ts", ".wasm")}`;
-        if (config.outDir) {
-            cmd += " -o " + outFile;
-        }
-        buildFile(cmd);
+  let config = loadConfig(CONFIG_PATH, true);
+  const ASCONFIG_PATH = path.join(process.cwd(), config.config);
+  if (config.config && config.config !== "none" && !existsSync(ASCONFIG_PATH)) {
+    console.log(
+      `${chalk.bgMagentaBright(" WARN ")}${chalk.dim(":")} Could not locate asconfig.json file! If you do not want to provide a config, set "config": "none"`,
+    );
+  }
+  ensureDeps(config);
+  let pkgRunner = getPkgRunner();
+  const inputFiles = await glob(config.input);
+  let buildArgs = getBuildArgs(config);
+  for (const file of inputFiles) {
+    let cmd = `${pkgRunner} asc ${file}${buildArgs}`;
+    const outFile = `${config.outDir}/${file.slice(file.lastIndexOf("/") + 1).replace(".ts", ".wasm")}`;
+    if (config.outDir) {
+      cmd += " -o " + outFile;
     }
+    buildFile(cmd);
+  }
 }
 function ensureDeps(config) {
-    const pkg = JSON.parse(readFileSync(PKG_PATH).toString());
-    if (config.buildOptions.target == "wasi") {
-        if (!existsSync("./node_modules/@assemblyscript/wasi-shim/asconfig.json")) {
-            console.log(`${chalk.bgRed(" ERROR ")}${chalk.dim(":")} could not find @assemblyscript/wasi-shim! Add it to your dependencies to run with WASI!`);
-            process.exit(1);
-        }
-        if (pkg.dependencies &&
-            !Object.keys(pkg.dependencies).includes("@assemblyscript/wasi-shim") &&
-            pkg.devDependencies &&
-            !Object.keys(pkg.devDependencies).includes("@assemblyscript/wasi-shim") &&
-            pkg.peerDependencies &&
-            !Object.keys(pkg.peerDependencies).includes("@assemblyscript/wasi-shim") &&
-            existsSync("./node_modules/@assemblyscript/wasi-shim/asconfig.json")) {
-            console.log(`${chalk.bold.bgMagentaBright(" WARN ")}${chalk.dim(":")} @assemblyscript/wasi-shim is not included in project dependencies!"`);
-        }
+  const pkg = JSON.parse(readFileSync(PKG_PATH).toString());
+  if (config.buildOptions.target == "wasi") {
+    if (!existsSync("./node_modules/@assemblyscript/wasi-shim/asconfig.json")) {
+      console.log(
+        `${chalk.bgRed(" ERROR ")}${chalk.dim(":")} could not find @assemblyscript/wasi-shim! Add it to your dependencies to run with WASI!`,
+      );
+      process.exit(1);
+    }
+    if (
+      pkg.dependencies &&
+      !Object.keys(pkg.dependencies).includes("@assemblyscript/wasi-shim") &&
+      pkg.devDependencies &&
+      !Object.keys(pkg.devDependencies).includes("@assemblyscript/wasi-shim") &&
+      pkg.peerDependencies &&
+      !Object.keys(pkg.peerDependencies).includes(
+        "@assemblyscript/wasi-shim",
+      ) &&
+      existsSync("./node_modules/@assemblyscript/wasi-shim/asconfig.json")
+    ) {
+      console.log(
+        `${chalk.bold.bgMagentaBright(" WARN ")}${chalk.dim(":")} @assemblyscript/wasi-shim is not included in project dependencies!"`,
+      );
     }
+  }
 }
 function getPkgRunner() {
-    switch (process.env.npm_config_user_agent) {
-        case "pnpm": {
-            return "pnpx";
-        }
-        case "yarn": {
-            return "yarn";
-        }
-        case "bun": {
-            return "bunx";
-        }
+  switch (process.env.npm_config_user_agent) {
+    case "pnpm": {
+      return "pnpx";
+    }
+    case "yarn": {
+      return "yarn";
     }
-    return "npx";
+    case "bun": {
+      return "bunx";
+    }
+  }
+  return "npx";
 }
 function buildFile(command) {
-    execSync(command, { stdio: "inherit" });
+  execSync(command, { stdio: "inherit" });
 }
 function getBuildArgs(config) {
-    let buildArgs = "";
-    buildArgs += " --transform as-test/transform --transform json-as/transform";
-    if (config.config && config.config !== "none") {
-        buildArgs += " --config " + config.config;
-    }
-    // Should also strip any bindings-enabling from asconfig
-    if (config.buildOptions.target == "bindings") {
-        buildArgs += " --bindings raw --exportRuntime --exportStart _start";
-    }
-    else if (config.buildOptions.target == "wasi") {
-        buildArgs +=
-            " --config ./node_modules/@assemblyscript/wasi-shim/asconfig.json";
-    }
-    else {
-        console.log(`${chalk.bgRed(" ERROR ")}${chalk.dim(":")} could determine target in config! Set target to 'bindings' or 'wasi'`);
-        process.exit(0);
-    }
-    if (config.buildOptions.args.length &&
-        config.buildOptions.args.find((v) => v.length > 0)) {
-        buildArgs += " " + config.buildOptions.args.join(" ");
-    }
-    return buildArgs;
+  let buildArgs = "";
+  buildArgs += " --transform as-test/transform --transform json-as/transform";
+  if (config.config && config.config !== "none") {
+    buildArgs += " --config " + config.config;
+  }
+  // Should also strip any bindings-enabling from asconfig
+  if (config.buildOptions.target == "bindings") {
+    buildArgs += " --bindings raw --exportRuntime --exportStart _start";
+  } else if (config.buildOptions.target == "wasi") {
+    buildArgs +=
+      " --config ./node_modules/@assemblyscript/wasi-shim/asconfig.json";
+  } else {
+    console.log(
+      `${chalk.bgRed(" ERROR ")}${chalk.dim(":")} could determine target in config! Set target to 'bindings' or 'wasi'`,
+    );
+    process.exit(0);
+  }
+  if (
+    config.buildOptions.args.length &&
+    config.buildOptions.args.find((v) => v.length > 0)
+  ) {
+    buildArgs += " " + config.buildOptions.args.join(" ");
+  }
+  return buildArgs;
 }

package/bin/index.js

@@ -7,140 +7,170 @@ const _args = process.argv.slice(2);
 const flags = [];
 const args = [];
 const COMMANDS = ["run", "build", "test", "init"];
-const version = "0.3.1";
+const version = "0.3.3";
 for (const arg of _args) {
-    if (arg.startsWith("-"))
-        flags.push(arg);
-    else
-        args.push(arg);
+  if (arg.startsWith("-")) flags.push(arg);
+  else args.push(arg);
 }
 if (!args.length) {
-    if (flags.includes("--version") || flags.includes("-v")) {
-        console.log("as-test v" + version.toString());
-    }
-    else {
-        info();
-    }
-}
-else if (COMMANDS.includes(args[0])) {
-    const command = args.shift();
-    if (command === "build") {
-        build();
-    }
-    else if (command === "run") {
-        run();
-    }
-    else if (command === "test") {
-        build().then(() => {
-            run();
-        });
-    }
-    else if (command === "init") {
-        init(args);
-    }
-}
-else {
-    console.log(chalk.bgRed(" ERROR ") +
-        chalk.dim(":") +
-        " " +
-        chalk.bold("Unknown command: ") +
-        args[0]);
+  if (flags.includes("--version") || flags.includes("-v")) {
+    console.log("as-test v" + version.toString());
+  } else {
+    info();
+  }
+} else if (COMMANDS.includes(args[0])) {
+  const command = args.shift();
+  if (command === "build") {
+    build();
+  } else if (command === "run") {
+    run();
+  } else if (command === "test") {
+    build().then(() => {
+      run();
+    });
+  } else if (command === "init") {
+    init(args);
+  }
+} else {
+  console.log(
+    chalk.bgRed(" ERROR ") +
+      chalk.dim(":") +
+      " " +
+      chalk.bold("Unknown command: ") +
+      args[0],
+  );
 }
 function info() {
-    console.log(chalk.bold.blueBright("as-test") +
-        " is a testing framework for AssemblyScript. " +
-        chalk.dim("(v" + version + ")") +
-        "\n");
-    console.log(chalk.bold("Usage: as-test") +
-        " " +
-        chalk.dim("<command>") +
-        " " +
-        chalk.bold.blueBright("[...flags]") +
-        " " +
-        chalk.bold("[...args]") +
-        " " +
-        chalk.dim("(alias: ast)") +
-        "\n");
-    console.log(chalk.bold("Commands:"));
-    console.log("  " +
-        chalk.bold.blueBright("run") +
-        "       " +
-        chalk.dim("<my-test.spec.ts>") +
-        "       " +
-        "Run unit tests with selected runtime");
-    console.log("  " +
-        chalk.bold.blueBright("build") +
-        "     " +
-        chalk.dim("<my-test.spec.ts>") +
-        "       " +
-        "Build unit tests and compile");
-    console.log("  " +
-        chalk.bold.blueBright("test") +
-        "      " +
-        chalk.dim("<my-test.spec.ts>") +
-        "       " +
-        "Build and run unit tests with selected runtime" +
-        "\n");
-    console.log("  " +
-        chalk.bold.magentaBright("init") +
-        "       " +
-        chalk.strikethrough.dim("") +
-        "                       " +
-        "Initialize an empty testing template");
-    console.log("  " +
-        chalk.strikethrough.bold.magentaBright("config") +
-        "     " +
-        chalk.strikethrough.dim("as-test.config.json") +
-        "    " +
-        "Specify the configuration file");
-    console.log("  " +
-        chalk.strikethrough.bold.magentaBright("reporter") +
-        "   " +
-        chalk.strikethrough.dim("<tap>") +
-        "                  " +
-        "Specify the test reporter to use");
-    console.log("  " +
-        chalk.strikethrough.bold.magentaBright("use") +
-        "        " +
-        chalk.strikethrough.dim("wasmtime") +
-        "               " +
-        "Specify the runtime to use" +
-        "\n");
-    console.log(chalk.bold("Flags:"));
-    console.log("  " +
-        chalk.strikethrough.dim("run") +
-        "        " +
-        chalk.strikethrough.bold.blue("--coverage") +
-        "             " +
-        "Use code coverage");
-    console.log("  " +
-        chalk.strikethrough.dim("run") +
-        "        " +
-        chalk.strikethrough.bold.blue("--snapshot") +
-        "             " +
-        "Take a snapshot of the tests");
-    console.log("  " +
-        chalk.strikethrough.dim("use") +
-        "        " +
-        chalk.strikethrough.bold.blue("--list") +
-        "                 " +
-        "List supported runtimes");
-    console.log("  " +
-        chalk.strikethrough.dim("reporter") +
-        "   " +
-        chalk.strikethrough.bold.blue("--list") +
-        "                 " +
-        "List supported reporters");
-    console.log("  " +
-        chalk.strikethrough.dim("<command>") +
-        "  " +
-        chalk.strikethrough.bold.blue("--help") +
-        "                 " +
-        "Print info about command" +
-        "\n");
-    console.log(chalk.dim("If your using this, consider dropping a star, it would help a lot!") + "\n");
-    console.log("View the repo:                   " +
-        chalk.magenta("https://github.com/JairusSW/as-test"));
-    console.log("View the docs:                   " +
-        chalk.strikethrough.blue("https://docs.jairus.dev/as-test"));
+  console.log(
+    chalk.bold.blueBright("as-test") +
+      " is a testing framework for AssemblyScript. " +
+      chalk.dim("(v" + version + ")") +
+      "\n",
+  );
+  console.log(
+    chalk.bold("Usage: as-test") +
+      " " +
+      chalk.dim("<command>") +
+      " " +
+      chalk.bold.blueBright("[...flags]") +
+      " " +
+      chalk.bold("[...args]") +
+      " " +
+      chalk.dim("(alias: ast)") +
+      "\n",
+  );
+  console.log(chalk.bold("Commands:"));
+  console.log(
+    "  " +
+      chalk.bold.blueBright("run") +
+      "       " +
+      chalk.dim("<my-test.spec.ts>") +
+      "       " +
+      "Run unit tests with selected runtime",
+  );
+  console.log(
+    "  " +
+      chalk.bold.blueBright("build") +
+      "     " +
+      chalk.dim("<my-test.spec.ts>") +
+      "       " +
+      "Build unit tests and compile",
+  );
+  console.log(
+    "  " +
+      chalk.bold.blueBright("test") +
+      "      " +
+      chalk.dim("<my-test.spec.ts>") +
+      "       " +
+      "Build and run unit tests with selected runtime" +
+      "\n",
+  );
+  console.log(
+    "  " +
+      chalk.bold.magentaBright("init") +
+      "       " +
+      chalk.strikethrough.dim("") +
+      "                       " +
+      "Initialize an empty testing template",
+  );
+  console.log(
+    "  " +
+      chalk.strikethrough.bold.magentaBright("config") +
+      "     " +
+      chalk.strikethrough.dim("as-test.config.json") +
+      "    " +
+      "Specify the configuration file",
+  );
+  console.log(
+    "  " +
+      chalk.strikethrough.bold.magentaBright("reporter") +
+      "   " +
+      chalk.strikethrough.dim("<tap>") +
+      "                  " +
+      "Specify the test reporter to use",
+  );
+  console.log(
+    "  " +
+      chalk.strikethrough.bold.magentaBright("use") +
+      "        " +
+      chalk.strikethrough.dim("wasmtime") +
+      "               " +
+      "Specify the runtime to use" +
+      "\n",
+  );
+  console.log(chalk.bold("Flags:"));
+  console.log(
+    "  " +
+      chalk.strikethrough.dim("run") +
+      "        " +
+      chalk.strikethrough.bold.blue("--coverage") +
+      "             " +
+      "Use code coverage",
+  );
+  console.log(
+    "  " +
+      chalk.strikethrough.dim("run") +
+      "        " +
+      chalk.strikethrough.bold.blue("--snapshot") +
+      "             " +
+      "Take a snapshot of the tests",
+  );
+  console.log(
+    "  " +
+      chalk.strikethrough.dim("use") +
+      "        " +
+      chalk.strikethrough.bold.blue("--list") +
+      "                 " +
+      "List supported runtimes",
+  );
+  console.log(
+    "  " +
+      chalk.strikethrough.dim("reporter") +
+      "   " +
+      chalk.strikethrough.bold.blue("--list") +
+      "                 " +
+      "List supported reporters",
+  );
+  console.log(
+    "  " +
+      chalk.strikethrough.dim("<command>") +
+      "  " +
+      chalk.strikethrough.bold.blue("--help") +
+      "                 " +
+      "Print info about command" +
+      "\n",
+  );
+  console.log(
+    chalk.dim(
+      "If your using this, consider dropping a star, it would help a lot!",
+    ) + "\n",
+  );
+  console.log(
+    "View the repo:                   " +
+      chalk.magenta("https://github.com/JairusSW/as-test"),
+  );
+  console.log(
+    "View the docs:                   " +
+      chalk.strikethrough.blue("https://docs.jairus.dev/as-test"),
+  );
 }