Glacier · Gleam Incremental Interactive Unit Testing
Glacier brings incremental interactive unit testing to Gleam. It is meant as a drop-in replacement for gleeunit and depends on a fork of it.
![Glacier Logo](https://raw.githubusercontent.com/inoas/glacier/main/glacier-logo.png)
Installation
-
Run:
gleam remove gleeunit gleam add glacier --dev gleam clean
-
Open
YOUR_GlEAM_PROJECT/test/YOUR_GLEAM_PROJECT.gleam
and replaceimport gleeunit
withimport glacier
andgleeunit.main()
withglacier.main()
(or alias glacier as gleeunit). -
If you want to run on Deno 1.40+ open
gleam.toml
and add:[javascript.deno] allow_read = ["./"] allow_net = ["deno.land"] allow_run = ["gleam"]
Usage
- 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
- Save gleam module within your projects
src
ortest
gleam directory and watch associated tests to re-run.
Notice: On Linux 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:
- Pass in the
glacier
flag like so:gleam test -- --glacier
, save a gleam module and only related test modules will rerun. - Or pass in a specific unit test modules to rerun, for example:
gleam test -- test/my_module_test.gleam
. - If
gleam test
is passed without any--
-arguments it behaves the same as gleeunit. - 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:
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
or Deno.watchFs
:
Documentation
Documentation can be found at https://hexdocs.pm/glacier.
Contributing to Glacier
See DEVELOPMENT.md.