fix: Redo SCoverage report parsing logic to parse external XML format #193
Conversation
This file contains hidden or 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
The current parsers use the scoverage-data/scoverage.coverage.xml file which is meant to be used internally for storing data. SCoverage has a different XML reporting format for external consumption. Newer versions of the library default to txt files for internal data. SonarQube and other similar tools rely on the external format. The new implementation adds capability to parse the external format from XML attributes and computes partial lines based on the executed statements. Also adds new test case which is inline with the external format. Changes are not breaking, the previous format is also supported.
The current parsers use the scoverage-data/scoverage.coverage.xml file which is meant to be used internally for storing data. SCoverage has a different XML reporting format for external consumption. Newer versions of the library default to txt files for internal data. SonarQube and other similar tools rely on the external format. The new implementation adds capability to parse the external format from XML attributes and computes partial lines based on the executed statements. Also adds new test case which is inline with the external format. Changes are not breaking, the previous format is also supported.
The current parsers use the scoverage-data/scoverage.coverage.xml file which is meant to be used internally for storing data. SCoverage has a different XML reporting format for external consumption. Newer versions of the library default to txt files for internal data. SonarQube and other similar tools rely on the external format. The new implementation adds capability to parse the external format from XML attributes and computes partial lines based on the executed statements. Also adds new test case which is inline with the external format. Changes are not breaking, the previous format is also supported.
The current parsers use the scoverage-data/scoverage.coverage.xml file which is meant to be used internally for storing data. SCoverage has a different XML reporting format for external consumption. Newer versions of the library default to txt files for internal data. SonarQube and other similar tools rely on the external format. The new implementation adds capability to parse the external format from XML attributes and computes partial lines based on the executed statements. Also adds new test case which is inline with the external format. Changes are not breaking, the previous format is also supported.
There was a problem hiding this comment.
thank you for the PR! it appears our CI is not working for community contributions (i might have broken it with a recent change) but we can get that sorted
left a few comments. i think i (or someone) will need to ramp up a bit on the format you're supporting here because there are some things i don't understand from a quick glance:
- what the
startandendattributes on eachstatementmean - why
line="5"appears several times, some havingbranch="true"and others havingbranch="false" - why something having partial coverage is not tied to the
branchattribute - why a fully-covered branch should be recorded as a line instead of a branch
does /src/main/scala/CoverageClass.scala have, like, 500-character lines with several totally distinct statements and control flow blocks on them?
if you could explain that'd help, else i'll try to get back to you early next week!
Comment on lines
+69
to
+71
| # We only mark it as a branch if it's a partial coverage | ||
| coverage_type = CoverageType.branch if is_partial else CoverageType.line | ||
| _file.append(line, report_builder_session.create_coverage_line(cov, coverage_type)) |
There was a problem hiding this comment.
why would we want to do this?
| # Add the line | ||
| ln = int(child_text(statement, "line")) | ||
| hits = child_text(statement, "count") | ||
| is_partial = len(included_statements) > 1 and len(covered_statements) < len(included_statements) |
There was a problem hiding this comment.
wouldn't is_partial factor in whether the branch attribute is true?
|
#199 i think this PR should fix the CI issue |
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.
The current parsers use the scoverage-data/scoverage.coverage.xml file which is meant to be used internally for storing data. SCoverage has a different XML reporting format for external consumption. Newer versions of the library default to txt files for internal data instead of xml. SonarQube and other similar tools rely on the external format. The new implementation adds capability to parse the external format from XML attributes and computes partial lines based on the executed statements. Also adds new test case which is inline with the external format.
Changes are not breaking, the previous format is also supported.
Reference Links: