Even more experimentation with how branch and path coverage is presented

Author: sebastianbergmann

src/Report/Html/Renderer/File.php

@@ -655,14 +655,10 @@ private function renderSourceWithBranchCoverage(FileNode $node): string
 
                 if (isset($lineData[$startLine])) {
                     if (!isset($branchStartData[$startLine])) {
-                        $branchStartData[$startLine] = ['total' => 0, 'hit' => 0];
+                        $branchStartData[$startLine] = [];
                     }
 
-                    $branchStartData[$startLine]['total']++;
-
-                    if ($branch->hit !== []) {
-                        $branchStartData[$startLine]['hit']++;
-                    }
+                    $branchStartData[$startLine][] = $branch->hit !== [];
                 }
 
                 foreach (range($branch->line_start, $branch->line_end) as $line) {
@@ -700,8 +696,16 @@ private function renderSourceWithBranchCoverage(FileNode $node): string
                     $lineCss = 'warning';
                 }
 
-                if (isset($branchStartData[$i]) && $branchStartData[$i]['total'] > 1) {
-                    $coverageCount = $branchStartData[$i]['hit'] . '/' . $branchStartData[$i]['total'];
+                if (isset($branchStartData[$i]) && count($branchStartData[$i]) > 1) {
+                    $markers = '';
+
+                    foreach ($branchStartData[$i] as $isHit) {
+                        $markers .= $isHit
+                            ? '<span class="branch-hit">&bull;</span>'
+                            : '<span class="branch-miss">&bull;</span>';
+                    }
+
+                    $coverageCount = $markers;
                 }
 
                 $popoverContent = '<ul>';
@@ -846,7 +850,23 @@ private function renderBranchStructure(FileNode $node): string
                 continue;
             }
 
-            $branches .= '<h5 class="structure-heading"><a name="' . htmlspecialchars($methodName, self::HTML_SPECIAL_CHARS_FLAGS) . '">' . $this->abbreviateMethodName($methodName) . '</a></h5>' . "\n";
+            $branchCount    = count($methodData->branches);
+            $hitBranchCount = 0;
+
+            foreach ($methodData->branches as $branch) {
+                if ($branch->hit !== []) {
+                    $hitBranchCount++;
+                }
+            }
+
+            $badge = sprintf(
+                ' <span class="%s">%d/%d</span>',
+                $hitBranchCount === $branchCount ? 'success' : ($hitBranchCount === 0 ? 'danger' : 'warning'),
+                $hitBranchCount,
+                $branchCount,
+            );
+
+            $branches .= '<h5 class="structure-heading"><a name="' . htmlspecialchars($methodName, self::HTML_SPECIAL_CHARS_FLAGS) . '">' . $this->abbreviateMethodName($methodName) . '</a>' . $badge . '</h5>' . "\n";
             $branches .= '<table class="table table-bordered table-sm structure-table">' . "\n";
             $branches .= '<thead><tr><th>#</th><th>Lines</th><th>Status</th><th>Tests</th></tr></thead>' . "\n";
             $branches .= '<tbody>' . "\n";
@@ -923,14 +943,28 @@ private function renderPathStructure(FileNode $node): string
                 continue;
             }
 
