as-test 0.1.3 → 0.1.5

package/assembly/index.ts

@@ -2,17 +2,17 @@ import { rainbow } from "as-rainbow";
 import { TestGroup } from "./src/group";
 import { Expectation } from "./src/expectation";
 import { formatTime } from "./util";
-import { stringify } from "as-console/assembly";
-import { CoverPoint, __COVER, __HASHES, __POINTS } from "as-test/assembly/coverage";
+import { stringify } from "as-console/stringify";
+import { __COVER, __HASHES, __POINTS } from "as-test/assembly/coverage";
 import { createTable } from "table-as";
 
 /**
  * Enumeration representing the verdict of a test case.
  */
 export enum Verdict {
-    Unreachable,
-    Ok,
-    Fail
+  Unreachable,
+  Ok,
+  Fail,
 }
 
 // Globals
@@ -28,10 +28,10 @@ let __test_options!: RunOptions;
 
 /**
  * Creates a test group containing multiple test cases.
- * 
+ *
  * @param {string} description - The name of the test group
  * @param {() => void} callback - The block containing the test cases for this group
- * 
+ *
  * @example
  * ```ts
  * describe("my test suite", () => {
@@ -41,20 +41,20 @@ let __test_options!: RunOptions;
  * ```
  */
 export function describe(description: string, callback: () => void): void {
-    const group = new TestGroup(description, callback);
+  const group = new TestGroup(description, callback);
 
-    current_group = group;
-    groups.push(group);
+  current_group = group;
+  groups.push(group);
 }
 
 /**
  * Creates a test group containing multiple test cases
- * 
+ *
  * @param {string} description - The name of the test group
  * @param {() => void} callback - The block containing the test cases for this group
- * 
+ *
  * @example
- * 
+ *
  * ```ts
  * test("1 + 3 = 4", () => {
  *  expect(1 + 3).toBe(4);
@@ -62,20 +62,20 @@ export function describe(description: string, callback: () => void): void {
  * ```
  */
 export function test(description: string, callback: () => void): void {
-    const group = new TestGroup(description, callback);
+  const group = new TestGroup(description, callback);
 
-    current_group = group;
-    groups.push(group);
+  current_group = group;
+  groups.push(group);
 }
 
 /**
  * Creates a test group containing multiple test cases
- * 
+ *
  * @param {string} description - The name of the test group
  * @param {() => void} callback - The block containing the test cases for this group
- * 
+ *
  * @example
- * 
+ *
  * ```ts
  * it("should perform additions", () => {
  *  expect(1 + 3).toBe(4);
@@ -83,22 +83,22 @@ export function test(description: string, callback: () => void): void {
  * ```
  */
 export function it(description: string, callback: () => void): void {
-    const group = new TestGroup(description, callback);
+  const group = new TestGroup(description, callback);
 
-    current_group = group;
-    groups.push(group);
+  current_group = group;
+  groups.push(group);
 }
 
 /**
  * Creates an expectation object for making assertions within a test case.
- * 
- * Use this function to chain assertions about a specific value. 
- * The returned expectation object provides various methods for testing 
+ *
+ * Use this function to chain assertions about a specific value.
+ * The returned expectation object provides various methods for testing
  * different properties and conditions of the value.
- * 
+ *
  * @param {T} value - The value to be asserted against.
  * @returns {Expectation<T>} - The expectation object for chaining assertions.
- * 
+ *
  * @example
  * ```ts
  * test("number comparison", () => {
@@ -108,94 +108,93 @@ export function it(description: string, callback: () => void): void {
  * ```
  */
 export function expect<T>(value: T): Expectation<T> {
-    const result = new Expectation<T>(value);
-    current_group!.addExpectation(result);
+  const result = new Expectation<T>(value);
+  current_group!.addExpectation(result);
 
-    return result;
+  return result;
 }
 
 /**
  * Formats and prints content to the terminal
  * Can be disabled like so:
- * 
+ *
  * ```js
  * // ...
- * 
+ *
  * run({ log: false });
  * ```
- * 
+ *
  * @param {T} data - The data to format and print
  */
 export function log<T>(data: T): void {
-    if (!__test_options.log) return;
-    const formatted = stringify(data);
-    if (formatted) {
-        const lines = formatted.split("\n");
-        for (let i = 0; i < lines.length; i++) {
-            const line = unchecked(lines[i]);
-            console.log("  " + rainbow.bgYellow(" LOG ") + " " + line);
-        }
-        console.log("");
+  if (!__test_options.log) return;
+  const formatted = stringify(data);
+  if (formatted) {
+    const lines = formatted.split("\n");
+    for (let i = 0; i < lines.length; i++) {
+      const line = unchecked(lines[i]);
+      console.log("  " + rainbow.bgYellow(" LOG ") + " " + line);
     }
+    console.log("");
+  }
 }
 
 /**
  * Registers a callback function to be executed before each test group is run.
- * 
+ *
  * @param {() => void} callback - The function to be executed before each test group.
  */
 export function beforeAll(callback: () => void): void {
-    before_all_callback = callback;
+  before_all_callback = callback;
 }
 
 /**
  * Registers a callback function to be executed after each test group is run.
- * 
+ *
  * @param {() => void} callback - The function to be executed after each test group.
  */
 export function afterAll(callback: () => void): void {
-    after_all_callback = callback;
+  after_all_callback = callback;
 }
 
 /**
  * Registers a callback function to be executed before each test case is run.
- * 
+ *
  * @param {() => void} callback - The function to be executed before each test case.
  */
 export function beforeEach(callback: () => void): void {
-    before_each_callback = callback;
+  before_each_callback = callback;
 }
 
 /**
  * Registers a callback function to be executed after each test case is run.
- * 
+ *
  * @param {() => void} callback - The function to be executed after each test case.
  */
 export function afterEach(callback: () => void): void {
-    after_each_callback = callback;
+  after_each_callback = callback;
 }
 
 /**
  * Class defining options that can be passed to the `run` function.
- * 
+ *
  * Currently, it offers a single option:
- * 
+ *
  * - `log` (boolean, default: true): Controls whether enable the log() function
  **/
 class RunOptions {
-    log: boolean = true;
-    coverage: boolean = false;
+  log: boolean = true;
 }
 
 /**
  * Runs all the test suites defined within the current test scope.
- * 
+ *
  * This function executes all the test cases you've defined in your test suites.
  * It iterates through each suite, runs the tests within the suite, and tracks results.
  * Finally, it prints a colorful summary of the test execution.
- * 
+ *
  * @param {RunOptions} [options] - Optional options for running tests.
- * 
+ *
  * @example
  * ```javascript
  * describe("Math operations", () => {
@@ -204,95 +203,158 @@ class RunOptions {
  *   });
  *   // ... other tests
  * });
- * 
+ *
  * run(); // Executes all tests in the "Math operations" suite
  * ```
  */
 export function run(options: RunOptions = new RunOptions()): void {
-    __test_options = options;
-    console.log(rainbow.boldMk(rainbow.blueBright(` _____  _____      _____  _____  _____  _____ `)));
-    console.log(rainbow.boldMk(rainbow.blueBright(`|  _  ||   __| ___|_   _||   __||   __||_   _|`)));
-    console.log(rainbow.boldMk(rainbow.blueBright(`|     ||__   ||___| | |  |   __||__   |  | |  `)));
-    console.log(rainbow.boldMk(rainbow.blueBright(`|__|__||_____|      |_|  |_____||_____|  |_|  `)));
-    console.log(rainbow.dimMk("\n------------------- v0.1.3 -------------------\n"));
-    if (options.coverage) {
-        console.log(rainbow.bgBlueBright(" PLUGIN ") + " " + rainbow.dimMk("Using Code Coverage") + "\n");
+  __test_options = options;
+  console.log(
+    rainbow.boldMk(
+      rainbow.blueBright(` _____  _____      _____  _____  _____  _____ `),
+    ),
+  );
+  console.log(
+    rainbow.boldMk(
+      rainbow.blueBright(`|  _  ||   __| ___|_   _||   __||   __||_   _|`),
+    ),
+  );
+  console.log(
+    rainbow.boldMk(
+      rainbow.blueBright(`|     ||__   ||___| | |  |   __||__   |  | |  `),
+    ),
+  );
+  console.log(
+    rainbow.boldMk(
+      rainbow.blueBright(`|__|__||_____|      |_|  |_____||_____|  |_|  `),
+    ),
+  );
+  console.log(
+    rainbow.dimMk("\n------------------- v0.1.5 -------------------\n"),
+  );
+  // @ts-ignore
+  if (isDefined(COVERAGE_USE)) {
+    console.log(
+      rainbow.bgBlueBright(" PLUGIN ") +
+        " " +
+        rainbow.dimMk("Using Code Coverage") +
+        "\n",
+    );
+  }
+  const suites = groups.length;
+  let failed = 0;
+  let tests = 0;
+  let failed_tests = 0;
+  let failed_suite_logs = "";
+  const start = performance.now();
+  for (let i = 0; i < groups.length; i++) {
+    if (before_all_callback) before_all_callback();
+    const suite = unchecked(groups[i]);
+    suite.run();
+    for (let i = 0; i < suite.results.length; i++) {
+      const expectation = unchecked(suite.results[i]);
+      const verdict = expectation.verdict;
+      tests++;
+      if (verdict == Verdict.Ok) {
+        suite.passed++;
+      } else if (verdict == Verdict.Fail) {
+        suite.verdict = Verdict.Fail;
+        suite.failed++;
+        failed_tests++;
+      }
     }
-    const suites = groups.length;
-    let failed = 0;
-    let tests = 0;
-    let failed_tests = 0;
-    let failed_suite_logs = "";
-    const start = performance.now();
-    for (let i = 0; i < groups.length; i++) {
-        if (before_all_callback) before_all_callback();
-        const suite = unchecked(groups[i]);
-        suite.run();
-        for (let i = 0; i < suite.results.length; i++) {
-            const expectation = unchecked(suite.results[i]);
-            const verdict = expectation.verdict;
-            tests++;
-            if (verdict == Verdict.Ok) {
-                suite.passed++;
-            } else if (verdict == Verdict.Fail) {
-                suite.verdict = Verdict.Fail;
-                suite.failed++;
-                failed_tests++;
-            }
-        }
-        if (suite.verdict == Verdict.Unreachable) {
-            suite.verdict = Verdict.Ok;
-            console.log(rainbow.bgGreenBright(" PASS ") + " " + rainbow.dimMk(suite.description) + "\n");
-        } else {
-            failed++;
-            const txt = rainbow.bgRed(" FAIL ") + " " + rainbow.dimMk(suite.description) + "\n";
-            failed_suite_logs += txt
-            console.log(txt);
-        }
-
-        const report = suite.getLogs();
-        if (report) {
-            if (report.passed) console.log(report.passed!);
-            if (report.failed) failed_suite_logs += report.failed!;
-
-        }
-        if (after_all_callback) after_all_callback();
+    if (suite.verdict == Verdict.Unreachable) {
+      suite.verdict = Verdict.Ok;
+      console.log(
+        rainbow.bgGreenBright(" PASS ") +
+          " " +
+          rainbow.dimMk(suite.description) +
+          "\n",
+      );
+    } else {
+      failed++;
+      const txt =
+        rainbow.bgRed(" FAIL ") + " " + rainbow.dimMk(suite.description) + "\n";
+      failed_suite_logs += txt;
+      console.log(txt);
     }
 
-    if (failed) {
-        console.log(rainbow.red("------------------ [FAILED] ------------------\n"));
-        console.log(failed_suite_logs);
+    const report = suite.getLogs();
+    if (report) {
+      if (report.passed) console.log(report.passed!);
+      if (report.failed) failed_suite_logs += report.failed!;
     }
+    if (after_all_callback) after_all_callback();
+  }
 
+  if (failed) {
+    console.log(
+      rainbow.red("------------------ [FAILED] ------------------\n"),
+    );
+    console.log(failed_suite_logs);
+  }
 
-    if (options.coverage && __HASHES().size) {
-        console.log(rainbow.dimMk("----------------- [COVERAGE] -----------------\n"));
-        const points = __HASHES().values();
+  // @ts-ignore
+  if (isDefined(COVERAGE_USE) && isDefined(COVERAGE_SHOW) && __HASHES().size) {
+    console.log(
+      rainbow.dimMk("----------------- [COVERAGE] -----------------\n"),
+    );
+    const points = __HASHES().values();
 
-        const table: string[][] = [
-            ["Location", "Type", "Hash"]
-        ];
+    const table: string[][] = [["Location", "Type", "Hash"]];
 
-        for (let i = 0; i < points.length; i++) {
-            const point = unchecked(points[i]);
-            const file = point.file;
-            const reference = point.file + ":" + point.line.toString() + ":" + point.column.toString();
-            const type = point.type;
-            const hash = point.hash;
-            table.push([rainbow.underlineMk(reference), type, "#" + hash]);
-        }
-        console.log(rainbow.dimMk(createTable(table)) + "\n");
+    for (let i = 0; i < points.length; i++) {
+      const point = unchecked(points[i]);
+      const file = point.file;
+      const reference =
+        point.file +
+        ":" +
+        point.line.toString() +
+        ":" +
+        point.column.toString();
+      const type = point.type;
+      const hash = point.hash;
+      table.push([rainbow.underlineMk(reference), type, "#" + hash]);
     }
+    console.log(rainbow.dimMk(createTable(table)) + "\n");
+  }
 
-    console.log(rainbow.dimMk("----------------- [RESULTS] ------------------\n"));
-    const ms = performance.now() - start;
-    console.log(rainbow.boldMk("Test Suites: ") + (failed ? rainbow.boldMk(rainbow.red(failed.toString() + " failed")) : rainbow.boldMk(rainbow.green("0 failed"))) + ", " + suites.toString() + " total");
-    console.log(rainbow.boldMk("Tests:       ") + (failed_tests ? rainbow.boldMk(rainbow.red(failed_tests.toString() + " failed")) : rainbow.boldMk(rainbow.green("0 failed"))) + ", " + tests.toString() + " total");
-    if (options.coverage) console.log(rainbow.boldMk("Coverage:    ") + (__HASHES().size ? rainbow.boldMk(rainbow.red(__HASHES().size.toString() + " failed")) : rainbow.boldMk(rainbow.green("0 failed"))) + ", " + __POINTS().toString() + " total");
-    console.log(rainbow.boldMk("Snapshots:   ") + "0 total");
-    console.log(rainbow.boldMk("Time:        ") + formatTime(ms));
-    __COVER("joe mom")
-    if (failed) {
-        process.exit(1);
-    }
-}
+  console.log(
+    rainbow.dimMk("----------------- [RESULTS] ------------------\n"),
+  );
+  const ms = performance.now() - start;
+  console.log(
+    rainbow.boldMk("Test Suites: ") +
+      (failed
+        ? rainbow.boldMk(rainbow.red(failed.toString() + " failed"))
+        : rainbow.boldMk(rainbow.green("0 failed"))) +
+      ", " +
+      suites.toString() +
+      " total",
+  );
+  console.log(
+    rainbow.boldMk("Tests:       ") +
+      (failed_tests
+        ? rainbow.boldMk(rainbow.red(failed_tests.toString() + " failed"))
+        : rainbow.boldMk(rainbow.green("0 failed"))) +
+      ", " +
+      tests.toString() +
+      " total",
+  );
+  // @ts-ignore
+  if (isDefined(COVERAGE_USE))
+    console.log(
+      rainbow.boldMk("Coverage:    ") +
+        (__HASHES().size
+          ? rainbow.boldMk(rainbow.red(__HASHES().size.toString() + " failed"))
+          : rainbow.boldMk(rainbow.green("0 failed"))) +
+        ", " +
+        __POINTS().toString() +
+        " total",
+    );
+  console.log(rainbow.boldMk("Snapshots:   ") + "0 total");
+  console.log(rainbow.boldMk("Time:        ") + formatTime(ms));
+  if (failed) {
+    process.exit(1);
+  }
+}

package/assembly/reporters/tap.ts

@@ -0,0 +1,30 @@
+import { Verdict } from "..";
+import { TestGroup } from "../src/group";
+
+export class TapReporter {
+  public groups: TestGroup[];
+  constructor(groups: TestGroup[]) {
+    this.groups = groups;
+  }
+  report(): string {
+    let out = "TAP version 14\n";
+    let totalTests: i32 = this.groups.length;
+
+    out += "1.." + totalTests.toString();
+    for (let i = 0; i < this.groups.length; i++) {
+      const group = unchecked(this.groups[i]);
+      if (group.verdict === Verdict.Ok) {
+        out += `\nok ${i} - ${group.description}`;
+      } else if (group.verdict === Verdict.Fail) {
+        out += `\nnot ok ${i} - ${group.description}`;
+        out += "  ---";
+        out += `  message: '${group.description}'`;
+        out += `  severity: fail`;
+        for (let ii = 0; ii < group.results.length; ii++) {
+          const res = unchecked(group.results[ii]);
+          if (res.verdict === Verdict.Ok) continue;
+        }
+      }
+    }
+  }
+}