blob: 790b5c3544d6c4ce264c20ddb171bff1ddce3a76 (
plain)
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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe LimitedCapacity::Worker, :clean_gitlab_redis_queues, :aggregate_failures do
let(:worker_class) do
Class.new do
def self.name
'DummyWorker'
end
include ApplicationWorker
include LimitedCapacity::Worker
end
end
let(:worker) { worker_class.new }
let(:job_tracker) do
LimitedCapacity::JobTracker.new(worker_class.name)
end
before do
worker.jid = 'my-jid'
allow(worker).to receive(:job_tracker).and_return(job_tracker)
end
describe 'required methods' do
it { expect { worker.perform_work }.to raise_error(NotImplementedError) }
it { expect { worker.remaining_work_count }.to raise_error(NotImplementedError) }
it { expect { worker.max_running_jobs }.to raise_error(NotImplementedError) }
end
describe 'Sidekiq options' do
it 'does not retry failed jobs' do
expect(worker_class.sidekiq_options['retry']).to eq(0)
end
it 'does not deduplicate jobs' do
expect(worker_class.get_deduplicate_strategy).to eq(:none)
end
end
describe '.perform_with_capacity' do
subject(:perform_with_capacity) { worker_class.perform_with_capacity(:arg) }
let(:max_running_jobs) { 3 }
before do
expect_next_instance_of(worker_class) do |instance|
expect(instance).to receive(:remove_failed_jobs)
allow(instance).to receive(:max_running_jobs).and_return(max_running_jobs)
end
end
it 'enqueues jobs' do
expect(worker_class)
.to receive(:bulk_perform_async)
.with([[:arg], [:arg], [:arg]])
perform_with_capacity
end
end
describe '#perform' do
subject(:perform) { worker.perform(:arg) }
context 'with capacity' do
before do
allow(worker).to receive(:max_running_jobs).and_return(10)
allow(worker).to receive(:running_jobs_count).and_return(0)
allow(worker).to receive(:remaining_work_count).and_return(0)
end
it 'calls perform_work' do
expect(worker).to receive(:perform_work).with(:arg)
perform
end
it 're-enqueues itself' do
allow(worker).to receive(:perform_work)
expect(worker).to receive(:re_enqueue).with(:arg)
perform
end
it 'reports prometheus metrics' do
allow(worker).to receive(:perform_work)
expect(worker).to receive(:report_prometheus_metrics).once.and_call_original
expect(worker).to receive(:report_running_jobs_metrics).twice.and_call_original
perform
end
it 'updates the running set' do
expect(job_tracker.running_jids).to be_empty
allow(worker).to receive(:perform_work)
perform
expect(job_tracker.running_jids).to be_empty
end
end
context 'with capacity and without work' do
before do
allow(worker).to receive(:max_running_jobs).and_return(10)
allow(worker).to receive(:remaining_work_count).and_return(0)
allow(worker).to receive(:perform_work)
end
it 'does not re-enqueue itself' do
expect(worker_class).not_to receive(:perform_async)
perform
end
end
context 'without capacity' do
before do
allow(worker).to receive(:max_running_jobs).and_return(10)
allow(job_tracker).to receive(:register).and_return(false)
allow(worker).to receive(:remaining_work_count).and_return(10)
end
it 'does not call perform_work' do
expect(worker).not_to receive(:perform_work)
perform
end
it 'does not re-enqueue itself' do
expect(worker_class).not_to receive(:perform_async)
perform
end
end
context 'when perform_work fails' do
before do
allow(worker).to receive(:max_running_jobs).and_return(10)
allow(job_tracker).to receive(:register).and_return(true)
end
it 'does not re-enqueue itself' do
expect(worker).not_to receive(:re_enqueue)
expect { perform }.to raise_error(NotImplementedError)
end
it 'removes itself from the running set' do
expect(job_tracker).to receive(:remove).with('my-jid')
expect { perform }.to raise_error(NotImplementedError)
end
it 'reports prometheus metrics' do
expect(worker).to receive(:report_prometheus_metrics)
expect { perform }.to raise_error(NotImplementedError)
end
end
end
describe '#remove_failed_jobs' do
subject(:remove_failed_jobs) { worker.remove_failed_jobs }
it 'removes failed jobs' do
job_tracker.register('a-job-id', 10)
expect(job_tracker).to receive(:clean_up).and_call_original
expect { remove_failed_jobs }.to change { job_tracker.running_jids.size }.by(-1)
end
end
describe '#report_prometheus_metrics' do
subject(:report_prometheus_metrics) { worker.report_prometheus_metrics }
before do
allow(worker).to receive(:running_jobs_count).and_return(5)
allow(worker).to receive(:max_running_jobs).and_return(7)
allow(worker).to receive(:remaining_work_count).and_return(9)
end
it 'reports number of running jobs' do
labels = { worker: 'DummyWorker' }
report_prometheus_metrics
expect(Gitlab::Metrics.registry.get(:limited_capacity_worker_running_jobs).get(labels)).to eq(5)
expect(Gitlab::Metrics.registry.get(:limited_capacity_worker_max_running_jobs).get(labels)).to eq(7)
expect(Gitlab::Metrics.registry.get(:limited_capacity_worker_remaining_work_count).get(labels)).to eq(9)
end
end
end
|
