as-test 0.4.4 → 0.5.1

package/assembly/index.ts

@@ -1,11 +1,16 @@
-import { rainbow } from "as-rainbow";
 import { Suite } from "./src/suite";
 import { Expectation } from "./src/expectation";
 import { stringify } from "as-console/stringify";
-import { __COVER, __HASHES, __POINTS } from "as-test/assembly/coverage";
+import {
+  __COVER,
+  __POINTS,
+  __UNCOVERED,
+  __ALL_POINTS,
+  CoverPoint,
+} from "as-test/assembly/coverage";
 import { JSON } from "json-as";
-import { term } from "./util/term";
 import { Log } from "./src/log";
+import { sendFileEnd, sendFileStart, sendReport } from "./util/wipc";
 
 let entrySuites: Suite[] = [];
 
@@ -46,21 +51,7 @@ let __test_options!: RunOptions;
  * ```
  */
 export function describe(description: string, callback: () => void): void {
-  const suite = new Suite(description, callback, "describe");
-
-  if (depth >= 0) {
-    const _suite = suites[depth];
-    if (_suite.depth == depth) {
-      _suite.addSuite(suite);
-    } else {
-      suite.depth = ++depth;
-      suites.push(suite);
-    }
-  } else {
-    suite.file = FILE;
-    entrySuites.push(suite);
-    suites.push(suite);
-  }
+  registerSuite(description, callback, "describe");
 }
 
 /**
@@ -78,21 +69,7 @@ export function describe(description: string, callback: () => void): void {
  * ```
  */
 export function test(description: string, callback: () => void): void {
-  const suite = new Suite(description, callback, "test");
-
-  if (depth >= 0) {
-    const _suite = suites[depth];
-    if (_suite.depth == depth) {
-      _suite.addSuite(suite);
-    } else {
-      suite.depth = ++depth;
-      suites.push(suite);
-    }
-  } else {
-    suite.file = FILE;
-    entrySuites.push(suite);
-    suites.push(suite);
-  }
+  registerSuite(description, callback, "test");
 }
 
 /**
@@ -110,21 +87,28 @@ export function test(description: string, callback: () => void): void {
  * ```
  */
 export function it(description: string, callback: () => void): void {
-  const suite = new Suite(description, callback, "it");
+  registerSuite(description, callback, "it");
+}
 
-  if (depth >= 0) {
-    const _suite = suites[depth];
-    if (_suite.depth == depth) {
-      _suite.addSuite(suite);
-    } else {
-      suite.depth = ++depth;
-      suites.push(suite);
-    }
-  } else {
-    suite.file = FILE;
-    entrySuites.push(suite);
-    suites.push(suite);
-  }
+/**
+ * Creates a skipped test group.
+ */
+export function xdescribe(description: string, callback: () => void): void {
+  registerSuite(description, callback, "xdescribe");
+}
+
+/**
+ * Creates a skipped test case.
+ */
+export function xtest(description: string, callback: () => void): void {
+  registerSuite(description, callback, "xtest");
+}
+
+/**
+ * Creates a skipped test case alias.
+ */
+export function xit(description: string, callback: () => void): void {
+  registerSuite(description, callback, "xit");
 }
 
 /**
@@ -145,8 +129,12 @@ export function it(description: string, callback: () => void): void {
  * });
  * ```
  */
