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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
|
import { GlAlert, GlEmptyState, GlLink, GlLoadingIcon, GlTabs } from '@gitlab/ui';
import Vue, { nextTick } from 'vue';
import VueApollo from 'vue-apollo';
import { trimText } from 'helpers/text_helper';
import createMockApollo from 'helpers/mock_apollo_helper';
import waitForPromises from 'helpers/wait_for_promises';
import { mountExtended } from 'helpers/vue_test_utils_helper';
import PipelineSchedules from '~/ci/pipeline_schedules/components/pipeline_schedules.vue';
import DeletePipelineScheduleModal from '~/ci/pipeline_schedules/components/delete_pipeline_schedule_modal.vue';
import TakeOwnershipModal from '~/ci/pipeline_schedules/components/take_ownership_modal.vue';
import PipelineSchedulesTable from '~/ci/pipeline_schedules/components/table/pipeline_schedules_table.vue';
import deletePipelineScheduleMutation from '~/ci/pipeline_schedules/graphql/mutations/delete_pipeline_schedule.mutation.graphql';
import playPipelineScheduleMutation from '~/ci/pipeline_schedules/graphql/mutations/play_pipeline_schedule.mutation.graphql';
import takeOwnershipMutation from '~/ci/pipeline_schedules/graphql/mutations/take_ownership.mutation.graphql';
import getPipelineSchedulesQuery from '~/ci/pipeline_schedules/graphql/queries/get_pipeline_schedules.query.graphql';
import {
mockGetPipelineSchedulesGraphQLResponse,
mockPipelineScheduleNodes,
mockPipelineScheduleCurrentUser,
deleteMutationResponse,
playMutationResponse,
takeOwnershipMutationResponse,
emptyPipelineSchedulesResponse,
} from '../mock_data';
Vue.use(VueApollo);
const $toast = {
show: jest.fn(),
};
describe('Pipeline schedules app', () => {
let wrapper;
const successHandler = jest.fn().mockResolvedValue(mockGetPipelineSchedulesGraphQLResponse);
const successEmptyHandler = jest.fn().mockResolvedValue(emptyPipelineSchedulesResponse);
const failedHandler = jest.fn().mockRejectedValue(new Error('GraphQL error'));
const deleteMutationHandlerSuccess = jest.fn().mockResolvedValue(deleteMutationResponse);
const deleteMutationHandlerFailed = jest.fn().mockRejectedValue(new Error('GraphQL error'));
const playMutationHandlerSuccess = jest.fn().mockResolvedValue(playMutationResponse);
const playMutationHandlerFailed = jest.fn().mockRejectedValue(new Error('GraphQL error'));
const takeOwnershipMutationHandlerSuccess = jest
.fn()
.mockResolvedValue(takeOwnershipMutationResponse);
const takeOwnershipMutationHandlerFailed = jest
.fn()
.mockRejectedValue(new Error('GraphQL error'));
const createMockApolloProvider = (
requestHandlers = [[getPipelineSchedulesQuery, successHandler]],
) => {
return createMockApollo(requestHandlers);
};
const createComponent = (requestHandlers) => {
wrapper = mountExtended(PipelineSchedules, {
provide: {
fullPath: 'gitlab-org/gitlab',
},
mocks: {
$toast,
},
apolloProvider: createMockApolloProvider(requestHandlers),
});
};
const findTable = () => wrapper.findComponent(PipelineSchedulesTable);
const findAlert = () => wrapper.findComponent(GlAlert);
const findDeleteModal = () => wrapper.findComponent(DeletePipelineScheduleModal);
const findLoadingIcon = () => wrapper.findComponent(GlLoadingIcon);
const findTakeOwnershipModal = () => wrapper.findComponent(TakeOwnershipModal);
const findTabs = () => wrapper.findComponent(GlTabs);
const findEmptyState = () => wrapper.findComponent(GlEmptyState);
const findLink = () => wrapper.findComponent(GlLink);
const findNewButton = () => wrapper.findByTestId('new-schedule-button');
const findAllTab = () => wrapper.findByTestId('pipeline-schedules-all-tab');
const findActiveTab = () => wrapper.findByTestId('pipeline-schedules-active-tab');
const findInactiveTab = () => wrapper.findByTestId('pipeline-schedules-inactive-tab');
const findSchedulesCharacteristics = () =>
wrapper.findByTestId('pipeline-schedules-characteristics');
afterEach(() => {
wrapper.destroy();
});
describe('default', () => {
beforeEach(() => {
createComponent();
});
it('displays table, tabs and new button', async () => {
await waitForPromises();
expect(findTable().exists()).toBe(true);
expect(findNewButton().exists()).toBe(true);
expect(findTabs().exists()).toBe(true);
expect(findAlert().exists()).toBe(false);
});
it('handles loading state', async () => {
expect(findLoadingIcon().exists()).toBe(true);
await waitForPromises();
expect(findLoadingIcon().exists()).toBe(false);
});
});
describe('fetching pipeline schedules', () => {
it('fetches query and passes an array of pipeline schedules', async () => {
createComponent();
expect(successHandler).toHaveBeenCalled();
await waitForPromises();
expect(findTable().props('schedules')).toEqual(mockPipelineScheduleNodes);
expect(findTable().props('currentUser')).toEqual(mockPipelineScheduleCurrentUser);
});
it('shows query error alert', async () => {
createComponent([[getPipelineSchedulesQuery, failedHandler]]);
await waitForPromises();
expect(findAlert().text()).toBe('There was a problem fetching pipeline schedules.');
});
});
describe('deleting a pipeline schedule', () => {
it('shows delete mutation error alert', async () => {
createComponent([
[getPipelineSchedulesQuery, successHandler],
[deletePipelineScheduleMutation, deleteMutationHandlerFailed],
]);
await waitForPromises();
findDeleteModal().vm.$emit('deleteSchedule');
await waitForPromises();
expect(findAlert().text()).toBe('There was a problem deleting the pipeline schedule.');
});
it('deletes pipeline schedule and refetches query', async () => {
createComponent([
[getPipelineSchedulesQuery, successHandler],
[deletePipelineScheduleMutation, deleteMutationHandlerSuccess],
]);
jest.spyOn(wrapper.vm.$apollo.queries.schedules, 'refetch');
await waitForPromises();
const scheduleId = mockPipelineScheduleNodes[0].id;
findTable().vm.$emit('showDeleteModal', scheduleId);
expect(wrapper.vm.$apollo.queries.schedules.refetch).not.toHaveBeenCalled();
findDeleteModal().vm.$emit('deleteSchedule');
await waitForPromises();
expect(deleteMutationHandlerSuccess).toHaveBeenCalledWith({
id: scheduleId,
});
expect(wrapper.vm.$apollo.queries.schedules.refetch).toHaveBeenCalled();
expect($toast.show).toHaveBeenCalledWith('Pipeline schedule successfully deleted.');
});
it('handles delete modal visibility correctly', async () => {
createComponent();
await waitForPromises();
expect(findDeleteModal().props('visible')).toBe(false);
findTable().vm.$emit('showDeleteModal', mockPipelineScheduleNodes[0].id);
await nextTick();
expect(findDeleteModal().props('visible')).toBe(true);
expect(findTakeOwnershipModal().props('visible')).toBe(false);
findDeleteModal().vm.$emit('hideModal');
await nextTick();
expect(findDeleteModal().props('visible')).toBe(false);
});
});
describe('playing a pipeline schedule', () => {
it('shows play mutation error alert', async () => {
createComponent([
[getPipelineSchedulesQuery, successHandler],
[playPipelineScheduleMutation, playMutationHandlerFailed],
]);
await waitForPromises();
findTable().vm.$emit('playPipelineSchedule');
await waitForPromises();
expect(findAlert().text()).toBe('There was a problem playing the pipeline schedule.');
});
it('plays pipeline schedule', async () => {
createComponent([
[getPipelineSchedulesQuery, successHandler],
[playPipelineScheduleMutation, playMutationHandlerSuccess],
]);
await waitForPromises();
const scheduleId = mockPipelineScheduleNodes[0].id;
findTable().vm.$emit('playPipelineSchedule', scheduleId);
await waitForPromises();
expect(playMutationHandlerSuccess).toHaveBeenCalledWith({
id: scheduleId,
});
expect(findAlert().text()).toBe(
'Successfully scheduled a pipeline to run. Go to the Pipelines page for details.',
);
});
});
describe('taking ownership of a pipeline schedule', () => {
it('shows take ownership mutation error alert', async () => {
createComponent([
[getPipelineSchedulesQuery, successHandler],
[takeOwnershipMutation, takeOwnershipMutationHandlerFailed],
]);
await waitForPromises();
findTakeOwnershipModal().vm.$emit('takeOwnership');
await waitForPromises();
expect(findAlert().text()).toBe(
'There was a problem taking ownership of the pipeline schedule.',
);
});
it('takes ownership of pipeline schedule and refetches query', async () => {
createComponent([
[getPipelineSchedulesQuery, successHandler],
[takeOwnershipMutation, takeOwnershipMutationHandlerSuccess],
]);
jest.spyOn(wrapper.vm.$apollo.queries.schedules, 'refetch');
await waitForPromises();
const scheduleId = mockPipelineScheduleNodes[1].id;
findTable().vm.$emit('showTakeOwnershipModal', scheduleId);
expect(wrapper.vm.$apollo.queries.schedules.refetch).not.toHaveBeenCalled();
findTakeOwnershipModal().vm.$emit('takeOwnership');
await waitForPromises();
expect(takeOwnershipMutationHandlerSuccess).toHaveBeenCalledWith({
id: scheduleId,
});
expect(wrapper.vm.$apollo.queries.schedules.refetch).toHaveBeenCalled();
expect($toast.show).toHaveBeenCalledWith('Successfully taken ownership from Admin.');
});
it('handles take ownership modal visibility correctly', async () => {
createComponent();
await waitForPromises();
expect(findTakeOwnershipModal().props('visible')).toBe(false);
findTable().vm.$emit('showTakeOwnershipModal', mockPipelineScheduleNodes[0].id);
await nextTick();
expect(findTakeOwnershipModal().props('visible')).toBe(true);
expect(findDeleteModal().props('visible')).toBe(false);
findTakeOwnershipModal().vm.$emit('hideModal');
await nextTick();
expect(findTakeOwnershipModal().props('visible')).toBe(false);
});
});
describe('pipeline schedule tabs', () => {
beforeEach(async () => {
createComponent();
await waitForPromises();
});
it('displays All tab with count', () => {
expect(trimText(findAllTab().text())).toBe(`All ${mockPipelineScheduleNodes.length}`);
});
it('displays Active tab with no count', () => {
expect(findActiveTab().text()).toBe('Active');
});
it('displays Inactive tab with no count', () => {
expect(findInactiveTab().text()).toBe('Inactive');
});
it('should refetch the schedules query on a tab click', async () => {
jest.spyOn(wrapper.vm.$apollo.queries.schedules, 'refetch').mockImplementation(jest.fn());
expect(wrapper.vm.$apollo.queries.schedules.refetch).toHaveBeenCalledTimes(0);
await findAllTab().trigger('click');
expect(wrapper.vm.$apollo.queries.schedules.refetch).toHaveBeenCalledTimes(1);
});
});
describe('Empty pipeline schedules response', () => {
it('should show an empty state', async () => {
createComponent([[getPipelineSchedulesQuery, successEmptyHandler]]);
await waitForPromises();
const schedulesCharacteristics = findSchedulesCharacteristics();
expect(findEmptyState().exists()).toBe(true);
expect(schedulesCharacteristics.text()).toContain('Runs for a specific branch or tag.');
expect(schedulesCharacteristics.text()).toContain('Can have custom CI/CD variables.');
expect(schedulesCharacteristics.text()).toContain(
'Runs with the same project permissions as the schedule owner.',
);
expect(findLink().exists()).toBe(true);
expect(findLink().text()).toContain('scheduled pipelines documentation.');
});
});
});
|