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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe WorkerAttributes, feature_category: :shared do
using RSpec::Parameterized::TableSyntax
let(:worker) do
Class.new do
def self.name
"TestWorker"
end
include ApplicationWorker
end
end
let(:child_worker) do
Class.new(worker) do
def self.name
"TestChildworker"
end
end
end
describe 'class attributes' do
shared_examples 'setting class attributes' do
context 'when the attribute is set' do
before do
worker.public_send(setter, *values, **kwargs)
end
it 'returns the expected value' do
expect(worker.public_send(getter)).to eq(expected)
expect(child_worker.public_send(getter)).to eq(expected)
end
end
context 'when the attribute is not set' do
it 'returns the default value' do
expect(worker.public_send(getter)).to eq(default)
expect(child_worker.public_send(getter)).to eq(default)
end
end
context 'when the attribute is set in the child worker' do
before do
child_worker.public_send(setter, *values, **kwargs)
end
it 'returns the default value for the parent, and the expected value for the child' do
expect(worker.public_send(getter)).to eq(default)
expect(child_worker.public_send(getter)).to eq(expected)
end
end
end
# rubocop: disable Layout/LineLength -- using table synxax
where(:getter, :setter, :default, :values, :kwargs, :expected) do
:worker_has_external_dependencies? | :worker_has_external_dependencies! | false | [] | {} | true
:idempotent? | :idempotent! | false | [] | {} | true
:big_payload? | :big_payload! | false | [] | {} | true
:get_feature_category | :feature_category | nil | [:foo] | {} | :foo
:get_urgency | :urgency | :low | [:high] | {} | :high
:get_worker_resource_boundary | :worker_resource_boundary | :unknown | [:cpu] | {} | :cpu
:get_weight | :weight | 1 | [3] | {} | 3
:get_tags | :tags | [] | [:foo, :bar] | {} | [:foo, :bar]
:get_deduplicate_strategy | :deduplicate | :until_executing | [:none] | {} | :none
:get_deduplication_options | :deduplicate | {} | [:none, { including_scheduled: true }] | {} | { including_scheduled: true }
:database_health_check_attrs | :defer_on_database_health_signal | nil | [:gitlab_main, [:users], 1.minute] | {} | { gitlab_schema: :gitlab_main, tables: [:users], delay_by: 1.minute, block: nil }
end
# rubocop: enable Layout/LineLength
with_them do
it_behaves_like 'setting class attributes'
end
context 'when using multiple databases' do
before do
skip_if_shared_database(:ci)
end
# rubocop: disable Layout/LineLength -- using table synxax
where(:getter, :setter, :default, :values, :kwargs, :expected) do
:get_least_restrictive_data_consistency | :data_consistency | :always | [:always] | { overrides: { ci: :delayed, main: :sticky } } | :delayed
:get_least_restrictive_data_consistency | :data_consistency | :always | [:always] | {} | :always
:get_data_consistency_per_database | :data_consistency | { main: :always, ci: :always } | [:sticky] | { overrides: { ci: :delayed } } | { ci: :delayed, main: :sticky }
:get_data_consistency_per_database | :data_consistency | { main: :always, ci: :always } | [:sticky] | {} | { ci: :sticky, main: :sticky }
end
# rubocop: enable Layout/LineLength
with_them do
it_behaves_like 'setting class attributes'
end
end
context 'when using a single database with ci connection' do
before do
skip_if_database_exists(:ci)
skip_if_multiple_databases_not_setup(:ci)
end
# rubocop: disable Layout/LineLength -- using table synxax
where(:getter, :setter, :default, :values, :kwargs, :expected) do
:get_data_consistency_per_database | :data_consistency | { main: :always, ci: :always } | [:sticky] | { overrides: { ci: :delayed } } | { main: :sticky, ci: :sticky }
:get_data_consistency_per_database | :data_consistency | { main: :always, ci: :always } | [:sticky] | {} | { main: :sticky, ci: :sticky }
:get_least_restrictive_data_consistency | :data_consistency | :always | [:always] | { overrides: { ci: :delayed, main: :sticky } } | :always
:get_least_restrictive_data_consistency | :data_consistency | :always | [:always] | {} | :always
end
# rubocop: enable Layout/LineLength
with_them do
it_behaves_like 'setting class attributes'
end
end
context 'when using a single database' do
before do
skip_if_database_exists(:ci)
skip_if_multiple_databases_are_setup(:ci)
end
# rubocop: disable Layout/LineLength -- using table synxax
where(:getter, :setter, :default, :values, :kwargs, :expected) do
:get_data_consistency_per_database | :data_consistency | { main: :always } | [:sticky] | { overrides: { ci: :delayed } } | { main: :sticky }
:get_data_consistency_per_database | :data_consistency | { main: :always } | [:sticky] | {} | { main: :sticky }
:get_least_restrictive_data_consistency | :data_consistency | :always | [:always] | { overrides: { ci: :delayed, main: :sticky } } | :always
:get_least_restrictive_data_consistency | :data_consistency | :always | [:always] | {} | :always
end
# rubocop: enable Layout/LineLength
with_them do
it_behaves_like 'setting class attributes'
end
end
end
describe '.data_consistency' do
context 'with invalid data_consistency' do
it 'raises exception' do
expect { worker.data_consistency(:invalid) }
.to raise_error('Invalid data consistency: invalid')
end
end
context 'with invalid data_consistency in overrides' do
it 'raises exception' do
expect { worker.data_consistency(:always, overrides: { ci: :invalid }) }
.to raise_error('Invalid data consistency: {:ci=>:invalid}')
end
end
context 'when feature_flag is provided' do
before do
stub_feature_flags(test_feature_flag: false)
skip_default_enabled_yaml_check
end
it 'returns correct feature flag value' do
worker.data_consistency(:sticky, feature_flag: :test_feature_flag)
expect(worker.get_data_consistency_feature_flag_enabled?).not_to be(true)
expect(child_worker.get_data_consistency_feature_flag_enabled?).not_to be(true)
end
end
context 'when overrides are provided in a single database setup' do
before do
skip_if_database_exists(:ci)
skip_if_multiple_databases_are_setup(:ci)
end
it 'returns correct feature flag value' do
worker.data_consistency(:always, overrides: { ci: :delayed })
expect(worker.get_data_consistency_per_database).to eq({ main: :always })
end
context 'when feature_flag is provided' do
before do
skip_default_enabled_yaml_check
end
context 'when feature_flag is disable' do
before do
stub_feature_flags(test_feature_flag: false)
end
it 'returns correct feature flag value' do
worker.data_consistency(:always, feature_flag: :test_feature_flag, overrides: { ci: :delayed })
expect(worker.get_data_consistency_per_database).to eq({ main: :always })
expect(worker.get_least_restrictive_data_consistency).to eq(:always)
end
end
it 'returns correct feature flag value' do
worker.data_consistency(:always, feature_flag: :test_feature_flag, overrides: { ci: :delayed })
expect(worker.get_data_consistency_per_database).to eq({ main: :always })
expect(worker.get_least_restrictive_data_consistency).to eq(:always)
end
end
end
context 'when overrides are provided in a single database setup with ci connection' do
before do
skip_if_database_exists(:ci)
skip_if_multiple_databases_not_setup(:ci)
end
it 'returns correct feature flag value' do
worker.data_consistency(:always, overrides: { ci: :delayed })
expect(worker.get_data_consistency_per_database).to eq({ ci: :always, main: :always })
end
context 'when feature_flag is provided' do
before do
skip_default_enabled_yaml_check
end
context 'when feature_flag is disable' do
before do
stub_feature_flags(test_feature_flag: false)
end
it 'returns correct feature flag value' do
worker.data_consistency(:always, feature_flag: :test_feature_flag, overrides: { ci: :delayed })
expect(worker.get_data_consistency_per_database).to eq({ main: :always, ci: :always })
expect(worker.get_least_restrictive_data_consistency).to eq(:always)
end
end
it 'returns correct feature flag value' do
worker.data_consistency(:always, feature_flag: :test_feature_flag, overrides: { ci: :delayed })
expect(worker.get_data_consistency_per_database).to eq({ ci: :always, main: :always })
expect(worker.get_least_restrictive_data_consistency).to eq(:always)
end
end
end
context 'when overrides are provided in a multi database setup' do
before do
skip_if_shared_database(:ci)
end
it 'returns correct feature flag value' do
worker.data_consistency(:always, overrides: { ci: :delayed })
expect(worker.get_data_consistency_per_database).to eq({ ci: :delayed, main: :always })
end
context 'when feature_flag is provided' do
before do
skip_default_enabled_yaml_check
end
context 'when feature_flag is disable' do
before do
stub_feature_flags(test_feature_flag: false)
end
it 'returns correct feature flag value' do
worker.data_consistency(:always, feature_flag: :test_feature_flag, overrides: { ci: :delayed })
expect(worker.get_data_consistency_per_database).to eq({ main: :always, ci: :always })
expect(worker.get_least_restrictive_data_consistency).to eq(:always)
end
end
it 'returns correct feature flag value' do
worker.data_consistency(:always, feature_flag: :test_feature_flag, overrides: { ci: :delayed })
expect(worker.get_data_consistency_per_database).to eq({ ci: :delayed, main: :always })
expect(worker.get_least_restrictive_data_consistency).to eq(:delayed)
end
end
end
end
describe '#deduplication_enabled?' do
subject(:deduplication_enabled?) { worker.deduplication_enabled? }
context 'when no feature flag is set' do
before do
worker.deduplicate(:until_executing)
end
it 'returns true' do
expect(worker.deduplication_enabled?).to be(true)
expect(child_worker.deduplication_enabled?).to be(true)
end
end
context 'when feature flag is set' do
before do
skip_default_enabled_yaml_check
worker.deduplicate(:until_executing, feature_flag: :my_feature_flag)
end
context 'when the FF is enabled' do
before do
stub_feature_flags(my_feature_flag: true)
end
it 'returns true' do
expect(worker.deduplication_enabled?).to be(true)
expect(child_worker.deduplication_enabled?).to be(true)
end
end
context 'when the FF is disabled' do
before do
stub_feature_flags(my_feature_flag: false)
end
it 'returns false' do
expect(worker.deduplication_enabled?).to be(false)
expect(child_worker.deduplication_enabled?).to be(false)
end
end
end
end
describe '#defer_on_database_health_signal?' do
subject(:defer_on_database_health_signal?) { worker.defer_on_database_health_signal? }
context 'when defer_on_database_health_signal is set' do
before do
worker.defer_on_database_health_signal(:gitlab_main, [:users], 1.minute)
end
it { is_expected.to be(true) }
end
context 'when defer_on_database_health_signal is not set' do
it { is_expected.to be(false) }
end
end
end
|
