-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
error-config.spec.ts
133 lines (113 loc) · 4.21 KB
/
error-config.spec.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
import { mock } from 'jest-mock-extended';
import { RenovateConfig, partial, platform } from '../../../test/util';
import { GlobalConfig } from '../../config/global';
import { CONFIG_VALIDATION } from '../../constants/error-messages';
import { logger } from '../../logger';
import type { Pr } from '../../modules/platform';
import {
raiseConfigWarningIssue,
raiseCredentialsWarningIssue,
} from './error-config';
jest.mock('../../modules/platform');
let config: RenovateConfig;
beforeEach(() => {
// default values
config = partial<RenovateConfig>({
onboardingBranch: 'configure/renovate',
suppressNotifications: ['deprecationWarningIssues'],
configWarningReuseIssue: true,
confidential: false,
});
});
describe('workers/repository/error-config', () => {
describe('raiseConfigWarningIssue()', () => {
beforeEach(() => {
GlobalConfig.reset();
});
it('creates issues', async () => {
const expectedBody = `There are missing credentials for the authentication-required feature. As a precaution, Renovate will pause PRs until it is resolved.
Location: \`package.json\`
Error type: some-error
Message: some-message
`;
const error = new Error(CONFIG_VALIDATION);
error.validationSource = 'package.json';
error.validationMessage = 'some-message';
error.validationError = 'some-error';
platform.ensureIssue.mockResolvedValueOnce('created');
const res = await raiseCredentialsWarningIssue(config, error);
expect(res).toBeUndefined();
expect(logger.warn).toHaveBeenCalledWith(
{ configError: error, res: 'created' },
'Configuration Warning'
);
expect(platform.ensureIssue).toHaveBeenCalledWith(
expect.objectContaining({ body: expectedBody })
);
});
it('creates issues (dryRun)', async () => {
const error = new Error(CONFIG_VALIDATION);
error.validationSource = 'package.json';
error.validationMessage = 'some-message';
platform.ensureIssue.mockResolvedValueOnce('created');
GlobalConfig.set({ dryRun: 'full' });
const res = await raiseConfigWarningIssue(config, error);
expect(res).toBeUndefined();
expect(logger.info).toHaveBeenCalledWith(
{ configError: error },
'DRY-RUN: Would ensure configuration error issue'
);
});
it('handles onboarding', async () => {
const error = new Error(CONFIG_VALIDATION);
error.validationSource = 'package.json';
error.validationMessage = 'some-message';
const pr = partial<Pr>({
title: 'onboarding',
number: 1,
state: 'open',
});
platform.getBranchPr.mockResolvedValue(pr);
const res = await raiseConfigWarningIssue(config, error);
expect(res).toBeUndefined();
expect(platform.updatePr).toHaveBeenCalledWith(
expect.objectContaining({ prTitle: pr.title, number: pr.number })
);
});
it('handles onboarding (dryRun)', async () => {
const error = new Error(CONFIG_VALIDATION);
error.validationSource = 'package.json';
error.validationMessage = 'some-message';
const pr = partial<Pr>({
number: 1,
state: 'open',
});
platform.getBranchPr.mockResolvedValue(pr);
GlobalConfig.set({ dryRun: 'full' });
const res = await raiseConfigWarningIssue(config, error);
expect(res).toBeUndefined();
expect(logger.info).toHaveBeenCalledWith(
`DRY-RUN: Would update PR #${pr.number}`
);
});
it('disable issue creation on config failure', async () => {
const notificationName = 'configErrorIssue';
const error = new Error(CONFIG_VALIDATION);
error.validationSource = 'package.json';
error.validationMessage = 'some-message';
// config.suppressNotifications = ['deprecationWarningIssues']
config.suppressNotifications = [notificationName];
platform.getBranchPr.mockResolvedValueOnce({
...mock<Pr>(),
number: 1,
state: '!open',
});
const res = await raiseConfigWarningIssue(config, error);
expect(res).toBeUndefined();
expect(logger.info).toHaveBeenCalledWith(
{ notificationName },
'Configuration failure, issues will be suppressed'
);
});
});
});