as-test 0.2.1 → 0.3.1

package/CHANGELOG.md

@@ -23,4 +23,5 @@ v0.1.10 - Feat: support node, deno, and bun
 v0.2.0 - Fix mock -> mockFn artifacts
 v0.2.1 - Remove accidental logging
 
-[UNRELEASED] - Feat: snapshotting
+v0.3.0 - Pass metadata through terminal - Support for multiple files - Better reporting - Timing for suites - Terminal utilities
+v0.3.1 - Add screenshot of completed tests to readme

package/README.md

@@ -3,7 +3,7 @@
 |  _  ||   __| ___|_   _||   __||   __||_   _|
 |     ||__   ||___| | |  |   __||__   |  | |  
 |__|__||_____|      |_|  |_____||_____|  |_|  
-v0.2.1
+v0.3.1
 </pre>
 </h5>
 
@@ -17,14 +17,6 @@ You'll also need to install `visitor-as`
 
 `npm i visitor-as --save-dev`
 
-## Templates
-
-I provide two templates for reference
-
-[WASI](https://github.com/JairusSW/as-test/tree/template/wasi)
-
-[Node/Bun/Deno](https://github.com/JairusSW/as-test/tree/template/node-bun-deno)
-
 View the docs: https://docs.jairus.dev/as-test
 
 ## Usage
@@ -37,101 +29,116 @@ as-test init
 
 Note: You can use either `ast` or `as-test` in the terminal.
 
-Next, create a test file
+Next, take a look at the generated test file
 
-`assembly/__tests__/test.spec.ts`
+`assembly/__tests__/example.spec.ts`
 
 ```js
 import {
-  describe,
-  expect,
-  test,
-  beforeAll,
-  afterAll,
-  beforeEach,
-  afterEach,
-  mockFn,
-  log,
-  run
+    describe,
+    expect,
+    test,
+    beforeAll,
+    afterAll,
+    mockFn,
+    log,
+    run,
+    it
 } from "as-test";
 
 beforeAll(() => {
-  log("Setting up test environment...");
+    log("Setting up test environment...");
 });
 
 afterAll(() => {
-  log("Tearing down test environment...");
+    log("Tearing down test environment...");
 });
 
 // Mock/override the function console.log
 mockFn<void>("console.log", (data: string): void => {
-  console.log("[MOCKED]: " + data + "\n");
+    console.log("[MOCKED]: " + data + "\n");
+});
+
+describe("Should sleep", () => {
+    test("1ms", () => {
+        const start = Date.now();
+        sleep(1);
+        expect(Date.now() - start).toBeGreaterOrEqualTo(1);
+    });
+    test("10ms", () => {
+        const start = Date.now();
+        sleep(10);
+        expect(Date.now() - start).toBeGreaterOrEqualTo(10);
+    });
+    test("1s", () => {
+        const start = Date.now();
+        sleep(1000);
+        expect(Date.now() - start).toBeGreaterOrEqualTo(1000);
+    });
+    test("5s", () => {
+        const start = Date.now();
+        log("Sleeping...");
+        sleep(5000);
+        log("Done!");
+        expect(Date.now() - start).toBeGreaterOrEqualTo(5000);
+    });
 });
 
 describe("Math operations", () => {
-  beforeEach(() => {
-    log("Initializing test...");
-  });
-
-  afterEach(() => {
-    log("Cleaning up after test...");
-  });
-
-  test("Addition", () => {
-    expect(1 + 2).toBe(3);
-  });
-
-  test("Comparison", () => {
-    expect(5).toBeGreaterThan(3);
-    expect(2).toBeLessThan(4);
-  });
-
-  test("Type checking", () => {
-    expect("hello").toBeString();
-    expect(true).toBeBoolean();
-    expect(10.5).toBeNumber();
-  });
+    test("Addition", () => {
+        expect(1 + 2).toBe(3);
+    });
+
+    test("Subtraction", () => {
+        expect(1 - 2).toBe(-1);
+    });
+
+    test("Comparison", () => {
+        expect(5).toBeGreaterThan(3);
+        expect(2).toBeLessThan(4);
+    });
+
+    test("Type checking", () => {
+        expect("hello").toBeString();
+        expect(true).toBeBoolean();
+        expect(10.5).toBeNumber();
+    });
 });
 
-let myArray: i32[] = [];
+let myArray: i32[] = [1, 2, 3];
 
 describe("Array manipulation", () => {
-  beforeAll(() => {
-    myArray = [1, 2, 3];
-  });
+    test("Array length", () => {
+        expect(myArray).toHaveLength(3);
+    });
 
-  test("Array length", () => {
-    expect(myArray).toHaveLength(3);
-  });
+    test("Array inclusion", () => {
+        expect(myArray).toContain(2);
+    });
 
-  test("Array inclusion", () => {
-    expect(myArray).toContain(2);
-  });
+    it("should be empty", () => { });
 });
 
-run({
-  log: true
-});
+run();
+
+function sleep(ms: i64): void {
+    const target = Date.now() + ms;
+    while (target > Date.now()) { }
+}
 ```
 
 Build and run it using as-test
 
 ```bash
-as-test test
+npm run test
 ```
 
+<img src="https://raw.githubusercontent.com/JairusSW/as-test/main/assets/img/screenshot.png">
+
 <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.
-
-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/as-test.config.json

@@ -1,22 +1,19 @@
 {
   "input": ["./assembly/__tests__/*.spec.ts"],
   "outDir": "./build",
-  "config": "./asconfig.json",
-  "suites": [],
-  "coverage": {
-    "enabled": true,
-    "show": false
+  "logs": "./logs",
+  "config": "none",
+  "plugins": {
+    "coverage": true
   },
   "buildOptions": {
     "args": [],
-    "wasi": true,
-    "parallel": true,
-    "verbose": true
+    "target": "bindings"
   },
   "runOptions": {
     "runtime": {
-      "name": "wasmtime",
-      "run": "wasmtime <file>"
+      "name": "node",
+      "run": "node ./tests/<name>.run.js"
     }
   }
 }

package/assembly/__tests__/array.spec.ts

@@ -0,0 +1,19 @@
+import { describe, expect, test, run, it } from "..";
+
+const myArray: i32[] = [1, 2, 3];
+
+describe("Array manipulation", () => {
+  test("Array length", () => {
+    expect(myArray).toHaveLength(3);
+  });
+
+  test("Array inclusion", () => {
+    expect(myArray).toContain(2);
+  });
+
+  it("should be empty", () => {});
+});
+
+run({
+  log: false,
+});

package/assembly/__tests__/math.spec.ts

@@ -0,0 +1,16 @@
+import { describe, expect, test, run } from "..";
+
+describe("Math operations", () => {
+  test("Addition", () => {
+    expect(1 + 2).toBe(3);
+  });
+
+  test("Comparison", () => {
+    expect(5).toBeGreaterThan(3);
+    expect(2).toBeLessThan(4);
+  });
+});
+
+run({
+  log: false,
+});

package/assembly/__tests__/sleep.spec.ts

@@ -0,0 +1,28 @@
+import { describe, expect, log, run, test } from "..";
+import { sleep } from "as-sleep/assembly";
+describe("Should sleep", () => {
+  test("1ms", () => {
+    const start = Date.now();
+    sleep(1);
+    expect(Date.now() - start).toBeGreaterOrEqualTo(1);
+  });
+  test("10ms", () => {
+    const start = Date.now();
+    sleep(10);
+    expect(Date.now() - start).toBeGreaterOrEqualTo(10);
+  });
+  test("1s", () => {
+    const start = Date.now();
+    sleep(1000);
+    expect(Date.now() - start).toBeGreaterOrEqualTo(1000);
+  });
+  test("5s", () => {
+    const start = Date.now();
+    log("Sleeping...");
+    sleep(5000);
+    log("Done!");
+    expect(Date.now() - start).toBeGreaterOrEqualTo(5000);
+  });
+});
+
+run();