Fix total coverage calculation #17
Open
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
Per https://confluence.atlassian.com/pages/viewpage.action?pageId=79986990 which is already referenced for the calculation: So in order to calculate the Total Percentage Coverage metric using data from an XML report you have to use the following equation: TPC = (coveredconditionals + coveredstatements + coveredmethods) / (conditionals + statements + methods) Using elements is incorrect because, as that page notes, "elements" is conditionals + statements, which means the previous calculation would double-count statements. Also, the clover-format XML includes multiple `metrics` elements which were being redundantly counted. Each `file` element contains a `metrics` element, but then there is also a `metrics` element within each `class` defined in that file. Finally, there is a `project` level `metrics` element which summarizes all the files tested. Therefore, we only need to pick out the `project` level element to get the total metrics, and the summing is not necessary. However, I've left the summing in place so that this could be extended with, for instance, a coverage check on only modified files.
|
@ggilder fancy repeating your PR over here? https://github.com/willpower232/cloverparser/blob/537ab3a8807b7c9bce9148a0e674278b3fb64952/src/CloverParser.php#L102-L109 |
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.
Per https://confluence.atlassian.com/pages/viewpage.action?pageId=79986990 which is already referenced for the calculation:
Using elements is incorrect because, as that page notes, "elements" is conditionals + statements, which means the previous calculation would double-count statements.
Also, the clover-format XML includes multiple
metricselements which were being redundantly counted. Eachfileelement contains ametricselement, but then there is also ametricselement within eachclassdefined in that file. Finally, there is aprojectlevelmetricselement which summarizes all the files tested.Therefore, we only need to pick out the
projectlevel element to get the total metrics, and the summing is not necessary. However, I've left the summing in place so that this could be extended with, for instance, a coverage check on only modified files.