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
|
import { mount } from '@vue/test-utils';
import { GlBroadcastMessage, GlForm } from '@gitlab/ui';
import AxiosMockAdapter from 'axios-mock-adapter';
import { createAlert } from '~/alert';
import axios from '~/lib/utils/axios_utils';
import { HTTP_STATUS_BAD_REQUEST } from '~/lib/utils/http_status';
import MessageForm from '~/admin/broadcast_messages/components/message_form.vue';
import { TYPE_BANNER, TYPE_NOTIFICATION, THEMES } from '~/admin/broadcast_messages/constants';
import waitForPromises from 'helpers/wait_for_promises';
import { extendedWrapper } from 'helpers/vue_test_utils_helper';
import { MOCK_TARGET_ACCESS_LEVELS } from '../mock_data';
jest.mock('~/alert');
describe('MessageForm', () => {
let wrapper;
let axiosMock;
const defaultProps = {
message: 'zzzzzzz',
broadcastType: TYPE_BANNER,
theme: THEMES[0].value,
dismissable: false,
targetPath: '',
targetAccessLevels: [],
startsAt: new Date(),
endsAt: new Date(),
};
const messagesPath = '_messages_path_';
const findPreview = () => extendedWrapper(wrapper.findComponent(GlBroadcastMessage));
const findThemeSelect = () => wrapper.findComponent('[data-testid=theme-select]');
const findDismissable = () => wrapper.findComponent('[data-testid=dismissable-checkbox]');
const findTargetRoles = () => wrapper.findComponent('[data-testid=target-roles-checkboxes]');
const findSubmitButton = () => wrapper.findComponent('[data-testid=submit-button]');
const findForm = () => wrapper.findComponent(GlForm);
function createComponent({ broadcastMessage = {}, glFeatures = {} }) {
wrapper = mount(MessageForm, {
provide: {
glFeatures,
targetAccessLevelOptions: MOCK_TARGET_ACCESS_LEVELS,
messagesPath,
previewPath: '_preview_path_',
},
propsData: {
broadcastMessage: {
...defaultProps,
...broadcastMessage,
},
},
});
}
beforeEach(() => {
axiosMock = new AxiosMockAdapter(axios);
});
afterEach(() => {
axiosMock.restore();
createAlert.mockClear();
});
describe('the message preview', () => {
it('renders the preview with the user selected theme', () => {
const theme = 'blue';
createComponent({ broadcastMessage: { theme } });
expect(findPreview().props().theme).toEqual(theme);
});
it('renders the placeholder text when the user message is blank', () => {
createComponent({ broadcastMessage: { message: ' ' } });
expect(wrapper.text()).toContain(wrapper.vm.$options.i18n.messagePlaceholder);
});
});
describe('theme select dropdown', () => {
it('renders for Banners', () => {
createComponent({ broadcastMessage: { broadcastType: TYPE_BANNER } });
expect(findThemeSelect().exists()).toBe(true);
});
it('does not render for Notifications', () => {
createComponent({ broadcastMessage: { broadcastType: TYPE_NOTIFICATION } });
expect(findThemeSelect().exists()).toBe(false);
});
});
describe('dismissable checkbox', () => {
it('renders for Banners', () => {
createComponent({ broadcastMessage: { broadcastType: TYPE_BANNER } });
expect(findDismissable().exists()).toBe(true);
});
it('does not render for Notifications', () => {
createComponent({ broadcastMessage: { broadcastType: TYPE_NOTIFICATION } });
expect(findDismissable().exists()).toBe(false);
});
});
describe('target roles checkboxes', () => {
it('renders when roleTargetedBroadcastMessages feature is enabled', () => {
createComponent({ glFeatures: { roleTargetedBroadcastMessages: true } });
expect(findTargetRoles().exists()).toBe(true);
});
it('does not render when roleTargetedBroadcastMessages feature is disabled', () => {
createComponent({ glFeatures: { roleTargetedBroadcastMessages: false } });
expect(findTargetRoles().exists()).toBe(false);
});
});
describe('form submit button', () => {
it('renders the "add" text when the message is not persisted', () => {
createComponent({ broadcastMessage: { id: undefined } });
expect(wrapper.text()).toContain(wrapper.vm.$options.i18n.add);
});
it('renders the "update" text when the message is persisted', () => {
createComponent({ broadcastMessage: { id: 100 } });
expect(wrapper.text()).toContain(wrapper.vm.$options.i18n.update);
});
it('is disabled when the user message is blank', () => {
createComponent({ broadcastMessage: { message: ' ' } });
expect(findSubmitButton().props().disabled).toBe(true);
});
it('is not disabled when the user message is present', () => {
createComponent({ broadcastMessage: { message: 'alsdjfkldsj' } });
expect(findSubmitButton().props().disabled).toBe(false);
});
});
describe('form submission', () => {
const defaultPayload = {
message: defaultProps.message,
broadcast_type: defaultProps.broadcastType,
theme: defaultProps.theme,
dismissable: defaultProps.dismissable,
target_path: defaultProps.targetPath,
target_access_levels: defaultProps.targetAccessLevels,
starts_at: defaultProps.startsAt,
ends_at: defaultProps.endsAt,
};
it('sends a create request for a new message form', async () => {
createComponent({ broadcastMessage: { id: undefined } });
findForm().vm.$emit('submit', { preventDefault: () => {} });
await waitForPromises();
expect(axiosMock.history.post).toHaveLength(1);
expect(axiosMock.history.post[0]).toMatchObject({
url: messagesPath,
data: JSON.stringify(defaultPayload),
});
});
it('shows an error alert if the create request fails', async () => {
createComponent({ broadcastMessage: { id: undefined } });
axiosMock.onPost(messagesPath).replyOnce(HTTP_STATUS_BAD_REQUEST);
findForm().vm.$emit('submit', { preventDefault: () => {} });
await waitForPromises();
expect(createAlert).toHaveBeenCalledWith(
expect.objectContaining({
message: wrapper.vm.$options.i18n.addError,
}),
);
});
it('sends an update request for a persisted message form', async () => {
const id = 1337;
createComponent({ broadcastMessage: { id } });
findForm().vm.$emit('submit', { preventDefault: () => {} });
await waitForPromises();
expect(axiosMock.history.patch).toHaveLength(1);
expect(axiosMock.history.patch[0]).toMatchObject({
url: `${messagesPath}/${id}`,
data: JSON.stringify(defaultPayload),
});
});
it('shows an error alert if the update request fails', async () => {
const id = 1337;
createComponent({ broadcastMessage: { id } });
axiosMock.onPost(`${messagesPath}/${id}`).replyOnce(HTTP_STATUS_BAD_REQUEST);
findForm().vm.$emit('submit', { preventDefault: () => {} });
await waitForPromises();
expect(createAlert).toHaveBeenCalledWith(
expect.objectContaining({
message: wrapper.vm.$options.i18n.updateError,
}),
);
});
});
});
|
