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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe 'Query.runners', feature_category: :fleet_visibility do
include GraphqlHelpers
let_it_be(:current_user) { create_default(:user, :admin) }
describe 'Query.runners' do
let_it_be(:project) { create(:project, :repository, :public) }
let_it_be(:instance_runner) { create(:ci_runner, :instance, version: 'abc', revision: '123', description: 'Instance runner', ip_address: '127.0.0.1') }
let_it_be(:project_runner) { create(:ci_runner, :project, active: false, version: 'def', revision: '456', description: 'Project runner', projects: [project], ip_address: '127.0.0.1') }
let(:runners_graphql_data) { graphql_data_at(:runners) }
let(:params) { {} }
let(:fields) do
<<~QUERY
nodes {
#{all_graphql_fields_for('CiRunner', excluded: excluded_fields)}
}
QUERY
end
let(:query) do
%(
query {
runners {
#{fields}
}
}
)
end
# Exclude fields from deeper objects which are problematic:
# - ownerProject.pipeline: Needs arguments (iid or sha)
# - project.productAnalyticsState: Can be requested only for 1 Project(s) at a time.
let(:excluded_fields) { %w[pipeline productAnalyticsState] }
it 'returns expected runners' do
post_graphql(query, current_user: current_user)
expect(runners_graphql_data['nodes']).to contain_exactly(
*Ci::Runner.all.map { |expected_runner| a_graphql_entity_for(expected_runner) }
)
end
context 'with filters' do
shared_examples 'a working graphql query returning expected runners' do
it_behaves_like 'a working graphql query' do
before do
post_graphql(query, current_user: current_user)
end
end
it 'returns expected runners' do
post_graphql(query, current_user: current_user)
expect(runners_graphql_data['nodes']).to contain_exactly(
*Array(expected_runners).map { |expected_runner| a_graphql_entity_for(expected_runner) }
)
end
end
context 'when filtered on type and status' do
let(:query) do
%(
query {
runners(type: #{runner_type}, status: #{status}) {
#{fields}
}
}
)
end
before do
allow_next_instance_of(::Gitlab::Ci::RunnerUpgradeCheck) do |instance|
allow(instance).to receive(:check_runner_upgrade_suggestion)
end
end
context 'runner_type is INSTANCE_TYPE and status is ACTIVE' do
let(:runner_type) { 'INSTANCE_TYPE' }
let(:status) { 'ACTIVE' }
let(:expected_runners) { instance_runner }
it_behaves_like 'a working graphql query returning expected runners'
end
context 'runner_type is PROJECT_TYPE and status is NEVER_CONTACTED' do
let(:runner_type) { 'PROJECT_TYPE' }
let(:status) { 'NEVER_CONTACTED' }
let(:expected_runners) { project_runner }
it_behaves_like 'a working graphql query returning expected runners'
end
end
context 'when filtered on version prefix' do
let_it_be(:runner_15_10_1) { create_ci_runner(version: '15.10.1') }
let_it_be(:runner_15_11_0) { create_ci_runner(version: '15.11.0') }
let_it_be(:runner_15_11_1) { create_ci_runner(version: '15.11.1') }
let_it_be(:runner_16_1_0) { create_ci_runner(version: '16.1.0') }
let(:fields) do
<<~QUERY
nodes {
id
}
QUERY
end
let(:query) do
%(
query {
runners(versionPrefix: "#{version_prefix}") {
#{fields}
}
}
)
end
context 'when version_prefix is "15."' do
let(:version_prefix) { '15.' }
it_behaves_like 'a working graphql query returning expected runners' do
let(:expected_runners) { [runner_15_10_1, runner_15_11_0, runner_15_11_1] }
end
end
context 'when version_prefix is "15.11."' do
let(:version_prefix) { '15.11.' }
it_behaves_like 'a working graphql query returning expected runners' do
let(:expected_runners) { [runner_15_11_0, runner_15_11_1] }
end
end
context 'when version_prefix is "15.11.0"' do
let(:version_prefix) { '15.11.0' }
it_behaves_like 'a working graphql query returning expected runners' do
let(:expected_runners) { runner_15_11_0 }
end
end
context 'when version_prefix is not digits' do
let(:version_prefix) { 'a.b' }
it_behaves_like 'a working graphql query returning expected runners' do
let(:expected_runners) do
[instance_runner, project_runner, runner_15_10_1, runner_15_11_0, runner_15_11_1, runner_16_1_0]
end
end
end
def create_ci_runner(args = {}, version:)
create(:ci_runner, :project, **args).tap do |runner|
create(:ci_runner_machine, runner: runner, version: version)
end
end
end
context 'when filtered by creator' do
let_it_be(:user) { create(:user) }
let_it_be(:runner_created_by_user) { create(:ci_runner, :project, creator: user) }
let(:query) do
%(
query {
runners(creatorId: "#{creator.to_global_id}") {
#{fields}
}
}
)
end
context 'when existing user id given' do
let(:creator) { user }
before do
create(:ci_runner, :project, creator: create(:user)) # Should not be returned
end
it_behaves_like 'a working graphql query returning expected runners' do
let(:expected_runners) { runner_created_by_user }
end
end
context 'when non existent user id given' do
let(:creator) { User.new(id: non_existing_record_id) }
it 'does not return any runners' do
post_graphql(query, current_user: current_user)
expect(graphql_data_at(:runners, :nodes)).to be_empty
end
end
end
end
end
describe 'Runner query limits' do
let_it_be(:user) { create(:user, :admin) }
let_it_be(:user2) { create(:user) }
let_it_be(:user3) { create(:user) }
let_it_be(:group) { create(:group) }
let_it_be(:project) { create(:project) }
let_it_be(:tag_list) { %w[n_plus_1_test some_tag] }
let_it_be(:args) do
{ current_user: user, token: { personal_access_token: create(:personal_access_token, user: user) } }
end
let_it_be(:runner1) { create(:ci_runner, tag_list: tag_list, creator: user) }
let_it_be(:runner2) do
create(:ci_runner, :group, groups: [group], tag_list: tag_list, creator: user)
end
let_it_be(:runner3) do
create(:ci_runner, :project, projects: [project], tag_list: tag_list, creator: user)
end
let(:runner_fragment) do
<<~QUERY
#{all_graphql_fields_for('CiRunner', excluded: excluded_fields)}
createdBy {
id
username
webPath
webUrl
}
QUERY
end
# Exclude fields that are already hardcoded above (or tested separately),
# and also some fields from deeper objects which are problematic:
# - createdBy: Known N+1 issues, but only on exotic fields which we don't normally use
# - ownerProject.pipeline: Needs arguments (iid or sha)
# - project.productAnalyticsState: Can be requested only for 1 Project(s) at a time.
let(:excluded_fields) { %w[createdBy jobs pipeline productAnalyticsState] }
let(:runners_query) do
<<~QUERY
{
runners {
nodes { #{runner_fragment} }
}
}
QUERY
end
it 'avoids N+1 queries', :use_sql_query_cache do
personal_access_token = create(:personal_access_token, user: user)
args = { current_user: user, token: { personal_access_token: personal_access_token } }
runners_control = ActiveRecord::QueryRecorder.new(skip_cached: false) { post_graphql(runners_query, **args) }
setup_additional_records
expect { post_graphql(runners_query, **args) }.not_to exceed_query_limit(runners_control)
end
def setup_additional_records
# Add more runners (including owned by other users)
runner4 = create(:ci_runner, tag_list: tag_list + %w[tag1 tag2], creator: user2)
runner5 = create(:ci_runner, :group, groups: [create(:group)], tag_list: tag_list + %w[tag2 tag3], creator: user3)
# Add one more project to runner
runner3.assign_to(create(:project))
# Add more runner managers (including to existing runners)
runner_manager1 = create(:ci_runner_machine, runner: runner1)
create(:ci_runner_machine, runner: runner1)
create(:ci_runner_machine, runner: runner2, system_xid: runner_manager1.system_xid)
create(:ci_runner_machine, runner: runner3)
create(:ci_runner_machine, runner: runner4, version: '16.4.1')
create(:ci_runner_machine, runner: runner5, version: '16.4.0', system_xid: runner_manager1.system_xid)
create(:ci_runner_machine, runner: runner3)
create(:ci_build, :failed, runner: runner4)
create(:ci_build, :failed, runner: runner5)
[runner4, runner5]
end
end
describe 'pagination' do
let(:data_path) { [:runners] }
def pagination_query(params)
graphql_query_for(:runners, params, "#{page_info} nodes { id }")
end
def pagination_results_data(runners)
runners.map { |runner| GitlabSchema.parse_gid(runner['id'], expected_type: ::Ci::Runner).model_id.to_i }
end
let_it_be(:runners) do
common_args = {
version: 'abc',
revision: '123',
ip_address: '127.0.0.1'
}
[
create(:ci_runner, :instance, created_at: 4.days.ago, contacted_at: 3.days.ago, **common_args),
create(:ci_runner, :instance, created_at: 30.hours.ago, contacted_at: 1.day.ago, **common_args),
create(:ci_runner, :instance, created_at: 1.day.ago, contacted_at: 1.hour.ago, **common_args),
create(:ci_runner, :instance, created_at: 2.days.ago, contacted_at: 2.days.ago, **common_args),
create(:ci_runner, :instance, created_at: 3.days.ago, contacted_at: 1.second.ago, **common_args)
]
end
context 'when sorted by contacted_at ascending' do
let(:ordered_runners) { runners.sort_by(&:contacted_at) }
it_behaves_like 'sorted paginated query' do
let(:sort_param) { :CONTACTED_ASC }
let(:first_param) { 2 }
let(:all_records) { ordered_runners.map(&:id) }
end
end
context 'when sorted by created_at' do
let(:ordered_runners) { runners.sort_by(&:created_at).reverse }
it_behaves_like 'sorted paginated query' do
let(:sort_param) { :CREATED_DESC }
let(:first_param) { 2 }
let(:all_records) { ordered_runners.map(&:id) }
end
end
end
end
RSpec.describe 'Group.runners' do
include GraphqlHelpers
let_it_be(:group) { create(:group) }
let_it_be(:group_owner) { create_default(:user) }
before do
group.add_owner(group_owner)
end
describe 'edges' do
let_it_be(:runner) do
create(:ci_runner, :group,
active: false,
version: 'def',
revision: '456',
description: 'Project runner',
groups: [group],
ip_address: '127.0.0.1')
end
let(:query) do
%(
query($path: ID!) {
group(fullPath: $path) {
runners {
edges {
webUrl
editUrl
node { #{all_graphql_fields_for('CiRunner')} }
}
}
}
}
)
end
it 'contains custom edge information' do
r = GitlabSchema.execute(query,
context: { current_user: group_owner },
variables: { path: group.full_path })
edges = graphql_dig_at(r.to_h, :data, :group, :runners, :edges)
expect(edges).to contain_exactly(a_graphql_entity_for(web_url: be_present, edit_url: be_present))
end
end
end
|