Skip to content

Commit 1fdfa35

Browse files
williamjallenwilliamjallen
authored
Revamp coverage file UI (#3108)
The current UI for viewing individual coverage files is outdated, the technical implementation is poor for a multitude of reasons, and branch coverage is currently entirely broken. This PR completely replaces the page with a brand new Vue-based UI. Before: <img width="2754" height="1064" alt="image" src="https://github.com/user-attachments/assets/6154ae96-2268-435d-abd1-b01ba58fc6d1" /> After: <img width="2736" height="1136" alt="image" src="https://github.com/user-attachments/assets/b144cd44-e49c-415a-8a44-b2bb919960dc" /> <img width="2774" height="1140" alt="image" src="https://github.com/user-attachments/assets/b2598034-81f1-4e71-90f9-f59d5ee3aaf1" />
1 parent 84b3f1b commit 1fdfa35

15 files changed

Lines changed: 416 additions & 193 deletions

File tree

‎app/Http/Controllers/CoverageController.php‎

Lines changed: 2 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,7 @@
88
use App\Utils\TestingDay;
99
use CDash\Database;
1010
use CDash\Model\Build;
11-
use CDash\Model\CoverageFile;
12-
use CDash\Model\CoverageFileLog;
1311
use CDash\Model\Project;
14-
use Exception;
1512
use Illuminate\Http\JsonResponse;
1613
use Illuminate\Http\RedirectResponse;
1714
use Illuminate\Support\Facades\Auth;
@@ -455,98 +452,6 @@ public function viewCoverage(): View|RedirectResponse
455452
->with('xsl_content', generate_XSLT($xml, 'viewCoverage', true));
456453
}
457454

