exercism / exercism/mips-test-runner

Upgrade to version 3 spec

Open
#15 0 comments 0 reactions 0 assignees View on GitHub
x:action/improve x:knowledge/advanced x:module/test-runner x:size/large x:type/coding
Dominant language
Shell
Stars
0
Forks
5
PR merge metrics
No merged PRs in 30d

Description

If possible, this test runner should be updated to version 3 of the [test runner interface specification](https://github.com/exercism/docs/blob/main/building/tooling/test-runners/interface.md). In version 3, one additional feature is enabled: the ability to link individual tests to tasks.
This allows the website to show which tests belong to which tasks.

The way tests are linked to tasks is via an (optional) `task_id` field, which is an integer that matches the number of the task as defined in the exercise's `instructions.md` file (note: the instructions start at index 1).

This is an example of a test in the `results.json` file:

```json
{
"name": "Expected oven time in minutes",
"status": "pass",
"task_id": 1,
"test_code": "Assert.Equal(40, Lasagna.ExpectedMinutesInOven());"
}
```

You are completely free in how to implement this. Some options are:

1. Add metadata to a test that the test runner can then discover while running the tests (e.g. an attribute or annotation)
2. Define a test name/task id mapping (e.g. in the exercise's `.meta/config.json` file)
3. Any other option you can think of...

As this test runner currently implements version 1 of the test runner specification, it might be good to first upgrade to version 2 of the test runner specification before upgrading to version 3.

Let me know if there are any questions.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.