as-test 0.0.4 → 0.0.6

package/.github/workflows/nodejs.yml

@@ -0,0 +1,28 @@
+name: Node.js CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+      
+      - name: Install Wasmtime
+        uses: jcbhmr/setup-wasmtime@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+
+      - name: Install dependencies
+        if: steps.node-cache.outputs.cache-hit != 'true'
+        run: yarn
+      
+      - name: Build tests
+        run: yarn run build:test
+
+      - name: Perform tests
+        run: yarn run test:wasmtime

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+v0.0.0 - Initial project setup
+v0.0.1 - Updates to UI, some bug fixes
+v0.0.2 - Diff between expected and recieved results
+v0.0.3 - Added `afterEach`, `beforeEach`, `afterAll`, `beforeAll`, `test`, `it`, `.toBeGreaterThan`, `.toBeGreaterThanOrEqualTo`, ect..
+v0.0.4 - Fix import issue in README usage section
+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

package/README.md

@@ -3,7 +3,7 @@
 |  _  ||   __| ___|_   _||   __||   __||_   _|
 |     ||__   ||___| | |  |   __||__   |  | |  
 |__|__||_____|      |_|  |_____||_____|  |_|  
-v0.0.4
+v0.0.5
 </pre>
 </h5>
 
@@ -86,7 +86,7 @@ run({
 });
 ```
 
-<h5>
+<h6>
 <pre> _____  _____      _____  _____  _____  _____ 
 |  _  ||   __| ___|_   _||   __||   __||_   _|
 |     ||__   ||___| | |  |   __||__   |  | |  
@@ -115,7 +115,35 @@ Tests:       0 failed, 8 total
 Snapshots:   0 total
 Time:        101.812μs
 </pre>
-</h5>
+</h6>
+
+## Running
+
+You can run as-test *anywhere* that WASI is supported! I've yet to add support for bindings, but all it needs is access to the terminal.
+
+To add WASI support, install it with
+
+```
+npm install @assemblyscript/wasi-shim
+```
+
+Add the following scripts to your `package.json` where NAME-HERE is your test file.
+You can swap out `wasmtime` with [Node.js](https://nodejs.org/), [Wasmer](https://wasmer.io/), [Wasm3](https://github.com/wasm3/wasm3), or any WASI-supporting runtime
+
+```json
+"scripts": {
+  "test": "wasmtime ./build/NAME.spec.wasm",
+  "pretest": "asc asc NAME.spec.ts -o build/NAME.spec.wasm --bindings esm --config ./node_modules/@assemblyscript/wasi-shim/asconfig.json"
+}
+```
+
+And finally, run it with:
+
+```bash
+npm run test
+```
+
+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!
 

package/assembly/index.ts

@@ -1,7 +1,7 @@
 import { rainbow } from "as-rainbow";
 import { TestGroup } from "./src/group";
 import { Expectation } from "./src/expectation";
-import { colorText, formatTime } from "./util";
+import { formatTime } from "./util";
 import { stringify } from "as-console/assembly";
 
 /**
@@ -214,11 +214,12 @@ export function run(options: RunOptions = new RunOptions()): void {
     console.log(rainbow.boldMk(rainbow.green(`|  _  ||   __| ___|_   _||   __||   __||_   _|`)));
     console.log(rainbow.boldMk(rainbow.green(`|     ||__   ||___| | |  |   __||__   |  | |  `)));
     console.log(rainbow.boldMk(rainbow.green(`|__|__||_____|      |_|  |_____||_____|  |_|  `)));
-    console.log(rainbow.dimMk("\n-----------------------------------------\n"));
+    console.log(rainbow.dimMk             ("\n------------------- v0.0.6 -------------------\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();
@@ -241,17 +242,33 @@ export function run(options: RunOptions = new RunOptions()): void {
             console.log(rainbow.bgGreenBright(" PASS ") + " " + rainbow.dimMk(suite.description) + "\n");
         } else {
             failed++;
-            console.log(rainbow.bgRed(" FAIL ") + " " + rainbow.dimMk(suite.description) + "\n");
+            const txt = rainbow.bgRed(" FAIL ") + " " + rainbow.dimMk(suite.description) + "\n";
+            failed_suite_logs += txt
+            console.log(txt);
         }
 
         const report = suite.report();
-        if (report) console.log(report);
+        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);
+        console.log(rainbow.red("----------------- [RESULTS] ------------------\n"));
+    } else {
+        console.log(rainbow.dimMk("----------------- [RESULTS] ------------------\n"));
+    }
     const ms = performance.now() - start;
-    console.log(rainbow.dimMk("-----------------------------------------\n"));
     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("Snapshots:   ") + "0 total");
-    console.log(rainbow.boldMk("Time:        ") + formatTime(ms))
+    console.log(rainbow.boldMk("Time:        ") + formatTime(ms));
+    if (failed) {
+        process.exit(1)
+    }
 }

package/assembly/src/expectation.ts

@@ -5,9 +5,9 @@ import { Verdict } from "..";
 
 export class Expectation<T> extends Node {
     public verdict: Verdict = Verdict.Unreachable;
-    public left: T;
+    private left: T;
     private _left: string | null = null;
-    public right: u64 = 0;
+    private right: u64 = 0;
     private _right: string | null = null;
     private _not: boolean = false;
     private op: string = "=";
@@ -44,7 +44,7 @@ export class Expectation<T> extends Node {
      * @returns - void
      */
     toBeGreaterThan(value: T): void {
-        if (!isInteger<T>() && !isFloat<T>()) throw new Error("toBeGreaterThan() can only be used on number types. Received " + nameof<T>() + " instead!");
+        if (!isInteger<T>() && !isFloat<T>()) ERROR("toBeGreaterThan() can only be used on number types!");
 
         this.verdict = this.left > value ? Verdict.Ok : Verdict.Fail;
         store<T>(changetype<usize>(this), value, offsetof<Expectation<T>>("right"));
@@ -63,7 +63,7 @@ export class Expectation<T> extends Node {
      * @returns - void
      */
     toBeGreaterOrEqualTo(value: T): void {
-        if (!isInteger<T>() && !isFloat<T>()) throw new Error("toBeGreaterOrEqualTo() can only be used on number types. Received " + nameof<T>() + " instead!");
+        if (!isInteger<T>() && !isFloat<T>()) ERROR("toBeGreaterOrEqualTo() can only be used on number types!");
 
         this.verdict = this.left >= value ? Verdict.Ok : Verdict.Fail;
         store<T>(changetype<usize>(this), value, offsetof<Expectation<T>>("right"));
@@ -82,7 +82,7 @@ export class Expectation<T> extends Node {
      * @returns - void
      */
     toBeLessThan(value: T): void {
-        if (!isInteger<T>() && !isFloat<T>()) throw new Error("toBeLessThan() can only be used on number types. Received " + nameof<T>() + " instead!");
+        if (!isInteger<T>() && !isFloat<T>()) ERROR("toBeLessThan() can only be used on number types!");
 
         this.verdict = this.left < value ? Verdict.Ok : Verdict.Fail;
         store<T>(changetype<usize>(this), value, offsetof<Expectation<T>>("right"));
@@ -101,7 +101,7 @@ export class Expectation<T> extends Node {
      * @returns - void
      */
     toBeLessThanOrEqualTo(value: T): void {
-        if (!isInteger<T>() && !isFloat<T>()) throw new Error("toBeLessThanOrEqualTo() can only be used on number types. Received " + nameof<T>() + " instead!");
+        if (!isInteger<T>() && !isFloat<T>()) ERROR("toBeLessThanOrEqualTo() can only be used on number types!");
 
         this.verdict = this.left <= value ? Verdict.Ok : Verdict.Fail;
         store<T>(changetype<usize>(this), value, offsetof<Expectation<T>>("right"));

package/assembly/src/group.ts

@@ -21,16 +21,30 @@ export class TestGroup {
         this.results.push(test);
     }
 
-    report(): string | null {
-        let report = "";
+    report(): ReportLogs | null {
+        let passed_logs = "";
+        let failed_logs = "";
         for (let i = 0; i < this.results.length; i++) {
-            const result = unchecked(this.results[i]).report();
-            if (result) report += result + "\n";
+            const result = unchecked(this.results[i]);
+            const report = result.report();
+            if (report) {
+                if (result.verdict === Verdict.Fail) failed_logs += report + "\n";
+                else if (result.verdict === Verdict.Ok) passed_logs += report + "\n";
+            }
+        }
+        return {
+            passed: passed_logs.length ? passed_logs : null,
+            failed: failed_logs.length ? failed_logs : null
         }
-        return report.length ? report : null;
     }
 
     run(): void {
         this.callback();
     }
 }
+
+
+class ReportLogs {
+    passed: string | null;
+    failed: string | null;
+}

package/assembly/test.ts

@@ -10,7 +10,6 @@ import {
     run
 } from ".";
 
-
 // Shared setup for all tests (executed once before all tests)
 beforeAll(() => {
     log("Setting up test environment...");

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "as-test",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Testing framework for AssemblyScript. Compatible with WASI or Bindings ",
   "types": "assembly/index.ts",
   "author": "Jairus Tanaka",
   "contributors": [],
   "license": "MIT",
   "scripts": {
-    "build:test": "asc assembly/test.ts -o build/test.wasm --bindings esm --config ./node_modules/@assemblyscript/wasi-shim/asconfig.json",
+    "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/test.build.log",
     "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",
     "bench:wasmtime": "wasmtime ./build/bench.wasm",
     "build:transform": "tsc -p ./transform",
-    "test:wasmtime": "wasmtime ./build/test.wasm",
     "prettier": "as-prettier -w ."
   },
   "devDependencies": {
@@ -31,7 +31,11 @@
     "url": "git+https://github.com/JairusSW/as-test.git"
   },
   "keywords": [
-    "assemblyscript"
+    "assemblyscript",
+    "testing",
+    "test",
+    "as-pect",
+    "aspect"
   ],
   "bugs": {
     "url": "https://github.com/JairusSW/as-test/issues"