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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
import MockAdapter from 'axios-mock-adapter';
import { mountExtended } from 'helpers/vue_test_utils_helper';
import waitForPromises from 'helpers/wait_for_promises';
import axios from '~/lib/utils/axios_utils';
import Poll from '~/lib/utils/poll';
import extensionsContainer from '~/vue_merge_request_widget/components/extensions/container';
import { registerExtension } from '~/vue_merge_request_widget/components/extensions';
import terraformExtension from '~/vue_merge_request_widget/extensions/terraform';
import {
plans,
validPlanWithName,
validPlanWithoutName,
invalidPlanWithName,
invalidPlanWithoutName,
} from '../../components/terraform/mock_data';
describe('Terraform extension', () => {
let wrapper;
let mock;
const endpoint = '/path/to/terraform/report.json';
const successStatusCode = 200;
const errorStatusCode = 500;
const findListItem = (at) => wrapper.findAllByTestId('extension-list-item').at(at);
registerExtension(terraformExtension);
const mockPollingApi = (response, body, header) => {
mock.onGet(endpoint).reply(response, body, header);
};
const createComponent = () => {
wrapper = mountExtended(extensionsContainer, {
propsData: {
mr: {
terraformReportsPath: endpoint,
},
},
});
return axios.waitForAll();
};
beforeEach(() => {
mock = new MockAdapter(axios);
});
afterEach(() => {
wrapper.destroy();
mock.restore();
});
describe('summary', () => {
describe('while loading', () => {
const loadingText = 'Loading Terraform reports...';
it('should render loading text', async () => {
mockPollingApi(successStatusCode, plans, {});
createComponent();
expect(wrapper.text()).toContain(loadingText);
await waitForPromises();
expect(wrapper.text()).not.toContain(loadingText);
});
});
describe('when the fetching fails', () => {
beforeEach(() => {
mockPollingApi(errorStatusCode, null, {});
return createComponent();
});
it('should generate one invalid plan and render correct summary text', () => {
expect(wrapper.text()).toContain('1 Terraform report failed to generate');
});
});
describe('when the fetching succeeds', () => {
describe.each`
responseType | response | summaryTitle | summarySubtitle
${'1 invalid report'} | ${{ 0: invalidPlanWithName }} | ${'1 Terraform report failed to generate'} | ${''}
${'2 valid reports'} | ${{ 0: validPlanWithName, 1: validPlanWithName }} | ${'2 Terraform reports were generated in your pipelines'} | ${''}
${'1 valid and 2 invalid reports'} | ${{ 0: validPlanWithName, 1: invalidPlanWithName, 2: invalidPlanWithName }} | ${'Terraform report was generated in your pipelines'} | ${'2 Terraform reports failed to generate'}
`('and received $responseType', ({ response, summaryTitle, summarySubtitle }) => {
beforeEach(async () => {
mockPollingApi(successStatusCode, response, {});
return createComponent();
});
it(`should render correct summary text`, () => {
expect(wrapper.text()).toContain(summaryTitle);
if (summarySubtitle) {
expect(wrapper.text()).toContain(summarySubtitle);
}
});
});
});
});
describe('expanded data', () => {
beforeEach(async () => {
mockPollingApi(successStatusCode, plans, {});
await createComponent();
wrapper.findByTestId('toggle-button').trigger('click');
});
describe.each`
reportType | title | subtitle | logLink | lineNumber
${'a valid report with name'} | ${`The job ${validPlanWithName.job_name} generated a report.`} | ${`Reported Resource Changes: ${validPlanWithName.create} to add, ${validPlanWithName.update} to change, ${validPlanWithName.delete} to delete`} | ${validPlanWithName.job_path} | ${0}
${'a valid report without name'} | ${'A Terraform report was generated in your pipelines.'} | ${`Reported Resource Changes: ${validPlanWithoutName.create} to add, ${validPlanWithoutName.update} to change, ${validPlanWithoutName.delete} to delete`} | ${validPlanWithoutName.job_path} | ${1}
${'an invalid report with name'} | ${`The job ${invalidPlanWithName.job_name} failed to generate a report.`} | ${'Generating the report caused an error.'} | ${invalidPlanWithName.job_path} | ${2}
${'an invalid report without name'} | ${'A Terraform report failed to generate.'} | ${'Generating the report caused an error.'} | ${invalidPlanWithoutName.job_path} | ${3}
`('renders correct text for $reportType', ({ title, subtitle, logLink, lineNumber }) => {
it('renders correct text', () => {
expect(findListItem(lineNumber).text()).toContain(title);
expect(findListItem(lineNumber).text()).toContain(subtitle);
});
it(`${logLink ? 'renders' : "doesn't render"} the log link`, () => {
const logText = 'Full log';
if (logLink) {
expect(
findListItem(lineNumber)
.find('[data-testid="extension-actions-button"]')
.attributes('href'),
).toBe(logLink);
} else {
expect(findListItem(lineNumber).text()).not.toContain(logText);
}
});
});
});
describe('polling', () => {
let pollRequest;
let pollStop;
beforeEach(() => {
pollRequest = jest.spyOn(Poll.prototype, 'makeRequest');
pollStop = jest.spyOn(Poll.prototype, 'stop');
});
afterEach(() => {
pollRequest.mockRestore();
pollStop.mockRestore();
});
describe('successful poll', () => {
beforeEach(() => {
mockPollingApi(successStatusCode, plans, {});
return createComponent();
});
it('does not make additional requests after poll is successful', () => {
expect(pollRequest).toHaveBeenCalledTimes(1);
expect(pollStop).toHaveBeenCalledTimes(1);
});
});
describe('polling fails', () => {
beforeEach(() => {
mockPollingApi(errorStatusCode, null, {});
return createComponent();
});
it('generates one broken plan', () => {
expect(wrapper.text()).toContain('1 Terraform report failed to generate');
});
it('does not make additional requests after poll is unsuccessful', () => {
expect(pollRequest).toHaveBeenCalledTimes(1);
expect(pollStop).toHaveBeenCalledTimes(1);
});
});
});
});
|
