https://github.com/exercism/yamlscript-test-runner
https://github.com/exercism/yamlscript-test-runner
exercism-test-runner exercism-tooling maintained
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/exercism/yamlscript-test-runner
- Owner: exercism
- License: agpl-3.0
- Created: 2024-07-09T06:37:54.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-05-01T05:19:05.000Z (about 1 month ago)
- Last Synced: 2025-05-04T16:19:18.908Z (about 1 month ago)
- Topics: exercism-test-runner, exercism-tooling, maintained
- Language: Shell
- Size: 70.3 KB
- Stars: 1
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Exercism YAMLScript Test Runner
===============================
The Docker image to automatically run tests on YAMLScript 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. Open a terminal in the project's root
2. 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 update the affected
`tests//expected_results.json` file(s).
## 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 update the affected
`tests//expected_results.json` file(s).
## Testing repository integrity
This repository has a Makefile for testing / linting various things.
You should run the `make test` command and ensure it finishes cleanly before
pushing commits.
[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