diff options
Diffstat (limited to 'spec/requests/api/ci/runner/runners_post_spec.rb')
-rw-r--r-- | spec/requests/api/ci/runner/runners_post_spec.rb | 250 |
1 files changed, 250 insertions, 0 deletions
diff --git a/spec/requests/api/ci/runner/runners_post_spec.rb b/spec/requests/api/ci/runner/runners_post_spec.rb new file mode 100644 index 00000000000..7c362fae7d2 --- /dev/null +++ b/spec/requests/api/ci/runner/runners_post_spec.rb @@ -0,0 +1,250 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe API::Ci::Runner, :clean_gitlab_redis_shared_state do + include StubGitlabCalls + include RedisHelpers + include WorkhorseHelpers + + let(:registration_token) { 'abcdefg123456' } + + before do + stub_feature_flags(ci_enable_live_trace: true) + stub_gitlab_calls + stub_application_setting(runners_registration_token: registration_token) + allow_any_instance_of(::Ci::Runner).to receive(:cache_attributes) + end + + describe '/api/v4/runners' do + describe 'POST /api/v4/runners' do + context 'when no token is provided' do + it 'returns 400 error' do + post api('/runners') + + expect(response).to have_gitlab_http_status(:bad_request) + end + end + + context 'when invalid token is provided' do + it 'returns 403 error' do + post api('/runners'), params: { token: 'invalid' } + + expect(response).to have_gitlab_http_status(:forbidden) + end + end + + context 'when valid token is provided' do + it 'creates runner with default values' do + post api('/runners'), params: { token: registration_token } + + runner = ::Ci::Runner.first + + expect(response).to have_gitlab_http_status(:created) + expect(json_response['id']).to eq(runner.id) + expect(json_response['token']).to eq(runner.token) + expect(runner.run_untagged).to be true + expect(runner.active).to be true + expect(runner.token).not_to eq(registration_token) + expect(runner).to be_instance_type + end + + context 'when project token is used' do + let(:project) { create(:project) } + + it 'creates project runner' do + post api('/runners'), params: { token: project.runners_token } + + expect(response).to have_gitlab_http_status(:created) + expect(project.runners.size).to eq(1) + runner = ::Ci::Runner.first + expect(runner.token).not_to eq(registration_token) + expect(runner.token).not_to eq(project.runners_token) + expect(runner).to be_project_type + end + end + + context 'when group token is used' do + let(:group) { create(:group) } + + it 'creates a group runner' do + post api('/runners'), params: { token: group.runners_token } + + expect(response).to have_gitlab_http_status(:created) + expect(group.runners.reload.size).to eq(1) + runner = ::Ci::Runner.first + expect(runner.token).not_to eq(registration_token) + expect(runner.token).not_to eq(group.runners_token) + expect(runner).to be_group_type + end + end + end + + context 'when runner description is provided' do + it 'creates runner' do + post api('/runners'), params: { + token: registration_token, + description: 'server.hostname' + } + + expect(response).to have_gitlab_http_status(:created) + expect(::Ci::Runner.first.description).to eq('server.hostname') + end + end + + context 'when runner tags are provided' do + it 'creates runner' do + post api('/runners'), params: { + token: registration_token, + tag_list: 'tag1, tag2' + } + + expect(response).to have_gitlab_http_status(:created) + expect(::Ci::Runner.first.tag_list.sort).to eq(%w(tag1 tag2)) + end + end + + context 'when option for running untagged jobs is provided' do + context 'when tags are provided' do + it 'creates runner' do + post api('/runners'), params: { + token: registration_token, + run_untagged: false, + tag_list: ['tag'] + } + + expect(response).to have_gitlab_http_status(:created) + expect(::Ci::Runner.first.run_untagged).to be false + expect(::Ci::Runner.first.tag_list.sort).to eq(['tag']) + end + end + + context 'when tags are not provided' do + it 'returns 400 error' do + post api('/runners'), params: { + token: registration_token, + run_untagged: false + } + + expect(response).to have_gitlab_http_status(:bad_request) + expect(json_response['message']).to include( + 'tags_list' => ['can not be empty when runner is not allowed to pick untagged jobs']) + end + end + end + + context 'when option for locking Runner is provided' do + it 'creates runner' do + post api('/runners'), params: { + token: registration_token, + locked: true + } + + expect(response).to have_gitlab_http_status(:created) + expect(::Ci::Runner.first.locked).to be true + end + end + + context 'when option for activating a Runner is provided' do + context 'when active is set to true' do + it 'creates runner' do + post api('/runners'), params: { + token: registration_token, + active: true + } + + expect(response).to have_gitlab_http_status(:created) + expect(::Ci::Runner.first.active).to be true + end + end + + context 'when active is set to false' do + it 'creates runner' do + post api('/runners'), params: { + token: registration_token, + active: false + } + + expect(response).to have_gitlab_http_status(:created) + expect(::Ci::Runner.first.active).to be false + end + end + end + + context 'when access_level is provided for Runner' do + context 'when access_level is set to ref_protected' do + it 'creates runner' do + post api('/runners'), params: { + token: registration_token, + access_level: 'ref_protected' + } + + expect(response).to have_gitlab_http_status(:created) + expect(::Ci::Runner.first.ref_protected?).to be true + end + end + + context 'when access_level is set to not_protected' do + it 'creates runner' do + post api('/runners'), params: { + token: registration_token, + access_level: 'not_protected' + } + + expect(response).to have_gitlab_http_status(:created) + expect(::Ci::Runner.first.ref_protected?).to be false + end + end + end + + context 'when maximum job timeout is specified' do + it 'creates runner' do + post api('/runners'), params: { + token: registration_token, + maximum_timeout: 9000 + } + + expect(response).to have_gitlab_http_status(:created) + expect(::Ci::Runner.first.maximum_timeout).to eq(9000) + end + + context 'when maximum job timeout is empty' do + it 'creates runner' do + post api('/runners'), params: { + token: registration_token, + maximum_timeout: '' + } + + expect(response).to have_gitlab_http_status(:created) + expect(::Ci::Runner.first.maximum_timeout).to be_nil + end + end + end + + %w(name version revision platform architecture).each do |param| + context "when info parameter '#{param}' info is present" do + let(:value) { "#{param}_value" } + + it "updates provided Runner's parameter" do + post api('/runners'), params: { + token: registration_token, + info: { param => value } + } + + expect(response).to have_gitlab_http_status(:created) + expect(::Ci::Runner.first.read_attribute(param.to_sym)).to eq(value) + end + end + end + + it "sets the runner's ip_address" do + post api('/runners'), + params: { token: registration_token }, + headers: { 'X-Forwarded-For' => '123.111.123.111' } + + expect(response).to have_gitlab_http_status(:created) + expect(::Ci::Runner.first.ip_address).to eq('123.111.123.111') + end + end + end +end |