458-
public function viewCoverageFile(): View
459-
{
460-
$this->setBuildById(intval($_GET['buildid'] ?? 0));
461-
462-
$fileid = intval($_GET['fileid'] ?? 0);
463-
464-
$db = Database::getInstance();
465-
466-
$role = 0;
467-
$user2project = $db->executePreparedSingleRow('
468-
SELECT role
469-
FROM user2project
470-
WHERE
471-
userid=?
472-
AND projectid=?
473-
', [intval(Auth::id() ?? 0), $this->project->Id]);
474-
if (!empty($user2project)) {
475-
$role = $user2project['role'];
476-
}
477-
if (!$this->project->ShowCoverageCode && $role < 2) {
478-
abort(403, "This project doesn't allow display of coverage code. Contact the administrator of the project.");
479-
}
480-
481-
// Load coverage file.
482-
$coverageFile = new CoverageFile();
483-
$coverageFile->Id = $fileid;
484-
$coverageFile->Load();
485-
486-
// Split on all forms of line breaks
487-
$file_array = preg_split('/\R/', rtrim($coverageFile->File));
488-
if ($file_array === false) {
489-
throw new Exception('Error parsing coverage file.');
490-
}
491-
$i = 0;
492-
493-
// Load the coverage info.
494-
$log = new CoverageFileLog();
495-
$log->BuildId = $this->build->Id;
496-
$log->FileId = $fileid;
497-
$log->Load();
498-
499-
// Detect if we have branch coverage or not.
500-
$hasBranchCoverage = false;
501-
if (!empty($log->Branches)) {
502-
$hasBranchCoverage = true;
503-
}
504-
505-
foreach ($file_array as $line) {
506-
$linenumber = $i + 1;
507-
$line = htmlentities($line);
508-
509-
$file_array[$i] = '<span class="warning">' . str_pad(strval($linenumber), 5, ' ', STR_PAD_LEFT) . '</span>';
510-
511-
if ($hasBranchCoverage) {
512-
if (array_key_exists("$i", $log->Branches)) {
513-
$code = $log->Branches["$i"];
514-
515-
// Branch coverage data is stored as <# covered> / <total branches>.
516-
$branchCoverageData = explode('/', $code);
517-
if ($branchCoverageData[0] != $branchCoverageData[1]) {
518-
$file_array[$i] .= '<span class="error">';
519-
} else {
520-
$file_array[$i] .= '<span class="normal">';
521-
}
522-
$file_array[$i] .= str_pad($code, 5, ' ', STR_PAD_LEFT) . '</span>';
523-
} else {
524-
$file_array[$i] .= str_pad('', 5, ' ', STR_PAD_LEFT);
525-
}
526-
}
527-
528-
if (array_key_exists($i, $log->Lines)) {
529-
$code = $log->Lines[$i];
530-
if ($code == 0) {
531-
$file_array[$i] .= '<span class="error">';
532-
} else {
533-
$file_array[$i] .= '<span class="normal">';
534-
}
535-
$file_array[$i] .= str_pad($code, 5, ' ', STR_PAD_LEFT) . ' | ' . $line;
536-
$file_array[$i] .= '</span>';
537-
} else {
538-
$file_array[$i] .= str_pad('', 5, ' ', STR_PAD_LEFT) . ' | ' . $line;
539-
}
540-
$i++;
541-
}
542-
543-
$file = implode('<br>', $file_array);
544-
545-
return $this->view('coverage.coverage-file', 'Coverage')
546-
->with('coverage_file', $coverageFile)
547-
->with('log', $file);
548-
}
549-
550455
public function ajaxGetViewCoverage(): JsonResponse
551456
{
552457
@set_time_limit(0);
@@ -663,7 +568,7 @@ public function ajaxGetViewCoverage(): JsonResponse
663568
$coveragefile = $db->executePrepared("
664569
SELECT
665570
cf.fullpath,
666-
c.fileid,
571+
c.id AS fileid,
667572
c.locuntested,
668573
c.loctested,
669574
c.branchestested,
@@ -914,7 +819,7 @@ public function ajaxGetViewCoverage(): JsonResponse
914819
} elseif (!$covfile['covered'] || !($this->project->ShowCoverageCode || $role >= EloquentProject::PROJECT_ADMIN)) {
915820
$row[] = $covfile['fullpath'];
916821
} else {
917-
$row[] = '<a class="cdash-link" href="viewCoverageFile.php?buildid=' . $this->build->Id . '&#38;fileid=' . $covfile['fileid'] . '">' . $covfile['fullpath'] . '</a>';
822+
$row[] = '<a class="cdash-link" href="' . url('/builds/' . $this->build->Id . '/coverage/' . $covfile['fileid']) . '">' . $covfile['fullpath'] . '</a>';
918823
}
919824

920825
// Second column (Status)

‎app/Http/Controllers/CoverageFileController.php‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?php
2+
3+
namespace App\Http\Controllers;
4+
5+
use Illuminate\Http\Request;
6+
use Illuminate\View\View;
7+
8+
final class CoverageFileController extends AbstractBuildController
9+
{
10+
public function __invoke(Request $request, int $build_id, int $file_id): View
11+
{
12+
$this->setBuildById($build_id);
13+
14+
return $this->vue('coverage-file-page', 'Coverage', [
15+
'build-id' => $this->build->Id,
16+
'file-id' => $file_id,
17+
]);
18+
}
19+
}

‎app/cdash/tests/test_branchcoverage.php‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -133,13 +133,6 @@ protected function verifyResults()
133133
AND cf.fullpath = './MathFunctions/mysqrt.cxx'");
134134
$fileid = $fileid_result[0]->fileid;
135135

136-
// Make sure branch coverage is being displayed properly.
137-
$content = $this->get($this->url . "/viewCoverageFile.php?buildid=$this->buildid&fileid=$fileid");
138-
if (!str_contains($content, '<span class="error"> 1/2</span><span class="normal"> 7 | if (x &lt;= 0)</span>')) {
139-
$this->fail('\"<span class="error"> 1/2</span><span class="normal"> 7 | if (x &lt;= 0)</span>\" not found when expected');
140-
return 1;
141-
}
142-
143136
// Make sure our uncovered results also made it into the database.
144137
$row = DB::select(
145138
"SELECT loctested, locuntested FROM coverage

‎app/cdash/tests/test_multicoverage.php‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -135,11 +135,7 @@ public function verifyResults()
135135
}
136136

137137
// Make sure branch coverage is being displayed properly.
138-
$content = $this->get($this->url . "/viewCoverageFile.php?buildid=$this->BuildId&fileid=$fileid");
139-
if (!str_contains($content, '<span class="error"> 1/2</span><span class="normal"> 2 | if (i == 0)</span>')) {
140-
$this->fail('\"<span class="error"> 1/2</span><span class="normal"> 2 | if (i == 0)</span>\" not found when expected');
141-
return 1;
142-
}
138+
$this->get($this->url . "/builds/$this->BuildId/coverage/$fileid");
143139
break;
144140

145141
case './bar.py':

‎app/cdash/tests/test_projectwebpage.php‎

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -104,27 +104,8 @@ public function testSubmissionInsightCoverageLog(): void
104104
$buildid = $jsonobj['coverages'][0]['buildid'];
105105

106106
// Verify coverage log.
107-
$content = $this->connect($this->url . '/ajax/getviewcoverage.php?sEcho=1&iColumns=6&sColumns=&iDisplayStart=0&iDisplayLength=25&mDataProp_0=0&mDataProp_1=1&mDataProp_2=2&mDataProp_3=3&mDataProp_4=4&mDataProp_5=5&sSearch=&bRegex=false&sSearch_0=&bRegex_0=false&bSearchable_0=true&sSearch_1=&bRegex_1=false&bSearchable_1=true&sSearch_2=&bRegex_2=false&bSearchable_2=true&sSearch_3=&bRegex_3=false&bSearchable_3=true&sSearch_4=&bRegex_4=false&bSearchable_4=true&sSearch_5=&bRegex_5=false&bSearchable_5=true&iSortCol_0=2&sSortDir_0=asc&iSortingCols=1&bSortable_0=true&bSortable_1=true&bSortable_2=true&bSortable_3=true&bSortable_4=true&bSortable_5=true&buildid=' . $buildid . '&status=4&nlow=2&nmedium=3&nsatisfactory=43&ncomplete=32&metricerror=0.49&metricpass=0.7&userid=1&displaylabels=0');
107+
$this->connect($this->url . '/ajax/getviewcoverage.php?sEcho=1&iColumns=6&sColumns=&iDisplayStart=0&iDisplayLength=25&mDataProp_0=0&mDataProp_1=1&mDataProp_2=2&mDataProp_3=3&mDataProp_4=4&mDataProp_5=5&sSearch=&bRegex=false&sSearch_0=&bRegex_0=false&bSearchable_0=true&sSearch_1=&bRegex_1=false&bSearchable_1=true&sSearch_2=&bRegex_2=false&bSearchable_2=true&sSearch_3=&bRegex_3=false&bSearchable_3=true&sSearch_4=&bRegex_4=false&bSearchable_4=true&sSearch_5=&bRegex_5=false&bSearchable_5=true&iSortCol_0=2&sSortDir_0=asc&iSortingCols=1&bSortable_0=true&bSortable_1=true&bSortable_2=true&bSortable_3=true&bSortable_4=true&bSortable_5=true&buildid=' . $buildid . '&status=4&nlow=2&nmedium=3&nsatisfactory=43&ncomplete=32&metricerror=0.49&metricpass=0.7&userid=1&displaylabels=0');
108108

109-
$jsonobj = json_decode($content, true);
110-
// Find specific fileid in response.
111-
$url = null;
112-
foreach ($jsonobj['aaData'] as $row) {
113-
if (str_contains($row[0], 'itkCannyEdgesDistanceAdvectionFieldFeatureGenerator.h')) {
114-
$url = substr($row[0], 28, 43);
115-
}
116-
}
117-
if ($url === null) {
118-
$this->fail('Failed to find specific coverage file');
119-
}
120-
$url = str_replace('&#38;', '&', $url);
121-
$content = $this->connect($this->url . '/' . $url);
122-
$expected = '<span class="normal"> 1 | #ifndef __itkNormalVectorDiffusionFunction_txx</span><br><span class="warning"> 18</span><span class="normal"> 2 | #define __itkNormalVectorDiffusionFunction_txx</span>';
123-
124-
if (!$this->findString($content, $expected)) {
125-
$this->fail('Coverage log is wrong');
126-
return;
127-
}
128109
$this->assertTrue(true, "Submission of $file has succeeded");
129110
}
130111

‎package-lock.json‎

Lines changed: 47 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
},
1919
"dependencies": {
2020
"@apollo/client": "^3.13.9",
21+
"@codemirror/state": "^6.5.2",
22+
"@codemirror/view": "^6.38.1",
2123
"@fortawesome/fontawesome-svg-core": "^7.0.0",
2224
"@fortawesome/free-brands-svg-icons": "^7.0.0",
2325
"@fortawesome/free-regular-svg-icons": "^7.0.0",

0 commit comments

Comments
 (0)