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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
|
import {
GlDisclosureDropdown,
GlDropdownDivider,
GlModal,
GlToggle,
GlDisclosureDropdownItem,
} from '@gitlab/ui';
import Vue from 'vue';
import VueApollo from 'vue-apollo';
import createMockApollo from 'helpers/mock_apollo_helper';
import { stubComponent } from 'helpers/stub_component';
import waitForPromises from 'helpers/wait_for_promises';
import { shallowMountExtended } from 'helpers/vue_test_utils_helper';
import { isLoggedIn } from '~/lib/utils/common_utils';
import toast from '~/vue_shared/plugins/global_toast';
import WorkItemActions from '~/work_items/components/work_item_actions.vue';
import WorkItemStateToggle from '~/work_items/components/work_item_state_toggle.vue';
import {
STATE_OPEN,
TEST_ID_CONFIDENTIALITY_TOGGLE_ACTION,
TEST_ID_NOTIFICATIONS_TOGGLE_FORM,
TEST_ID_DELETE_ACTION,
TEST_ID_PROMOTE_ACTION,
TEST_ID_COPY_REFERENCE_ACTION,
TEST_ID_COPY_CREATE_NOTE_EMAIL_ACTION,
TEST_ID_TOGGLE_ACTION,
} from '~/work_items/constants';
import updateWorkItemNotificationsMutation from '~/work_items/graphql/update_work_item_notifications.mutation.graphql';
import projectWorkItemTypesQuery from '~/work_items/graphql/project_work_item_types.query.graphql';
import convertWorkItemMutation from '~/work_items/graphql/work_item_convert.mutation.graphql';
import {
convertWorkItemMutationResponse,
projectWorkItemTypesQueryResponse,
convertWorkItemMutationErrorResponse,
updateWorkItemNotificationsMutationResponse,
} from '../mock_data';
jest.mock('~/lib/utils/common_utils');
jest.mock('~/vue_shared/plugins/global_toast');
describe('WorkItemActions component', () => {
Vue.use(VueApollo);
let wrapper;
const mockWorkItemReference = 'gitlab-org/gitlab-test#1';
const mockWorkItemCreateNoteEmail =
'gitlab-incoming+gitlab-org-gitlab-test-2-ddpzuq0zd2wefzofcpcdr3dg7-issue-1@gmail.com';
const findModal = () => wrapper.findComponent(GlModal);
const findConfidentialityToggleButton = () =>
wrapper.findByTestId(TEST_ID_CONFIDENTIALITY_TOGGLE_ACTION);
const findDeleteButton = () => wrapper.findByTestId(TEST_ID_DELETE_ACTION);
const findPromoteButton = () => wrapper.findByTestId(TEST_ID_PROMOTE_ACTION);
const findCopyReferenceButton = () => wrapper.findByTestId(TEST_ID_COPY_REFERENCE_ACTION);
const findWorkItemToggleOption = () => wrapper.findComponent(WorkItemStateToggle);
const findCopyCreateNoteEmailButton = () =>
wrapper.findByTestId(TEST_ID_COPY_CREATE_NOTE_EMAIL_ACTION);
const findDropdownItems = () => wrapper.findAll('[data-testid="work-item-actions-dropdown"] > *');
const findDropdownItemsActual = () =>
findDropdownItems().wrappers.map((x) => {
if (x.is(GlDropdownDivider)) {
return { divider: true };
}
return {
testId: x.attributes('data-testid'),
text: x.text(),
};
});
const findNotificationsToggle = () => wrapper.findComponent(GlToggle);
const modalShowSpy = jest.fn();
const $toast = {
show: jest.fn(),
hide: jest.fn(),
};
const typesQuerySuccessHandler = jest.fn().mockResolvedValue(projectWorkItemTypesQueryResponse);
const convertWorkItemMutationSuccessHandler = jest
.fn()
.mockResolvedValue(convertWorkItemMutationResponse);
const convertWorkItemMutationErrorHandler = jest
.fn()
.mockResolvedValue(convertWorkItemMutationErrorResponse);
const toggleNotificationsOffHandler = jest
.fn()
.mockResolvedValue(updateWorkItemNotificationsMutationResponse(false));
const toggleNotificationsOnHandler = jest
.fn()
.mockResolvedValue(updateWorkItemNotificationsMutationResponse(true));
const toggleNotificationsFailureHandler = jest
.fn()
.mockRejectedValue(new Error('Failed to subscribe'));
const createComponent = ({
canUpdate = true,
canDelete = true,
isConfidential = false,
subscribed = false,
isParentConfidential = false,
convertWorkItemMutationHandler = convertWorkItemMutationSuccessHandler,
notificationsMutationHandler,
workItemType = 'Task',
workItemReference = mockWorkItemReference,
workItemCreateNoteEmail = mockWorkItemCreateNoteEmail,
} = {}) => {
wrapper = shallowMountExtended(WorkItemActions, {
isLoggedIn: isLoggedIn(),
apolloProvider: createMockApollo([
[projectWorkItemTypesQuery, typesQuerySuccessHandler],
[convertWorkItemMutation, convertWorkItemMutationHandler],
[updateWorkItemNotificationsMutation, notificationsMutationHandler],
]),
propsData: {
workItemState: STATE_OPEN,
fullPath: 'gitlab-org/gitlab-test',
workItemId: 'gid://gitlab/WorkItem/1',
canUpdate,
canDelete,
isConfidential,
subscribed,
isParentConfidential,
workItemType,
workItemReference,
workItemCreateNoteEmail,
},
provide: {
isGroup: false,
glFeatures: { workItemsMvc2: true },
},
mocks: {
$toast,
},
stubs: {
GlModal: stubComponent(GlModal, {
methods: {
show: jest.fn(),
},
}),
GlDisclosureDropdownItem,
GlDisclosureDropdown: stubComponent(GlDisclosureDropdown, {
methods: {
close: modalShowSpy,
},
}),
},
});
};
beforeEach(() => {
isLoggedIn.mockReturnValue(true);
});
it('renders modal', () => {
createComponent();
expect(findModal().props('visible')).toBe(false);
});
it('renders dropdown actions', () => {
createComponent();
expect(findDropdownItemsActual()).toEqual([
{
testId: TEST_ID_NOTIFICATIONS_TOGGLE_FORM,
text: '',
},
{
divider: true,
},
{
testId: TEST_ID_CONFIDENTIALITY_TOGGLE_ACTION,
text: 'Turn on confidentiality',
},
{
testId: TEST_ID_TOGGLE_ACTION,
text: '',
},
{
testId: TEST_ID_COPY_REFERENCE_ACTION,
text: 'Copy reference',
},
{
testId: TEST_ID_COPY_CREATE_NOTE_EMAIL_ACTION,
text: 'Copy task email address',
},
{
divider: true,
},
{
testId: TEST_ID_DELETE_ACTION,
text: 'Delete task',
},
]);
});
describe('toggle confidentiality action', () => {
it.each`
isConfidential | buttonText
${true} | ${'Turn off confidentiality'}
${false} | ${'Turn on confidentiality'}
`(
'renders confidentiality toggle button with text "$buttonText"',
({ isConfidential, buttonText }) => {
createComponent({ isConfidential });
expect(findConfidentialityToggleButton().text()).toBe(buttonText);
},
);
it('emits `toggleWorkItemConfidentiality` event when clicked', () => {
createComponent();
findConfidentialityToggleButton().vm.$emit('action');
expect(wrapper.emitted('toggleWorkItemConfidentiality')[0]).toEqual([true]);
});
it.each`
props | propName | value
${{ isParentConfidential: true }} | ${'isParentConfidential'} | ${true}
${{ canUpdate: false }} | ${'canUpdate'} | ${false}
`('does not render when $propName is $value', ({ props }) => {
createComponent(props);
expect(findConfidentialityToggleButton().exists()).toBe(false);
});
});
describe('delete action', () => {
it('shows confirm modal when clicked', () => {
createComponent();
findDeleteButton().vm.$emit('action');
expect(modalShowSpy).toHaveBeenCalled();
});
it('emits event when clicking OK button', () => {
createComponent();
findModal().vm.$emit('ok');
expect(wrapper.emitted('deleteWorkItem')).toEqual([[]]);
});
it('does not render when canDelete is false', () => {
createComponent({ canDelete: false });
expect(findDeleteButton().exists()).toBe(false);
});
});
describe('notifications action', () => {
beforeEach(() => {
createComponent();
isLoggedIn.mockReturnValue(true);
});
it('renders toggle button', () => {
expect(findNotificationsToggle().exists()).toBe(true);
});
it.each`
scenario | subscribedToNotifications | notificationsMutationHandler | subscribed | toastMessage
${'turned off'} | ${false} | ${toggleNotificationsOffHandler} | ${false} | ${'Notifications turned off.'}
${'turned on'} | ${true} | ${toggleNotificationsOnHandler} | ${true} | ${'Notifications turned on.'}
`(
'calls mutation and displays toast when notification toggle is $scenario',
async ({
subscribedToNotifications,
notificationsMutationHandler,
subscribed,
toastMessage,
}) => {
createComponent({ notificationsMutationHandler });
findNotificationsToggle().vm.$emit('change', subscribedToNotifications);
await waitForPromises();
expect(notificationsMutationHandler).toHaveBeenCalledWith({
input: {
id: 'gid://gitlab/WorkItem/1',
subscribed,
},
});
expect(toast).toHaveBeenCalledWith(toastMessage);
},
);
it('emits error when the update notification mutation fails', async () => {
createComponent({ notificationsMutationHandler: toggleNotificationsFailureHandler });
findNotificationsToggle().vm.$emit('change', false);
await waitForPromises();
expect(wrapper.emitted('error')).toEqual([['Failed to subscribe']]);
});
});
describe('promote action', () => {
it.each`
workItemType | show
${'Task'} | ${false}
${'Objective'} | ${false}
`('does not show promote button for $workItemType', ({ workItemType, show }) => {
createComponent({ workItemType });
expect(findPromoteButton().exists()).toBe(show);
});
it('promote key result to objective', async () => {
createComponent({ workItemType: 'Key Result' });
await waitForPromises();
expect(findPromoteButton().exists()).toBe(true);
findPromoteButton().vm.$emit('action');
await waitForPromises();
expect(convertWorkItemMutationSuccessHandler).toHaveBeenCalled();
expect($toast.show).toHaveBeenCalledWith('Promoted to objective.');
expect(wrapper.emitted('promotedToObjective')).toEqual([[]]);
});
it('emits error when promote mutation fails', async () => {
createComponent({
workItemType: 'Key Result',
convertWorkItemMutationHandler: convertWorkItemMutationErrorHandler,
});
await waitForPromises();
expect(findPromoteButton().exists()).toBe(true);
findPromoteButton().vm.$emit('action');
await waitForPromises();
expect(convertWorkItemMutationErrorHandler).toHaveBeenCalled();
expect(wrapper.emitted('error')).toEqual([
['Something went wrong while promoting the key result. Please try again.'],
]);
});
});
describe('copy reference action', () => {
it('shows toast when user clicks on the action', () => {
createComponent();
expect(findCopyReferenceButton().exists()).toBe(true);
findCopyReferenceButton().vm.$emit('action');
expect(toast).toHaveBeenCalledWith('Reference copied');
});
});
describe('copy email address action', () => {
it.each(['key result', 'objective'])(
'renders correct button name when work item is %s',
(workItemType) => {
createComponent({ workItemType });
expect(findCopyCreateNoteEmailButton().text()).toEqual(
`Copy ${workItemType} email address`,
);
},
);
it('shows toast when user clicks on the action', () => {
createComponent();
expect(findCopyCreateNoteEmailButton().exists()).toBe(true);
findCopyCreateNoteEmailButton().vm.$emit('action');
expect(toast).toHaveBeenCalledWith('Email address copied');
});
});
it('renders the toggle status button', () => {
createComponent();
expect(findWorkItemToggleOption().exists()).toBe(true);
});
});
|