Added branch coverage statistics to XML report

sebastianbergmann · Dec 13, 2024 · f8dd662 · f8dd662
1 parent b36a500
commit f8dd662
Show file tree

Hide file tree

Showing 11 changed files with 349 additions and 0 deletions.
diff --git a/src/Report/Xml/Facade.php b/src/Report/Xml/Facade.php
@@ -252,6 +252,11 @@ private function setTotals(AbstractNode $node, Totals $totals): void
             $node->numberOfExecutedLines(),
         );
 
+        $totals->setNumBranches(
+            $node->numberOfExecutableBranches(),
+            $node->numberOfExecutedBranches(),
+        );
+
         $totals->setNumClasses(
             $node->numberOfClasses(),
             $node->numberOfTestedClasses(),

diff --git a/src/Report/Xml/Totals.php b/src/Report/Xml/Totals.php
@@ -21,6 +21,7 @@
 {
     private DOMNode $container;
     private DOMElement $linesNode;
+    private DOMElement $branchesNode;
     private DOMElement $methodsNode;
     private DOMElement $functionsNode;
     private DOMElement $classesNode;
@@ -36,6 +37,11 @@ public function __construct(DOMElement $container)
             'lines',
         );
 
+        $this->branchesNode = $dom->createElementNS(
+            'https://schema.phpunit.de/coverage/1.0',
+            'branches',
+        );
+
         $this->methodsNode = $dom->createElementNS(
             'https://schema.phpunit.de/coverage/1.0',
             'methods',
@@ -57,6 +63,7 @@ public function __construct(DOMElement $container)
         );
 
         $container->appendChild($this->linesNode);
+        $container->appendChild($this->branchesNode);
         $container->appendChild($this->methodsNode);
         $container->appendChild($this->functionsNode);
         $container->appendChild($this->classesNode);
@@ -81,6 +88,16 @@ public function setNumLines(int $loc, int $cloc, int $ncloc, int $executable, in
         );
     }
 
+    public function setNumBranches(int $count, int $tested): void
+    {
+        $this->branchesNode->setAttribute('count', (string) $count);
+        $this->branchesNode->setAttribute('tested', (string) $tested);
+        $this->branchesNode->setAttribute(
+            'percent',
+            $count === 0 ? '0' : sprintf('%01.2F', Percentage::fromFractionAndTotal($tested, $count)->asFloat()),
+        );
+    }
+
     public function setNumClasses(int $count, int $tested): void
     {
         $this->classesNode->setAttribute('count', (string) $count);

diff --git a/tests/_files/Report/XML/CoverageForBankAccount/BankAccount.php.xml b/tests/_files/Report/XML/CoverageForBankAccount/BankAccount.php.xml
@@ -3,6 +3,7 @@
   <file name="BankAccount.php" path="%e">
     <totals>
       <lines total="35" comments="0" code="35" executable="8" executed="5" percent="62.50"/>
+      <branches count="0" tested="0" percent="0"/>
       <methods count="4" tested="3" percent="75.00"/>
       <functions count="0" tested="0" percent="0"/>
       <classes count="1" tested="0" percent="0.00"/>

diff --git a/tests/_files/Report/XML/CoverageForBankAccount/index.xml b/tests/_files/Report/XML/CoverageForBankAccount/index.xml
@@ -14,6 +14,7 @@
     <directory name="%s">
       <totals>
         <lines total="35" comments="0" code="35" executable="8" executed="5" percent="62.50"/>
+        <branches count="0" tested="0" percent="0"/>
         <methods count="4" tested="3" percent="75.00"/>
         <functions count="0" tested="0" percent="0"/>
         <classes count="1" tested="0" percent="0.00"/>
@@ -22,6 +23,7 @@
       <file name="BankAccount.php" href="BankAccount.php.xml">
         <totals>
           <lines total="35" comments="0" code="35" executable="8" executed="5" percent="62.50"/>
+          <branches count="0" tested="0" percent="0"/>
           <methods count="4" tested="3" percent="75.00"/>
           <functions count="0" tested="0" percent="0"/>
           <classes count="1" tested="0" percent="0.00"/>

diff --git a/tests/_files/Report/XML/CoverageForClassWithAnonymousFunction/index.xml b/tests/_files/Report/XML/CoverageForClassWithAnonymousFunction/index.xml
@@ -11,6 +11,7 @@
     <directory name="%s">
       <totals>
         <lines total="20" comments="1" code="19" executable="8" executed="8" percent="100.00"/>
+        <branches count="0" tested="0" percent="0"/>
         <methods count="1" tested="1" percent="100.00"/>
         <functions count="0" tested="0" percent="0"/>
         <classes count="1" tested="1" percent="100.00"/>
@@ -19,6 +20,7 @@
       <file name="source_with_class_and_anonymous_function.php" href="source_with_class_and_anonymous_function.php.xml">
         <totals>
           <lines total="20" comments="1" code="19" executable="8" executed="8" percent="100.00"/>
+          <branches count="0" tested="0" percent="0"/>
           <methods count="1" tested="1" percent="100.00"/>
           <functions count="0" tested="0" percent="0"/>
           <classes count="1" tested="1" percent="100.00"/>

diff --git a/...ML/CoverageForClassWithAnonymousFunction/source_with_class_and_anonymous_function.php.xml b/...ML/CoverageForClassWithAnonymousFunction/source_with_class_and_anonymous_function.php.xml
@@ -3,6 +3,7 @@
   <file name="source_with_class_and_anonymous_function.php" path="%e">
     <totals>
       <lines total="20" comments="1" code="19" executable="8" executed="8" percent="100.00"/>
+      <branches count="0" tested="0" percent="0"/>
       <methods count="1" tested="1" percent="100.00"/>
       <functions count="0" tested="0" percent="0"/>
       <classes count="1" tested="1" percent="100.00"/>

diff --git a/tests/_files/Report/XML/CoverageForFileWithIgnoredLines/index.xml b/tests/_files/Report/XML/CoverageForFileWithIgnoredLines/index.xml
@@ -11,6 +11,7 @@
     <directory name="%s">
       <totals>
         <lines total="43" comments="11" code="32" executable="1" executed="1" percent="100.00"/>
+        <branches count="0" tested="0" percent="0"/>
         <methods count="0" tested="0" percent="0"/>
         <functions count="1" tested="1" percent="100.00"/>
         <classes count="0" tested="0" percent="0"/>
@@ -19,6 +20,7 @@
       <file name="source_with_ignore.php" href="source_with_ignore.php.xml">
         <totals>
           <lines total="43" comments="11" code="32" executable="1" executed="1" percent="100.00"/>
+          <branches count="0" tested="0" percent="0"/>
           <methods count="0" tested="0" percent="0"/>
           <functions count="1" tested="1" percent="100.00"/>
           <classes count="0" tested="0" percent="0"/>

diff --git a/tests/_files/Report/XML/CoverageForFileWithIgnoredLines/source_with_ignore.php.xml b/tests/_files/Report/XML/CoverageForFileWithIgnoredLines/source_with_ignore.php.xml
@@ -3,6 +3,7 @@
   <file name="source_with_ignore.php" path="%e">
     <totals>
       <lines total="43" comments="11" code="32" executable="1" executed="1" percent="100.00"/>
+      <branches count="0" tested="0" percent="0"/>
       <methods count="0" tested="0" percent="0"/>
       <functions count="1" tested="1" percent="100.00"/>
       <classes count="0" tested="0" percent="0"/>