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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Cache::Import::Caching, :clean_gitlab_redis_cache, :clean_gitlab_redis_shared_state, feature_category: :importers do
shared_examples 'validated redis value' do
let(:value) { double('value', to_s: Object.new) }
it 'raise error if value.to_s does not return a String' do
value_as_string = value.to_s
message = /Value '#{value_as_string}' of type '#{value_as_string.class}' for '#{value.inspect}' is not a String/
expect { subject }.to raise_error(message)
end
end
describe '.read' do
it 'reads a value from the cache' do
described_class.write('foo', 'bar')
expect(described_class.read('foo')).to eq('bar')
end
it 'returns nil if the cache key does not exist' do
expect(described_class.read('foo')).to be_nil
end
it 'refreshes the cache key if a value is present' do
described_class.write('foo', 'bar')
redis = double(:redis)
expect(redis).to receive(:get).with(/foo/).and_return('bar')
expect(redis).to receive(:expire).with(/foo/, described_class::TIMEOUT)
expect(Gitlab::Redis::Cache).to receive(:with).exactly(4).times.and_yield(redis)
described_class.read('foo')
end
it 'does not refresh the cache key if a value is empty' do
described_class.write('foo', nil)
redis = double(:redis)
expect(redis).to receive(:get).with(/foo/).and_return('')
expect(redis).not_to receive(:expire)
expect(Gitlab::Redis::Cache).to receive(:with).twice.and_yield(redis)
described_class.read('foo')
end
end
describe '.read_integer' do
it 'returns an Integer' do
described_class.write('foo', '10')
expect(described_class.read_integer('foo')).to eq(10)
end
it 'returns nil if no value was found' do
expect(described_class.read_integer('foo')).to be_nil
end
end
describe '.write' do
it 'writes a value to the cache and returns the written value' do
expect(described_class.write('foo', 10)).to eq(10)
expect(described_class.read('foo')).to eq('10')
end
it_behaves_like 'validated redis value' do
subject { described_class.write('foo', value) }
end
end
describe '.increment_by' do
it_behaves_like 'validated redis value' do
subject { described_class.increment_by('foo', value) }
end
end
describe '.increment' do
before do
allow(Gitlab::Redis::SharedState).to receive(:with).and_return('OK')
end
it 'increment a key and returns the current value' do
expect(described_class.increment('foo')).to eq(1)
value = Gitlab::Redis::Cache.with { |r| r.get(described_class.cache_key_for('foo')) }
expect(value.to_i).to eq(1)
end
end
describe '.set_add' do
it 'adds a value to a set' do
described_class.set_add('foo', 10)
described_class.set_add('foo', 10)
key = described_class.cache_key_for('foo')
values = Gitlab::Redis::Cache.with { |r| r.smembers(key) }
expect(values).to eq(['10'])
end
it_behaves_like 'validated redis value' do
subject { described_class.set_add('foo', value) }
end
end
describe '.set_includes?' do
it 'returns false when the key does not exist' do
expect(described_class.set_includes?('foo', 10)).to eq(false)
end
it 'returns false when the value is not present in the set' do
described_class.set_add('foo', 10)
expect(described_class.set_includes?('foo', 20)).to eq(false)
end
it 'returns true when the set includes the given value' do
described_class.set_add('foo', 10)
expect(described_class.set_includes?('foo', 10)).to eq(true)
end
it_behaves_like 'validated redis value' do
subject { described_class.set_includes?('foo', value) }
end
end
describe '.values_from_set' do
it 'returns empty list when the set is empty' do
expect(described_class.values_from_set('foo')).to eq([])
end
it 'returns the set list of values' do
described_class.set_add('foo', 10)
expect(described_class.values_from_set('foo')).to eq(['10'])
end
end
describe '.hash_add' do
it 'adds a value to a hash' do
described_class.hash_add('foo', 1, 1)
described_class.hash_add('foo', 2, 2)
key = described_class.cache_key_for('foo')
values = Gitlab::Redis::Cache.with { |r| r.hgetall(key) }
expect(values).to eq({ '1' => '1', '2' => '2' })
end
it_behaves_like 'validated redis value' do
subject { described_class.hash_add('foo', 1, value) }
end
end
describe '.values_from_hash' do
it 'returns empty hash when the hash is empty' do
expect(described_class.values_from_hash('foo')).to eq({})
end
it 'returns the set list of values' do
described_class.hash_add('foo', 1, 1)
expect(described_class.values_from_hash('foo')).to eq({ '1' => '1' })
end
end
describe '.write_multiple' do
it 'sets multiple keys when key_prefix not set' do
mapping = { 'foo' => 10, 'bar' => 20 }
described_class.write_multiple(mapping)
mapping.each do |key, value|
full_key = described_class.cache_key_for(key)
found = Gitlab::Redis::Cache.with { |r| r.get(full_key) }
expect(found).to eq(value.to_s)
end
end
it 'sets multiple keys with correct prefix' do
mapping = { 'foo' => 10, 'bar' => 20 }
described_class.write_multiple(mapping, key_prefix: 'pref/')
mapping.each do |key, value|
full_key = described_class.cache_key_for("pref/#{key}")
found = Gitlab::Redis::Cache.with { |r| r.get(full_key) }
expect(found).to eq(value.to_s)
end
end
it_behaves_like 'validated redis value' do
let(:mapping) { { 'foo' => value, 'bar' => value } }
subject { described_class.write_multiple(mapping) }
end
end
describe '.expire' do
it 'sets the expiration time of a key' do
timeout = 1.hour.to_i
described_class.write('foo', 'bar', timeout: 2.hours.to_i)
described_class.expire('foo', timeout)
key = described_class.cache_key_for('foo')
found_ttl = Gitlab::Redis::Cache.with { |r| r.ttl(key) }
expect(found_ttl).to be <= timeout
end
end
describe '.write_if_greater' do
it_behaves_like 'validated redis value' do
subject { described_class.write_if_greater('foo', value) }
end
end
describe '.list_add' do
it 'adds a value to a list' do
described_class.list_add('foo', 10)
described_class.list_add('foo', 20)
key = described_class.cache_key_for('foo')
values = Gitlab::Redis::Cache.with { |r| r.lrange(key, 0, -1) }
expect(values).to eq(%w[10 20])
end
context 'when a limit is provided' do
it 'limits the size of the list to the number of items defined by the limit' do
described_class.list_add('foo', 10, limit: 3)
described_class.list_add('foo', 20, limit: 3)
described_class.list_add('foo', 30, limit: 3)
described_class.list_add('foo', 40, limit: 3)
key = described_class.cache_key_for('foo')
values = Gitlab::Redis::Cache.with { |r| r.lrange(key, 0, -1) }
expect(values).to eq(%w[20 30 40])
end
end
it_behaves_like 'validated redis value' do
subject { described_class.list_add('foo', value) }
end
end
describe '.values_from_list' do
it 'returns empty hash when the list is empty' do
expect(described_class.values_from_list('foo')).to eq([])
end
it 'returns the items stored in the list in order' do
described_class.list_add('foo', 10)
described_class.list_add('foo', 20)
described_class.list_add('foo', 10)
expect(described_class.values_from_list('foo')).to eq(%w[10 20 10])
end
end
describe '.del' do
it 'deletes the key' do
described_class.write('foo', 'value')
expect { described_class.del('foo') }.to change { described_class.read('foo') }.from('value').to(nil)
end
end
end
|