When Using subtest, all subtest captured output is written into the Parent Output Property
@BethanyG is already working on this.
Since May 28, 2021.
Assessment
This issue has not been assessed yet.
Description
If a user has used print() or other debugging methods in their code and the tests for that code are using unittest.subtest, the captured output for the subtests is being written into the parent output property in the results.json file -- one set of of output for each subtest. Not an ideal situation.
Steps to reproduce:
Using the tests/example-partial-failure-with-subtests/ test:
- Add
print("User output is captured!")on line 8 ofexample_partial_failure_with_subtests.py - Run ./bin/run.sh example-partial-failure-with-subtests
- Note that
results.jsonhas an entry that looks like this forExampleSuccessTest.test_abc:
"name": "ExampleSuccessTest.test_abc",
"status": "pass",
"test_code": "input_data = ['frog', 'fish', 'coconut', 'pineapple', 'carrot', 'cucumber', 'grass', 'tree']\nresult_data = [(\"Hello, World!\", param) for param in input_data]\nnumber_of_variants = range(1, len(input_data) + 1)\n\nfor variant, param, result in zip(number_of_variants, input_data, result_data):\n with self.subTest(f\"variation #{variant}\", param=param, result=result):\n self.assertEqual(hello(param), result,",
"task_id": 1,
"output": "User output is captured!\nUser output is captured!\nUser output is captured!\nUser output is captured!\nUser output is captured!\nUser output is captured!\nUser output is captured!\nUser output is captured!"
}
Ideally, we'd write captured output for a subtest into the output property for that subtest. In cases where there is not a subtest report (pytest only reports failed subtests), we would annotate the parent test output to indicate it came from a successful subtest.
- Dominant language
- Python
- Stars
- 13
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from exercism/python-test-runner
-
exercism/python-test-runner#101 · 7 comments · 1 assignee ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
All issues in exercism/python-test-runner
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100