Tooling and CI set up + 1st four exercises #25
Conversation
Completed the hello-world and leap exercises. Updated configuration.
Completed the difference-of-squares practice exercise, and added the `bin/format-all.sh` script that recursively searches for .odin files and runs `odinfmt` on them.
All source files have been reformatted with the `odinfmt.json` spec. `bin/format-all.sh` is now run automatically on commit.
The `test.yml` GitHub workflow now pushes any changes that it makes, so that they persist in the repo.
`test.yml` now only attempts a commit and push if the automated formatting actually changed any files.
The verify-exercises script now runs the individual test for both concept and practice exercises, and is the default in the GitHub workflow.
Tests were lifted from the Gleam track.
- The README now contains more thorough instructions on how to add a new exercise. - Fixed a variable name in the test runner that caused the "test all solutions" loop to run multiple times when verifying solutions.
|
I'll review this on Tuesday |
| @@ -0,0 +1,14 @@ | |||
| package difference_of_squares | |||
|
|
|||
| square_of_sum :: proc(n: int) -> int { | |||
There was a problem hiding this comment.
This should be the student stub. It looks like this is the example solution.
There was a problem hiding this comment.
😳 Oops, yes I think this got overwritten by the test script and I missed it – that needs a fix too
There was a problem hiding this comment.
The test script had a bug where it clobbered student stubs if the test failed. This has been fixed.
There was a problem hiding this comment.
This file still needs to revert to an actual stub :)
There was a problem hiding this comment.
Oh man, this has tripped me up too many times now 🙈. I'll fix this, and add a check to bin/run-test.sh that fails the test if the stub solution passes.
There was a problem hiding this comment.
I added a test that fails if the stub turns out to be a valid solution
- Fixed bin/run-test.sh so that it doesn't delete the stub solution when a test fails. - Restored exercises, and added a NotImplemented error condition for the stubs.
- Ran the code formatter on source files. - Rehaul of the README to follow Python's example.
exercises/practice/resistor-color/.meta/resistor_color_example.odin
Outdated
Show resolved
Hide resolved
The workflow now uses a fixed commit hash to pull a specific release of Odin. We now use Ubuntu 22.04 which has the libffi8 dependency, and add clang as the only other dependency.
| @@ -0,0 +1,14 @@ | |||
| package difference_of_squares | |||
|
|
|||
| square_of_sum :: proc(n: int) -> int { | |||
There was a problem hiding this comment.
This file still needs to revert to an actual stub :)
exercises/practice/difference-of-squares/difference_of_squares_test.odin
Outdated
Show resolved
Hide resolved
Added a check to bin/run-test.sh so that verifies that the stub solution does *not* pass any tests. Fixed hello-world.odin to actually be a stub.
- Improved bin/run-test.sh to add more visible color coding to the output. - Replaced NotImplemented error codes with a compile-time panic for procedures that have not yet been implemented. - Fixed stubs that were actually complete examples.
- Exercises' unit tests were modified so that only a minimal subset of tests are initially enabled; the rest are skipped. - The test runner was modified to automatically unskip all test cases before running the tests.
README.md
Outdated
| This is what users will start with when solving the exercise. | ||
| - Add tests to `<slug>_test.odin`. | ||
| Verify that the slug solution would fail _all_ tests. | ||
| Consider adding an error return enumeration such as `NotImplemented` to ensure that the stub solution's return values are invalid for all test cases. |
There was a problem hiding this comment.
I don't believe this still applies.
There was a problem hiding this comment.
Good catch! I fixed that, and left a comment about how we should check the stub solution in the test runner
|
Feel free to merge! |
|
I think you're the one who has to press the big "merge" button, @Nezteb 😁 |
Tooling and CI set up + 1st four exercises (exercism#25)
This PR sets up the basic foundation for the Odin track so that contributors can focus on creating new exercises:
test.ymlnow runsconfiglet lintand tests for all exercises. Any new.odinfiles are automatically formatted according to the specification inodinfmt.json. The CI workflow was tested as I created new exercises.bin/{runtest.sh,verify_exercises}) has been fixed to work together correctly.bin/format_all.shscript was added to automatically format all.odinfiles (individual files can be formatted by invokingodinfmtdirectly).