Update starter files #27
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
ErikSchierboom
commented
Apr 7, 2021
ErikSchierboom
commented
- Add version to output
- Update README
- Rename test directory to tests
- Update ignored files
- Update shell scripts
- Simplify TODOs
- Add sanitize option
iHiD
approved these changes
Apr 7, 2021
| 4. Build the test runner, conforming to the [Test Runner interface specification](https://github.com/exercism/docs/blob/main/building/tooling/test-runners/interface.md). | ||
| - Update the files to match your track's needs. At the very least, you'll need to update `bin/run.sh`, `Dockerfile` and the test files in the `tests` directory | ||
| - Tip: look for `TODO:` comments to point you towards code that need updating | ||
| - Tip: look for `OPTIONAL:` comments to point you towards code that _could_ be useful | ||
|
|
||
| Once you're happy with your test runner, [open an issue on the exercism/automated-tests repo](https://github.com/exercism/automated-tests/issues/new?assignees=&labels=&template=new-test-runner.md&title=%5BNew+Test+Runner%5D+) to request an official test runner repository for your track. |
There was a problem hiding this comment.
This repository has been archived by the owner. It is now read-only.
The link is a 404
| 3. Remove this [Exercism Test Runner Template](#exercism-test-runner-template) section from the `README.md` file | ||
| 4. Build the test runner, conforming to the [Test Runner interface specification](https://github.com/exercism/docs/blob/main/building/tooling/test-runners/interface.md). | ||
| - Update the files to match your track's needs. At the very least, you'll need to update `bin/run.sh`, `Dockerfile` and the test files in the `tests` directory | ||
| - Tip: look for `TODO:` comments to point you towards code that need updating |
There was a problem hiding this comment.
Suggested change
| - Tip: look for `TODO:` comments to point you towards code that need updating | |
| - 💡 Tip: look for `TODO:` comments to point you towards code that need updating |
| 4. Build the test runner, conforming to the [Test Runner interface specification](https://github.com/exercism/docs/blob/main/building/tooling/test-runners/interface.md). | ||
| - Update the files to match your track's needs. At the very least, you'll need to update `bin/run.sh`, `Dockerfile` and the test files in the `tests` directory | ||
| - Tip: look for `TODO:` comments to point you towards code that need updating | ||
| - Tip: look for `OPTIONAL:` comments to point you towards code that _could_ be useful |
There was a problem hiding this comment.
Suggested change
| - Tip: look for `OPTIONAL:` comments to point you towards code that _could_ be useful | |
| - 💡 Tip: look for `OPTIONAL:` comments to point you towards code that _could_ be useful |
| @@ -53,10 +46,23 @@ 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" `test/<test-name>/results.json`. All files created during the test run itself are discarded. | |||
| These are [golden tests][golden] that compare the `results.json` generated by running the current state of the code against the "known good" `tests/<test-name>/results.json`. All files created during the test run itself are discarded. | |||
There was a problem hiding this comment.
I would rename this block to:
## Verify the test runner
To test the behaviour of the test runner, do the following:There was a problem hiding this comment.
You might want to write golden tests (snapshot tests), which is a common term used in a lot of languages / test libs / frameworks.
|
|
||
| # Arguments: | ||
| # $1: exercise slug | ||
| # $2: **RELATIVE** path to solution folder (with trailing slash) | ||
| # $3: **RELATIVE** path to output directory (with trailing slash) | ||
| # $2: absolute path to solution folder |
There was a problem hiding this comment.
The trailing slash part is probably still important. absolute only means it starts with a drive, mount or /
| # Example: | ||
| # ./bin/run-tests.sh | ||
|
|
||
| exit_code=0 |
There was a problem hiding this comment.
Suggested change
| exit_code=0 | |
| set -euo pipefail | |
| exit_code=0 |
|
|
||
| echo "$SLUG: comparing ${OUTPUT_DIR}/results" | ||
| diff "${INPUT_DIR}/results.json" "${OUTPUT_DIR}/results.json" | ||
| slug="$1" |
There was a problem hiding this comment.
Suggested change
| slug="$1" | |
| set -euo pipefail | |
| slug="$1" |
| # PLACEHOLDER - Insert call to run your language tests here | ||
| # Arguments: | ||
| # $1: exercise slug | ||
| # $2: absolute path to solution folder |
There was a problem hiding this comment.
The trailing slash part is probably still important. absolute only means it starts with a drive, mount or /
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.