Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JairusSW/as-test
Testing framework for AssemblyScript. Compatible with WASI or Bindings
https://github.com/JairusSW/as-test
as-pect aspect assemblyscript test testing
Last synced: 8 days ago
JSON representation
Testing framework for AssemblyScript. Compatible with WASI or Bindings
- Host: GitHub
- URL: https://github.com/JairusSW/as-test
- Owner: JairusSW
- License: mit
- Created: 2024-05-21T03:13:18.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-06-21T14:47:01.000Z (11 days ago)
- Last Synced: 2024-06-21T22:50:19.116Z (10 days ago)
- Topics: as-pect, aspect, assemblyscript, test, testing
- Language: TypeScript
- Homepage:
- Size: 75.2 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-assemblyscript - as-test - WIP testing framework (Packages)
README
_____ _____ _____ _____ _____ _____
| _ || __| ___|_ _|| __|| __||_ _|
| ||__ ||___| | | | __||__ | | |
|__|__||_____| |_| |_____||_____| |_|
v0.1.0
## Installation
```bash
npm install as-test
```
## Usage
```js
import {
describe,
expect,
test,
beforeAll,
afterAll,
beforeEach,
afterEach,
log,
run
} from "as-test";
// Shared setup for all tests (executed once before all tests)
beforeAll(() => {
log("Setting up test environment...");
});
// Shared teardown for all tests (executed once after all tests)
afterAll(() => {
log("Tearing down test environment...");
});
describe("Math operations", () => {
// Setup before each test in this group (optional)
beforeEach(() => {
log("Initializing test...");
});
// Teardown after each test in this group (optional)
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();
});
});
let myArray: i32[] = [];
describe("Array manipulation", () => {
beforeAll(() => {
myArray = [1, 2, 3];
});
test("Array length", () => {
expect(myArray).toHaveLength(3);
});
test("Array inclusion", () => {
expect(myArray).toContain(2);
});
});
run({
log: false
});
```
_____ _____ _____ _____ _____ _____
| _ || __| ___|_ _|| __|| __||_ _|
| ||__ ||___| | | | __||__ | | |
|__|__||_____| |_| |_____||_____| |_|
-----------------------------------------
[PASS] Math operations
[PASS] Array manipulation
[PASS] Addition
[PASS] Comparison
[PASS] Type checking
[PASS] Array length
[PASS] Array inclusion
-----------------------------------------
Test Suites: 0 failed, 2 total
Tests: 0 failed, 8 total
Snapshots: 0 total
Time: 101.812μs
## 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!
## Notes
This library is in the EARLY STAGES OF DEVELOPMENT!
If you want a feature, drop an issue (and again, maybe a star). I'll likely add it in less than 7 days.
## Contact
Contact me at:
Email: `[email protected]`
GitHub: `JairusSW`
Discord: `jairussw`
## Issues
Please submit an issue to https://github.com/JairusSW/as-test/issues if you find anything wrong with this library