Merge pull request #1 from ggilder/remove-redundant-elements-calculation

Remove redundant elements calculation

Author: willpower232

.github/workflows/run-tests.yml

@@ -45,6 +45,7 @@ jobs:
         run: composer test
 
       - name: Upload coverage
+        if: github.ref == 'refs/heads/main'
         env:
           COVERAGE_KEY: ${{ secrets.COVERAGE_KEY }}
           COVERAGE_HOST: ${{ secrets.COVERAGE_HOST }}

composer.json

@@ -11,6 +11,7 @@
         "php-parallel-lint/php-parallel-lint": "^1.3",
         "phpstan/phpstan": "^1.10",
         "phpunit/phpunit": "^10.0 || ^11.0",
+        "robiningelbrecht/phpunit-coverage-tools": "^1.8",
         "squizlabs/php_codesniffer": "^3.6"
     },
     "autoload": {
@@ -27,7 +28,7 @@
             "parallel-lint --exclude vendor ."
         ],
         "phpunit": [
-            "XDEBUG_MODE=coverage phpunit --coverage-clover coverage.clover tests"
+            "XDEBUG_MODE=coverage phpunit -d --min-coverage=100 --coverage-clover coverage.clover tests"
         ],
         "sniff": [
             "phpcs --standard=PSR12 src/ tests/"

phpunit.xml

@@ -9,4 +9,9 @@
       <directory suffix=".php">./src</directory>
     </include>
   </source>
+  <extensions>
+    <bootstrap class="RobinIngelbrecht\PHPUnitCoverageTools\PhpUnitExtension">
+      <parameter name="exitOnLowCoverage" value="1" />
+    </bootstrap>
+  </extensions>
 </phpunit>

src/CloverParser.php

@@ -4,6 +4,16 @@
 
 use SimpleXMLElement;
 
+/**
+ * Calculation reference https://confluence.atlassian.com/pages/viewpage.action?pageId=79986990
+ * 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 as according to that page notes, "elements" is conditionals + statements,
+ * which means including them in the calculation would double-count statements.
+ */
 class CloverParser
 {
     /** @var array<string> */
@@ -52,14 +62,12 @@ protected function reset(): void
             'methods' => 0,
             'conditionals' => 0,
             'statements' => 0,
-            'elements' => 0,
         ];
 
         $this->coveredTotals = [
             'coveredmethods' => 0,
             'coveredconditionals' => 0,
             'coveredstatements' => 0,
-            'coveredelements' => 0,
         ];
 
         $this->hasCalculatedTotals = false;
@@ -77,13 +85,6 @@ public function calculateTotals(): self
 
                     continue;
                 }
-
-                foreach ($project->xpath('//file') as $file) {
-                    // no other way of seeing if the element exists?
-                    if ($file->metrics->count() > 0) {
-                        $this->incrementTotalsWithMetrics($file->metrics);
-                    }
-                }
             }
         }
 
@@ -105,8 +106,6 @@ protected function incrementTotalsWithMetrics(SimpleXMLElement $metrics): void
         $this->coveredTotals['coveredconditionals'] += (int) $metrics['coveredconditionals'];
         $this->totals['statements'] += (int) $metrics['statements'];
         $this->coveredTotals['coveredstatements'] += (int) $metrics['coveredstatements'];
-        $this->totals['elements'] += (int) $metrics['elements'];
-        $this->coveredTotals['coveredelements'] += (int) $metrics['coveredelements'];
     }
 
     public function getPercentage(): float

tests/CloverParserTest.php

@@ -79,10 +79,11 @@ public function testCalculationFromProject(): void
         $this->assertSame(77.54237288135593, $parser->getPercentage());
     }
 
-    public function testCalculationFromFiles(): void
+    public function testCalculationMissingProjectMetrics(): void
     {
         $parser = new CloverParser();
 
+        // This is not a realistic file; clover metrics should always have top-level project metrics
         $clover = <<<ENDCLOVER
         <?xml version="1.0" encoding="UTF-8"?>
         <coverage generated="1618905787">
@@ -114,7 +115,7 @@ public function testCalculationFromFiles(): void
 
         $parser->addFile($path);
 
-        $this->assertSame(20.51282051282051, $parser->getPercentage());
+        $this->assertSame(0.0, $parser->getPercentage());
     }
 
     public function testCalculationAvoidsDivisionByZero(): void