Add support for build error links when project not repo root (#3633)

williamjallen · web-flow · commit 280037c0944f · 2026-04-10T20:15:20.000Z
Not all projects have the root of their CMake project at the root of the
repository. CDash currently assumes the project is at the top level of
the repository, meaning that all build error links are broken for
projects where this is not the case. This PR adds the ability to specify
the repository-relative path to the top-level CMakeLists.txt.
diff --git a/app/Http/Controllers/BuildController.php b/app/Http/Controllers/BuildController.php
@@ -34,10 +34,13 @@ public function build(Request $request, int $build_id): View
     {
         $this->setBuildById($build_id);
 
+        $project = Project::findOrFail((int) $this->project->Id);
+
         $params = [
             'build-id' => $this->build->Id,
-            'repository-type' => $this->project->CvsViewerType,
-            'repository-url' => $this->project->CvsUrl,
+            'repository-type' => $project->cvsviewertype,
+            'repository-url' => $project->cvsurl,
+            'repository-cmake-project-root' => $project->cmakeprojectroot,
         ];
 
         $onlyNewErrors = $request->has('onlydeltap');
diff --git a/app/Models/Project.php b/app/Models/Project.php
@@ -49,6 +49,7 @@
  * @property ?string $ldapfilter
  * @property ?string $banner
  * @property ?string $logoUrl
+ * @property ?string $cmakeprojectroot
  *
  * @method Builder<Project> forUser()
  * @method Builder<Project> administeredByUser()
@@ -97,6 +98,7 @@ class Project extends Model
         'viewsubprojectslink',
         'ldapfilter',
         'banner',
+        'cmakeprojectroot',
     ];
 
     protected $casts = [
diff --git a/database/migrations/2026_04_10_121615_cmake_project_root_option.php b/database/migrations/2026_04_10_121615_cmake_project_root_option.php
@@ -0,0 +1,15 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Support\Facades\DB;
+
+return new class extends Migration {
+    public function up(): void
+    {
+        DB::statement('ALTER TABLE project ADD COLUMN cmakeprojectroot text');
+    }
+
+    public function down(): void
+    {
+    }
+};
diff --git a/graphql/schema.graphql b/graphql/schema.graphql
@@ -214,6 +214,9 @@ type Project {
   "Example: https://github.com/Kitware/CDash"
   vcsUrl: Url @rename(attribute: "cvsurl")
 
+  "Relative path to the root of the CMake project in the repository."
+  cmakeProjectRoot: String @rename(attribute: "cmakeprojectroot")
+
   bugTracker: BugTracker @rename(attribute: "bugtrackertype")
 
   "Example: https://github.com/Kitware/CDash/issues"
@@ -420,6 +423,8 @@ input UpdateProjectInput @validator {
 
   vcsUrl: Url @rename(attribute: "cvsurl")
 
+  cmakeProjectRoot: String @rename(attribute: "cmakeprojectroot")
+
   bugTracker: BugTracker @rename(attribute: "bugtrackertype")
 
   bugTrackerUrl: Url @rename(attribute: "bugtrackerurl")
diff --git a/resources/js/vue/components/BuildBuildPage.vue b/resources/js/vue/components/BuildBuildPage.vue
@@ -104,6 +104,7 @@
                 :show-fixed-errors="showFixedErrors"
                 :repository-type="repositoryType"
                 :repository-url="repositoryUrl"
+                :repository-cmake-project-root="repositoryCmakeProjectRoot"
               />
             </div>
           </details>
@@ -116,6 +117,7 @@
             :show-fixed-errors="showFixedErrors"
             :repository-type="repositoryType"
             :repository-url="repositoryUrl"
+            :repository-cmake-project-root="repositoryCmakeProjectRoot"
           />
         </div>
       </loading-indicator>
@@ -200,6 +202,11 @@ export default {
       type: [String, null],
       required: true,
     },
+
+    repositoryCmakeProjectRoot: {
+      type: [String, null],
+      required: true,
+    },
   },
 
   apollo: {
diff --git a/resources/js/vue/components/BuildBuildPage/BuildErrorItem.vue b/resources/js/vue/components/BuildBuildPage/BuildErrorItem.vue
@@ -129,6 +129,11 @@ export default {
       required: true,
     },
 
+    repositoryCmakeProjectRoot: {
+      type: [String, null],
+      required: true,
+    },
+
     revision: {
       type: String,
       required: false,
@@ -174,7 +179,7 @@ export default {
       ];
 
       const matches = text.match(new RegExp(`(${regexPrefixes.join('|')})[^:]*:[0-9]+:[0-9]+`, 'g'));
-      const repository = getRepository(this.repositoryType, this.repositoryUrl);
+      const repository = getRepository(this.repositoryType, this.repositoryUrl, this.repositoryCmakeProjectRoot);
 
       if (!repository || !matches) {
         return new Map();
diff --git a/resources/js/vue/components/BuildBuildPage/BuildErrorList.vue b/resources/js/vue/components/BuildBuildPage/BuildErrorList.vue
@@ -25,6 +25,7 @@
               :source-directory="build.sourceDirectory"
               :repository-type="repositoryType"
               :repository-url="repositoryUrl"
+              :repository-cmake-project-root="repositoryCmakeProjectRoot"
               :revision="build.updateStep?.revision"
             />
           </div>
@@ -48,6 +49,7 @@
               :source-directory="build.sourceDirectory"
               :repository-type="repositoryType"
               :repository-url="repositoryUrl"
+              :repository-cmake-project-root="repositoryCmakeProjectRoot"
               :revision="build.updateStep?.revision"
             />
           </div>
@@ -153,6 +155,11 @@ export default {
       type: [String, null],
       required: true,
     },
+
+    repositoryCmakeProjectRoot: {
+      type: [String, null],
+      required: true,
+    },
   },
 
   apollo: {
diff --git a/resources/js/vue/components/ProjectSettings/GeneralTab.vue b/resources/js/vue/components/ProjectSettings/GeneralTab.vue
@@ -253,6 +253,14 @@
             placeholder="https://example.com"
             test-id="vcs-url-input"
           />
+
+          <InputField
+            v-model="form.cmakeProjectRoot"
+            :validation-error="validationErrors?.cmakeProjectRoot?.[0]"
+            label="CMake Project Root "
+            placeholder="/src"
+            test-id="cmake-project-root-input"
+          />
         </div>
 
         <div class="tw-flex tw-flex-row tw-gap-4">
@@ -519,6 +527,7 @@ export default {
         homeUrl: '',
         vcsViewer: null,
         vcsUrl: '',
+        cmakeProjectRoot: '',
         bugTracker: null,
         bugTrackerUrl: '',
         bugTrackerNewIssueUrl: '',
@@ -562,6 +571,7 @@ export default {
             homeUrl
             vcsViewer
             vcsUrl
+            cmakeProjectRoot
             bugTracker
             bugTrackerUrl
             bugTrackerNewIssueUrl
diff --git a/resources/js/vue/components/shared/RepositoryIntegrations.js b/resources/js/vue/components/shared/RepositoryIntegrations.js
@@ -4,12 +4,15 @@
  * @param {...String} components
  */
 function makeUrlFromComponents(...components) {
-  return components.map(part => part.replace(/\/+$/, '')).join('/');
+  return components.filter(component => component !== null)
+    .map(part => part.replace(/\/+$|^\/+/, ''))
+    .join('/');
 }
 
 export class Repository {
-  constructor(repositoryUrl) {
+  constructor(repositoryUrl, repositoryCmakeProjectRoot) {
     this.repositoryUrl = repositoryUrl;
+    this.repositoryCmakeProjectRoot = repositoryCmakeProjectRoot;
   }
 
   /**
@@ -49,7 +52,7 @@ export class GitHub extends Repository {
   }
 
   getFileUrl(commit, path) {
-    return makeUrlFromComponents(this.repositoryUrl, 'blob', commit, path);
+    return makeUrlFromComponents(this.repositoryUrl, 'blob', commit, this.repositoryCmakeProjectRoot, path);
   }
 }
 
@@ -62,21 +65,22 @@ export class GitLab extends Repository {
     return makeUrlFromComponents(this.repositoryUrl, '-', 'compare', `${commit1}...${commit2}`);
   }
   getFileUrl(commit, path) {
-    return makeUrlFromComponents(this.repositoryUrl, '-', 'blob', commit, path);
+    return makeUrlFromComponents(this.repositoryUrl, '-', 'blob', commit, this.repositoryCmakeProjectRoot, path);
   }
 }
 
 /**
  * @param {String} repositoryType
  * @param {String} repositoryUrl
+ * @param {String} repositoryCmakeProjectRoot
  * @return ?Repository
  */
-export function getRepository(repositoryType, repositoryUrl) {
+export function getRepository(repositoryType, repositoryUrl, repositoryCmakeProjectRoot) {
   switch (repositoryType.toLowerCase()) {
   case 'github':
-    return new GitHub(repositoryUrl);
+    return new GitHub(repositoryUrl, repositoryCmakeProjectRoot);
   case 'gitlab':
-    return new GitLab(repositoryUrl);
+    return new GitLab(repositoryUrl, repositoryCmakeProjectRoot);
   default:
     return null;
   }
diff --git a/tests/Browser/Pages/BuildBuildPageTest.php b/tests/Browser/Pages/BuildBuildPageTest.php
@@ -364,6 +364,41 @@ public function testLinksToMainBranchWhenRepositoryConfiguredAndNoUpdateStep():
         });
     }
 
+    public function testLinksCorrectlyWhenNotRootOfRepository(): void
+    {
+        $this->project->cvsviewertype = 'github';
+        $this->project->cvsurl = 'https://example.com/org/repo';
+        $this->project->cmakeprojectroot = '/source';
+        $this->project->save();
+
+        $stdOutPart1 = Str::uuid()->toString();
+        $stdOutPart2 = Str::uuid()->toString();
+        $sourceDirectory = '/absolute/path/to/source';
+        $filePath = $sourceDirectory . '/foo/bar.cpp:10:20';
+
+        /** @var Build $build */
+        $build = $this->project->builds()->create([
+            'siteid' => $this->site->id,
+            'name' => Str::uuid()->toString(),
+            'uuid' => Str::uuid()->toString(),
+            'sourcedirectory' => $sourceDirectory,
+        ]);
+
+        $build->buildErrors()->save(BuildError::factory()->make([
+            'stdoutput' => $stdOutPart1 . $filePath . $stdOutPart2,
+        ]));
+
+        $this->browse(function (Browser $browser) use ($filePath, $stdOutPart2, $stdOutPart1, $build): void {
+            $browser->visit("/builds/{$build->id}/build")
+                ->waitForText('1 ERROR')
+                ->assertSee($stdOutPart1)
+                ->assertSee($stdOutPart2)
+                ->assertSeeLink($filePath)
+                ->assertPresent('a[href="https://example.com/org/repo/blob/main/source/foo/bar.cpp"]')
+            ;
+        });
+    }
+
     public function testLinksToUpdateRevisionWhenRepositoryConfiguredAndHasUpdateStep(): void
     {
         $this->project->cvsviewertype = 'github';
diff --git a/tests/Browser/Pages/ProjectSettingsPageTest.php b/tests/Browser/Pages/ProjectSettingsPageTest.php
@@ -100,6 +100,7 @@ public static function canChangeGeneralTabFieldCases(): array
         $documentationurl = fake()->url();
         $testdataurl = fake()->url();
         $vcsurl = fake()->url();
+        $cmakeprojectroot = Str::uuid()->toString();
         $bugtrackerurl = fake()->url();
         $bugtrackernewissueurl = fake()->url();
         $emailmaxitems = fake()->numberBetween(1, 100);
@@ -138,6 +139,8 @@ public static function canChangeGeneralTabFieldCases(): array
             ['@vcs-viewer-input', 'GITLAB', 'cvsviewertype', 'gitlab', 'select'],
             ['@vcs-url-input', $vcsurl, 'cvsurl', $vcsurl, 'string'],
             ['@vcs-url-input', '', 'cvsurl', null, 'string'],
+            ['@cmake-project-root-input', $cmakeprojectroot, 'cmakeprojectroot', $cmakeprojectroot, 'string'],
+            ['@cmake-project-root-input', '', 'cmakeprojectroot', null, 'string'],
             ['@bug-tracker-input', 'None', 'bugtrackertype', null, 'select'],
             ['@bug-tracker-input', 'GITHUB', 'bugtrackertype', 'GitHub', 'select'],
             ['@bug-tracker-input', 'JIRA', 'bugtrackertype', 'JIRA', 'select'],
diff --git a/tests/Feature/GraphQL/Mutations/UpdateProjectTest.php b/tests/Feature/GraphQL/Mutations/UpdateProjectTest.php
@@ -181,6 +181,7 @@ public static function fieldValues(): array
             ['homeUrl', 'https://kitware.com', 'homeurl', 'https://kitware.com'],
             ['vcsViewer', 'GITLAB', 'cvsviewertype', 'gitlab'],
             ['vcsUrl', 'https://gitlab.kitware.com/kitware/cdash', 'cvsurl', 'https://gitlab.kitware.com/kitware/cdash'],
+            ['cmakeProjectRoot', '/abc', 'cmakeprojectroot', '/abc'],
             ['bugTracker', 'JIRA', 'bugtrackertype', 'JIRA'],
             ['bugTrackerUrl', 'https://jira.kitware.com', 'bugtrackerurl', 'https://jira.kitware.com'],
             ['bugTrackerNewIssueUrl', 'https://jira.kitware.com/new', 'bugtrackernewissueurl', 'https://jira.kitware.com/new'],
diff --git a/tests/Feature/GraphQL/ProjectTypeTest.php b/tests/Feature/GraphQL/ProjectTypeTest.php
@@ -125,6 +125,8 @@ public static function fieldValues(): array
             ...$vcsViewerValues,
             ['cvsurl', 'https://github.com/Kitware/CDash', 'vcsUrl', 'https://github.com/Kitware/CDash'],
             ['cvsurl', null, 'vcsUrl', null],
+            ['cmakeprojectroot', '/abc', 'cmakeProjectRoot', '/abc'],
+            ['cmakeprojectroot', null, 'cmakeProjectRoot', null],
             ...$bugTrackerValues,
             ['bugtrackerurl', 'https://github.com/Kitware/CDash/issues', 'bugTrackerUrl', 'https://github.com/Kitware/CDash/issues'],
             ['bugtrackerurl', null, 'bugTrackerUrl', null],
diff --git a/tests/Spec/repository-integrations.spec.js b/tests/Spec/repository-integrations.spec.js
@@ -8,31 +8,31 @@ import {
 describe('RepositoryIntegrations', () => {
   describe('getRepository', () => {
     it('returns a GitHub instance for "github" type', () => {
-      const repo = getRepository('github', 'https://github.com/foo/bar');
+      const repo = getRepository('github', 'https://github.com/foo/bar', '');
       expect(repo).toBeInstanceOf(GitHub);
       expect(repo.repositoryUrl).toBe('https://github.com/foo/bar');
     });
 
     it('returns a GitLab instance for "gitlab" type', () => {
-      const repo = getRepository('gitlab', 'https://gitlab.com/foo/bar');
+      const repo = getRepository('gitlab', 'https://gitlab.com/foo/bar', '');
       expect(repo).toBeInstanceOf(GitLab);
       expect(repo.repositoryUrl).toBe('https://gitlab.com/foo/bar');
     });
 
     it('is case insensitive for repository type', () => {
-      const repo = getRepository('GitHub', 'https://github.com/foo/bar');
+      const repo = getRepository('GitHub', 'https://github.com/foo/bar', '');
       expect(repo).toBeInstanceOf(GitHub);
     });
 
     it('returns null for unknown repository types', () => {
-      const repo = getRepository('bitbucket', 'https://bitbucket.org/foo/bar');
+      const repo = getRepository('bitbucket', 'https://bitbucket.org/foo/bar', '');
       expect(repo).toBeNull();
     });
   });
 
   describe('GitHub', () => {
     const repoUrl = 'https://github.com/foo/bar';
-    const repo = new GitHub(repoUrl);
+    const repo = new GitHub(repoUrl, '/src');
 
     it('generates correct commit URL', () => {
       const commit = 'abcdef123456';
@@ -47,20 +47,20 @@ describe('RepositoryIntegrations', () => {
 
     it('generates correct file URL', () => {
       const commit = 'abcdef123456';
-      const path = 'src/main.cpp';
-      expect(repo.getFileUrl(commit, path)).toBe(`${repoUrl}/blob/${commit}/${path}`);
+      const path = 'main.cpp';
+      expect(repo.getFileUrl(commit, path, '')).toBe(`${repoUrl}/blob/${commit}/src/${path}`);
     });
 
     it('handles trailing slashes in repository URL', () => {
-      const repoWithSlash = new GitHub('https://github.com/foo/bar/');
+      const repoWithSlash = new GitHub('https://github.com/foo/bar/', '');
       const commit = '123';
       expect(repoWithSlash.getCommitUrl(commit)).toBe('https://github.com/foo/bar/commit/123');
     });
   });
 
   describe('GitLab', () => {
     const repoUrl = 'https://gitlab.com/foo/bar';
-    const repo = new GitLab(repoUrl);
+    const repo = new GitLab(repoUrl, '/src');
 
     it('generates correct commit URL', () => {
       const commit = 'abcdef123456';
@@ -75,12 +75,12 @@ describe('RepositoryIntegrations', () => {
 
     it('generates correct file URL', () => {
       const commit = 'abcdef123456';
-      const path = 'src/main.cpp';
-      expect(repo.getFileUrl(commit, path)).toBe(`${repoUrl}/-/blob/${commit}/${path}`);
+      const path = 'main.cpp';
+      expect(repo.getFileUrl(commit, path, '')).toBe(`${repoUrl}/-/blob/${commit}/src/${path}`);
     });
 
     it('handles trailing slashes in repository URL', () => {
-      const repoWithSlash = new GitLab('https://gitlab.com/foo/bar/');
+      const repoWithSlash = new GitLab('https://gitlab.com/foo/bar/', '');
       const commit = '123';
       expect(repoWithSlash.getCommitUrl(commit)).toBe('https://gitlab.com/foo/bar/-/commit/123');
     });

Original file line number	Diff line number	Diff line change
`@@ -4,12 +4,15 @@`
`4`	`4`	`* @param {...String} components`
`5`	`5`	`*/`
`6`	`6`	`function makeUrlFromComponents(...components) {`
`7`		`- return components.map(part => part.replace(/\/+$/, '')).join('/');`
	`7`	`+ return components.filter(component => component !== null)`
	`8`	`+ .map(part => part.replace(/\/+$\|^\/+/, ''))`
	`9`	`+ .join('/');`
`8`	`10`	`}`
`9`	`11`
`10`	`12`	`export class Repository {`
`11`		`- constructor(repositoryUrl) {`
	`13`	`+ constructor(repositoryUrl, repositoryCmakeProjectRoot) {`
`12`	`14`	`this.repositoryUrl = repositoryUrl;`
	`15`	`+ this.repositoryCmakeProjectRoot = repositoryCmakeProjectRoot;`
`13`	`16`	`}`
`14`	`17`
`15`	`18`	`/**`
`@@ -49,7 +52,7 @@ export class GitHub extends Repository {`
`49`	`52`	`}`
`50`	`53`
`51`	`54`	`getFileUrl(commit, path) {`
`52`		`- return makeUrlFromComponents(this.repositoryUrl, 'blob', commit, path);`
	`55`	`+ return makeUrlFromComponents(this.repositoryUrl, 'blob', commit, this.repositoryCmakeProjectRoot, path);`
`53`	`56`	`}`
`54`	`57`	`}`
`55`	`58`
`@@ -62,21 +65,22 @@ export class GitLab extends Repository {`
`62`	`65`	return makeUrlFromComponents(this.repositoryUrl, '-', 'compare', `${commit1}...${commit2}`);
`63`	`66`	`}`
`64`	`67`	`getFileUrl(commit, path) {`
`65`		`- return makeUrlFromComponents(this.repositoryUrl, '-', 'blob', commit, path);`
	`68`	`+ return makeUrlFromComponents(this.repositoryUrl, '-', 'blob', commit, this.repositoryCmakeProjectRoot, path);`
`66`	`69`	`}`
`67`	`70`	`}`
`68`	`71`
`69`	`72`	`/**`
`70`	`73`	`* @param {String} repositoryType`
`71`	`74`	`* @param {String} repositoryUrl`
	`75`	`+ * @param {String} repositoryCmakeProjectRoot`
`72`	`76`	`* @return ?Repository`
`73`	`77`	`*/`
`74`		`-export function getRepository(repositoryType, repositoryUrl) {`
	`78`	`+export function getRepository(repositoryType, repositoryUrl, repositoryCmakeProjectRoot) {`
`75`	`79`	`switch (repositoryType.toLowerCase()) {`
`76`	`80`	`case 'github':`
`77`		`- return new GitHub(repositoryUrl);`
	`81`	`+ return new GitHub(repositoryUrl, repositoryCmakeProjectRoot);`
`78`	`82`	`case 'gitlab':`
`79`		`- return new GitLab(repositoryUrl);`
	`83`	`+ return new GitLab(repositoryUrl, repositoryCmakeProjectRoot);`
`80`	`84`	`default:`
`81`	`85`	`return null;`
`82`	`86`	`}`