-            if (count($methodData->paths) > 100) {
-                $paths .= '<h5 class="structure-heading"><a name="' . htmlspecialchars($methodName, self::HTML_SPECIAL_CHARS_FLAGS) . '">' . $this->abbreviateMethodName($methodName) . '</a></h5>' . "\n";
-                $paths .= '<p>' . count($methodData->paths) . ' is too many paths to sensibly render, consider refactoring your code to bring this number down.</p>';
+            $pathCount    = count($methodData->paths);
+            $hitPathCount = 0;
 
-                continue;
+            foreach ($methodData->paths as $path) {
+                if ($path->hit !== []) {
+                    $hitPathCount++;
+                }
+            }
+
+            $badge = sprintf(
+                ' <span class="%s">%d/%d</span>',
+                $hitPathCount === $pathCount ? 'success' : ($hitPathCount === 0 ? 'danger' : 'warning'),
+                $hitPathCount,
+                $pathCount,
+            );
+
+            $paths .= '<h5 class="structure-heading"><a name="' . htmlspecialchars($methodName, self::HTML_SPECIAL_CHARS_FLAGS) . '">' . $this->abbreviateMethodName($methodName) . '</a>' . $badge . '</h5>' . "\n";
+
+            if ($pathCount > 100) {
+                $paths .= '<details><summary>' . $pathCount . ' paths &mdash; click to expand</summary>' . "\n";
             }
 
-            $paths .= '<h5 class="structure-heading"><a name="' . htmlspecialchars($methodName, self::HTML_SPECIAL_CHARS_FLAGS) . '">' . $this->abbreviateMethodName($methodName) . '</a></h5>' . "\n";
             $paths .= '<table class="table table-bordered table-sm structure-table">' . "\n";
             $paths .= '<thead><tr><th>#</th><th>Branches</th><th>Status</th><th>Tests</th></tr></thead>' . "\n";
             $paths .= '<tbody>' . "\n";
@@ -988,6 +1022,10 @@ private function renderPathStructure(FileNode $node): string
             }
 
             $paths .= '</tbody></table>' . "\n";
+
+            if ($pathCount > 100) {
+                $paths .= '</details>' . "\n";
+            }
         }
 
         $pathsTemplate->setVar(['paths' => $paths]);

src/Report/Html/Renderer/Template/css/style.css

@@ -185,6 +185,16 @@ td.col-0 {
  display: none;
 }
 
+.branch-hit {
+ color: var(--phpunit-success-bar);
+ font-weight: bold;
+}
+
+.branch-miss {
+ color: var(--phpunit-danger-bar);
+ font-weight: bold;
+}
+
 td span.comment {
  color: var(--bs-secondary-color);
 }

tests/_files/Report/HTML/PathCoverageForSourceWithoutNamespace/source_without_namespace.php_branch.html

@@ -166,7 +166,7 @@
     <tr class="danger popin d-flex"><td  data-bs-title="0 tests cover line 12. These are covering 0 out of the 1 code branches." data-bs-content="&lt;ul&gt;&lt;/ul&gt;" data-bs-placement="top" data-bs-html="true" class="col-1 text-end"><a id="12" href="#12">12</a></td><td class="coverage-count"></td><td class="col codeLine"><span class="keyword">function</span><span class="default">&nbsp;</span><span class="default">&amp;</span><span class="default">foo</span><span class="keyword">(</span><span class="default">$bar</span><span class="keyword">)</span></td></tr>
     <tr class="danger popin d-flex"><td  data-bs-title="0 tests cover line 13. These are covering 0 out of the 1 code branches." data-bs-content="&lt;ul&gt;&lt;/ul&gt;" data-bs-placement="top" data-bs-html="true" class="col-1 text-end"><a id="13" href="#13">13</a></td><td class="coverage-count"></td><td class="col codeLine"><span class="keyword">{</span></td></tr>
     <tr class="danger popin d-flex"><td  data-bs-title="0 tests cover line 14. These are covering 0 out of the 2 code branches." data-bs-content="&lt;ul&gt;&lt;/ul&gt;" data-bs-placement="top" data-bs-html="true" class="col-1 text-end"><a id="14" href="#14">14</a></td><td class="coverage-count"></td><td class="col codeLine"><span class="default">&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="default">$baz</span><span class="default">&nbsp;</span><span class="keyword">=</span><span class="default">&nbsp;</span><span class="keyword">function</span><span class="default">&nbsp;</span><span class="keyword">(</span><span class="keyword">)</span><span class="default">&nbsp;</span><span class="keyword">{</span><span class="keyword">}</span><span class="keyword">;</span></td></tr>
-    <tr class="danger popin d-flex"><td  data-bs-title="0 tests cover line 15. These are covering 0 out of the 4 code branches." data-bs-content="&lt;ul&gt;&lt;/ul&gt;" data-bs-placement="top" data-bs-html="true" class="col-1 text-end"><a id="15" href="#15">15</a></td><td class="coverage-count">0/3</td><td class="col codeLine"><span class="default">&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="default">$a</span><span class="default">&nbsp;&nbsp;&nbsp;</span><span class="keyword">=</span><span class="default">&nbsp;</span><span class="default">true</span><span class="default">&nbsp;</span><span class="keyword">?</span><span class="default">&nbsp;</span><span class="default">true</span><span class="default">&nbsp;</span><span class="keyword">:</span><span class="default">&nbsp;</span><span class="default">false</span><span class="keyword">;</span></td></tr>
+    <tr class="danger popin d-flex"><td  data-bs-title="0 tests cover line 15. These are covering 0 out of the 4 code branches." data-bs-content="&lt;ul&gt;&lt;/ul&gt;" data-bs-placement="top" data-bs-html="true" class="col-1 text-end"><a id="15" href="#15">15</a></td><td class="coverage-count"><span class="branch-miss">&bull;</span><span class="branch-miss">&bull;</span><span class="branch-miss">&bull;</span></td><td class="col codeLine"><span class="default">&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="default">$a</span><span class="default">&nbsp;&nbsp;&nbsp;</span><span class="keyword">=</span><span class="default">&nbsp;</span><span class="default">true</span><span class="default">&nbsp;</span><span class="keyword">?</span><span class="default">&nbsp;</span><span class="default">true</span><span class="default">&nbsp;</span><span class="keyword">:</span><span class="default">&nbsp;</span><span class="default">false</span><span class="keyword">;</span></td></tr>
     <tr class="danger popin d-flex"><td  data-bs-title="0 tests cover line 16. These are covering 0 out of the 1 code branches." data-bs-content="&lt;ul&gt;&lt;/ul&gt;" data-bs-placement="top" data-bs-html="true" class="col-1 text-end"><a id="16" href="#16">16</a></td><td class="coverage-count"></td><td class="col codeLine"><span class="default">&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="default">$b</span><span class="default">&nbsp;&nbsp;&nbsp;</span><span class="keyword">=</span><span class="default">&nbsp;</span><span class="string">&quot;</span><span class="string">{</span><span class="string">$a</span><span class="keyword">}</span><span class="string">&quot;</span><span class="keyword">;</span></td></tr>
     <tr class="danger popin d-flex"><td  data-bs-title="0 tests cover line 17. These are covering 0 out of the 1 code branches." data-bs-content="&lt;ul&gt;&lt;/ul&gt;" data-bs-placement="top" data-bs-html="true" class="col-1 text-end"><a id="17" href="#17">17</a></td><td class="coverage-count"></td><td class="col codeLine"><span class="default">&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="default">$c</span><span class="default">&nbsp;&nbsp;&nbsp;</span><span class="keyword">=</span><span class="default">&nbsp;</span><span class="string">&quot;</span><span class="string">${</span><span class="string">b</span><span class="keyword">}</span><span class="string">&quot;</span><span class="keyword">;</span></td></tr>
     <tr class="danger popin d-flex"><td  data-bs-title="0 tests cover line 18. These are covering 0 out of the 1 code branches." data-bs-content="&lt;ul&gt;&lt;/ul&gt;" data-bs-placement="top" data-bs-html="true" class="col-1 text-end"><a id="18" href="#18">18</a></td><td class="coverage-count"></td><td class="col codeLine"><span class="keyword">}</span></td></tr>
@@ -182,7 +182,7 @@ <h4>Branches</h4>
     Please also be aware that some branches may be implicit rather than explicit, e.g. an <code>if</code> statement
     <i>always</i> has an <code>else</code> as part of its logical flow even if you didn't write one.
 </p>
-<h5 class="structure-heading"><a name="foo">foo</a></h5>
+<h5 class="structure-heading"><a name="foo">foo</a> <span class="danger">0/4</span></h5>
 <table class="table table-bordered table-sm structure-table">
 <thead><tr><th>#</th><th>Lines</th><th>Status</th><th>Tests</th></tr></thead>
 <tbody>
@@ -191,13 +191,13 @@ <h5 class="structure-heading"><a name="foo">foo</a></h5>
 <tr class="danger"><td>3</td><td><a href="#15">L15</a></td><td>Not covered</td><td>&mdash;</td></tr>
 <tr class="danger"><td>4</td><td><a href="#15">L15</a>&ndash;<a href="#18">L18</a></td><td>Not covered</td><td>&mdash;</td></tr>
 </tbody></table>
-<h5 class="structure-heading"><a name="{closure:%se.php:14-14}">{closure:%se.php:14-14}</a></h5>
+<h5 class="structure-heading"><a name="{closure:%se.php:14-14}">{closure:%se.php:14-14}</a> <span class="danger">0/1</span></h5>
 <table class="table table-bordered table-sm structure-table">
 <thead><tr><th>#</th><th>Lines</th><th>Status</th><th>Tests</th></tr></thead>
 <tbody>
 <tr class="danger"><td>1</td><td><a href="#14">L14</a></td><td>Not covered</td><td>&mdash;</td></tr>
 </tbody></table>
-<h5 class="structure-heading"><a name="{main}">{main}</a></h5>
+<h5 class="structure-heading"><a name="{main}">{main}</a> <span class="success">1/1</span></h5>
 <table class="table table-bordered table-sm structure-table">
 <thead><tr><th>#</th><th>Lines</th><th>Status</th><th>Tests</th></tr></thead>
 <tbody>

tests/_files/Report/HTML/PathCoverageForSourceWithoutNamespace/source_without_namespace.php_path.html

@@ -182,20 +182,20 @@ <h4>Paths</h4>
     Please also be aware that some paths may include implicit rather than explicit branches, e.g. an <code>if</code> statement
     <i>always</i> has an <code>else</code> as part of its logical flow even if you didn't write one.
 </p>
-<h5 class="structure-heading"><a name="foo">foo</a></h5>
+<h5 class="structure-heading"><a name="foo">foo</a> <span class="danger">0/2</span></h5>
 <table class="table table-bordered table-sm structure-table">
 <thead><tr><th>#</th><th>Branches</th><th>Status</th><th>Tests</th></tr></thead>
 <tbody>
 <tr class="danger"><td>1</td><td><a href="#12">L12</a> &rarr; <a href="#15">L15</a> &rarr; <a href="#15">L15</a></td><td>Not covered</td><td>&mdash;</td></tr>
 <tr class="danger"><td>2</td><td><a href="#12">L12</a> &rarr; <a href="#15">L15</a> &rarr; <a href="#15">L15</a></td><td>Not covered</td><td>&mdash;</td></tr>
 </tbody></table>
-<h5 class="structure-heading"><a name="{closure:%se.php:14-14}">{closure:%se.php:14-14}</a></h5>
+<h5 class="structure-heading"><a name="{closure:%se.php:14-14}">{closure:%se.php:14-14}</a> <span class="danger">0/1</span></h5>
 <table class="table table-bordered table-sm structure-table">
 <thead><tr><th>#</th><th>Branches</th><th>Status</th><th>Tests</th></tr></thead>
 <tbody>
 <tr class="danger"><td>1</td><td><a href="#14">L14</a></td><td>Not covered</td><td>&mdash;</td></tr>
 </tbody></table>
-<h5 class="structure-heading"><a name="{main}">{main}</a></h5>
+<h5 class="structure-heading"><a name="{main}">{main}</a> <span class="success">1/1</span></h5>
 <table class="table table-bordered table-sm structure-table">
 <thead><tr><th>#</th><th>Branches</th><th>Status</th><th>Tests</th></tr></thead>
 <tbody>