Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/exercism/c-test-runner
https://github.com/exercism/c-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/c-test-runner
- Owner: exercism
- License: agpl-3.0
- Created: 2019-10-11T13:32:54.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-21T15:00:39.000Z (7 months ago)
- Last Synced: 2024-05-22T19:00:23.003Z (7 months ago)
- Topics: community-contributions-paused, exercism-test-runner, exercism-tooling
- Language: C
- Size: 162 KB
- Stars: 5
- Watchers: 10
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Exercism C Test Runner
The Docker image to automatically run tests on C 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 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.
## Known weaknesses
The regular expression that looks for calls to `RUN_TEST` cannot handle multiline comments or more than one function call per line. The calls need to be kept simple:
```c
RUN_TEST(test_date);
RUN_TEST(test_date_and_time_with_day_rollover);
// RUN_TEST(test_your_birthday);
```
[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