as-test 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -7,4 +7,7 @@ v0.0.5 - Switch errors to be thrown at compile time instead of runtime
 v0.0.6 - Failed tests should be pushed to bottom of logs
 v0.0.8 - Fix readme typo in v0.0.7
 v0.0.9 - Fix type issue
-v0.1.0 - Fix more type issues
+
+v0.1.0 - Fix more type issues
+v0.1.1 - Add code coverage!
+v0.1.2 - Fix bugs with globals and dependencies

package/README.md

@@ -3,7 +3,7 @@
 |  _  ||   __| ___|_   _||   __||   __||_   _|
 |     ||__   ||___| | |  |   __||__   |  | |  
 |__|__||_____|      |_|  |_____||_____|  |_|  
-v0.1.0
+v0.1.1
 </pre>
 </h5>
 
@@ -13,6 +13,25 @@ v0.1.0
 npm install as-test
 ```
 
+Add the transform to your `asc` command (e.g. in package.json)
+
+```bash
+--transform as-test/transform
+```
+
+Alternatively, add it to your `asconfig.json`
+
+```
+{
+  // ...
+  "options": {
+    "transform": ["as-test/transform"]
+  }
+}
+```
+
+Note: The transform *is* OPTIONAL, though it is required to enable code coverage.
+
 ## Usage
 
 ```js
