Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding info to TESTS.md #61

Open
BNAndras opened this issue Mar 7, 2024 · 0 comments
Open

Adding info to TESTS.md #61

BNAndras opened this issue Mar 7, 2024 · 0 comments

Comments

@BNAndras
Copy link
Member

BNAndras commented Mar 7, 2024

@pfertyk, some thoughts on the TESTS.md setup.

First, we want to explain the commonalities of both workflows. We want to explain the structure of the tests, what's being passed in as solution_script, and what's being returned by each test as [expected, ...some code...]. We should highlight all tests are executed currently, since other tracks support tests being set to pending if you're working offline. Then you just enable each test after the previous one fails until all passed. That's not relevant since both workflows use the test runner so students should be aware all tests will be run for both.

We should also highlight how to pull down the test runner image for offline testing. To that end, maybe the test runner should have an optional mode for students. They navigate to their solution folder and run "docker test runner whatever --offline". The test runner picks up the current folder, parses the slug out, and then uses the current folder as the output directory for the results.json. Then we just need to highlight what the results.json is and how to read it (preferably with examples).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant