Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inoas/glacier
Gleam Incremental Interactive Unit Testing
https://github.com/inoas/glacier
Last synced: 27 days ago
JSON representation
Gleam Incremental Interactive Unit Testing
- Host: GitHub
- URL: https://github.com/inoas/glacier
- Owner: inoas
- License: apache-2.0
- Created: 2022-12-19T00:50:36.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T21:48:05.000Z (8 months ago)
- Last Synced: 2024-04-12T00:50:06.337Z (8 months ago)
- Language: Gleam
- Homepage: https://hexdocs.pm/glacier
- Size: 545 KB
- Stars: 12
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-gleam - glacier - [📚](https://hexdocs.pm/glacier/) - Gleam Incremental Interactive Unit Testing (Packages / Testing)
README
# Glacier · Gleam Incremental Interactive Unit Testing
[](https://hex.pm/packages/glacier)
[](https://hexdocs.pm/glacier/)
[](https://github.com/inoas/glacier/blob/main/LICENCE)
**Glacier** brings incremental interactive unit testing to
[Gleam](https://gleam.run). It is meant as a drop-in replacement for
[gleeunit](https://hexdocs.pm/gleeunit) and depends on a fork of it.
Glacier: «A persistent body of dense ice that is constantly moving under its own weight.»
## Installation
1. Run:
```shell
gleam remove gleeunit
gleam add glacier --dev
gleam clean
```
2. Open `YOUR_GlEAM_PROJECT/test/YOUR_GLEAM_PROJECT.gleam` and replace `import gleeunit` with
`import glacier` and `gleeunit.main()` with `glacier.main()` (or alias glacier as gleeunit).
3. If you want to run on **Deno 1.40+** open `gleam.toml` and add:
```toml
[javascript.deno]
allow_read = ["./"]
allow_net = ["deno.land"]
allow_run = ["gleam"]
```
## Usage
1. Run any one of these, of which some are synonyms:
- `gleam test --target erlang -- --glacier`
- `gleam test --target erl -- --glacier`
- `gleam test --target javascript --runtime deno -- --glacier`
- `gleam test --target javascript --runtime nodejs -- --glacier`
- `gleam test --target js --runtime node -- --glacier`
2. Save gleam module within your projects `src` or `test` gleam directory and
watch associated tests to re-run.
*Notice: On Linux [**inotify**](https://en.wikipedia.org/wiki/Inotify) must be installed.*
## Upgrading Glacier
Make sure to run `gleam clean` after upgrading Glacier as a dependency.
## Improvements over gleeunit
**Glacier** differs from **gleeunit** insofar, that it let's you:
1. Pass in the `glacier` flag like so: `gleam test -- --glacier`, save a gleam
module and only related test modules will rerun.
2. Or pass in a specific unit test modules to rerun, for example:
`gleam test -- test/my_module_test.gleam`.
3. If `gleam test` is passed without any `--`-arguments it behaves the same as
**gleeunit**.
4. You can still pass in target or runtime flags, such as `--target javascript`
`--runtime deno`, aka:
- `gleam test --target javascript --runtime deno -- --glacier`
- `gleam test --target javascript --runtime deno -- test/my_module_test.gleam`.
- `gleam test --target js --runtime deno -- test/my_module_test.gleam`.
*Note: `gleam test` must only be executed from the base project directory!*
### Testing against Erlang, NodeJS and Deno simultaneously
Run these in 3 terminals side by side:
- `gleam test -- --glacier # this implies --target erlang`
- `gleam test --target js --runtime node -- --glacier`
- `gleam test --target js --runtime deno -- --glacier`
## Requirements & Installation
### Requirements
Requires Gleam 1.0.0 or later.
#### Target specific requirements
- Erlang/OTP 25 (lower may or may not run)
- NodeJS 18 LTS+ (lower may or may not run)
- Deno v1.30.0+ (lower does not run)
#### Target Erlang
Development and testing only happens on very recent stable Erlang/OTP versions, and thus may or may not run on previous versions.
Depends on [fs](https://hexdocs.pm/fs/):
- Linux [relies](https://github.com/synrc/fs#backends) on [**inotify**](https://en.wikipedia.org/wiki/Inotify).
- Mac: Should work out of the box.
- Windows: Should work out of the box.
#### Target JavaScript/NodeJS/Deno
Development and testing only happens on very recent NodeJS LTS versions, and thus may or may not run on previous versions.
Depends on [NodeJS:`fsPromises.watch`](https://nodejs.org/api/fs.html#fspromiseswatchfilename-options) or [`Deno.watchFs`](https://deno.land/[email protected]?s=Deno.watchFs):
- Linux: [relies](https://nodejs.org/docs/latest-v18.x/api/fs.html#fs_caveats) on [**inotify**](https://en.wikipedia.org/wiki/Inotify).
- Mac: Should work out of the box.
- Windows: Should work out of the box.
## Documentation
Documentation can be found at .
## Contributing to Glacier
See [DEVELOPMENT.md](./DEVELOPMENT.md).
## License
[Apache 2.0](./LICENCE)