-
Rhys Arkins authoredRhys Arkins authored
index.spec.ts 39.88 KiB
// TODO fix mocks
import nock from 'nock';
import { Platform, RepoParams } from '..';
import * as httpMock from '../../../test/httpMock';
import {
REPOSITORY_ARCHIVED,
REPOSITORY_CHANGED,
REPOSITORY_DISABLED,
REPOSITORY_EMPTY,
REPOSITORY_MIRRORED,
} from '../../constants/error-messages';
import {
PR_STATE_NOT_OPEN,
PR_STATE_OPEN,
} from '../../constants/pull-requests';
import { BranchStatus } from '../../types';
import * as _git from '../../util/git';
import * as _hostRules from '../../util/host-rules';
const gitlabApiHost = 'https://gitlab.com';
describe('platform/gitlab', () => {
let gitlab: Platform;
let hostRules: jest.Mocked<typeof _hostRules>;
let git: jest.Mocked<typeof _git>;
beforeEach(async () => {
// reset module
jest.resetModules();
jest.resetAllMocks();
gitlab = await import('.');
jest.mock('../../util/host-rules');
jest.mock('delay');
hostRules = require('../../util/host-rules');
jest.mock('../../util/git');
git = require('../../util/git');
git.branchExists.mockResolvedValue(true);
git.isBranchStale.mockResolvedValue(true);
git.getBranchCommit.mockResolvedValue(
'0d9c7726c3d628b7e28af234595cfd20febdbf8e'
);
hostRules.find.mockReturnValue({
token: 'abc123',
});
httpMock.reset();
httpMock.setup();
});
describe('initPlatform()', () => {
it(`should throw if no token`, async () => {
await expect(gitlab.initPlatform({} as any)).rejects.toThrow();
});
it(`should throw if auth fails`, async () => {
// user
httpMock.scope(gitlabApiHost).get('/api/v4/user').reply(403);
const res = gitlab.initPlatform({
token: 'some-token',
endpoint: undefined,
});
await expect(res).rejects.toThrow('Init: Authentication failure');
expect(httpMock.getTrace()).toMatchSnapshot();
});
it(`should default to gitlab.com`, async () => {
httpMock.scope(gitlabApiHost).get('/api/v4/user').reply(200, {
email: 'a@b.com',
name: 'Renovate Bot',
});
expect(
await gitlab.initPlatform({
token: 'some-token',
endpoint: undefined, })
).toMatchSnapshot();
expect(httpMock.getTrace()).toMatchSnapshot();
});
it(`should accept custom endpoint`, async () => {
httpMock.scope('https://gitlab.renovatebot.com').get('/user').reply(200, {
email: 'a@b.com',
name: 'Renovate Bot',
});
expect(
await gitlab.initPlatform({
endpoint: 'https://gitlab.renovatebot.com',
token: 'some-token',
})
).toMatchSnapshot();
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('getRepos', () => {
it('should throw an error if it receives an error', async () => {
httpMock
.scope(gitlabApiHost)
.get(
'/api/v4/projects?membership=true&per_page=100&with_merge_requests_enabled=true&min_access_level=30'
)
.replyWithError('getRepos error');
await expect(gitlab.getRepos()).rejects.toThrow('getRepos error');
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('should return an array of repos', async () => {
httpMock
.scope(gitlabApiHost)
.get(
'/api/v4/projects?membership=true&per_page=100&with_merge_requests_enabled=true&min_access_level=30'
)
.reply(200, [
{
path_with_namespace: 'a/b',
},
{
path_with_namespace: 'c/d',
},
{
path_with_namespace: 'c/e',
archived: true,
},
{
path_with_namespace: 'c/f',
mirror: true,
},
]);
const repos = await gitlab.getRepos();
expect(repos).toMatchSnapshot();
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
async function initRepo(
repoParams: RepoParams = {
repository: 'some/repo',
localDir: '',
optimizeForDisabled: false,
},
repoResp = null,
scope = httpMock.scope(gitlabApiHost)
): Promise<nock.Scope> {
const repo = repoParams.repository;
const justRepo = repo.split('/').slice(0, 2).join('/');
scope .get(`/api/v4/projects/${encodeURIComponent(repo)}`)
.reply(
200,
repoResp || {
default_branch: 'master',
http_url_to_repo: `https://gitlab.com/${justRepo}.git`,
}
)
.get('/api/v4/user')
.reply(200, {
email: 'a@b.com',
});
await gitlab.initRepo(repoParams);
return scope;
}
describe('initRepo', () => {
it(`should throw error if disabled in renovate.json`, async () => {
httpMock
.scope(gitlabApiHost)
.get('/api/v4/projects/some%2Frepo')
.reply(200, {
default_branch: 'master',
http_url_to_repo: 'https://gitlab.com/some/repo.git',
})
.get(
'/api/v4/projects/some%2Frepo/repository/files/renovate.json?ref=master'
)
.reply(200, {
content: Buffer.from('{"enabled": false}').toString('base64'),
});
await expect(
gitlab.initRepo({
repository: 'some/repo',
localDir: '',
optimizeForDisabled: true,
})
).rejects.toThrow(REPOSITORY_DISABLED);
expect(httpMock.getTrace()).toMatchSnapshot();
});
it(`should escape all forward slashes in project names`, async () => {
httpMock
.scope(gitlabApiHost)
.get('/api/v4/projects/some%2Frepo%2Fproject')
.reply(200, [])
.get('/api/v4/user')
.reply(200, {
email: 'a@b.com',
});
await gitlab.initRepo({
repository: 'some/repo/project',
localDir: '',
optimizeForDisabled: false,
});
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('should throw an error if receiving an error', async () => {
httpMock
.scope(gitlabApiHost)
.get('/api/v4/projects/some%2Frepo')
.replyWithError('always error');
await expect(
gitlab.initRepo({
repository: 'some/repo',
localDir: '',
optimizeForDisabled: false,
})
).rejects.toThrow('always error');
expect(httpMock.getTrace()).toMatchSnapshot();
}); it('should throw an error if repository is archived', async () => {
httpMock
.scope(gitlabApiHost)
.get('/api/v4/projects/some%2Frepo')
.reply(200, { archived: true });
await expect(
gitlab.initRepo({
repository: 'some/repo',
localDir: '',
optimizeForDisabled: false,
})
).rejects.toThrow(REPOSITORY_ARCHIVED);
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('should throw an error if repository is a mirror', async () => {
httpMock
.scope(gitlabApiHost)
.get('/api/v4/projects/some%2Frepo')
.reply(200, { mirror: true });
await expect(
gitlab.initRepo({
repository: 'some/repo',
localDir: '',
optimizeForDisabled: false,
})
).rejects.toThrow(REPOSITORY_MIRRORED);
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('should throw an error if repository access is disabled', async () => {
httpMock
.scope(gitlabApiHost)
.get('/api/v4/projects/some%2Frepo')
.reply(200, { repository_access_level: 'disabled' });
await expect(
gitlab.initRepo({
repository: 'some/repo',
localDir: '',
optimizeForDisabled: false,
})
).rejects.toThrow(REPOSITORY_DISABLED);
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('should throw an error if MRs are disabled', async () => {
httpMock
.scope(gitlabApiHost)
.get('/api/v4/projects/some%2Frepo')
.reply(200, { merge_requests_access_level: 'disabled' });
await expect(
gitlab.initRepo({
repository: 'some/repo',
localDir: '',
optimizeForDisabled: false,
})
).rejects.toThrow(REPOSITORY_DISABLED);
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('should throw an error if repository has empty_repo property', async () => {
httpMock
.scope(gitlabApiHost)
.get('/api/v4/projects/some%2Frepo')
.reply(200, { empty_repo: true });
await expect(
gitlab.initRepo({
repository: 'some/repo',
localDir: '',
optimizeForDisabled: false,
})
).rejects.toThrow(REPOSITORY_EMPTY);
expect(httpMock.getTrace()).toMatchSnapshot();
}); it('should throw an error if repository is empty', async () => {
httpMock
.scope(gitlabApiHost)
.get('/api/v4/projects/some%2Frepo')
.reply(200, { default_branch: null });
await expect(
gitlab.initRepo({
repository: 'some/repo',
localDir: '',
optimizeForDisabled: false,
})
).rejects.toThrow(REPOSITORY_EMPTY);
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('should fall back if http_url_to_repo is empty', async () => {
httpMock
.scope(gitlabApiHost)
.get('/api/v4/user')
.reply(200, {})
.get('/api/v4/projects/some%2Frepo%2Fproject')
.reply(200, {
default_branch: 'master',
http_url_to_repo: null,
});
await gitlab.initRepo({
repository: 'some/repo/project',
localDir: '',
optimizeForDisabled: false,
});
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('getRepoForceRebase', () => {
it('should return false', async () => {
await initRepo(
{
repository: 'some/repo/project',
localDir: '',
optimizeForDisabled: false,
},
{
default_branch: 'master',
http_url_to_repo: null,
merge_method: 'merge',
}
);
expect(await gitlab.getRepoForceRebase()).toBe(false);
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('should return true', async () => {
await initRepo(
{
repository: 'some/repo/project',
localDir: '',
optimizeForDisabled: false,
},
{
default_branch: 'master',
http_url_to_repo: null,
merge_method: 'ff',
}
);
expect(await gitlab.getRepoForceRebase()).toBe(true);
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('setBaseBranch(branchName)', () => {
it('sets the base branch', async () => {
httpMock .scope(gitlabApiHost)
.get(`/api/v4/projects/some%2Frepo`)
.reply(200, {
default_branch: 'master',
http_url_to_repo: `https://gitlab.com/some/repo.git`,
})
.get('/api/v4/user')
.reply(200, {
email: 'a@b.com',
});
await gitlab.initRepo({
repository: 'some/repo',
localDir: '',
optimizeForDisabled: false,
});
await gitlab.setBaseBranch();
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('uses default base branch', async () => {
httpMock
.scope(gitlabApiHost)
.get(`/api/v4/projects/some%2Frepo`)
.reply(200, {
default_branch: 'master',
http_url_to_repo: `https://gitlab.com/some/repo.git`,
})
.get('/api/v4/user')
.reply(200, {
email: 'a@b.com',
});
await gitlab.initRepo({
repository: 'some/repo',
localDir: '',
optimizeForDisabled: false,
});
await gitlab.setBaseBranch();
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('getAllRenovateBranches()', () => {
it('sends to gitFs', async () => {
await initRepo();
await gitlab.getAllRenovateBranches('');
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('getBranchLastCommitTime()', () => {
it('sends to gitFs', async () => {
await initRepo();
await gitlab.getBranchLastCommitTime('');
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('isBranchStale()', () => {
it('sends to gitFs', async () => {
await initRepo();
await gitlab.isBranchStale('');
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('getBranchPr(branchName)', () => {
it('should return null if no PR exists', async () => {
const scope = await initRepo();
scope
.get(
'/api/v4/projects/some%2Frepo/merge_requests?per_page=100&state=opened&source_branch=some-branch'
)
.reply(200, []);
const pr = await gitlab.getBranchPr('some-branch'); expect(pr).toBeNull();
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('should return the PR object', async () => {
const scope = await initRepo();
scope
.get(
'/api/v4/projects/some%2Frepo/merge_requests?per_page=100&state=opened&source_branch=some-branch'
)
.reply(200, [
{
iid: 91,
source_branch: 'some-branch',
target_branch: 'master',
state: 'opened',
},
])
.get(
'/api/v4/projects/some%2Frepo/merge_requests/91?include_diverged_commits_count=1'
)
.reply(200, {
iid: 91,
state: 'opened',
additions: 1,
deletions: 1,
commits: 1,
source_branch: 'some-branch',
target_branch: 'master',
base: {
sha: '1234',
},
})
.get(
'/api/v4/projects/some%2Frepo/repository/commits/0d9c7726c3d628b7e28af234595cfd20febdbf8e/statuses'
)
.reply(200, [])
.get('/api/v4/projects/some%2Frepo/repository/branches/some-branch')
.reply(200, [{ status: 'success' }]);
const pr = await gitlab.getBranchPr('some-branch');
expect(pr).toMatchSnapshot();
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('getBranchStatus(branchName, requiredStatusChecks)', () => {
it('returns success if requiredStatusChecks null', async () => {
const res = await gitlab.getBranchStatus('somebranch', null);
expect(res).toEqual(BranchStatus.green);
});
it('return failed if unsupported requiredStatusChecks', async () => {
const res = await gitlab.getBranchStatus('somebranch', ['foo']);
expect(res).toEqual(BranchStatus.red);
});
it('returns pending if no results', async () => {
const scope = await initRepo();
scope
.get(
'/api/v4/projects/some%2Frepo/repository/commits/0d9c7726c3d628b7e28af234595cfd20febdbf8e/statuses'
)
.reply(200, []);
const res = await gitlab.getBranchStatus('somebranch', []);
expect(res).toEqual(BranchStatus.yellow);
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('returns success if all are success', async () => {
const scope = await initRepo();
scope
.get(
'/api/v4/projects/some%2Frepo/repository/commits/0d9c7726c3d628b7e28af234595cfd20febdbf8e/statuses'
)
.reply(200, [{ status: 'success' }, { status: 'success' }]); const res = await gitlab.getBranchStatus('somebranch', []);
expect(res).toEqual(BranchStatus.green);
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('returns success if optional jobs fail', async () => {
const scope = await initRepo();
scope
.get(
'/api/v4/projects/some%2Frepo/repository/commits/0d9c7726c3d628b7e28af234595cfd20febdbf8e/statuses'
)
.reply(200, [
{ status: 'success' },
{ status: 'failed', allow_failure: true },
]);
const res = await gitlab.getBranchStatus('somebranch', []);
expect(res).toEqual(BranchStatus.green);
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('returns success if all are optional', async () => {
const scope = await initRepo();
scope
.get(
'/api/v4/projects/some%2Frepo/repository/commits/0d9c7726c3d628b7e28af234595cfd20febdbf8e/statuses'
)
.reply(200, [{ status: 'failed', allow_failure: true }]);
const res = await gitlab.getBranchStatus('somebranch', []);
expect(res).toEqual(BranchStatus.green);
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('returns failure if any mandatory jobs fails', async () => {
const scope = await initRepo();
scope
.get(
'/api/v4/projects/some%2Frepo/repository/commits/0d9c7726c3d628b7e28af234595cfd20febdbf8e/statuses'
)
.reply(200, [
{ status: 'success' },
{ status: 'failed', allow_failure: true },
{ status: 'failed' },
]);
const res = await gitlab.getBranchStatus('somebranch', []);
expect(res).toEqual(BranchStatus.red);
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('maps custom statuses to yellow', async () => {
const scope = await initRepo();
scope
.get(
'/api/v4/projects/some%2Frepo/repository/commits/0d9c7726c3d628b7e28af234595cfd20febdbf8e/statuses'
)
.reply(200, [{ status: 'success' }, { status: 'foo' }]);
const res = await gitlab.getBranchStatus('somebranch', []);
expect(res).toEqual(BranchStatus.yellow);
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('throws repository-changed', async () => {
expect.assertions(2);
git.branchExists.mockResolvedValue(false);
await initRepo();
await expect(gitlab.getBranchStatus('somebranch', [])).rejects.toThrow(
REPOSITORY_CHANGED
);
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('getBranchStatusCheck', () => {
it('returns null if no results', async () => {
const scope = await initRepo();
scope
.get( '/api/v4/projects/some%2Frepo/repository/commits/0d9c7726c3d628b7e28af234595cfd20febdbf8e/statuses'
)
.reply(200, []);
const res = await gitlab.getBranchStatusCheck(
'somebranch',
'some-context'
);
expect(res).toBeNull();
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('returns null if no matching results', async () => {
const scope = await initRepo();
scope
.get(
'/api/v4/projects/some%2Frepo/repository/commits/0d9c7726c3d628b7e28af234595cfd20febdbf8e/statuses'
)
.reply(200, [{ name: 'context-1', status: 'pending' }]);
const res = await gitlab.getBranchStatusCheck(
'somebranch',
'some-context'
);
expect(res).toBeNull();
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('returns status if name found', async () => {
const scope = await initRepo();
scope
.get(
'/api/v4/projects/some%2Frepo/repository/commits/0d9c7726c3d628b7e28af234595cfd20febdbf8e/statuses'
)
.reply(200, [
{ name: 'context-1', status: 'pending' },
{ name: 'some-context', status: 'success' },
{ name: 'context-3', status: 'failed' },
]);
const res = await gitlab.getBranchStatusCheck(
'somebranch',
'some-context'
);
expect(res).toEqual(BranchStatus.green);
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('setBranchStatus', () => {
it.each([BranchStatus.green, BranchStatus.yellow, BranchStatus.red])(
'sets branch status %s',
async (state) => {
const scope = await initRepo();
scope
.post(
'/api/v4/projects/some%2Frepo/statuses/0d9c7726c3d628b7e28af234595cfd20febdbf8e'
)
.reply(200, {})
.get(
'/api/v4/projects/some%2Frepo/repository/commits/0d9c7726c3d628b7e28af234595cfd20febdbf8e/statuses'
)
.reply(200, []);
await gitlab.setBranchStatus({
branchName: 'some-branch',
context: 'some-context',
description: 'some-description',
state,
url: 'some-url',
});
expect(httpMock.getTrace()).toMatchSnapshot();
}
);
});
describe('mergeBranch()', () => { it('sends to gitFs', async () => {
await initRepo();
await gitlab.mergeBranch('branch');
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('deleteBranch()', () => {
it('sends to gitFs', async () => {
const scope = await initRepo();
scope
.get(
'/api/v4/projects/some%2Frepo/merge_requests?per_page=100&state=opened&source_branch=branch'
)
.reply(200, [
{
number: 1,
source_branch: 'branch-a',
title: 'branch a pr',
state: 'opened',
},
]);
await gitlab.deleteBranch('branch', true);
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('defaults to not closing associated PR', async () => {
await initRepo();
await gitlab.deleteBranch('branch2');
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('findIssue()', () => {
it('returns null if no issue', async () => {
httpMock
.scope(gitlabApiHost)
.get(
'/api/v4/projects/undefined/issues?per_page=100&author_id=undefined&state=opened'
)
.reply(200, [
{
iid: 1,
title: 'title-1',
},
{
iid: 2,
title: 'title-2',
},
]);
const res = await gitlab.findIssue('title-3');
expect(res).toBeNull();
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('finds issue', async () => {
httpMock
.scope(gitlabApiHost)
.get(
'/api/v4/projects/undefined/issues?per_page=100&author_id=undefined&state=opened'
)
.reply(200, [
{
iid: 1,
title: 'title-1',
},
{
iid: 2,
title: 'title-2',
},
])
.get('/api/v4/projects/undefined/issues/2')
.reply(200, { description: 'new-content' });
const res = await gitlab.findIssue('title-2'); expect(res).not.toBeNull();
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('ensureIssue()', () => {
it('creates issue', async () => {
httpMock
.scope(gitlabApiHost)
.get(
'/api/v4/projects/undefined/issues?per_page=100&author_id=undefined&state=opened'
)
.reply(200, [
{
iid: 1,
title: 'title-1',
},
{
iid: 2,
title: 'title-2',
},
])
.post('/api/v4/projects/undefined/issues')
.reply(200);
const res = await gitlab.ensureIssue({
title: 'new-title',
body: 'new-content',
});
expect(res).toEqual('created');
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('updates issue', async () => {
httpMock
.scope(gitlabApiHost)
.get(
'/api/v4/projects/undefined/issues?per_page=100&author_id=undefined&state=opened'
)
.reply(200, [
{
iid: 1,
title: 'title-1',
},
{
iid: 2,
title: 'title-2',
},
])
.get('/api/v4/projects/undefined/issues/2')
.reply(200, { description: 'new-content' })
.put('/api/v4/projects/undefined/issues/2')
.reply(200);
const res = await gitlab.ensureIssue({
title: 'title-2',
body: 'newer-content',
});
expect(res).toEqual('updated');
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('skips update if unchanged', async () => {
httpMock
.scope(gitlabApiHost)
.get(
'/api/v4/projects/undefined/issues?per_page=100&author_id=undefined&state=opened'
)
.reply(200, [
{
iid: 1,
title: 'title-1',
},
{
iid: 2, title: 'title-2',
},
])
.get('/api/v4/projects/undefined/issues/2')
.reply(200, { description: 'newer-content' });
const res = await gitlab.ensureIssue({
title: 'title-2',
body: 'newer-content',
});
expect(res).toBeNull();
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('ensureIssueClosing()', () => {
it('closes issue', async () => {
httpMock
.scope(gitlabApiHost)
.get(
'/api/v4/projects/undefined/issues?per_page=100&author_id=undefined&state=opened'
)
.reply(200, [
{
iid: 1,
title: 'title-1',
},
{
iid: 2,
title: 'title-2',
},
])
.put('/api/v4/projects/undefined/issues/2')
.reply(200);
await gitlab.ensureIssueClosing('title-2');
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('addAssignees(issueNo, assignees)', () => {
it('should add the given assignees to the issue', async () => {
httpMock
.scope(gitlabApiHost)
.get('/api/v4/users?username=someuser')
.reply(200, [{ id: 123 }])
.put('/api/v4/projects/undefined/merge_requests/42?assignee_id=123')
.reply(200);
await gitlab.addAssignees(42, ['someuser']);
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('should warn if more than one assignee', async () => {
httpMock
.scope(gitlabApiHost)
.get('/api/v4/users?username=someuser')
.reply(200, [{ id: 123 }])
.get('/api/v4/users?username=someotheruser')
.reply(200, [{ id: 124 }])
.put('/api/v4/projects/undefined/merge_requests/42?assignee_id=123')
.reply(200)
.put(
'/api/v4/projects/undefined/merge_requests/42?assignee_ids[]=123&assignee_ids[]=124'
)
.replyWithError('error');
await gitlab.addAssignees(42, ['someuser', 'someotheruser']);
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('should swallow error', async () => {
httpMock
.scope(gitlabApiHost)
.get('/api/v4/users?username=someuser')
.replyWithError('some error');
await gitlab.addAssignees(42, ['someuser', 'someotheruser']);
expect(httpMock.getTrace()).toMatchSnapshot(); });
it('should add the given assignees to the issue if supported', async () => {
httpMock
.scope(gitlabApiHost)
.get('/api/v4/users?username=someuser')
.reply(200, [{ id: 123 }])
.get('/api/v4/users?username=someotheruser')
.reply(200, [{ id: 124 }])
.put('/api/v4/projects/undefined/merge_requests/42?assignee_id=123')
.reply(200)
.put(
'/api/v4/projects/undefined/merge_requests/42?assignee_ids[]=123&assignee_ids[]=124'
)
.reply(200);
await gitlab.addAssignees(42, ['someuser', 'someotheruser']);
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('addReviewers(issueNo, reviewers)', () => {
it('should add the given reviewers to the PR', async () => {
// no-op
httpMock.scope(gitlabApiHost);
await gitlab.addReviewers(42, ['someuser', 'someotheruser']);
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('ensureComment', () => {
it('add comment if not found', async () => {
const scope = await initRepo();
scope
.get('/api/v4/projects/some%2Frepo/merge_requests/42/notes')
.reply(200, [])
.post('/api/v4/projects/some%2Frepo/merge_requests/42/notes')
.reply(200);
await gitlab.ensureComment({
number: 42,
topic: 'some-subject',
content: 'some\ncontent',
});
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('add updates comment if necessary', async () => {
const scope = await initRepo();
scope
.get('/api/v4/projects/some%2Frepo/merge_requests/42/notes')
.reply(200, [{ id: 1234, body: '### some-subject\n\nblablabla' }])
.put('/api/v4/projects/some%2Frepo/merge_requests/42/notes/1234')
.reply(200);
await gitlab.ensureComment({
number: 42,
topic: 'some-subject',
content: 'some\ncontent',
});
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('skips comment', async () => {
const scope = await initRepo();
scope
.get('/api/v4/projects/some%2Frepo/merge_requests/42/notes')
.reply(200, [{ id: 1234, body: '### some-subject\n\nsome\ncontent' }]);
await gitlab.ensureComment({
number: 42,
topic: 'some-subject',
content: 'some\ncontent',
});
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('handles comment with no description', async () => {
const scope = await initRepo();
scope .get('/api/v4/projects/some%2Frepo/merge_requests/42/notes')
.reply(200, [{ id: 1234, body: '!merge' }]);
await gitlab.ensureComment({
number: 42,
topic: null,
content: '!merge',
});
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('ensureCommentRemoval', () => {
it('deletes comment by topic if found', async () => {
const scope = await initRepo();
scope
.get('/api/v4/projects/some%2Frepo/merge_requests/42/notes')
.reply(200, [{ id: 1234, body: '### some-subject\n\nblablabla' }])
.delete('/api/v4/projects/some%2Frepo/merge_requests/42/notes/1234')
.reply(200);
await gitlab.ensureCommentRemoval({ number: 42, topic: 'some-subject' });
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('deletes comment by content if found', async () => {
const scope = await initRepo();
scope
.get('/api/v4/projects/some%2Frepo/merge_requests/42/notes')
.reply(200, [{ id: 1234, body: 'some-body\n' }])
.delete('/api/v4/projects/some%2Frepo/merge_requests/42/notes/1234')
.reply(200);
await gitlab.ensureCommentRemoval({ number: 42, content: 'some-body' });
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('findPr(branchName, prTitle, state)', () => {
it('returns true if no title and all state', async () => {
httpMock
.scope(gitlabApiHost)
.get(
'/api/v4/projects/undefined/merge_requests?per_page=100&author_id=undefined'
)
.reply(200, [
{
iid: 1,
source_branch: 'branch-a',
title: 'branch a pr',
state: 'opened',
},
]);
const res = await gitlab.findPr({
branchName: 'branch-a',
});
expect(res).toBeDefined();
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('returns true if not open', async () => {
httpMock
.scope(gitlabApiHost)
.get(
'/api/v4/projects/undefined/merge_requests?per_page=100&author_id=undefined'
)
.reply(200, [
{
iid: 1,
source_branch: 'branch-a',
title: 'branch a pr',
state: 'merged',
},
]);
const res = await gitlab.findPr({
branchName: 'branch-a',
state: PR_STATE_NOT_OPEN, });
expect(res).toBeDefined();
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('returns true if open and with title', async () => {
httpMock
.scope(gitlabApiHost)
.get(
'/api/v4/projects/undefined/merge_requests?per_page=100&author_id=undefined'
)
.reply(200, [
{
iid: 1,
source_branch: 'branch-a',
title: 'branch a pr',
state: 'opened',
},
]);
const res = await gitlab.findPr({
branchName: 'branch-a',
prTitle: 'branch a pr',
state: PR_STATE_OPEN,
});
expect(res).toBeDefined();
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('returns true with title', async () => {
httpMock
.scope(gitlabApiHost)
.get(
'/api/v4/projects/undefined/merge_requests?per_page=100&author_id=undefined'
)
.reply(200, [
{
iid: 1,
source_branch: 'branch-a',
title: 'branch a pr',
state: 'opened',
},
]);
const res = await gitlab.findPr({
branchName: 'branch-a',
prTitle: 'branch a pr',
});
expect(res).toBeDefined();
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('createPr(branchName, title, body)', () => {
it('returns the PR', async () => {
httpMock
.scope(gitlabApiHost)
.post('/api/v4/projects/undefined/merge_requests')
.reply(200, {
id: 1,
iid: 12345,
});
const pr = await gitlab.createPr({
branchName: 'some-branch',
prTitle: 'some-title',
prBody: 'the-body',
labels: null,
});
expect(pr).toMatchSnapshot();
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('uses default branch', async () => {
httpMock .scope(gitlabApiHost)
.post('/api/v4/projects/undefined/merge_requests')
.reply(200, {
id: 1,
iid: 12345,
});
const pr = await gitlab.createPr({
branchName: 'some-branch',
prTitle: 'some-title',
prBody: 'the-body',
labels: [],
useDefaultBranch: true,
});
expect(pr).toMatchSnapshot();
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('auto-accepts the MR when requested', async () => {
httpMock
.scope(gitlabApiHost)
.post('/api/v4/projects/undefined/merge_requests')
.reply(200, {
id: 1,
iid: 12345,
})
.get('/api/v4/projects/undefined/merge_requests/12345')
.reply(200)
.get('/api/v4/projects/undefined/merge_requests/12345')
.reply(200, {
merge_status: 'can_be_merged',
pipeline: {
id: 29626725,
sha: '2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f',
ref: 'patch-28',
status: 'success',
},
})
.put('/api/v4/projects/undefined/merge_requests/12345/merge')
.reply(200);
await gitlab.createPr({
branchName: 'some-branch',
prTitle: 'some-title',
prBody: 'the-body',
labels: [],
useDefaultBranch: true,
platformOptions: {
azureAutoComplete: false,
statusCheckVerify: false,
gitLabAutomerge: true,
},
});
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('getPr(prNo)', () => {
it('returns the PR', async () => {
httpMock
.scope(gitlabApiHost)
.get(
'/api/v4/projects/undefined/merge_requests/12345?include_diverged_commits_count=1'
)
.reply(200, {
id: 1,
iid: 12345,
description: 'a merge request',
state: 'merged',
merge_status: 'cannot_be_merged',
diverged_commits_count: 5,
source_branch: 'some-branch',
target_branch: 'master',
}) .get('/api/v4/projects/undefined/repository/branches/some-branch')
.reply(200, { commit: {} });
const pr = await gitlab.getPr(12345);
expect(pr).toMatchSnapshot();
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('returns the mergeable PR', async () => {
const scope = await initRepo();
scope
.get(
'/api/v4/projects/some%2Frepo/merge_requests/12345?include_diverged_commits_count=1'
)
.reply(200, {
id: 1,
iid: 12345,
description: 'a merge request',
state: 'open',
diverged_commits_count: 5,
source_branch: 'some-branch',
target_branch: 'master',
})
.get(
'/api/v4/projects/some%2Frepo/repository/commits/0d9c7726c3d628b7e28af234595cfd20febdbf8e/statuses'
)
.reply(200, [{ status: 'success' }])
.get('/api/v4/projects/some%2Frepo/repository/branches/some-branch')
.reply(200, { commit: null });
const pr = await gitlab.getPr(12345);
expect(pr).toMatchSnapshot();
expect(httpMock.getTrace()).toMatchSnapshot();
});
it('returns the PR with nonexisting branch', async () => {
httpMock
.scope(gitlabApiHost)
.get(
'/api/v4/projects/undefined/merge_requests/12345?include_diverged_commits_count=1'
)
.reply(200, {
id: 1,
iid: 12345,
description: 'a merge request',
state: 'open',
merge_status: 'cannot_be_merged',
diverged_commits_count: 2,
source_branch: 'some-branch',
target_branch: 'master',
})
.get('/api/v4/projects/undefined/repository/branches/some-branch')
.reply(404);
const pr = await gitlab.getPr(12345);
expect(pr).toMatchSnapshot();
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('updatePr(prNo, title, body)', () => {
jest.resetAllMocks();
it('updates the PR', async () => {
httpMock
.scope(gitlabApiHost)
.put('/api/v4/projects/undefined/merge_requests/1')
.reply(200);
await gitlab.updatePr(1, 'title', 'body');
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('mergePr(pr)', () => {
jest.resetAllMocks();
it('merges the PR', async () => {
httpMock
.scope(gitlabApiHost) .put('/api/v4/projects/undefined/merge_requests/1/merge')
.reply(200);
await gitlab.mergePr(1, undefined);
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
const prBody = `https://github.com/foo/bar/issues/5 plus also [a link](https://github.com/foo/bar/issues/5
Pull Requests are the best, here are some PRs.
## Open
These updates have all been created already. Click a checkbox below to force a retry/rebase of any.
- [ ] <!-- rebase-branch=renovate/major-got-packages -->[build(deps): update got packages (major)](../pull/2433) (\`gh-got\`, \`gl-got\`, \`got\`)
`;
describe('getPrBody(input)', () => {
it('returns updated pr body', () => {
expect(gitlab.getPrBody(prBody)).toMatchSnapshot();
});
});
describe('commitFiles()', () => {
it('sends to gitFs', async () => {
expect.assertions(1);
await initRepo();
await gitlab.commitFiles({
branchName: 'some-branch',
files: [{ name: 'SomeFile', contents: 'Some Content' }],
message: '',
});
expect(httpMock.getTrace()).toMatchSnapshot();
});
});
describe('getCommitMessages()', () => {
it('passes to git', async () => {
await initRepo();
expect(await gitlab.getCommitMessages()).toMatchSnapshot();
});
});
describe('getVulnerabilityAlerts()', () => {
it('returns empty', async () => {
const res = await gitlab.getVulnerabilityAlerts();
expect(res).toHaveLength(0);
});
});
describe('deleteLabel(issueNo, label)', () => {
it('should delete the label', async () => {
httpMock
.scope(gitlabApiHost)
.get(
'/api/v4/projects/undefined/merge_requests/42?include_diverged_commits_count=1'
)
.reply(200, {
id: 1,
iid: 12345,
description: 'a merge request',
state: 'merged',
merge_status: 'cannot_be_merged',
diverged_commits_count: 5,
source_branch: 'some-branch',
labels: ['foo', 'renovate', 'rebase'],
})
.get('/api/v4/projects/undefined/repository/branches/some-branch')
.reply(200, {
commit: {},
})
.put('/api/v4/projects/undefined/merge_requests/42')
.reply(200);
await gitlab.deleteLabel(42, 'rebase');
expect(httpMock.getTrace()).toMatchSnapshot(); });
});
});