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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::ApplicationContext do
describe '.with_context' do
it 'yields the block' do
expect { |b| described_class.with_context({}, &b) }.to yield_control
end
it 'passes the expected context on to labkit' do
user = build(:user)
project = build(:project)
fake_proc = duck_type(:call)
expected_context = hash_including(user: fake_proc, project: fake_proc, root_namespace: fake_proc)
expect(Labkit::Context).to receive(:with_context).with(expected_context)
described_class.with_context(
user: user,
project: project,
namespace: build(:namespace)) {}
end
it 'raises an error when passing invalid options' do
expect { described_class.with_context(no: 'option') {} }.to raise_error(ArgumentError)
end
end
describe '.with_raw_context' do
it 'yields the block' do
expect { |b| described_class.with_raw_context({}, &b) }.to yield_control
end
it 'passes the attributes unaltered on to labkit' do
attrs = { foo: :bar }
expect(Labkit::Context).to receive(:with_context).with(attrs)
described_class.with_raw_context(attrs) {}
end
end
describe '.push' do
it 'passes the expected context on to labkit' do
fake_proc = duck_type(:call)
expected_context = { user: fake_proc, client_id: fake_proc }
expect(Labkit::Context).to receive(:push).with(expected_context)
described_class.push(user: build(:user))
end
it 'raises an error when passing invalid options' do
expect { described_class.push(no: 'option')}.to raise_error(ArgumentError)
end
end
describe '.current_context_include?' do
it 'returns true if the key was present in the context' do
described_class.with_context(caller_id: "Hello") do
expect(described_class.current_context_include?(:caller_id)).to be(true)
end
end
it 'returns false if the key was not present in the current context' do
expect(described_class.current_context_include?(:caller_id)).to be(false)
end
end
describe '.current_context_attribute' do
it 'returns the raw attribute value' do
described_class.with_context(caller_id: "Hello") do
expect(described_class.current_context_attribute(:caller_id)).to be('Hello')
end
end
it 'returns the attribute value with meta prefix' do
described_class.with_context(feature_category: "secure") do
expect(described_class.current_context_attribute('meta.feature_category')).to be('secure')
end
end
it 'returns nil if the key was not present in the current context' do
expect(described_class.current_context_attribute(:caller_id)).to be(nil)
end
end
describe '#to_lazy_hash' do
let_it_be(:user) { create(:user) }
let_it_be(:project) { create(:project) }
let_it_be(:namespace) { create(:group) }
let_it_be(:subgroup) { create(:group, parent: namespace) }
def result(context)
context.to_lazy_hash.transform_values { |v| v.respond_to?(:call) ? v.call : v }
end
it 'does not call the attributes until needed' do
fake_proc = double('Proc')
expect(fake_proc).not_to receive(:call)
described_class.new(user: fake_proc, project: fake_proc, namespace: fake_proc).to_lazy_hash
end
it 'correctly loads the expected values when they are wrapped in a block' do
context = described_class.new(user: -> { user }, project: -> { project }, namespace: -> { subgroup })
expect(result(context))
.to include(user: user.username, project: project.full_path, root_namespace: namespace.full_path)
end
it 'correctly loads the expected values when passed directly' do
context = described_class.new(user: user, project: project, namespace: subgroup)
expect(result(context))
.to include(user: user.username, project: project.full_path, root_namespace: namespace.full_path)
end
it 'falls back to a projects namespace when a project is passed but no namespace' do
context = described_class.new(project: project)
expect(result(context))
.to include(project: project.full_path, root_namespace: project.full_path_components.first)
end
it 'contains known keys' do
context = described_class.new(project: project)
# Make sure all possible keys would be included
allow(context).to receive_message_chain(:set_values, :include?).and_return(true)
# If a newly added key is added to the context hash, we need to list it in
# the known keys constant. This spec ensures that we do.
expect(context.to_lazy_hash.keys).to contain_exactly(*described_class.known_keys)
end
describe 'setting the client' do
let_it_be(:remote_ip) { '127.0.0.1' }
let_it_be(:runner) { create(:ci_runner) }
let_it_be(:options) { { remote_ip: remote_ip, runner: runner, user: user } }
using RSpec::Parameterized::TableSyntax
where(:provided_options, :client) do
[:remote_ip] | :remote_ip
[:remote_ip, :runner] | :runner
[:remote_ip, :runner, :user] | :user
end
with_them do
it 'sets the client_id to the expected value' do
context = described_class.new(**options.slice(*provided_options))
client_id = case client
when :remote_ip then "ip/#{remote_ip}"
when :runner then "runner/#{runner.id}"
when :user then "user/#{user.id}"
end
expect(result(context)[:client_id]).to eq(client_id)
end
end
end
context 'when using a runner project' do
let_it_be_with_reload(:runner) { create(:ci_runner, :project) }
it 'sets project path from runner project' do
context = described_class.new(runner: runner)
expect(result(context)).to include(project: runner.runner_projects.first.project.full_path)
end
context 'when the runner serves multiple projects' do
before do
create(:ci_runner_project, runner: runner, project: create(:project))
end
it 'does not set project path' do
context = described_class.new(runner: runner)
expect(result(context)).to include(project: nil)
end
end
end
context 'when using an instance runner' do
let_it_be(:runner) { create(:ci_runner, :instance) }
it 'does not sets project path' do
context = described_class.new(runner: runner)
expect(result(context)).to include(project: nil)
end
end
end
describe '#use' do
let(:context) { described_class.new(user: build(:user)) }
it 'yields control' do
expect { |b| context.use(&b) }.to yield_control
end
it 'passes the expected context on to labkit' do
expect(Labkit::Context).to receive(:with_context).with(a_hash_including(user: duck_type(:call)))
context.use {}
end
it 'does not cause queries' do
context = described_class.new(project: create(:project), namespace: create(:group, :nested), user: create(:user))
expect { context.use { Gitlab::ApplicationContext.current } }.not_to exceed_query_limit(0)
end
end
end
|
