as-test 0.1.7 → 0.1.8

package/CHANGELOG.md

@@ -15,4 +15,5 @@ v0.1.3 - Revamp `log<T>(data: T)` with new as-console version
 v0.1.4 - Fix a few bugs with the cli
 v0.1.5 - Add skeleton cli and custom config
 v0.1.6 - Fix: args should be prefixed with a space
-v0.1.7 - Fix: remove warning about wasi-shim not being included when it is included
+v0.1.7 - Fix: remove warning about wasi-shim not being included when it is included
+v0.1.8 - Feat: function mocking

package/README.md

@@ -3,7 +3,7 @@
 |  _  ||   __| ___|_   _||   __||   __||_   _|
 |     ||__   ||___| | |  |   __||__   |  | |  
 |__|__||_____|      |_|  |_____||_____|  |_|  
-v0.1.7
+v0.1.8
 </pre>
 </h5>
 
@@ -38,27 +38,29 @@ import {
   afterAll,
   beforeEach,
   afterEach,
+  mock,
   log,
   run
 } from "as-test";
 
-// Shared setup for all tests (executed once before all tests)
 beforeAll(() => {
   log("Setting up test environment...");
 });
 
-// Shared teardown for all tests (executed once after all tests)
 afterAll(() => {
   log("Tearing down test environment...");
 });
 
+// Mock/override the function console.log
+mock("console.log", (data: string): void => {
+  console.log("[MOCKED]: " + data + "\n");
+});
+
 describe("Math operations", () => {
-  // Setup before each test in this group (optional)
   beforeEach(() => {
     log("Initializing test...");
   });
 
-  // Teardown after each test in this group (optional)
   afterEach(() => {
     log("Cleaning up after test...");
   });

package/asconfig.json

@@ -26,7 +26,7 @@
     }
   },
   "options": {
-    "transform": ["./transform"],
+    "transform": [],
     "disableWarning": [226]
   },
   "extends": "./node_modules/@assemblyscript/wasi-shim/asconfig.json"

package/assembly/__tests__/example.spec.ts

@@ -8,8 +8,23 @@ import {
   afterEach,
   log,
   run,
+  mock,
 } from "..";
 
