Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/exercism/wasm-test-runner
https://github.com/exercism/wasm-test-runner
community-contributions-paused exercism-test-runner exercism-tooling
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/exercism/wasm-test-runner
- Owner: exercism
- License: agpl-3.0
- Created: 2022-02-22T13:21:05.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T05:06:13.000Z (8 months ago)
- Last Synced: 2024-05-01T11:25:39.183Z (8 months ago)
- Topics: community-contributions-paused, exercism-test-runner, exercism-tooling
- Language: TypeScript
- Homepage:
- Size: 1.13 MB
- Stars: 0
- Watchers: 3
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Exercism WebAssembly Test Runner
[](https://github.com/exercism/wasm-test-runner/actions/workflows/deploy.yml) [](https://github.com/exercism/wasm-test-runner/actions/workflows/ci.js.yml)
The Docker image for automatically run tests on WebAssembly solutions submitted to [exercism][web-exercism].
> At this moment, the input path _must_ be relative to the `package.json` of this repository.
> `jest` doesn't like running outside of its tree.
> This might change in the future.
## Installation
Clone this repository and then run:
```shell
pnpm install
```
You'll need at least Node LTS for this to work.
```shell
pnpm build
```
## Usage
If you're developing this, you can run this via `pnpm` or the provided shell script.
- `.sh` enabled systems (UNIX, WSL): `pnpm execute:dev`
- `.bat` fallback (cmd.exe, Git Bash for Windows): _unsupported_
You'll want these `:dev` variants because it will _build_ the required code (it will transpile from TypeScript to JavaScript, which is necessary to run this in Node environments, unlike Deno environments).
When on Windows, if you're using Git Bash for Windows or a similar terminal, the `.sh` files will work, but will open a new window (which closes after execution).
The `.bat` scripts will work in the same terminal.
In this case it might be much easier to run `bin/run.sh` directly, so a new shell won't open.
You can also manually build using `pnpm` or `pnpm build`, and then run the script directly: `./bin/run.sh arg1 arg2 arg3`.
## Running the Solution's Tests
To run a solution's tests, do the following:
1. Open terminal in project's root
2. Run `./bin/run.sh []`
For example:
```shell
$ ./bin/run.sh two-fer ./test/fixtures/two-fer/pass
Using reporter : **/dist/reporter.js
Using test-root: **/test/fixtures/two-fer/pass/
Using base-root: **/
Using setup-env: **/dist/jest/setup.js
test/fixtures/two-fer/pass/ matches test/fixtures/two-fer/pass/. Not copying anything.
Using test/fixtures/two-fer/pass/.meta/config.json as base configuration
Enabling tests in test/fixtures/two-fer/pass/two-fer.spec.js
Determining test suites to run...
Find the output at:
test/fixtures/two-fer/pass/results.json
```
## Running the Tests of a Remote Solution
Instead of passing in an `` and ``, you can also directly pass in an `https://exercism.io` url, as long as you have the `exercism` CLI installed.
You can pass the following type of URLs:
- Published solutions: `/tracks/wasm/exercises//`
- Mentor solutions: `/mentor/solutions/`
- Your solutions: `/my/solutions/`
- Private solutions: `/solutions/`
For example:
```
$ ./bin/run.sh https://exercism.io/my/solutions/a7d1b71693fb4298a3a99bd352dd4d74
Exercism remote UUID: a7d1b71693fb4298a3a99bd352dd4d74
Downloaded to
C:\Users\Derk-Jan\Exercism\javascript\clock
...
Determining test suites to run...
Find the output at:
./tmp/clock/a7d1b71693fb4298a3a99bd352dd4d74/clock/results.json
```
As you can see, it will be copied to a local directory.
It's up to you to clean-up this directory.
## Running the Solution's Tests in Docker container
_This script is provided for testing purposes_
To run a solution's test in the Docker container, do the following:
1. Open terminal in project's root
2. Run `./bin/run-in-docker.sh `
## Maintaining
The `package.json` needs to be in-sync with the [`wasm` track `package.json`][git-wasm].
### Testing
Running the tests of the test-runner itself can be achieved by using the `test` script from `package.json`.
The tests delegate to the _build output_, which is why `pnpm test` first calls `pnpm build` before running `jest`.
**The tests take over a minute to run on a decent machine**.
[web-exercism]: https://exercism.io
[git-automated-tests]: https://github.com/exercism/automated-tests
[git-wasm]: https://github.com/exercism/wasm