Add missing lines-covered and lines-valid attributes #17738
Conversation
… XML This commit addresses the issue where the generated Cobertura XML report was missing the `lines-covered` and `lines-valid` attributes. The implementation now ensures these attributes are correctly populated. Updated the `CoberturaReportSuite` test suite to validate the presence of these attributes in the generated XML.
for more information, see https://pre-commit.ci
This comment has been minimized.
This comment has been minimized.
… XML This commit addresses the issue where the generated Cobertura XML report was missing the `lines-covered` and `lines-valid` attributes. The implementation now ensures these attributes are correctly populated. Updated the `CoberturaReportSuite` test suite to validate the presence of these attributes in the generated XML.
# Conflicts: # mypy/test/testreports.py
for more information, see https://pre-commit.ci
This comment has been minimized.
This comment has been minimized.
mypy/test/testreports.py
Outdated
| with tempfile.TemporaryDirectory() as tempdir: | ||
| reports = Reports(data_dir=tempdir, report_dirs={"dummy_report": tempdir}) | ||
|
|
||
| cobertura_reporter = CoberturaXmlReporter(reports, ".") | ||
| cobertura_reporter.root_package = cobertura_package | ||
| cobertura_reporter.on_finish() | ||
|
|
||
| # Convert the XML document to a string | ||
| xml_str = etree.tostring(cobertura_reporter.doc, pretty_print=True).decode("utf-8") | ||
|
|
||
| # Check that the required attributes are present | ||
| assert f'lines-covered="{cobertura_package.covered_lines}"' in xml_str | ||
| assert f'lines-valid="{cobertura_package.total_lines}"' in xml_str |
There was a problem hiding this comment.
Looks like you're testing a separate thing here. It's usually best to follow the AAA principle — checking one single thing per test: https://automationpanda.com/2020/07/07/arrange-act-assert-a-pattern-for-writing-good-tests/.
Hence, it's best to add new test cases unless you change the aspects of the existing ones. Just don't pile on extra logic. The tests must remain simple.
It's probably not a good idea to check substrings in XML text. No need to check if Python's XML writer works. The goal is to check that the reported produces the object having proper XML attributes. It's easier to check it against the object representation.
OTOH, looking closer, I think that the only change to really needed is changing that expected XML string on line 40. That test already checks everything needed, but you changed the produced output, so this test will keep failing until you adjust the expected value to match that new output shape.
for more information, see https://pre-commit.ci
|
According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅ |
This PR resolves an issue where the Cobertura XML report generated by MyPy was missing the lines-covered and lines-valid attributes in the element.
Changes made:
Fixes #17689