feat: Support for Platform "Gerrit"

docs/usage/configuration-options.md

@@ -859,6 +859,11 @@ Renovate follows tags _strictly_, this can cause problems when a tagged stream i
 For example: you're following the `next` tag, but later the stream you actually want is called `stable` instead.
 If `next` is no longer getting updates, you must switch your `followTag` to `stable` to get updates again.
 
+## gerritAutoApprove
+
+If set to `true`, Renovate automatically approves its own changes.
+This means Renovate assigns the Code-Review label = +2.
+
 ## gitAuthor
 
 You can customize the Git author that's used whenever Renovate creates a commit.

lib/config/options/index.ts

@@ -2423,7 +2423,15 @@ const options: RenovateOptions[] = [
     description: `Use platform API to perform commits instead of using Git directly.`,
     type: 'boolean',
     default: false,
-    supportedPlatforms: ['github'],
+    supportedPlatforms: ['github', 'gerrit'],
+  },
+  {
+    name: 'gerritAutoApprove',
+    description:
+      'If set to `true`, Renovate automatically approves it's own changes. This means Renovate assigns the Code-Review label = +2.',
+    type: 'boolean',
+    default: false,
+    supportedPlatforms: ['gerrit'],
   },
   {
     name: 'branchNameStrict',

lib/config/presets/gerrit/index.spec.ts

@@ -0,0 +1,114 @@
+import * as httpMock from '../../../../test/http-mock';
+import { setPlatformApi } from '../../../modules/platform';
+import { setBaseUrl } from '../../../util/http/gerrit';
+import { PRESET_DEP_NOT_FOUND, PRESET_INVALID_JSON } from '../util';
+import * as gerrit from '.';
+
+jest.unmock('../../../modules/platform');
+
+const gerritEndpointUrl = 'https://dev.gerrit.com/renovate/';
+setBaseUrl(gerritEndpointUrl);
+
+describe('config/presets/gerrit/index', () => {
+  beforeAll(() => {
+    setPlatformApi('gerrit');
+  });
+
+  describe('fetchJSONFile()', () => {
+    it('returns JSON', async () => {
+      const data = { foo: 'bar' };
+      httpMock
+        .scope(gerritEndpointUrl)
+        .get(
+          '/a/projects/some%2Frepo/branches/HEAD/files/some-filename.json/content'
+        )
+        .reply(200, gerritFileResponse(JSON.stringify(data)));
+
+      const res = await gerrit.fetchJSONFile(
+        'some/repo',
+        'some-filename.json',
+        gerritEndpointUrl
+      );
+      expect(res).toEqual(data);
+    });
+
+    it('throws on not found error', async () => {
+      httpMock
+        .scope(gerritEndpointUrl)
+        .get(
+          '/a/projects/some%2Frepo/branches/HEAD/files/some-filename.json/content'
+        )
+        .reply(404);
+      await expect(
+        gerrit.fetchJSONFile(
+          'some/repo',
+          'some-filename.json',
+          gerritEndpointUrl
+        )
+      ).rejects.toThrow(PRESET_DEP_NOT_FOUND);
+    });
+
+    it('throws on invalid json', async () => {
+      httpMock
+        .scope(gerritEndpointUrl)
+        .get(
+          '/a/projects/some%2Frepo/branches/HEAD/files/some-filename.json/content'
+        )
+        .reply(200, gerritFileResponse('!@#'));
+      await expect(
+        gerrit.fetchJSONFile(
+          'some/repo',
+          'some-filename.json',
+          gerritEndpointUrl
+        )
+      ).rejects.toThrow(PRESET_INVALID_JSON);
+    });
+  });
+
+  describe('getPresetFromEndpoint()', () => {
+    it('uses custom path', async () => {
+      const data = { foo: 'bar' };
+      httpMock
+        .scope(gerritEndpointUrl)
+        .get(
+          `/a/projects/some%2Frepo/branches/HEAD/files/${encodeURIComponent(
+            'foo/bar/some-filename.json'
+          )}/content`
+        )
+        .reply(200, gerritFileResponse(JSON.stringify(data)));
+
+      const res = await gerrit.getPresetFromEndpoint(
+        'some/repo',
+        'some-filename',
+        'foo/bar',
+        gerritEndpointUrl
+      );
+      expect(res).toEqual(data);
+    });
+
+    it('uses custom path with tag', async () => {
+      const data = { foo: 'bar' };
+      httpMock
+        .scope(gerritEndpointUrl)
+        .get(
+          `/a/projects/some%2Frepo/branches/RENOVATE/files/${encodeURIComponent(
+            'foo/bar/some-filename.json'
+          )}/content`
+        )
+        .reply(200, gerritFileResponse(JSON.stringify(data)));
+
+      const res = await gerrit.getPresetFromEndpoint(
+        'some/repo',
+        'some-filename',
+        'foo/bar',
+        gerritEndpointUrl,
+        'RENOVATE'
+      );
+      expect(res).toEqual(data);
+    });
+  });
+});
+
+function gerritFileResponse(body: string): any {
+  return `)]}'\n${Buffer.from(body).toString('base64')}`;
+}

lib/config/presets/gerrit/index.ts

@@ -0,0 +1,47 @@
+import { logger } from '../../../logger';
+import { platform } from '../../../modules/platform';
+import { ExternalHostError } from '../../../types/errors/external-host-error';
+import { setBaseUrl } from '../../../util/http/gerrit';
+import type { Preset } from '../types';
+import { PRESET_DEP_NOT_FOUND, fetchPreset, parsePreset } from '../util';
+
+export async function fetchJSONFile(
+  repo: string,
+  fileName: string,
+  endpoint: string,
+  tag?: string | null
+): Promise<Preset> {
+  let raw: string | null;
+  try {
+    setBaseUrl(endpoint);
+    raw = await platform.getRawFile(fileName, repo, tag ?? 'HEAD'); //what is the meaning of a null result?
+  } catch (err) {
+    // istanbul ignore if: not testable with nock
+    if (err instanceof ExternalHostError) {
+      throw err;
+    }
+
+    logger.debug(`Preset file ${fileName} not found in ${repo}`);
+
+    throw new Error(PRESET_DEP_NOT_FOUND);
+  }
+
+  return parsePreset(raw!);
+}
+
+export function getPresetFromEndpoint(
+  repo: string,
+  filePreset: string,
+  presetPath: string | undefined,
+  endpoint: string,
+  tag?: string | null
+): Promise<Preset | undefined> {
+  return fetchPreset({
+    repo,
+    filePreset,
+    presetPath,
+    endpoint,
+    tag,
+    fetch: fetchJSONFile,
+  });
+}

lib/config/presets/local/__snapshots__/index.spec.ts.snap

@@ -24,6 +24,18 @@ exports[`config/presets/local/index getPreset() forwards to bitbucket 1`] = `
 ]
 `;
 
+exports[`config/presets/local/index getPreset() forwards to custom Gerrit 1`] = `
+[
+  [
+    "some/repo",
+    "default",
+    undefined,
+    "https://gerrit.example.com/path",
+    undefined,
+  ],
+]
+`;
+
 exports[`config/presets/local/index getPreset() forwards to custom bitbucket-server 1`] = `
 [
   [
@@ -96,6 +108,18 @@ exports[`config/presets/local/index getPreset() forwards to custom gitlab with a
 ]
 `;
 
+exports[`config/presets/local/index getPreset() forwards to gerrit with a tag 1`] = `
+[
+  [
+    "some/repo",
+    "default",
+    undefined,
+    undefined,
+    "someTag",
+  ],
+]
+`;
+
 exports[`config/presets/local/index getPreset() forwards to gitea 1`] = `
 [
   [

lib/config/presets/local/index.spec.ts

@@ -3,6 +3,7 @@ import { GlobalConfig } from '../../global';
 import * as _azure from '../azure';
 import * as _bitbucket from '../bitbucket';
 import * as _bitbucketServer from '../bitbucket-server';
+import * as _gerrit from '../gerrit';
 import * as _gitea from '../gitea';
 import * as _github from '../github';
 import * as _gitlab from '../gitlab';
@@ -11,13 +12,15 @@ import * as local from '.';
 jest.mock('../azure');
 jest.mock('../bitbucket');
 jest.mock('../bitbucket-server');
+jest.mock('../gerrit');
 jest.mock('../gitea');
 jest.mock('../github');
 jest.mock('../gitlab');
 
 const azure = mocked(_azure);
 const bitbucket = mocked(_bitbucket);
 const bitbucketServer = mocked(_bitbucketServer);
+const gerrit = mocked(_gerrit);
 const gitea = mocked(_gitea);
 const github = mocked(_github);
 const gitlab = mocked(_gitlab);
@@ -32,6 +35,7 @@ describe('config/presets/local/index', () => {
     gitea.getPresetFromEndpoint.mockResolvedValueOnce(preset);
     github.getPresetFromEndpoint.mockResolvedValueOnce(preset);
     gitlab.getPresetFromEndpoint.mockResolvedValueOnce(preset);
+    gerrit.getPresetFromEndpoint.mockResolvedValueOnce(preset);
   });
 
   describe('getPreset()', () => {
@@ -225,5 +229,29 @@ describe('config/presets/local/index', () => {
       expect(gitlab.getPresetFromEndpoint.mock.calls).toMatchSnapshot();
       expect(content).toEqual({ resolved: 'preset' });
     });
+
+    it('forwards to custom Gerrit', async () => {
+      GlobalConfig.set({
+        platform: 'gerrit',
+        endpoint: 'https://gerrit.example.com/path',
+      });
+      const content = await local.getPreset({
+        repo: 'some/repo',
+        presetName: 'default',
+      });
+      expect(gerrit.getPresetFromEndpoint.mock.calls).toMatchSnapshot();
+      expect(content).toEqual({ resolved: 'preset' });
+    });
+
+    it('forwards to gerrit with a tag', async () => {
+      GlobalConfig.set({ platform: 'gerrit' });
+      const content = await local.getPreset({
+        repo: 'some/repo',
+        presetName: 'default',
+        tag: 'someTag',
+      });
+      expect(gerrit.getPresetFromEndpoint.mock.calls).toMatchSnapshot();
+      expect(content).toEqual({ resolved: 'preset' });
+    });
   });
 });