+function hello(a: i32, b: i32, c: i32): void {
+  console.log("a: " + a.toString());
+  console.log("b: " + b.toString());
+  console.log("c: " + c.toString());
+}
+
+mock("hello", (a: i32, b: i32, c: i32): void => {
+  hello(a + 10, b + 10, c + 10);
+});
+
+mock("console.log", (data: string): void => {
+  console.log("[MOCKED]: " + data);
+});
+
 // Shared setup for all tests (executed once before all tests)
 beforeAll(() => {
   log("Setting up test environment...");
@@ -31,6 +46,11 @@ describe("Math operations", () => {
     log("Cleaning up after test...");
   });
 
+  test("Mock", () => {
+    hello(1, 2, 3);
+    console.log("hello");
+  });
+
   test("Addition", () => {
     expect(1 + 2).toBe(3);
   });

package/assembly/index.ts

@@ -175,6 +175,11 @@ export function afterEach(callback: () => void): void {
   after_each_callback = callback;
 }
 
+export function mock<returnType>(
+  fn: string,
+  callback: (...args: any[]) => returnType,
+): void {}
+
 /**
  * Class defining options that can be passed to the `run` function.
  *
@@ -230,7 +235,7 @@ export function run(options: RunOptions = new RunOptions()): void {
     ),
   );
   console.log(
-    rainbow.dimMk("\n------------------- v0.1.7 -------------------\n"),
+    rainbow.dimMk("\n------------------- v0.1.8 -------------------\n"),
   );
   // @ts-ignore
   if (isDefined(COVERAGE_USE)) {

package/assembly/test.ts

@@ -1,3 +1,4 @@
+declare function hello(): void;
 import {
   describe,
   expect,

package/bin/build.js

@@ -6,125 +6,113 @@ import { exec } from "child_process";
 import { formatTime } from "./util.js";
 import * as path from "path";
 export async function build(args) {
-  const CONFIG_PATH = path.join(process.cwd(), "./as-test.config.json");
-  let config;
-  if (!existsSync(CONFIG_PATH)) {
-    console.log(
-      chalk.bgMagentaBright(" WARN ") +
-        chalk.dim(":") +
-        " Could not locate config file in the current directory! Continuing with default config." +
-        "\n",
-    );
-    config = new Config();
-  } else {
-    config = Object.assign(
-      new Config(),
-      JSON.parse(readFileSync(CONFIG_PATH).toString()),
-    );
-    console.log(chalk.dim("Loading config from: " + CONFIG_PATH) + "\n");
-  }
-  const ASCONFIG_PATH = path.join(process.cwd(), config.config);
-  if (!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". Continuing with default config.' +
-        "\n",
-    );
-  }
-  const pkg = JSON.parse(readFileSync("./package.json").toString());
-  let buildCommands = [];
-  if (config.buildOptions.wasi) {
-    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",
-        ))
-    ) {
-        console.log(
-          chalk.bold.bgMagentaBright(" WARN ") +
-            chalk.dim(": @assemblyscript/wasi-shim") +
-            " is not included in project dependencies!",
-        );
+    const CONFIG_PATH = path.join(process.cwd(), "./as-test.config.json");
+    let config;
+    if (!existsSync(CONFIG_PATH)) {
+        console.log(chalk.bgMagentaBright(" WARN ") +
+            chalk.dim(":") +
+            " Could not locate config file in the current directory! Continuing with default config." +
+            "\n");
+        config = new Config();
     }
-  }
-  let packageManagerCommand = "npx";
-  if (
-    process.env.npm_config_user_agent &&
-    process.env.npm_config_user_agent.includes("pnpm")
-  ) {
-    packageManagerCommand = "pnpx";
-  } else if (
-    process.env.npm_config_user_agent &&
-    process.env.npm_config_user_agent.includes("yarn")
-  ) {
-    packageManagerCommand = "yarn run";
-  } else if (
-    process.env.npm_config_user_agent &&
-    process.env.npm_config_user_agent.includes("bun")
-  ) {
-    packageManagerCommand = "bunx";
-  }
-  console.log("");
-  const inputFiles = await glob(config.input);
-  for (const file of inputFiles) {
-    console.log(chalk.dim("Including " + file));
-    let command = `${packageManagerCommand} asc ${file}${args.length ? " " + args.join(" ") : ""}`;
-    if (config.buildOptions.wasi) {
-      command +=
-        " --config ./node_modules/@assemblyscript/wasi-shim/asconfig.json";
+    else {
+        config = Object.assign(new Config(), JSON.parse(readFileSync(CONFIG_PATH).toString()));
+        console.log(chalk.dim("Loading config from: " + CONFIG_PATH) + "\n");
+    }
+    const ASCONFIG_PATH = path.join(process.cwd(), config.config);
+    if (!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". Continuing with default config.' +
+            "\n");
     }
-    if (config.config !== "none") {
-      command += " --config " + config.config;
+    const pkg = JSON.parse(readFileSync("./package.json").toString());
+    let buildCommands = [];
+    if (config.buildOptions.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 outFile =
-      config.outDir +
-      "/" +
-      file.slice(file.lastIndexOf("/") + 1).replace(".ts", ".wasm");
-    if (config.outDir) {
-      command += " -o " + outFile;
+    let packageManagerCommand = "npx";
+    if (process.env.npm_config_user_agent &&
+        process.env.npm_config_user_agent.includes("pnpm")) {
+        packageManagerCommand = "pnpx";
     }
-    if (config.coverage.enabled) {
-      console.log(chalk.dim("Enabling coverage"));
-      command += " --use COVERAGE_USE=1 --transform as-test/transform";
-      if (config.coverage.show) command += " --use COVERAGE_SHOW=1";
+    else if (process.env.npm_config_user_agent &&
+        process.env.npm_config_user_agent.includes("yarn")) {
+        packageManagerCommand = "yarn run";
     }
-    if (config.buildOptions.args) {
-      command += " " + config.buildOptions.args.join(" ");
+    else if (process.env.npm_config_user_agent &&
+        process.env.npm_config_user_agent.includes("bun")) {
+        packageManagerCommand = "bunx";
     }
-    buildCommands.push(command);
-  }
-  const build = (command) => {
-    return new Promise((resolve, _) => {
-      console.log(chalk.dim("Building: " + command));
-      exec(command, (err, stdout, stderr) => {
-        if (config.buildOptions.verbose) {
-          process.stdout.write(stdout);
+    console.log("");
+    const inputFiles = await glob(config.input);
+    for (const file of inputFiles) {
+        console.log(chalk.dim("Including " + file));
+        let command = `${packageManagerCommand} asc ${file}${args.length ? " " + args.join(" ") : ""}`;
+        if (config.buildOptions.wasi) {
+            command +=
+                " --config ./node_modules/@assemblyscript/wasi-shim/asconfig.json";
         }
-        if (err) {
-          process.stderr.write(stderr + "\n");
-          process.exit(1);
+        if (config.config !== "none") {
+            command += " --config " + config.config;
+        }
+        const outFile = config.outDir +
+            "/" +
+            file.slice(file.lastIndexOf("/") + 1).replace(".ts", ".wasm");
+        if (config.outDir) {
+            command += " -o " + outFile;
+        }
+        if (config.coverage.enabled) {
+            console.log(chalk.dim("Enabling coverage"));
+            command += " --use COVERAGE_USE=1 --transform as-test/transform";
+            if (config.coverage.show)
+                command += " --use COVERAGE_SHOW=1";
+        }
+        if (config.buildOptions.args) {
+            command += " " + config.buildOptions.args.join(" ");
+        }
+        buildCommands.push(command);
+    }
+    const build = (command) => {
+        return new Promise((resolve, _) => {
+            console.log(chalk.dim("Building: " + command));
+            exec(command, (err, stdout, stderr) => {
+                if (config.buildOptions.verbose) {
+                    process.stdout.write(stdout);
+                }
+                if (err) {
+                    process.stderr.write(stderr + "\n");
+                    process.exit(1);
+                }
+                resolve();
+            });
+        });
+    };
+    if (config.buildOptions.parallel) {
+        console.log(chalk.dim("Building sources in parallel..."));
+        const start = performance.now();
+        let builders = [];
+        for (const command of buildCommands) {
+            builders.push(build(command));
         }
-        resolve();
-      });
-    });
-  };
-  if (config.buildOptions.parallel) {
-    console.log(chalk.dim("Building sources in parallel..."));
-    const start = performance.now();
-    let builders = [];
-    for (const command of buildCommands) {
-      builders.push(build(command));
+        await Promise.all(builders);
+        console.log(chalk.dim("Compiled in " + formatTime(performance.now() - start)) + "\n");
     }
-    await Promise.all(builders);
-    console.log(
-      chalk.dim("Compiled in " + formatTime(performance.now() - start)) + "\n",
-    );
-  }
 }

package/bin/index.js

@@ -7,14 +7,16 @@ const _args = process.argv.slice(2);
 const flags = [];
 const args = [];
 const COMMANDS = ["run", "build", "test", "init"];
-const version = "0.1.7";
+const version = "0.1.8";
 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("--tap")) {
-    console.log(`TAP version 13
+    if (flags.includes("--tap")) {
+        console.log(`TAP version 13
 # timing test
 ok 1 should be strictly equal
 not ok 2 should be strictly equal
@@ -28,161 +30,130 @@ not ok 2 should be strictly equal
 # tests 2
 # pass  1
 # fail  1`);
-  } else if (flags.includes("--version") || flags.includes("-v")) {
-    console.log("as-test" + " " + version.toString());
-  } else {
-    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]") +
+    }
+    else if (flags.includes("--version") || flags.includes("-v")) {
+        console.log("as-test" + " " + version.toString());
+    }
+    else {
+        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"));
+    }
+}
+else if (COMMANDS.includes(args[0])) {
+    const command = args.shift();
+    if (command === "build") {
+        build(args);
+    }
+    else if (command === "run") {
+        run();
+    }
+    else if (command === "test") {
+        build(args).then(() => {
+            run();
+        });
+    }
+    else if (command === "init") {
+        init(args);
+    }
+}
+else {
+    console.log(chalk.bgRed(" ERROR ") +
+        chalk.dim(":") +
         " " +
-        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"),
-    );
-  }
-} else if (COMMANDS.includes(args[0])) {
-  const command = args.shift();
-  if (command === "build") {
-    build(args);
-  } else if (command === "run") {
-    run();
-  } else if (command === "test") {
-    build(args).then(() => {
-      run();
-    });
-  } else if (command === "init") {
-    init(args);
-  }
-} else {
-  console.log(
-    chalk.bgRed(" ERROR ") +
-      chalk.dim(":") +
-      " " +
-      chalk.bold("Unknown command: ") +
-      args[0],
-  );
+        chalk.bold("Unknown command: ") +
+        args[0]);
 }