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
352
353
354
355
356
357
358
359
360
361
362
363
|
import { GlLoadingIcon, GlEmptyState, GlAlert, GlIntersectionObserver } from '@gitlab/ui';
import { mount, shallowMount } from '@vue/test-utils';
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 JobsTableTabs from '~/jobs/components/table/jobs_table_tabs.vue';
import JobsSkeletonLoader from '~/pages/admin/jobs/components/jobs_skeleton_loader.vue';
import getAllJobsQuery from '~/pages/admin/jobs/components/table/graphql/queries/get_all_jobs.query.graphql';
import getAllJobsCount from '~/pages/admin/jobs/components/table/graphql/queries/get_all_jobs_count.query.graphql';
import getCancelableJobsQuery from '~/pages/admin/jobs/components/table/graphql/queries/get_cancelable_jobs_count.query.graphql';
import AdminJobsTableApp from '~/pages/admin/jobs/components/table/admin_jobs_table_app.vue';
import CancelJobs from '~/pages/admin/jobs/components/cancel_jobs.vue';
import JobsTable from '~/jobs/components/table/jobs_table.vue';
import { createAlert } from '~/alert';
import { TEST_HOST } from 'spec/test_constants';
import JobsFilteredSearch from '~/jobs/components/filtered_search/jobs_filtered_search.vue';
import * as urlUtils from '~/lib/utils/url_utility';
import {
JOBS_FETCH_ERROR_MSG,
CANCELABLE_JOBS_ERROR_MSG,
LOADING_ARIA_LABEL,
RAW_TEXT_WARNING_ADMIN,
JOBS_COUNT_ERROR_MESSAGE,
} from '~/pages/admin/jobs/components/constants';
import {
mockAllJobsResponsePaginated,
mockCancelableJobsCountResponse,
mockAllJobsResponseEmpty,
statuses,
mockFailedSearchToken,
mockAllJobsCountResponse,
} from '../../../../../jobs/mock_data';
Vue.use(VueApollo);
jest.mock('~/alert');
describe('Job table app', () => {
let wrapper;
const successHandler = jest.fn().mockResolvedValue(mockAllJobsResponsePaginated);
const failedHandler = jest.fn().mockRejectedValue(new Error('GraphQL error'));
const cancelHandler = jest.fn().mockResolvedValue(mockCancelableJobsCountResponse);
const emptyHandler = jest.fn().mockResolvedValue(mockAllJobsResponseEmpty);
const countSuccessHandler = jest.fn().mockResolvedValue(mockAllJobsCountResponse);
const findSkeletonLoader = () => wrapper.findComponent(JobsSkeletonLoader);
const findLoadingSpinner = () => wrapper.findComponent(GlLoadingIcon);
const findTable = () => wrapper.findComponent(JobsTable);
const findEmptyState = () => wrapper.findComponent(GlEmptyState);
const findAlert = () => wrapper.findComponent(GlAlert);
const findTabs = () => wrapper.findComponent(JobsTableTabs);
const findCancelJobsButton = () => wrapper.findComponent(CancelJobs);
const findFilteredSearch = () => wrapper.findComponent(JobsFilteredSearch);
const triggerInfiniteScroll = () =>
wrapper.findComponent(GlIntersectionObserver).vm.$emit('appear');
const createMockApolloProvider = (handler, cancelableHandler, countHandler) => {
const requestHandlers = [
[getAllJobsQuery, handler],
[getCancelableJobsQuery, cancelableHandler],
[getAllJobsCount, countHandler],
];
return createMockApollo(requestHandlers);
};
const createComponent = ({
handler = successHandler,
cancelableHandler = cancelHandler,
countHandler = countSuccessHandler,
mountFn = shallowMount,
data = {},
} = {}) => {
wrapper = mountFn(AdminJobsTableApp, {
data() {
return {
...data,
};
},
provide: {
jobStatuses: statuses,
},
apolloProvider: createMockApolloProvider(handler, cancelableHandler, countHandler),
});
};
describe('loading state', () => {
it('should display skeleton loader when loading', () => {
createComponent();
expect(findSkeletonLoader().exists()).toBe(true);
expect(findTable().exists()).toBe(false);
expect(findLoadingSpinner().exists()).toBe(false);
});
it('when switching tabs only the skeleton loader should show', () => {
createComponent();
findTabs().vm.$emit('fetchJobsByStatus', null);
expect(findSkeletonLoader().exists()).toBe(true);
expect(findLoadingSpinner().exists()).toBe(false);
});
});
describe('loaded state', () => {
beforeEach(async () => {
createComponent();
await waitForPromises();
});
it('should display the jobs table with data', () => {
expect(findTable().exists()).toBe(true);
expect(findSkeletonLoader().exists()).toBe(false);
expect(findLoadingSpinner().exists()).toBe(false);
});
it('should refetch jobs query on fetchJobsByStatus event', async () => {
jest.spyOn(wrapper.vm.$apollo.queries.jobs, 'refetch').mockImplementation(jest.fn());
expect(wrapper.vm.$apollo.queries.jobs.refetch).toHaveBeenCalledTimes(0);
await findTabs().vm.$emit('fetchJobsByStatus');
expect(wrapper.vm.$apollo.queries.jobs.refetch).toHaveBeenCalledTimes(1);
});
describe('when infinite scrolling is triggered', () => {
it('does not display a skeleton loader', () => {
triggerInfiniteScroll();
expect(findSkeletonLoader().exists()).toBe(false);
});
it('handles infinite scrolling by calling fetch more', async () => {
triggerInfiniteScroll();
await nextTick();
const pageSize = 50;
expect(findLoadingSpinner().exists()).toBe(true);
expect(findLoadingSpinner().attributes('aria-label')).toBe(LOADING_ARIA_LABEL);
await waitForPromises();
expect(findLoadingSpinner().exists()).toBe(false);
expect(successHandler).toHaveBeenLastCalledWith({
first: pageSize,
after: mockAllJobsResponsePaginated.data.jobs.pageInfo.endCursor,
});
});
});
});
describe('empty state', () => {
it('should display empty state if there are no jobs and tab scope is null', async () => {
createComponent({ handler: emptyHandler, mountFn: mount });
await waitForPromises();
expect(findEmptyState().exists()).toBe(true);
expect(findTable().exists()).toBe(false);
});
it('should not display empty state if there are jobs and tab scope is not null', async () => {
createComponent({ handler: successHandler, mountFn: mount });
await waitForPromises();
expect(findEmptyState().exists()).toBe(false);
expect(findTable().exists()).toBe(true);
});
});
describe('error state', () => {
it('should show an alert if there is an error fetching the jobs data', async () => {
createComponent({ handler: failedHandler });
await waitForPromises();
expect(findAlert().text()).toBe(JOBS_FETCH_ERROR_MSG);
expect(findTable().exists()).toBe(false);
});
it('should show an alert if there is an error fetching the jobs count data', async () => {
createComponent({ handler: successHandler, countHandler: failedHandler });
await waitForPromises();
expect(findAlert().text()).toBe(JOBS_COUNT_ERROR_MESSAGE);
});
it('should show an alert if there is an error fetching the cancelable jobs data', async () => {
createComponent({ handler: successHandler, cancelableHandler: failedHandler });
await waitForPromises();
expect(findAlert().text()).toBe(CANCELABLE_JOBS_ERROR_MSG);
});
it('jobs table should still load if count query fails', async () => {
createComponent({ handler: successHandler, countHandler: failedHandler });
await waitForPromises();
expect(findTable().exists()).toBe(true);
});
it('jobs table should still load if cancel query fails', async () => {
createComponent({ handler: successHandler, cancelableHandler: failedHandler });
await waitForPromises();
expect(findTable().exists()).toBe(true);
});
it('jobs count should be zero if count query fails', async () => {
createComponent({ handler: successHandler, countHandler: failedHandler });
await waitForPromises();
expect(findTabs().props('allJobsCount')).toBe(0);
});
it('cancel button should be hidden if query fails', async () => {
createComponent({ handler: successHandler, cancelableHandler: failedHandler });
await waitForPromises();
expect(findCancelJobsButton().exists()).toBe(false);
});
});
describe('cancel jobs button', () => {
it('should display cancel all jobs button', async () => {
createComponent({ cancelableHandler: cancelHandler, mountFn: mount });
await waitForPromises();
expect(findCancelJobsButton().exists()).toBe(true);
});
it('should not display cancel all jobs button', async () => {
createComponent();
await waitForPromises();
expect(findCancelJobsButton().exists()).toBe(false);
});
});
describe('filtered search', () => {
it('should display filtered search', () => {
createComponent();
expect(findFilteredSearch().exists()).toBe(true);
});
// this test should be updated once BE supports tab and filtered search filtering
// https://gitlab.com/gitlab-org/gitlab/-/issues/356210
it.each`
scope | shouldDisplay
${null} | ${true}
${['FAILED', 'SUCCESS', 'CANCELED']} | ${false}
`(
'with tab scope $scope the filtered search displays $shouldDisplay',
async ({ scope, shouldDisplay }) => {
createComponent();
await waitForPromises();
await findTabs().vm.$emit('fetchJobsByStatus', scope);
expect(findFilteredSearch().exists()).toBe(shouldDisplay);
},
);
it('refetches jobs query when filtering', async () => {
createComponent();
jest.spyOn(wrapper.vm.$apollo.queries.jobs, 'refetch').mockImplementation(jest.fn());
expect(wrapper.vm.$apollo.queries.jobs.refetch).toHaveBeenCalledTimes(0);
await findFilteredSearch().vm.$emit('filterJobsBySearch', [mockFailedSearchToken]);
expect(wrapper.vm.$apollo.queries.jobs.refetch).toHaveBeenCalledTimes(1);
});
it('refetches jobs count query when filtering', async () => {
createComponent();
jest.spyOn(wrapper.vm.$apollo.queries.jobsCount, 'refetch').mockImplementation(jest.fn());
expect(wrapper.vm.$apollo.queries.jobsCount.refetch).toHaveBeenCalledTimes(0);
await findFilteredSearch().vm.$emit('filterJobsBySearch', [mockFailedSearchToken]);
expect(wrapper.vm.$apollo.queries.jobsCount.refetch).toHaveBeenCalledTimes(1);
});
it('shows raw text warning when user inputs raw text', async () => {
const expectedWarning = {
message: RAW_TEXT_WARNING_ADMIN,
type: 'warning',
};
createComponent();
jest.spyOn(wrapper.vm.$apollo.queries.jobs, 'refetch').mockImplementation(jest.fn());
await findFilteredSearch().vm.$emit('filterJobsBySearch', ['raw text']);
expect(createAlert).toHaveBeenCalledWith(expectedWarning);
expect(wrapper.vm.$apollo.queries.jobs.refetch).toHaveBeenCalledTimes(0);
});
it('updates URL query string when filtering jobs by status', async () => {
createComponent();
jest.spyOn(urlUtils, 'updateHistory');
await findFilteredSearch().vm.$emit('filterJobsBySearch', [mockFailedSearchToken]);
expect(urlUtils.updateHistory).toHaveBeenCalledWith({
url: `${TEST_HOST}/?statuses=FAILED`,
});
});
it('resets query param after clearing tokens', () => {
createComponent();
jest.spyOn(urlUtils, 'updateHistory');
findFilteredSearch().vm.$emit('filterJobsBySearch', [mockFailedSearchToken]);
expect(successHandler).toHaveBeenCalledWith({
first: 50,
statuses: 'FAILED',
});
expect(urlUtils.updateHistory).toHaveBeenCalledWith({
url: `${TEST_HOST}/?statuses=FAILED`,
});
findFilteredSearch().vm.$emit('filterJobsBySearch', []);
expect(urlUtils.updateHistory).toHaveBeenCalledWith({
url: `${TEST_HOST}/`,
});
expect(successHandler).toHaveBeenCalledWith({
first: 50,
statuses: null,
});
});
});
});
|