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
|
import { GlModal } from '@gitlab/ui';
import Vue, { nextTick } from 'vue';
import VueApollo from 'vue-apollo';
import createMockApollo from 'helpers/mock_apollo_helper';
import waitForPromises from 'helpers/wait_for_promises';
import { shallowMountExtended } from 'helpers/vue_test_utils_helper';
import { redirectTo } from '~/lib/utils/url_utility'; // eslint-disable-line import/no-deprecated
import ActionsCell from '~/jobs/components/table/cells/actions_cell.vue';
import eventHub from '~/jobs/components/table/event_hub';
import JobPlayMutation from '~/jobs/components/table/graphql/mutations/job_play.mutation.graphql';
import JobRetryMutation from '~/jobs/components/table/graphql/mutations/job_retry.mutation.graphql';
import JobUnscheduleMutation from '~/jobs/components/table/graphql/mutations/job_unschedule.mutation.graphql';
import JobCancelMutation from '~/jobs/components/table/graphql/mutations/job_cancel.mutation.graphql';
import {
mockJobsNodes,
mockJobsNodesAsGuest,
playMutationResponse,
retryMutationResponse,
unscheduleMutationResponse,
cancelMutationResponse,
} from '../../../mock_data';
jest.mock('~/lib/utils/url_utility');
Vue.use(VueApollo);
describe('Job actions cell', () => {
let wrapper;
const findMockJob = (jobName, nodes = mockJobsNodes) => {
const job = nodes.find(({ name }) => name === jobName);
expect(job).toBeDefined(); // ensure job is present
return job;
};
const mockJob = findMockJob('build');
const cancelableJob = findMockJob('cancelable');
const playableJob = findMockJob('playable');
const retryableJob = findMockJob('retryable');
const failedJob = findMockJob('failed');
const scheduledJob = findMockJob('scheduled');
const jobWithArtifact = findMockJob('with_artifact');
const cannotPlayJob = findMockJob('playable', mockJobsNodesAsGuest);
const cannotRetryJob = findMockJob('retryable', mockJobsNodesAsGuest);
const cannotPlayScheduledJob = findMockJob('scheduled', mockJobsNodesAsGuest);
const findRetryButton = () => wrapper.findByTestId('retry');
const findPlayButton = () => wrapper.findByTestId('play');
const findCancelButton = () => wrapper.findByTestId('cancel-button');
const findDownloadArtifactsButton = () => wrapper.findByTestId('download-artifacts');
const findCountdownButton = () => wrapper.findByTestId('countdown');
const findPlayScheduledJobButton = () => wrapper.findByTestId('play-scheduled');
const findUnscheduleButton = () => wrapper.findByTestId('unschedule');
const findModal = () => wrapper.findComponent(GlModal);
const playMutationHandler = jest.fn().mockResolvedValue(playMutationResponse);
const retryMutationHandler = jest.fn().mockResolvedValue(retryMutationResponse);
const unscheduleMutationHandler = jest.fn().mockResolvedValue(unscheduleMutationResponse);
const cancelMutationHandler = jest.fn().mockResolvedValue(cancelMutationResponse);
const $toast = {
show: jest.fn(),
};
const createMockApolloProvider = (requestHandlers) => {
return createMockApollo(requestHandlers);
};
const createComponent = (job, requestHandlers, props = {}) => {
wrapper = shallowMountExtended(ActionsCell, {
propsData: {
job,
...props,
},
apolloProvider: createMockApolloProvider(requestHandlers),
mocks: {
$toast,
},
});
};
it('displays the artifacts download button with correct link', () => {
createComponent(jobWithArtifact);
expect(findDownloadArtifactsButton().attributes('href')).toBe(
jobWithArtifact.artifacts.nodes[0].downloadPath,
);
});
it('does not display an artifacts download button', () => {
createComponent(mockJob);
expect(findDownloadArtifactsButton().exists()).toBe(false);
});
it.each`
button | action | jobType
${findPlayButton} | ${'play'} | ${cannotPlayJob}
${findRetryButton} | ${'retry'} | ${cannotRetryJob}
${findPlayScheduledJobButton} | ${'play scheduled'} | ${cannotPlayScheduledJob}
`('does not display the $action button if user cannot update build', ({ button, jobType }) => {
createComponent(jobType);
expect(button().exists()).toBe(false);
});
it.each`
button | action | jobType
${findPlayButton} | ${'play'} | ${playableJob}
${findRetryButton} | ${'retry'} | ${retryableJob}
${findDownloadArtifactsButton} | ${'download artifacts'} | ${jobWithArtifact}
${findCancelButton} | ${'cancel'} | ${cancelableJob}
`('displays the $action button', ({ button, jobType }) => {
createComponent(jobType);
expect(button().exists()).toBe(true);
});
it.each`
button | action | jobType | mutationFile | handler | jobId
${findPlayButton} | ${'play'} | ${playableJob} | ${JobPlayMutation} | ${playMutationHandler} | ${playableJob.id}
${findRetryButton} | ${'retry'} | ${retryableJob} | ${JobRetryMutation} | ${retryMutationHandler} | ${retryableJob.id}
${findCancelButton} | ${'cancel'} | ${cancelableJob} | ${JobCancelMutation} | ${cancelMutationHandler} | ${cancelableJob.id}
`('performs the $action mutation', ({ button, jobType, mutationFile, handler, jobId }) => {
createComponent(jobType, [[mutationFile, handler]]);
button().vm.$emit('click');
expect(handler).toHaveBeenCalledWith({ id: jobId });
});
it.each`
button | action | jobType | mutationFile | handler
${findUnscheduleButton} | ${'unschedule'} | ${scheduledJob} | ${JobUnscheduleMutation} | ${unscheduleMutationHandler}
${findCancelButton} | ${'cancel'} | ${cancelableJob} | ${JobCancelMutation} | ${cancelMutationHandler}
`(
'the mutation action $action emits the jobActionPerformed event',
async ({ button, jobType, mutationFile, handler }) => {
jest.spyOn(eventHub, '$emit').mockImplementation(() => {});
createComponent(jobType, [[mutationFile, handler]]);
button().vm.$emit('click');
await waitForPromises();
expect(eventHub.$emit).toHaveBeenCalledWith('jobActionPerformed');
expect(redirectTo).not.toHaveBeenCalled(); // eslint-disable-line import/no-deprecated
},
);
it.each`
button | action | jobType | mutationFile | handler | redirectLink
${findPlayButton} | ${'play'} | ${playableJob} | ${JobPlayMutation} | ${playMutationHandler} | ${'/root/project/-/jobs/1986'}
${findRetryButton} | ${'retry'} | ${retryableJob} | ${JobRetryMutation} | ${retryMutationHandler} | ${'/root/project/-/jobs/1985'}
`(
'the mutation action $action redirects to the job',
async ({ button, jobType, mutationFile, handler, redirectLink }) => {
jest.spyOn(eventHub, '$emit').mockImplementation(() => {});
createComponent(jobType, [[mutationFile, handler]]);
button().vm.$emit('click');
await waitForPromises();
expect(redirectTo).toHaveBeenCalledWith(redirectLink); // eslint-disable-line import/no-deprecated
expect(eventHub.$emit).not.toHaveBeenCalled();
},
);
it.each`
button | action | jobType
${findPlayButton} | ${'play'} | ${playableJob}
${findRetryButton} | ${'retry'} | ${retryableJob}
${findCancelButton} | ${'cancel'} | ${cancelableJob}
${findUnscheduleButton} | ${'unschedule'} | ${scheduledJob}
`('disables the $action button after first request', async ({ button, jobType }) => {
createComponent(jobType);
expect(button().props('disabled')).toBe(false);
button().vm.$emit('click');
await waitForPromises();
expect(button().props('disabled')).toBe(true);
});
describe('Retry button title', () => {
it('displays retry title when job has failed and is retryable', () => {
createComponent(failedJob);
expect(findRetryButton().attributes('title')).toBe('Retry');
});
it('displays run again title when job has passed and is retryable', () => {
createComponent(retryableJob);
expect(findRetryButton().attributes('title')).toBe('Run again');
});
});
describe('Scheduled Jobs', () => {
const today = () => new Date('2021-08-31');
beforeEach(() => {
jest.spyOn(Date, 'now').mockImplementation(today);
});
it('displays the countdown, play and unschedule buttons', () => {
createComponent(scheduledJob);
expect(findCountdownButton().exists()).toBe(true);
expect(findPlayScheduledJobButton().exists()).toBe(true);
expect(findUnscheduleButton().exists()).toBe(true);
});
it('unschedules a job', () => {
createComponent(scheduledJob, [[JobUnscheduleMutation, unscheduleMutationHandler]]);
findUnscheduleButton().vm.$emit('click');
expect(unscheduleMutationHandler).toHaveBeenCalledWith({
id: scheduledJob.id,
});
});
it('shows the play job confirmation modal', async () => {
createComponent(scheduledJob);
findPlayScheduledJobButton().vm.$emit('click');
await nextTick();
expect(findModal().exists()).toBe(true);
});
});
});
|