feat(gerrit): Add gitUrl support (#42672)

* feat: Gerrit supports gitUrl

This change adds support for the gitUrl parameter to the gerrit platform.

It queries the gerrit server to check what download options are available. If ssh is selected but not available, it will throw an error.

* feat: Gerrit supports gitUrl

This removes support for querying the supported download schemes and
instead hard-codes the default ssh port.

* fix: Review feedback

Addresses feedback left in review:
- constants for ports
- better SSH url creation
- more consistent util method usage

* fix: Review feedback

Addresses feedback left in review:
- Reverts SSH URL creation to ensure coverage target

* fix: Review feedback

Addresses feedback left in review:
- Convert switch statement to if/else
- Move endpointURL check into getGerritResponse

This makes the parse/clone calls unnecessary.

* fix: Review feedback

Addresses feedback left in review:
- Simplify ssh url creation

Author: spmiller

lib/config/options/index.ts

@@ -3247,6 +3247,7 @@ const options: Readonly<RenovateOptions>[] = [
     supportedPlatforms: [
       'bitbucket-server',
       'forgejo',
+      'gerrit',
       'gitea',
       'gitlab',
       'scm-manager',

lib/modules/platform/gerrit/index.ts

@@ -147,7 +147,7 @@ export async function initRepo({
     labels: projectInfo.labels ?? {},
   };
   const baseUrl = defaults.endpoint!;
-  const url = getGerritRepoUrl(repository, baseUrl);
+  const url = getGerritRepoUrl(repository, baseUrl, gitUrl);
   configureScm(repository, config.gerritUsername!);
   await git.initRepo({ url, cloneSubmodules, cloneSubmodulesFilter });
 

lib/modules/platform/gerrit/utils.spec.ts

@@ -24,26 +24,84 @@ describe('modules/platform/gerrit/utils', () => {
   });
 
   describe('getGerritRepoUrl()', () => {
-    it('create a git url with username/password', () => {
-      hostRules.find.mockReturnValue({
-        username: 'abc',
-        password: '123',
+    describe('no gitUrl provided', () => {
+      it('create a git url with username/password', () => {
+        hostRules.find.mockReturnValue({
+          username: 'abc',
+          password: '123',
+        });
+        const repoUrl = utils.getGerritRepoUrl('web/apps', baseUrl, undefined);
+        expect(repoUrl).toBe('https://abc:123@gerrit.example.com/a/web%2Fapps');
+      });
+
+      it('create a git url without username/password', () => {
+        hostRules.find.mockReturnValue({});
+        expect(() =>
+          utils.getGerritRepoUrl('web/apps', baseUrl, undefined),
+        ).toThrow('Init: You must configure a Gerrit Server username/password');
       });
-      const repoUrl = utils.getGerritRepoUrl('web/apps', baseUrl);
-      expect(repoUrl).toBe('https://abc:123@gerrit.example.com/a/web%2Fapps');
-    });
 
-    it('create a git url without username/password', () => {
-      hostRules.find.mockReturnValue({});
-      expect(() => utils.getGerritRepoUrl('web/apps', baseUrl)).toThrow(
-        'Init: You must configure a Gerrit Server username/password',
-      );
+      it('throws on invalid endpoint', () => {
+        expect(() =>
+          utils.getGerritRepoUrl('web/apps', '...', undefined),
+        ).toThrow(Error(CONFIG_GIT_URL_UNAVAILABLE));
+      });
+    });
+    describe('default gitUrl', () => {
+      it('create a git url with username/password', () => {
+        hostRules.find.mockReturnValue({
+          username: 'abc',
+          password: '123',
+        });
+        const repoUrl = utils.getGerritRepoUrl('web/apps', baseUrl, 'default');
+        expect(repoUrl).toBe('https://abc:123@gerrit.example.com/a/web%2Fapps');
+      });
+    });
+    describe('endpoint gitUrl', () => {
+      it('create a git url with username/password', () => {
+        hostRules.find.mockReturnValue({
+          username: 'abc',
+          password: '123',
+        });
+        const repoUrl = utils.getGerritRepoUrl('web/apps', baseUrl, 'endpoint');
+        expect(repoUrl).toBe('https://abc:123@gerrit.example.com/a/web%2Fapps');
+      });
     });
+    describe('ssh gitUrl', () => {
+      it('create a simple url', () => {
+        hostRules.find.mockReturnValue({
+          username: 'abc',
+          password: '123',
+        });
+        const repoUrl = utils.getGerritRepoUrl('web/apps', baseUrl, 'ssh');
+        expect(repoUrl).toBe('ssh://gerrit.example.com:29418/web/apps');
+      });
 
-    it('throws on invalid endpoint', () => {
-      expect(() => utils.getGerritRepoUrl('web/apps', '...')).toThrow(
-        Error(CONFIG_GIT_URL_UNAVAILABLE),
-      );
+      it('create a url with trailing slash', () => {
+        hostRules.find.mockReturnValue({
+          username: 'abc',
+          password: '123',
+        });
+        const repoUrl = utils.getGerritRepoUrl(
+          'web/apps',
+          'https://gerrit.example.com/',
+          'ssh',
+        );
+        expect(repoUrl).toBe('ssh://gerrit.example.com:29418/web/apps');
+      });
+
+      it('create a url when base has context', () => {
+        hostRules.find.mockReturnValue({
+          username: 'abc',
+          password: '123',
+        });
+        const repoUrl = utils.getGerritRepoUrl(
+          'web/apps',
+          'https://gerrit.example.com/context',
+          'ssh',
+        );
+        expect(repoUrl).toBe('ssh://gerrit.example.com:29418/web/apps');
+      });
     });
   });
 

lib/modules/platform/gerrit/utils.ts

@@ -6,7 +6,7 @@ import * as hostRules from '../../../util/host-rules.ts';
 import { regEx } from '../../../util/regex.ts';
 import { joinUrlParts, parseUrl } from '../../../util/url.ts';
 import { hashBody } from '../pr-body.ts';
-import type { Pr } from '../types.ts';
+import type { GitUrlOption, Pr } from '../types.ts';
 import type {
   GerritChange,
   GerritChangeStatus,
@@ -18,6 +18,8 @@ export const MIN_GERRIT_VERSION = '3.0.0';
 
 export const TAG_PULL_REQUEST_BODY = 'pull-request';
 
+const DEFAULT_SSH_PORT = `29418`;
+
 /**
  * Max comment size in Gerrit (16kiB by default)
  * https://gerrit-review.googlesource.com/Documentation/config-gerrit.html#change:~:text=change.commentSizeLimit
@@ -32,33 +34,49 @@ export const REQUEST_DETAILS_FOR_PRS: GerritRequestDetail[] = [
   'COMMIT_FOOTERS', // to get the commit message
 ] as const;
 
-export function getGerritRepoUrl(repository: string, endpoint: string): string {
+export function getGerritRepoUrl(
+  repository: string,
+  endpoint: string,
+  gitUrl: GitUrlOption | undefined,
+): string {
+  const endpointUrl = parseUrl(endpoint);
+  if (!endpointUrl) {
+    throw new Error(CONFIG_GIT_URL_UNAVAILABLE);
+  }
+
+  const url =
+    gitUrl === 'ssh'
+      ? createSshUrl(endpointUrl, repository)
+      : createHttpUrl(endpointUrl, endpoint, repository);
+  logger.trace({ url }, 'using URL based on configured endpoint');
+
+  return url;
+}
+
+function createSshUrl(url: URL, repository: string): string {
+  return `ssh://${url.host}:${DEFAULT_SSH_PORT}/${repository}`;
+}
+
+function createHttpUrl(url: URL, endpoint: string, repository: string): string {
   // Find options for current host and determine Git endpoint
   const opts = hostRules.find({
     hostType: 'gerrit',
     url: endpoint,
   });
 
-  const url = parseUrl(endpoint);
-  if (!url) {
-    throw new Error(CONFIG_GIT_URL_UNAVAILABLE);
-  }
   if (!(opts.username && opts.password)) {
     throw new Error(
       'Init: You must configure a Gerrit Server username/password',
     );
   }
+
   url.username = opts.username;
   url.password = opts.password;
   url.pathname = joinUrlParts(
     url.pathname,
     'a',
     encodeURIComponent(repository),
   );
-  logger.trace(
-    { url: url.toString() },
-    'using URL based on configured endpoint',
-  );
   return url.toString();
 }