@@ -82,7 +101,8 @@ describe("Array manipulation", () => {
 });
 
 run({
-  log: false
+  log: false,
+  coverage: true
 });
 ```
 
@@ -112,6 +132,7 @@ run({
 
 Test Suites: 0 failed, 2 total
 Tests:       0 failed, 8 total
+Coverage:    0 failed, 23 total
 Snapshots:   0 total
 Time:        101.812μs
 </pre>
@@ -147,6 +168,7 @@ To add `as-test` to your CI/CD workflow, check out [The provided example](https:
 
 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!

package/asconfig.json

@@ -0,0 +1,36 @@
+{
+    "targets": {
+      "test": {
+        "outFile": "build/test.spec.wasm",
+        "sourceMap": false,
+        "optimizeLevel": 0,
+        "shrinkLevel": 0,
+        "converge": false,
+        "noAssert": false
+      },
+      "debug": {
+        "outFile": "build/test.wasm",
+        "sourceMap": false,
+        "optimizeLevel": 0,
+        "shrinkLevel": 0,
+        "converge": false,
+        "noAssert": false
+      },
+      "bench": {
+        "outFile": "build/bench.wasm",
+        "sourceMap": false,
+        "optimizeLevel": 3,
+        "shrinkLevel": 0,
+        "converge": true,
+        "noAssert": false
+      }
+    },
+    "options": {
+      "transform": ["./transform"],
+      "disableWarning": [
+        226
+      ]
+    },
+    "extends": "./node_modules/@assemblyscript/wasi-shim/asconfig.json"
+  }
+  

package/assembly/coverage.ts

@@ -0,0 +1,31 @@
+export class CoverPoint {
+    public file: string = "";
+    public hash: string = "";
+    public line: i32 = 0;
+    public column: i32 = 0;
+    public type!: string;
+    public executed: boolean = false;
+}
+
+export class Coverage {
+    public hashes: Map<string, CoverPoint> = new Map<string, CoverPoint>();
+    public points: i32 = 0;
+    static SN: Coverage = new Coverage();
+}
+
+export function __REGISTER(point: CoverPoint): void {
+    Coverage.SN.points++;
+    Coverage.SN.hashes.set(point.hash, point);
+}
+
+export function __COVER(hash: string): void {
+    if (Coverage.SN.hashes.has(hash)) Coverage.SN.hashes.delete(hash);
+}
+
+export function __HASHES(): Map<string, CoverPoint> {
+    return Coverage.SN.hashes;
+}
+
+export function __POINTS(): i32 {
+    return Coverage.SN.points;
+}

package/assembly/index.ts

@@ -3,6 +3,7 @@ import { TestGroup } from "./src/group";
 import { Expectation } from "./src/expectation";
 import { formatTime } from "./util";
 import { stringify } from "as-console/assembly";
+import { __COVER, __HASHES, __POINTS } from "as-test/assembly/coverage";
 
 /**
  * Enumeration representing the verdict of a test case.
@@ -20,12 +21,9 @@ let groups: TestGroup[] = [];
 let before_all_callback: (() => void) | null = null;
 let after_all_callback: (() => void) | null = null;
 
-// @ts-ignore
-@global let before_each_callback: (() => void) | null = null;
-// @ts-ignore
-@global let after_each_callback: (() => void) | null = null;
-// @ts-ignore
-@global let __test_options!: RunOptions;
+export let before_each_callback: (() => void) | null = null;
+export let after_each_callback: (() => void) | null = null;
+let __test_options!: RunOptions;
 
 /**
  * Creates a test group containing multiple test cases.
@@ -184,7 +182,8 @@ export function afterEach(callback: () => void): void {
  * - `log` (boolean, default: true): Controls whether enable the log() function
  **/
 class RunOptions {
-    log: boolean = true
+    log: boolean = true;
+    coverage: boolean = false;
 }
 
 /**
@@ -210,11 +209,14 @@ class RunOptions {
  */
 export function run(options: RunOptions = new RunOptions()): void {
     __test_options = options;
-    console.log(rainbow.boldMk(rainbow.green(` _____  _____      _____  _____  _____  _____ `)));
-    console.log(rainbow.boldMk(rainbow.green(`|  _  ||   __| ___|_   _||   __||   __||_   _|`)));
-    console.log(rainbow.boldMk(rainbow.green(`|     ||__   ||___| | |  |   __||__   |  | |  `)));
-    console.log(rainbow.boldMk(rainbow.green(`|__|__||_____|      |_|  |_____||_____|  |_|  `)));
-    console.log(rainbow.dimMk             ("\n------------------- v0.1.0 -------------------\n"));
+    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.1 -------------------\n"));
+    if (options.coverage) {
+        console.log(rainbow.bgBlueBright(" PLUGIN ") + " " + rainbow.dimMk("Using Code Coverage") + "\n");
+    }
     const suites = groups.length;
     let failed = 0;
     let tests = 0;
@@ -247,7 +249,7 @@ export function run(options: RunOptions = new RunOptions()): void {
             console.log(txt);
         }
 
-        const report = suite.report();
+        const report = suite.getLogs();
         if (report) {
             if (report.passed) console.log(report.passed!);
             if (report.failed) failed_suite_logs += report.failed!;
@@ -259,16 +261,29 @@ export function run(options: RunOptions = new RunOptions()): void {
     if (failed) {
         console.log(rainbow.red("------------------ [FAILED] ------------------\n"));
         console.log(failed_suite_logs);
-        console.log(rainbow.red("----------------- [RESULTS] ------------------\n"));
-    } else {
-        console.log(rainbow.dimMk("----------------- [RESULTS] ------------------\n"));
     }
+
+
+    if (options.coverage && __HASHES().size) {
+        console.log(rainbow.dimMk("----------------- [COVERAGE] -----------------\n"));
+        const points = __HASHES().values();
+
+        for (let i = 0; i < points.length; i++) {
+            const point = unchecked(points[i]);
+            console.log(rainbow.bgRed(" UNCOVERED ") + " " + point.type + " at " + point.file + ":" + point.line.toString() + ":" + point.column.toString());
+        }
+        console.log("");
+    }
+
+    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(failed.toString() + " failed"))) + ", " + suites.toString() + " total");
-    console.log(rainbow.boldMk("Tests:       ") + (failed_tests ? rainbow.boldMk(rainbow.red(failed_tests.toString() + " failed")) : rainbow.boldMk(rainbow.green(failed_tests.toString() + " failed"))) + ", " + tests.toString() + " total");
+    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)
+        process.exit(1);
     }
 }

package/assembly/src/expectation.ts

@@ -1,7 +1,7 @@
 import { rainbow } from "as-rainbow";
 import { diff, visualize } from "../util";
 import { Node } from "./node";
-import { Verdict } from "..";
+import { Verdict, after_each_callback, before_each_callback } from "..";
 
 export class Expectation<T> extends Node {
     public verdict: Verdict = Verdict.Unreachable;

package/assembly/src/group.ts

@@ -21,7 +21,7 @@ export class TestGroup {
         this.results.push(test);
     }
 
-    report(): ReportLogs | null {
+    getLogs(): ReportLogs {
         let passed_logs = "";
         let failed_logs = "";
         for (let i = 0; i < this.results.length; i++) {

package/assembly/test.ts

@@ -63,6 +63,11 @@ describe("Array manipulation", () => {
     });
 });
 
+function foo(): void {
+    
+}
+
 run({
-    log: false
+    log: false,
+    coverage: true
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "as-test",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Testing framework for AssemblyScript. Compatible with WASI or Bindings ",
   "types": "assembly/index.ts",
   "author": "Jairus Tanaka",
@@ -8,23 +8,33 @@
   "license": "MIT",
   "scripts": {
     "test": "wasmtime ./build/test.wasm",
-    "pretest": "asc assembly/test.ts -o build/test.wasm --bindings esm --config ./node_modules/@assemblyscript/wasi-shim/asconfig.json",
-    "build:bench": "asc assembly/bench/bench.ts -o build/bench.wasm --config ./node_modules/@assemblyscript/wasi-shim/asconfig.json --optimizeLevel 3 --converge --exportRuntime --runtime stub",
+    "pretest": "TEST_DEBUG=all asc assembly/test.ts -o build/test.wasm --transform ./transform --bindings esm  --config ./node_modules/@assemblyscript/wasi-shim/asconfig.json",
     "bench:wasmtime": "wasmtime ./build/bench.wasm",
     "build:transform": "tsc -p ./transform",
     "prettier": "as-prettier -w ."
   },
   "devDependencies": {
+    "as-test": "./",
     "@assemblyscript/wasi-shim": "^0.1.0",
+    "@types/micromatch": "^4.0.7",
     "assemblyscript": "^0.27.22",
     "assemblyscript-prettier": "^3.0.1",
     "jest": "^29.7.0",
     "typescript": "^5.3.3",
-    "visitor-as": "^0.11.4"
+    "visitor-as": "^0.11.4",
+    "json-as": "^0.9.6"
+  },
+  "dependencies": {
+    "as-console": "^6.0.2",
+    "as-rainbow": "^0.1.0",
+    "as-string-sink": "^0.5.3",
+    "as-variant": "^0.4.1",
+    "chalk": "^5.3.0",
+    "micromatch": "^4.0.7"
   },
-  "dependencies": { "as-console": "^6.0.2", "as-convert-seconds": "^1.0.0", "as-rainbow": "^0.1.0", "as-string-sink": "^0.5.3", "as-variant": "^0.4.1", "json-as": "^0.9.6" },
   "overrides": {
-    "assemblyscript": "$assemblyscript"
+    "assemblyscript": "$assemblyscript",
+    "visitor-as": "$visitor-as"
   },
   "repository": {
     "type": "git",
@@ -45,4 +55,4 @@
   "publishConfig": {
     "@JairusSW:registry": "https://npm.pkg.github.com"
   }
-}
+}