Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/exercism/gleam-test-runner
https://github.com/exercism/gleam-test-runner
community-contributions-accepted exercism-test-runner exercism-tooling
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/exercism/gleam-test-runner
- Owner: exercism
- License: agpl-3.0
- Created: 2022-11-06T22:38:49.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-25T06:35:03.000Z (5 months ago)
- Last Synced: 2024-05-01T11:25:17.808Z (5 months ago)
- Topics: community-contributions-accepted, exercism-test-runner, exercism-tooling
- Language: Gleam
- Homepage:
- Size: 107 KB
- Stars: 2
- Watchers: 6
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-gleam - exercism_test_runner - [📚](https://hexdocs.pm/exercism_test_runner/) - A test framework for Gleam exercises on Exercism (Packages / Testing)
README
# Exercism Gleam Test Runner
The Docker image to automatically run tests on Gleam solutions submitted to [Exercism].
## Run the test runner
To run the tests of an arbitrary exercise, do the following:
1. Open a terminal in the project's root
2. Run `./bin/run.sh `
Once the test runner has finished, its results will be written to `/results.json`.
## Run the test runner on an exercise using Docker
_This script is provided for testing purposes, as it mimics how test runners run in Exercism's production environment._
To run the tests of an arbitrary exercise using the Docker image, do the following:
1. Open a terminal in the project's root
2. Run `./bin/run-in-docker.sh `
Once the test runner has finished, its results will be written to `/results.json`.
## Run the tests
To run the tests to verify the behavior of the test runner, do the following:
1. Ensure you have Gleam, Erlang, and jq installed on your macOS, Linux, or
similar machine.
1. Open a terminal in the project's root
2. Run `./bin/setup-locally.sh`
3. Run `./bin/run-tests.sh`
These are [golden tests][golden] that compare the `results.json` generated by running the current state of the code against the "known good" `tests//results.json`. All files created during the test run itself are discarded.
When you've made modifications to the code that will result in a new "golden" state, you'll need to generate and commit a new `tests//results.json` file.
## Run the tests using Docker
_This script is provided for testing purposes, as it mimics how test runners run in Exercism's production environment._
To run the tests to verify the behavior of the test runner using the Docker image, do the following:
1. Open a terminal in the project's root
2. Run `./bin/run-tests-in-docker.sh`
These are [golden tests][golden] that compare the `results.json` generated by running the current state of the code against the "known good" `tests//results.json`. All files created during the test run itself are discarded.
When you've made modifications to the code that will result in a new "golden" state, you'll need to generate and commit a new `tests//results.json` file.
[test-runners]: https://github.com/exercism/docs/tree/main/building/tooling/test-runners
[golden]: https://ro-che.info/articles/2017-12-04-golden-tests
[exercism]: https://exercism.io