Adds unit-test xml report generation task #212
+21
−0
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
msheiny
force-pushed
the
unittest_xml_task
branch
from
97f64cc to
b066d49
Compare
| @task(pre=[unittest]) | ||
| def unittest_xml_coverage(context): | ||
| """Produce an XML coverage report that can be ingested into other tools.""" | ||
| produce_xml_cmd = "coverage xml --include '{{ cookiecutter.app_name }}/*' --omit '*/migrations/*,*/tests/*'" |
There was a problem hiding this comment.
I wonder if it would be preferable not to omit migrations (since we should be sure to test data migrations if possible) and tests (since it would flag cases of dead test code that never gets called, etc.)
| cur_dir = os.path.dirname(__file__) | ||
| cov_xml_path = os.path.join(cur_dir, "coverage.xml") | ||
|
|
||
| # I was originally going to use ET lib but linter throws a CVE warning |
There was a problem hiding this comment.
Should be fine to use ElementTree and just add an appropriate noqa comment, IMHO.
There was a problem hiding this comment.
Okay latest commit i went back to using ET
msheiny
force-pushed
the
unittest_xml_task
branch
from
b066d49 to
497732b
Compare
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.
What's Changed
coverage.xml). This can be used by tooling (such as VSCode code coverage extensions) for ingestion.Of note that the XML has to be modified to work correctly with tooling outside the container. I first tried to use the std-lib xml to do this but received aruffCVE warning. I didn't want to pull in a new dependency here, so I did the hacky thing to just manipulate the file with string replacement. Open to feedback whether that was the right call or not.Earlier commit i worked around a CVE in XML but after feedback decided it was acceptable for dev environments and went back to using the stdlib xml helpers.
Testing
Tested this logic in the floor-plan app while I was reviewing a PR and it worked fine.