-export function expect<T>(value: T): Expectation<T> {
-  const test = new Expectation<T>(value);
+export function expect<T>(
+  value: T,
+  message: string = "",
+  location: string = "",
+): Expectation<T> {
+  const test = new Expectation<T>(value, message, snapshotKey(), location);
 
   if (current_suite) {
     current_suite!.addExpectation(test);
@@ -155,6 +143,17 @@ export function expect<T>(value: T): Expectation<T> {
   return test;
 }
 
+/**
+ * Creates a skipped expectation.
+ */
+export function xexpect<T>(
+  value: T,
+  message: string = "",
+  location: string = "",
+): Expectation<T> {
+  return expect<T>(value, message, location).skip();
+}
+
 /**
  * Formats and prints content to the terminal
  * Can be disabled like so:
@@ -168,17 +167,26 @@ export function expect<T>(value: T): Expectation<T> {
  * @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]);
-      if (current_suite) {
-        current_suite!.addLog(new Log(line));
-      }
+  if (!__as_test_log_is_enabled()) return;
+  __as_test_log_serialized(__as_test_log_default<T>(data));
+}
+
+export function __as_test_log_default<T>(data: T): string {
+  return stringify(data);
+}
+
+export function __as_test_log_is_enabled(): bool {
+  return __test_options.log;
+}
+
+export function __as_test_log_serialized(formatted: string): void {
+  if (!formatted) return;
+  const lines = formatted.split("\n");
+  for (let i = 0; i < lines.length; i++) {
+    const line = unchecked(lines[i]);
+    if (current_suite) {
+      current_suite!.addLog(new Log(line));
     }
-    term.write("\n");
   }
 }
 
@@ -263,15 +271,10 @@ class RunOptions {
  * ```
  */
 export function run(options: RunOptions = new RunOptions()): void {
-  // const buf = new ArrayBuffer(20);
-  // const bytes = process.stdin.read(buf);
-  // const stdinLn = term.write(String.UTF8.decodeUnsafe(changetype<usize>(buf), bytes) + "\n");
   __test_options = options;
   const time = new Time();
-  const fileLn = term.write(
-    `${rainbow.bgCyanBright(" FILE ")} ${rainbow.dimMk(FILE)}\n`,
-  );
-  term.write("\n");
+  let fileVerdict = "none";
+  sendFileStart(FILE);
   time.start = performance.now();
   for (let i = 0; i < entrySuites.length; i++) {
     // @ts-ignore
@@ -283,33 +286,117 @@ export function run(options: RunOptions = new RunOptions()): void {
     current_suite = null;
 
     suite.run();
+    if (suite.verdict == "fail") {
+      fileVerdict = "fail";
+    } else if (fileVerdict != "fail" && suite.verdict == "ok") {
+      fileVerdict = "ok";
+    } else if (fileVerdict == "none" && suite.verdict == "skip") {
+      fileVerdict = "skip";
+    }
 
     suites = [];
     depth = -1;
     current_suite = null;
   }
   time.end = performance.now();
-  fileLn.edit(
-    `${rainbow.bgCyanBright(" FILE ")} ${rainbow.dimMk(FILE)} ${rainbow.dimMk(time.format())}`,
-  );
-  const reportText = JSON.stringify(entrySuites);
-  const chunk_size = 48;
-  let chunks = reportText.length / chunk_size;
-  let index = 0;
-  term.write("\x1B[8m\n").clear(); // Hide text (so that the cursor doesn't flash for a moment)
-  while (chunks--) {
-    term
-      .write(
-        "READ_LINE" +
-          reportText.slice(index, (index += chunk_size)) +
-          "END_LINE\n",
-      )
-      .clear(); // Write a line and then clear it, making it invisible
+  sendFileEnd(FILE, fileVerdict, time.format());
+  const report = new FileReport();
+  report.suites = entrySuites;
+  report.coverage = collectCoverage();
+  sendReport(JSON.stringify(report));
+}
+
+function registerSuite(
+  description: string,
+  callback: () => void,
+  kind: string,
+): void {
+  const suite = new Suite(description, callback, kind);
+  if (depth >= 0) {
+    const _suite = suites[depth];
+    if (_suite.depth == depth) {
+      _suite.addSuite(suite);
+      return;
+    }
+    suite.depth = ++depth;
+    suites.push(suite);
+    return;
   }
-  if (index < reportText.length) {
-    term.write("READ_LINE" + reportText.slice(index) + "END_LINE\n").clear();
+
+  suite.file = FILE;
+  entrySuites.push(suite);
+  suites.push(suite);
+}
+
+
+@json
+class CoverageReport {
+  total: i32 = 0;
+  covered: i32 = 0;
+  uncovered: i32 = 0;
+  percent: f64 = 100.0;
+  points: CoveragePointReport[] = [];
+}
+
+
+@json
+class CoveragePointReport {
+  hash: string = "";
+  file: string = "";
+  line: i32 = 0;
+  column: i32 = 0;
+  type: string = "";
+  executed: bool = false;
+}
+
+
+@json
+class FileReport {
+  suites: Suite[] = [];
+  coverage: CoverageReport = new CoverageReport();
+}
+
+function collectCoverage(): CoverageReport {
+  const out = new CoverageReport();
+  out.total = __POINTS();
+  out.uncovered = __UNCOVERED();
+  out.covered = out.total - out.uncovered;
+  if (out.total <= 0) {
+    out.percent = 100.0;
+  } else {
+    out.percent = (<f64>out.covered * 100.0) / <f64>out.total;
+  }
+
+  const points = __ALL_POINTS();
+  for (let i = 0; i < points.length; i++) {
+    const point = unchecked(points[i]);
+    out.points.push(toCoveragePointReport(point));
+  }
+  return out;
+}
+
+function toCoveragePointReport(point: CoverPoint): CoveragePointReport {
+  const out = new CoveragePointReport();
+  out.hash = point.hash;
+  out.file = point.file;
+  out.line = point.line;
+  out.column = point.column;
+  out.type = point.type;
+  out.executed = point.executed;
+  return out;
+}
+
+function snapshotKey(): string {
+  if (!current_suite) return FILE + "::global::0";
+  const suite = current_suite!;
+  const parts = new Array<string>();
+  let cursor: Suite | null = suite;
+  while (cursor) {
+    parts.unshift(cursor.description);
+    cursor = cursor.parent;
   }
-  term.write("\x1B[0m\n").clear(); // Un-hide text
+  const path = parts.join(" > ");
+  return FILE + "::" + path + "::" + suite.tests.length.toString();
 }
 
 export class Result {