Select Git revision
onboarding.spec.js
onboarding.spec.js 13.45 KiB
const apis = require('../../../lib/workers/repository/apis');
const onboarding = require('../../../lib/workers/repository/onboarding');
const logger = require('../../_fixtures/logger');
const defaultConfig = require('../../../lib/config/defaults').getConfig();
describe('lib/workers/repository/onboarding', () => {
describe('isRepoPrivate(config)', () => {
let config;
beforeEach(() => {
config = {
api: {
getFileJson: jest.fn(),
},
packageFiles: [
'package.json',
{
packageFile: 'a/package.json',
},
],
};
});
it('returns true if all are private', async () => {
config.api.getFileJson.mockReturnValueOnce({ private: true });
config.api.getFileJson.mockReturnValueOnce({ private: true });
expect(await onboarding.isRepoPrivate(config)).toBe(true);
});
it('returns false if some are not private', async () => {
config.api.getFileJson.mockReturnValueOnce({ private: true });
config.api.getFileJson.mockReturnValueOnce({});
expect(await onboarding.isRepoPrivate(config)).toBe(false);
});
});
describe('ensurePr(config, branchUpgrades)', () => {
let config;
let branchUpgrades;
beforeEach(() => {
config = {
branchPrefix: 'renovate/',
errors: [],
warnings: [],
api: {
createPr: jest.fn(() => ({ displayNumber: 1 })),
getBranchPr: jest.fn(),
updatePr: jest.fn(),
},
logger,
};
branchUpgrades = [];
});
it('creates pr', async () => {
config.contentBaseBranch = 'next';
await onboarding.ensurePr(config, branchUpgrades);
expect(config.api.createPr.mock.calls.length).toBe(1);
expect(config.api.updatePr.mock.calls.length).toBe(0);
expect(config.api.createPr.mock.calls).toMatchSnapshot();
});
it('creates pr with preset descriptions', async () => {
config.description = ['Description 1', 'Description 2'];
await onboarding.ensurePr(config, branchUpgrades);
expect(config.api.createPr.mock.calls.length).toBe(1);
expect(config.api.updatePr.mock.calls.length).toBe(0);
expect(
config.api.createPr.mock.calls[0][2].indexOf('## Configuration Summary')
).not.toBe(-1);
expect(config.api.createPr.mock.calls[0]).toMatchSnapshot();
});
it('creates pr with dynamic descriptions', async () => {
config.labels = ['renovate', 'upgrades'];
config.assignees = ['rarkins'];
config.schedule = ['before 5am']; await onboarding.ensurePr(config, branchUpgrades);
expect(config.api.createPr.mock.calls.length).toBe(1);
expect(config.api.updatePr.mock.calls.length).toBe(0);
expect(
config.api.createPr.mock.calls[0][2].indexOf('## Configuration Summary')
).not.toBe(-1);
expect(config.api.createPr.mock.calls[0]).toMatchSnapshot();
});
it('updates pr', async () => {
config.api.getBranchPr.mockReturnValueOnce({});
await onboarding.ensurePr(config, branchUpgrades);
expect(config.api.createPr.mock.calls.length).toBe(0);
expect(config.api.updatePr.mock.calls.length).toBe(1);
});
it('does not update pr', async () => {
// prettier-ignore
const existingPrBody = "Welcome to [Renovate](https://renovateapp.com)!\n\nThis is an onboarding PR to help you understand and configure Renovate before any regular Pull Requests begin. Once you close this Pull Request, Renovate will begin keeping your dependencies up-to-date via automated Pull Requests.\n\nIf you have any questions, try reading our [Getting Started Configuring Renovate](https://renovateapp.com/docs/getting-started/configure-renovate) page first.\n\n---\n\nIt looks like your repository dependencies are already up-to-date and no initial Pull Requests will be necessary.\n\nSometimes you may see multiple options for the same dependency (e.g. pinning in one branch and upgrading in another). This is expected and allows you the flexibility to choose which to merge first. Once you merge any PR, others will be updated or removed the next time Renovate runs.\n\nWould you like to change the way Renovate is upgrading your dependencies? Simply edit the `renovate.json` in this branch and this Pull Request description will be updated the next time Renovate runs.\n\nOur [Configuration Docs](https://renovateapp.com/docs/) should be helpful if you wish to modify any behaviour.\n\n---\n\n#### Don't want a `renovate.json` file?\n\nYou are not required to *merge* this Pull Request - Renovate will begin even if this \"Configure Renovate\" PR is closed *unmerged* and without a `renovate.json` file. However, it's recommended that you add configuration to your repository to ensure behaviour matches what you see described here.\n\nAlternatively, you can add the same configuration settings into a \"renovate\" section of your `package.json` file(s) in this branch and delete the `renovate.json` from this PR. If you make these configuration changes in this branch then the results will be described in this PR after the next time Renovate runs.\n";
config.api.getBranchPr.mockReturnValueOnce({
title: 'Configure Renovate',
body: existingPrBody,
});
await onboarding.ensurePr(config, branchUpgrades);
expect(config.api.createPr.mock.calls.length).toBe(0);
expect(config.api.updatePr.mock.calls.length).toBe(0);
});
it('creates complex pr', async () => {
branchUpgrades = [
{
branchName: 'branch-a',
prTitle: 'Pin a',
upgrades: [
{
isPin: true,
depName: 'a',
repositoryUrl: 'https://a',
currentVersion: '^1.0.0',
newVersion: '1.1.0',
},
],
},
{
branchName: 'branch-b',
prTitle: 'Upgrade b',
schedule: 'on monday',
upgrades: [
{
depName: 'b',
currentVersion: '1.0.0',
newVersion: '2.0.0',
},
],
},
];
await onboarding.ensurePr(config, branchUpgrades);
expect(config.api.createPr.mock.calls.length).toBe(1);
expect(config.api.updatePr.mock.calls.length).toBe(0);
expect(config.api.createPr.mock.calls).toMatchSnapshot();
});
it('maintains yarn.lock', async () => {
branchUpgrades = [
{
branchName: 'renovate/lock-files',
prTitle: 'Lock File Maintenance',
schedule: 'before 5am on monday',
upgrades: [
{
type: 'lockFileMaintenance',
},
],
}, ];
await onboarding.ensurePr(config, branchUpgrades);
expect(config.api.createPr.mock.calls.length).toBe(1);
expect(config.api.updatePr.mock.calls.length).toBe(0);
expect(config.api.createPr.mock.calls).toMatchSnapshot();
});
it('handles groups', async () => {
branchUpgrades = [
{
branchName: 'branch-a',
prTitle: 'Pin a',
groupName: 'some-group',
upgrades: [
{
isPin: true,
depName: 'a',
repositoryUrl: 'https://a',
currentVersion: '^1.0.0',
newVersion: '1.1.0',
},
{
depName: 'b',
repositoryUrl: 'https://b',
currentVersion: '1.0.0',
newVersion: '2.0.0',
},
],
},
];
await onboarding.ensurePr(config, branchUpgrades);
expect(config.api.createPr.mock.calls.length).toBe(1);
expect(config.api.updatePr.mock.calls.length).toBe(0);
expect(config.api.createPr.mock.calls).toMatchSnapshot();
});
it('creates shows warnings and errors', async () => {
branchUpgrades = [
{
branchName: 'branch-a',
prTitle: 'Pin a',
upgrades: [
{
isPin: true,
depName: 'a',
repositoryUrl: 'https://a',
currentVersion: '^1.0.0',
newVersion: '1.1.0',
},
],
},
{
branchName: 'branch-b',
prTitle: 'Upgrade b',
upgrades: [
{
depName: 'b',
repositoryUrl: 'https://b',
currentVersion: '1.0.0',
newVersion: '2.0.0',
},
],
},
];
config.errors = [
{
depName: 'a',
message: 'uhoh a',
},
];
config.warnings = [
{ depName: 'b',
message: 'uhoh b',
},
];
await onboarding.ensurePr(config, branchUpgrades);
expect(config.api.createPr.mock.calls.length).toBe(1);
expect(config.api.updatePr.mock.calls.length).toBe(0);
expect(config.api.createPr.mock.calls).toMatchSnapshot();
});
});
describe('getOnboardingStatus(config)', () => {
let config;
beforeEach(() => {
config = { ...defaultConfig };
jest.resetAllMocks();
apis.detectPackageFiles = jest.fn(a => a);
config.api = {
commitFilesToBranch: jest.fn(),
createPr: jest.fn(() => ({ displayNumber: 1 })),
findPr: jest.fn(),
getFileContent: jest.fn(),
getPr: jest.fn(() => {}),
getCommitMessages: jest.fn(),
};
config.foundIgnoredPaths = true;
config.logger = logger;
config.types = { npm: true };
config.detectedPackageFiles = true;
onboarding.isRepoPrivate = jest.fn();
});
it('returns true if onboarding is false', async () => {
config.onboarding = false;
const res = await onboarding.getOnboardingStatus(config);
expect(res).toEqual(true);
expect(config.api.findPr.mock.calls.length).toBe(0);
expect(config.api.commitFilesToBranch.mock.calls.length).toBe(0);
});
it('returns true if renovate config present', async () => {
config.renovateJsonPresent = true;
const res = await onboarding.getOnboardingStatus(config);
expect(res).toEqual(true);
expect(config.api.findPr.mock.calls.length).toBe(0);
expect(config.api.commitFilesToBranch.mock.calls.length).toBe(0);
});
it('returns true if pr and pr is closed', async () => {
config.api.findPr.mockReturnValueOnce({ isClosed: true });
const res = await onboarding.getOnboardingStatus(config);
expect(res).toEqual(true);
expect(config.api.findPr.mock.calls.length).toBe(1);
expect(config.api.commitFilesToBranch.mock.calls.length).toBe(0);
});
it('commits files if pr is not closed and is rebaseable', async () => {
config.api.findPr.mockReturnValueOnce({});
config.api.getPr.mockReturnValueOnce({ canRebase: true });
const res = await onboarding.getOnboardingStatus(config);
expect(res).toEqual(false);
expect(config.api.findPr.mock.calls.length).toBe(1);
expect(config.api.commitFilesToBranch.mock.calls.length).toBe(1);
});
it('skips file update if existing pr is not rebaseable', async () => {
config.api.findPr.mockReturnValueOnce({});
config.api.getPr.mockReturnValueOnce({ canRebase: false });
const res = await onboarding.getOnboardingStatus(config);
expect(res).toEqual(false);
expect(config.api.findPr.mock.calls.length).toBe(1);
expect(config.api.commitFilesToBranch.mock.calls.length).toBe(0);
});
it('commits files and returns false if no pr', async () => {
const res = await onboarding.getOnboardingStatus(config);
expect(res).toEqual(false); expect(config.api.findPr.mock.calls.length).toBe(1);
expect(config.api.commitFilesToBranch.mock.calls.length).toBe(1);
expect(config.api.commitFilesToBranch.mock.calls[0]).toMatchSnapshot();
});
it('uses config:base if no npm', async () => {
config.types.npm = false;
config.types.meteor = true;
config.types.docker = true;
const res = await onboarding.getOnboardingStatus(config);
expect(res).toEqual(false);
expect(config.api.findPr.mock.calls.length).toBe(1);
expect(config.api.commitFilesToBranch.mock.calls.length).toBe(1);
expect(config.api.commitFilesToBranch.mock.calls[0]).toMatchSnapshot();
});
it('pins private repos', async () => {
onboarding.isRepoPrivate.mockReturnValueOnce(true);
const res = await onboarding.getOnboardingStatus(config);
expect(res).toEqual(false);
expect(config.api.findPr.mock.calls.length).toBe(1);
expect(config.api.commitFilesToBranch.mock.calls.length).toBe(1);
expect(config.api.commitFilesToBranch.mock.calls[0]).toMatchSnapshot();
});
it('commits files if existing content does not match', async () => {
config.api.getFileContent.mockReturnValueOnce('some-different-content');
const res = await onboarding.getOnboardingStatus(config);
expect(res).toEqual(false);
expect(config.api.findPr.mock.calls.length).toBe(1);
expect(config.api.commitFilesToBranch.mock.calls.length).toBe(1);
expect(config.api.commitFilesToBranch.mock.calls[0]).toMatchSnapshot();
});
it('skips commit files if existing content matches', async () => {
const existingContent = `{\n "extends": ["config:js-lib"]\n}\n`;
config.api.getFileContent.mockReturnValueOnce(existingContent);
const res = await onboarding.getOnboardingStatus(config);
expect(res).toEqual(false);
expect(config.api.findPr.mock.calls.length).toBe(1);
expect(config.api.commitFilesToBranch.mock.calls.length).toBe(0);
});
});
});