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
|
# frozen_string_literal: true
RSpec.describe QA::Runtime::Feature do
let(:api_client) { double('QA::Runtime::API::Client') }
let(:request) { Struct.new(:url).new('http://api') }
let(:response_post) { Struct.new(:code).new(201) }
before do
allow(described_class).to receive(:api_client).and_return(api_client)
end
where(:feature_flag) do
['a_flag', :a_flag]
end
with_them do
shared_examples 'enables a feature flag' do
it 'enables a feature flag for a scope' do
allow(described_class).to receive(:get)
.and_return(Struct.new(:code, :body).new(200, '[{ "name": "a_flag", "state": "on" }]'))
expect(QA::Runtime::API::Request).to receive(:new)
.with(api_client, "/features/a_flag").and_return(request)
expect(described_class).to receive(:post)
.with(request.url, { value: true, scope => actor_name }).and_return(response_post)
expect(QA::Runtime::API::Request).to receive(:new)
.with(api_client, "/features").and_return(request)
expect(QA::Runtime::Logger).to receive(:info).with("Enabling feature: a_flag for scope \"#{scope}: #{actor_name}\"")
expect(QA::Runtime::Logger).to receive(:info).with("Successfully enabled and verified feature flag: a_flag")
described_class.enable(feature_flag, scope => actor)
end
end
shared_examples 'disables a feature flag' do
it 'disables a feature flag for a scope' do
allow(described_class).to receive(:get)
.and_return(Struct.new(:code, :body).new(200, '[{ "name": "a_flag", "state": "off" }]'))
expect(QA::Runtime::API::Request).to receive(:new)
.with(api_client, "/features/a_flag").and_return(request)
expect(described_class).to receive(:post)
.with(request.url, { value: false, scope => actor_name }).and_return(response_post)
expect(QA::Runtime::API::Request).to receive(:new)
.with(api_client, "/features").and_return(request)
expect(QA::Runtime::Logger).to receive(:info).with("Disabling feature: a_flag for scope \"#{scope}: #{actor_name}\"")
expect(QA::Runtime::Logger).to receive(:info).with("Successfully disabled and verified feature flag: a_flag")
described_class.disable(feature_flag, scope => actor)
end
end
shared_examples 'checks a feature flag' do
context 'when the flag is enabled for a scope' do
it 'returns the feature flag state' do
expect(QA::Runtime::API::Request)
.to receive(:new)
.with(api_client, "/features")
.and_return(request)
expect(described_class)
.to receive(:get)
.and_return(Struct.new(:code, :body).new(200, %([{ "name": "a_flag", "state": "conditional", "gates": #{gates} }])))
expect(described_class.enabled?(feature_flag, scope => actor)).to be true
end
end
end
describe '.enable' do
it 'enables a feature flag' do
allow(described_class).to receive(:get)
.and_return(Struct.new(:code, :body).new(200, '[{ "name": "a_flag", "state": "on" }]'))
expect(QA::Runtime::API::Request).to receive(:new)
.with(api_client, "/features/a_flag").and_return(request)
expect(described_class).to receive(:post)
.with(request.url, { value: true }).and_return(response_post)
expect(QA::Runtime::API::Request).to receive(:new)
.with(api_client, "/features").and_return(request)
described_class.enable(feature_flag)
end
context 'when a project scope is provided' do
it_behaves_like 'enables a feature flag' do
let(:scope) { :project }
let(:actor_name) { 'group-name/project-name' }
let(:actor) { Struct.new(:full_path).new(actor_name) }
end
end
context 'when a group scope is provided' do
it_behaves_like 'enables a feature flag' do
let(:scope) { :group }
let(:actor_name) { 'group-name' }
let(:actor) { Struct.new(:full_path).new(actor_name) }
end
end
context 'when a user scope is provided' do
it_behaves_like 'enables a feature flag' do
let(:scope) { :user }
let(:actor_name) { 'user-name' }
let(:actor) { Struct.new(:username).new(actor_name) }
end
end
context 'when a feature group scope is provided' do
it_behaves_like 'enables a feature flag' do
let(:scope) { :feature_group }
let(:actor_name) { 'foo' }
let(:actor) { "foo" }
end
end
end
describe '.disable' do
it 'disables a feature flag' do
allow(described_class).to receive(:get)
.and_return(Struct.new(:code, :body).new(200, '[{ "name": "a_flag", "state": "off" }]'))
expect(QA::Runtime::API::Request).to receive(:new)
.with(api_client, "/features/a_flag").and_return(request)
expect(described_class).to receive(:post)
.with(request.url, { value: false }).and_return(response_post)
expect(QA::Runtime::API::Request).to receive(:new)
.with(api_client, "/features").and_return(request)
described_class.disable(feature_flag)
end
context 'when a project scope is provided' do
it_behaves_like 'disables a feature flag' do
let(:scope) { :project }
let(:actor_name) { 'group-name/project-name' }
let(:actor) { Struct.new(:full_path).new(actor_name) }
end
end
context 'when a group scope is provided' do
it_behaves_like 'disables a feature flag' do
let(:scope) { :group }
let(:actor_name) { 'group-name' }
let(:actor) { Struct.new(:full_path).new(actor_name) }
end
end
context 'when a user scope is provided' do
it_behaves_like 'disables a feature flag' do
let(:scope) { :user }
let(:actor_name) { 'user-name' }
let(:actor) { Struct.new(:username).new(actor_name) }
end
end
context 'when a feature group scope is provided' do
it_behaves_like 'disables a feature flag' do
let(:scope) { :feature_group }
let(:actor_name) { 'foo' }
let(:actor) { "foo" }
end
end
end
describe '.enabled?' do
it 'returns a feature flag state' do
expect(QA::Runtime::API::Request)
.to receive(:new)
.with(api_client, "/features")
.and_return(request)
expect(described_class)
.to receive(:get)
.and_return(Struct.new(:code, :body).new(200, '[{ "name": "a_flag", "state": "on" }]'))
expect(described_class.enabled?(feature_flag)).to be true
end
it 'raises an error when the scope is unknown' do
expect(QA::Runtime::API::Request)
.to receive(:new)
.with(api_client, "/features")
.and_return(request)
expect(described_class)
.to receive(:get)
.and_return(
Struct.new(:code, :body)
.new(200, %([{ "name": "a_flag", "state": "conditional", "gates": { "key": "groups", "value": ["foo"] } }])))
expect { described_class.enabled?(feature_flag, scope: 'foo') }.to raise_error(QA::Runtime::Feature::UnknownScopeError)
end
context 'when a project scope is provided' do
it_behaves_like 'checks a feature flag' do
let(:scope) { :project }
let(:actor_name) { 'group-name/project-name' }
let(:actor) { Struct.new(:full_path, :id).new(actor_name, 270) }
let(:gates) { %q([{"key": "actors", "value": ["Project:270"]}]) }
end
end
context 'when a group scope is provided' do
it_behaves_like 'checks a feature flag' do
let(:scope) { :group }
let(:actor_name) { 'group-name' }
let(:actor) { Struct.new(:full_path, :id).new(actor_name, 33) }
let(:gates) { %q([{"key": "actors", "value": ["Group:33"]}]) }
end
end
context 'when a user scope is provided' do
it_behaves_like 'checks a feature flag' do
let(:scope) { :user }
let(:actor_name) { 'user-name' }
let(:actor) { Struct.new(:full_path, :id).new(actor_name, 13) }
let(:gates) { %q([{"key": "actors", "value": ["User:13"]}]) }
end
end
context 'when a feature group scope is provided' do
it_behaves_like 'checks a feature flag' do
let(:scope) { :feature_group }
let(:actor_name) { 'foo' }
let(:actor) { "foo" }
let(:gates) { %q([{"key": "groups", "value": ["foo"]}]) }
end
end
context 'when a feature flag is not found via the API and there is no definition file' do
before do
allow(QA::Runtime::API::Request)
.to receive(:new)
.with(api_client, "/features")
.and_return(request)
allow(described_class)
.to receive(:get)
.and_return(Struct.new(:code, :body).new(200, '[]'))
allow(Dir).to receive(:glob).and_return([])
end
it 'raises an error' do
expect { described_class.enabled?(feature_flag) }
.to raise_error(QA::Runtime::Feature::UnknownFeatureFlagError)
end
end
context 'with definition files' do
context 'when no features are found via the API' do
before do
allow(QA::Runtime::API::Request)
.to receive(:new)
.with(api_client, "/features")
.and_return(request)
allow(described_class)
.to receive(:get)
.and_return(Struct.new(:code, :body).new(200, '[]'))
allow(Dir).to receive(:glob).and_return(['file_path'])
allow(File).to receive(:read).and_return(definition)
end
context 'with a default enabled defintion' do
let(:definition) { 'default_enabled: true' }
it 'returns a default enabled flag' do
expect(described_class.enabled?(feature_flag)).to be true
end
end
context 'with a default disabled defintion' do
let(:definition) { 'default_enabled: false' }
it 'returns a default disabled flag' do
expect(described_class.enabled?(feature_flag)).to be false
end
end
end
context 'when the feature is found via the API' do
before do
allow(QA::Runtime::API::Request)
.to receive(:new)
.with(api_client, "/features")
.and_return(request)
allow(described_class)
.to receive(:get)
.and_return(Struct.new(:code, :body).new(200, '[{ "name": "a_flag", "state": "on" }]'))
end
it 'returns the value from the API not the definition file' do
expect(Dir).not_to receive(:glob)
expect(File).not_to receive(:read)
expect(described_class.enabled?(feature_flag)).to be true
end
end
end
end
end
describe '.set' do
let(:scope) { { scope: 'actor' } }
it 'raises an error when the flag state is unknown' do
expect(described_class).not_to receive(:enable)
expect(described_class).not_to receive(:disable)
expect { described_class.set({ foo: 'bar' }, **scope) }.to raise_error(QA::Runtime::Feature::UnknownStateError, 'Unknown feature flag state: bar')
end
it 'enables feature flags' do
expect(described_class).to receive(:enable).with(:flag1, scope)
expect(described_class).to receive(:enable).with(:flag2, scope)
expect(described_class).not_to receive(:disable)
described_class.set({ flag1: 'enabled', flag2: 'enable' }, **scope)
end
it 'disables feature flags' do
expect(described_class).to receive(:disable).with(:flag1, scope)
expect(described_class).to receive(:disable).with(:flag2, scope)
expect(described_class).not_to receive(:enable)
described_class.set({ flag1: 'disable', flag2: 'disable' }, **scope)
end
it 'enables and disables feature flags' do
expect(described_class).to receive(:enable).with(:flag1, scope)
expect(described_class).to receive(:disable).with(:flag2, scope)
described_class.set({ flag1: 'enabled', flag2: 'disabled' }, **scope)
end
end
end
|
