Allow mypy to output a junit file with per-file results #16388
Merged
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
|
According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅ |
JukkaL
approved these changes
Nov 3, 2023
mrwright
added a commit
to mrwright/mypy
that referenced
this pull request
Nov 6, 2023
msullivan
pushed a commit
that referenced
this pull request
Nov 7, 2023
#16388 introduced a bug where, with `--junit-format=global`, the junit file would indicate an error (with no message) even if everything passed. That was because `_generate_junit_contents` would check if `messages_by_file` was empty or not to determine if there were failures, but with `--junit-format=global` we'd pass in a dictionary of the form `{None: all_messages}`; `all_messages` would be empty, but the resulting dictionary wouldn't be. The fix is to pass in an empty dictionary if there are no messages. I've tested manually with `--junit-format=global` and `--junit-format=per_file` in the successful case to make sure the files are written correctly now.
svalentin
added a commit
that referenced
this pull request
Nov 8, 2023
#16388 changed the definition of `write_junit_xml` but missed a call site in dmypy. This fixes it.
JelleZijlstra
pushed a commit
that referenced
this pull request
Jan 2, 2024
#16388 introduced a bug where invalid xml could be produced by `write_junit_xml`, as special characters were no longer being escaped. The fix is to revert the removal of `from xml.sax.saxutils import escape` and `escape("\n".join(messages))` in the `write_junit_xml` function. I've added a small test case which checks that the `<`, `>`, `&` are escaped correctly in the xml.
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.
Adds a new
--junit-formatflag to MyPy, which affects the structure of the junit file written when--junit-xmlis specified (it has no effect when not writing a junit file). This flag can takeglobalorper_fileas values:--junit-format=global(the default) preserves the existing junit structure, creating a junit file specifying a single "test" for the entire mypy run.--junit-format=per_filewill cause the junit file to have one test entry per file with failures (or a single entry, as in the existing behavior, in the case when typechecking passes).In some settings it can be useful to know which files had typechecking failures (for example, a CI system might want to display failures by file); while that information can be parsed out of the error messages in the existing junit files, it's much more convenient to have that represented in the junit structure.
Tests for the old and new junit structure have been added.