lib/config/presets/local/index.ts

@@ -3,6 +3,7 @@ import { GlobalConfig } from '../../global';
 import * as azure from '../azure';
 import * as bitbucket from '../bitbucket';
 import * as bitbucketServer from '../bitbucket-server';
+import * as gerrit from '../gerrit';
 import * as gitea from '../gitea';
 import * as github from '../github';
 import * as gitlab from '../gitlab';
@@ -12,6 +13,7 @@ const resolvers = {
   azure,
   bitbucket,
   'bitbucket-server': bitbucketServer,
+  gerrit,
   gitea,
   github,
   gitlab,

lib/constants/platforms.ts

@@ -2,6 +2,7 @@ export type PlatformId =
   | 'azure'
   | 'bitbucket'
   | 'bitbucket-server'
+  | 'gerrit'
   | 'gitea'
   | 'github'
   | 'gitlab';

lib/modules/platform/api.ts

@@ -2,6 +2,7 @@ import * as azure from './azure';
 import * as bitbucket from './bitbucket';
 import * as bitbucketServer from './bitbucket-server';
 import * as codecommit from './codecommit';
+import * as gerrit from './gerrit';
 import * as gitea from './gitea';
 import * as github from './github';
 import * as gitlab from './gitlab';
@@ -14,6 +15,7 @@ api.set('azure', azure);
 api.set('bitbucket', bitbucket);
 api.set('bitbucket-server', bitbucketServer);
 api.set('codecommit', codecommit);
+api.set('gerrit', gerrit);
 api.set('gitea', gitea);
 api.set('github', github);
 api.set('gitlab', gitlab);

lib/modules/platform/gerrit/__fixtures__/change-data.json

@@ -0,0 +1,63 @@
+{
+  "id": "Ied428f0315d85e00f0df1fecbc1d8fb993e30b41",
+  "project": "web/apps",
+  "created": "2018-06-15 06:33:07.000000000",
+  "updated": "2018-06-15 06:33:07.000000000",
+  "change_id": "...",
+  "_number": 123456,
+  "status": "NEW",
+  "branch": "main",
+  "subject": "Fix for",
+  "insertions": 12,
+  "deletions": 13,
+  "submittable": true,
+  "current_revision": "58eae5696a555441d2f5f2527fc5dd1dfdf81e48",
+  "labels": {
+    "Code-Review": {
+      "approved": {
+        "_account_id": 1000000,
+        "username": "user"
+      }
+    }
+  },
+  "revisions": {
+    "58eae5696a555441d2f5f2527fc5dd1dfdf81e48": {
+      "ref": "refs/changes/1/2",
+      "uploader": {
+        "username": "otheruser"
+      }
+    }
+  },
+  "messages": [
+    {
+      "id": "9d78ac236714cee8c2d86e95d638358925cf6853",
+      "tag": "pull-request",
+      "message": "Patch Set 1:\n\nOld PR-Body"
+    },
+    {
+      "id": "1d17c930381e88e177bbc59595c3ec941bd21028",
+      "tag": "pull-request",
+      "message": "Patch Set 12:\n\nLast PR-Body"
+    },
+    {
+      "id": "9d78ac236714cee8c2d86e95d638358925cf6853",
+      "message": "other message..."
+    }
+  ],
+  "reviewers": {
+    "REVIEWER": [
+      {
+        "_account_id": 10000,
+        "name": "Mrs User",
+        "email": "[email protected]",
+        "username": "username"
+      }
+    ]
+  },
+  "submit_records": [],
+  "hashtags": ["other-tag", "sourceBranch-renovate/dependency-1.x"],
+  "owner": {
+    "_account_id": 1000000
+  },
+  "problems": []
+}