summaryrefslogtreecommitdiff
path: root/spec/requests/api/graphql/ci/runner_spec.rb
diff options
context:
space:
mode:
Diffstat (limited to 'spec/requests/api/graphql/ci/runner_spec.rb')
-rw-r--r--spec/requests/api/graphql/ci/runner_spec.rb144
1 files changed, 144 insertions, 0 deletions
diff --git a/spec/requests/api/graphql/ci/runner_spec.rb b/spec/requests/api/graphql/ci/runner_spec.rb
new file mode 100644
index 00000000000..e1f84d23209
--- /dev/null
+++ b/spec/requests/api/graphql/ci/runner_spec.rb
@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'Query.runner(id)' do
+ include GraphqlHelpers
+
+ let_it_be(:user) { create_default(:user, :admin) }
+
+ let_it_be(:active_runner) do
+ create(:ci_runner, :instance, description: 'Runner 1', contacted_at: 2.hours.ago,
+ active: true, version: 'adfe156', revision: 'a', locked: true, ip_address: '127.0.0.1', maximum_timeout: 600,
+ access_level: 0, tag_list: %w[tag1 tag2], run_untagged: true)
+ end
+
+ let_it_be(:inactive_runner) do
+ create(:ci_runner, :instance, description: 'Runner 2', contacted_at: 1.day.ago, active: false,
+ version: 'adfe157', revision: 'b', ip_address: '10.10.10.10', access_level: 1, run_untagged: true)
+ end
+
+ def get_runner(id)
+ case id
+ when :active_runner
+ active_runner
+ when :inactive_runner
+ inactive_runner
+ end
+ end
+
+ shared_examples 'runner details fetch' do |runner_id|
+ let(:query) do
+ wrap_fields(query_graphql_path(query_path, all_graphql_fields_for('CiRunner')))
+ end
+
+ let(:query_path) do
+ [
+ [:runner, { id: get_runner(runner_id).to_global_id.to_s }]
+ ]
+ end
+
+ it 'retrieves expected fields' do
+ post_graphql(query, current_user: user)
+
+ runner_data = graphql_data_at(:runner)
+ expect(runner_data).not_to be_nil
+
+ runner = get_runner(runner_id)
+ expect(runner_data).to match a_hash_including(
+ 'id' => "gid://gitlab/Ci::Runner/#{runner.id}",
+ 'description' => runner.description,
+ 'contactedAt' => runner.contacted_at&.iso8601,
+ 'version' => runner.version,
+ 'shortSha' => runner.short_sha,
+ 'revision' => runner.revision,
+ 'locked' => runner.locked,
+ 'active' => runner.active,
+ 'status' => runner.status.to_s.upcase,
+ 'maximumTimeout' => runner.maximum_timeout,
+ 'accessLevel' => runner.access_level.to_s.upcase,
+ 'runUntagged' => runner.run_untagged,
+ 'ipAddress' => runner.ip_address,
+ 'runnerType' => 'INSTANCE_TYPE'
+ )
+ expect(runner_data['tagList']).to match_array runner.tag_list
+ end
+ end
+
+ shared_examples 'retrieval by unauthorized user' do |runner_id|
+ let(:query) do
+ wrap_fields(query_graphql_path(query_path, all_graphql_fields_for('CiRunner')))
+ end
+
+ let(:query_path) do
+ [
+ [:runner, { id: get_runner(runner_id).to_global_id.to_s }]
+ ]
+ end
+
+ it 'returns null runner' do
+ post_graphql(query, current_user: user)
+
+ expect(graphql_data_at(:runner)).to be_nil
+ end
+ end
+
+ describe 'for active runner' do
+ it_behaves_like 'runner details fetch', :active_runner
+ end
+
+ describe 'for inactive runner' do
+ it_behaves_like 'runner details fetch', :inactive_runner
+ end
+
+ describe 'by regular user' do
+ let(:user) { create_default(:user) }
+
+ it_behaves_like 'retrieval by unauthorized user', :active_runner
+ end
+
+ describe 'by unauthenticated user' do
+ let(:user) { nil }
+
+ it_behaves_like 'retrieval by unauthorized user', :active_runner
+ end
+
+ describe 'Query limits' do
+ def runner_query(runner)
+ <<~SINGLE
+ runner(id: "#{runner.to_global_id}") {
+ #{all_graphql_fields_for('CiRunner')}
+ }
+ SINGLE
+ end
+
+ let(:single_query) do
+ <<~QUERY
+ {
+ active: #{runner_query(active_runner)}
+ }
+ QUERY
+ end
+
+ let(:double_query) do
+ <<~QUERY
+ {
+ active: #{runner_query(active_runner)}
+ inactive: #{runner_query(inactive_runner)}
+ }
+ QUERY
+ end
+
+ it 'does not execute more queries per runner', :aggregate_failures do
+ # warm-up license cache and so on:
+ post_graphql(single_query, current_user: user)
+
+ control = ActiveRecord::QueryRecorder.new { post_graphql(single_query, current_user: user) }
+
+ expect { post_graphql(double_query, current_user: user) }
+ .not_to exceed_query_limit(control)
+ expect(graphql_data_at(:active)).not_to be_nil
+ expect(graphql_data_at(:inactive)).not_to be_nil
+ end
+ end
+end