debian-mirror-gitlab/spec/requests/api/ci/runners_spec.rb

1097 lines
38 KiB
Ruby
Raw Normal View History

2019-12-26 22:10:19 +05:30
# frozen_string_literal: true
2016-04-02 18:10:28 +05:30
require 'spec_helper'
2020-07-28 23:09:34 +05:30
RSpec.describe API::Ci::Runners do
2020-05-24 23:13:21 +05:30
let_it_be(:admin) { create(:user, :admin) }
let_it_be(:user) { create(:user) }
let_it_be(:user2) { create(:user) }
let_it_be(:group_guest) { create(:user) }
let_it_be(:group_reporter) { create(:user) }
let_it_be(:group_developer) { create(:user) }
let_it_be(:group_maintainer) { create(:user) }
let_it_be(:project) { create(:project, creator_id: user.id) }
let_it_be(:project2) { create(:project, creator_id: user.id) }
let_it_be(:group) { create(:group).tap { |group| group.add_owner(user) } }
let_it_be(:subgroup) { create(:group, parent: group) }
let_it_be(:shared_runner, reload: true) { create(:ci_runner, :instance, description: 'Shared runner') }
let_it_be(:project_runner, reload: true) { create(:ci_runner, :project, description: 'Project runner', projects: [project]) }
let_it_be(:two_projects_runner) { create(:ci_runner, :project, description: 'Two projects runner', projects: [project, project2]) }
let_it_be(:group_runner_a) { create(:ci_runner, :group, description: 'Group runner A', groups: [group]) }
let_it_be(:group_runner_b) { create(:ci_runner, :group, description: 'Group runner B', groups: [subgroup]) }
before_all do
group.add_guest(group_guest)
group.add_reporter(group_reporter)
group.add_developer(group_developer)
group.add_maintainer(group_maintainer)
project.add_maintainer(user)
project2.add_maintainer(user)
project.add_reporter(user2)
2016-04-02 18:10:28 +05:30
end
describe 'GET /runners' do
context 'authorized user' do
2018-12-05 23:21:45 +05:30
it 'returns response status and headers' do
2016-04-02 18:10:28 +05:30
get api('/runners', user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2017-08-17 22:00:37 +05:30
expect(response).to include_pagination_headers
2018-12-05 23:21:45 +05:30
end
it 'returns user available runners' do
get api('/runners', user)
expect(json_response).to match_array [
a_hash_including('description' => 'Project runner'),
a_hash_including('description' => 'Two projects runner'),
2020-04-22 19:07:51 +05:30
a_hash_including('description' => 'Group runner A'),
a_hash_including('description' => 'Group runner B')
2018-12-05 23:21:45 +05:30
]
2016-04-02 18:10:28 +05:30
end
2016-09-13 17:45:13 +05:30
it 'filters runners by scope' do
2018-12-05 23:21:45 +05:30
create(:ci_runner, :project, :inactive, description: 'Inactive project runner', projects: [project])
get api('/runners?scope=paused', user)
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2017-08-17 22:00:37 +05:30
expect(response).to include_pagination_headers
2018-12-05 23:21:45 +05:30
expect(json_response).to match_array [
a_hash_including('description' => 'Inactive project runner')
]
2016-04-02 18:10:28 +05:30
end
2016-09-13 17:45:13 +05:30
it 'avoids filtering if scope is invalid' do
2016-04-02 18:10:28 +05:30
get api('/runners?scope=unknown', user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2016-04-02 18:10:28 +05:30
end
2018-12-05 23:21:45 +05:30
it 'filters runners by type' do
get api('/runners?type=project_type', user)
expect(json_response).to match_array [
a_hash_including('description' => 'Project runner'),
a_hash_including('description' => 'Two projects runner')
]
end
it 'does not filter by invalid type' do
get api('/runners?type=bogus', user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2018-12-05 23:21:45 +05:30
end
it 'filters runners by status' do
create(:ci_runner, :project, :inactive, description: 'Inactive project runner', projects: [project])
get api('/runners?status=paused', user)
expect(json_response).to match_array [
a_hash_including('description' => 'Inactive project runner')
]
end
it 'does not filter by invalid status' do
get api('/runners?status=bogus', user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2018-12-05 23:21:45 +05:30
end
2019-07-07 11:18:12 +05:30
it 'filters runners by tag_list' do
create(:ci_runner, :project, description: 'Runner tagged with tag1 and tag2', projects: [project], tag_list: %w[tag1 tag2])
create(:ci_runner, :project, description: 'Runner tagged with tag2', projects: [project], tag_list: ['tag2'])
get api('/runners?tag_list=tag1,tag2', user)
expect(json_response).to match_array [
a_hash_including('description' => 'Runner tagged with tag1 and tag2')
]
end
2016-04-02 18:10:28 +05:30
end
context 'unauthorized user' do
2016-09-13 17:45:13 +05:30
it 'does not return runners' do
2016-04-02 18:10:28 +05:30
get api('/runners')
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:unauthorized)
2016-04-02 18:10:28 +05:30
end
end
end
describe 'GET /runners/all' do
context 'authorized user' do
context 'with admin privileges' do
2018-12-05 23:21:45 +05:30
it 'returns response status and headers' do
get api('/runners/all', admin)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-12-05 23:21:45 +05:30
expect(response).to include_pagination_headers
end
2016-09-13 17:45:13 +05:30
it 'returns all runners' do
2016-04-02 18:10:28 +05:30
get api('/runners/all', admin)
2018-12-05 23:21:45 +05:30
expect(json_response).to match_array [
a_hash_including('description' => 'Project runner'),
a_hash_including('description' => 'Two projects runner'),
2020-04-22 19:07:51 +05:30
a_hash_including('description' => 'Group runner A'),
a_hash_including('description' => 'Group runner B'),
2018-12-05 23:21:45 +05:30
a_hash_including('description' => 'Shared runner')
]
end
it 'filters runners by scope' do
get api('/runners/all?scope=shared', admin)
shared = json_response.all? { |r| r['is_shared'] }
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2017-08-17 22:00:37 +05:30
expect(response).to include_pagination_headers
2016-04-02 18:10:28 +05:30
expect(json_response).to be_an Array
2018-11-08 19:23:39 +05:30
expect(json_response[0]).to have_key('ip_address')
2016-04-02 18:10:28 +05:30
expect(shared).to be_truthy
end
2018-12-05 23:21:45 +05:30
it 'filters runners by scope' do
get api('/runners/all?scope=specific', admin)
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-12-05 23:21:45 +05:30
expect(response).to include_pagination_headers
expect(json_response).to match_array [
a_hash_including('description' => 'Project runner'),
a_hash_including('description' => 'Two projects runner'),
2020-04-22 19:07:51 +05:30
a_hash_including('description' => 'Group runner A'),
a_hash_including('description' => 'Group runner B')
2018-12-05 23:21:45 +05:30
]
2016-04-02 18:10:28 +05:30
end
2018-12-05 23:21:45 +05:30
it 'avoids filtering if scope is invalid' do
get api('/runners/all?scope=unknown', admin)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2018-12-05 23:21:45 +05:30
end
2018-11-08 19:23:39 +05:30
2020-04-22 19:07:51 +05:30
it 'filters runners by project type' do
2018-12-05 23:21:45 +05:30
get api('/runners/all?type=project_type', admin)
2018-11-08 19:23:39 +05:30
2018-12-05 23:21:45 +05:30
expect(json_response).to match_array [
a_hash_including('description' => 'Project runner'),
a_hash_including('description' => 'Two projects runner')
]
end
2016-04-02 18:10:28 +05:30
2020-04-22 19:07:51 +05:30
it 'filters runners by group type' do
get api('/runners/all?type=group_type', admin)
expect(json_response).to match_array [
a_hash_including('description' => 'Group runner A'),
a_hash_including('description' => 'Group runner B')
]
end
2018-12-05 23:21:45 +05:30
it 'does not filter by invalid type' do
get api('/runners/all?type=bogus', admin)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2018-12-05 23:21:45 +05:30
end
it 'filters runners by status' do
create(:ci_runner, :project, :inactive, description: 'Inactive project runner', projects: [project])
get api('/runners/all?status=paused', admin)
expect(json_response).to match_array [
a_hash_including('description' => 'Inactive project runner')
]
end
it 'does not filter by invalid status' do
get api('/runners/all?status=bogus', admin)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2018-12-05 23:21:45 +05:30
end
2019-07-07 11:18:12 +05:30
it 'filters runners by tag_list' do
create(:ci_runner, :project, description: 'Runner tagged with tag1 and tag2', projects: [project], tag_list: %w[tag1 tag2])
create(:ci_runner, :project, description: 'Runner tagged with tag2', projects: [project], tag_list: ['tag2'])
get api('/runners/all?tag_list=tag1,tag2', admin)
expect(json_response).to match_array [
a_hash_including('description' => 'Runner tagged with tag1 and tag2')
]
end
2016-04-02 18:10:28 +05:30
end
2018-12-05 23:21:45 +05:30
context 'without admin privileges' do
it 'does not return runners list' do
get api('/runners/all', user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2018-12-05 23:21:45 +05:30
end
2016-04-02 18:10:28 +05:30
end
end
context 'unauthorized user' do
2016-09-13 17:45:13 +05:30
it 'does not return runners' do
2016-04-02 18:10:28 +05:30
get api('/runners')
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:unauthorized)
2016-04-02 18:10:28 +05:30
end
end
end
describe 'GET /runners/:id' do
context 'admin user' do
context 'when runner is shared' do
2016-09-13 17:45:13 +05:30
it "returns runner's details" do
2016-04-02 18:10:28 +05:30
get api("/runners/#{shared_runner.id}", admin)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2016-04-02 18:10:28 +05:30
expect(json_response['description']).to eq(shared_runner.description)
2018-05-09 12:01:36 +05:30
expect(json_response['maximum_timeout']).to be_nil
2016-04-02 18:10:28 +05:30
end
end
context 'when runner is not shared' do
2018-11-08 19:23:39 +05:30
context 'when unused runner is present' do
let!(:unused_project_runner) { create(:ci_runner, :project, :without_projects) }
it 'deletes unused runner' do
expect do
delete api("/runners/#{unused_project_runner.id}", admin)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:no_content)
2020-07-28 23:09:34 +05:30
end.to change { ::Ci::Runner.project_type.count }.by(-1)
2018-11-08 19:23:39 +05:30
end
end
2016-09-13 17:45:13 +05:30
it "returns runner's details" do
2018-10-15 14:42:47 +05:30
get api("/runners/#{project_runner.id}", admin)
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-10-15 14:42:47 +05:30
expect(json_response['description']).to eq(project_runner.description)
end
it "returns the project's details for a project runner" do
get api("/runners/#{project_runner.id}", admin)
expect(json_response['projects'].first['id']).to eq(project.id)
2016-04-02 18:10:28 +05:30
end
end
2020-07-28 23:09:34 +05:30
it 'returns 404 if runner does not exist' do
2019-07-07 11:18:12 +05:30
get api('/runners/0', admin)
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2016-04-02 18:10:28 +05:30
end
end
context "runner project's administrative user" do
context 'when runner is not shared' do
2016-09-13 17:45:13 +05:30
it "returns runner's details" do
2018-10-15 14:42:47 +05:30
get api("/runners/#{project_runner.id}", user)
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-10-15 14:42:47 +05:30
expect(json_response['description']).to eq(project_runner.description)
2016-04-02 18:10:28 +05:30
end
end
context 'when runner is shared' do
2016-09-13 17:45:13 +05:30
it "returns runner's details" do
2016-04-02 18:10:28 +05:30
get api("/runners/#{shared_runner.id}", user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2016-04-02 18:10:28 +05:30
expect(json_response['description']).to eq(shared_runner.description)
end
end
end
context 'other authorized user' do
2018-10-15 14:42:47 +05:30
it "does not return project runner's details" do
get api("/runners/#{project_runner.id}", user2)
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2016-04-02 18:10:28 +05:30
end
end
context 'unauthorized user' do
2018-10-15 14:42:47 +05:30
it "does not return project runner's details" do
get api("/runners/#{project_runner.id}")
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:unauthorized)
2016-04-02 18:10:28 +05:30
end
end
end
describe 'PUT /runners/:id' do
context 'admin user' do
2019-12-04 20:38:33 +05:30
# see https://gitlab.com/gitlab-org/gitlab-foss/issues/48625
2018-11-18 11:00:15 +05:30
context 'single parameter update' do
it 'runner description' do
description = shared_runner.description
update_runner(shared_runner.id, admin, description: "#{description}_updated")
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-11-18 11:00:15 +05:30
expect(shared_runner.reload.description).to eq("#{description}_updated")
end
it 'runner active state' do
active = shared_runner.active
update_runner(shared_runner.id, admin, active: !active)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-11-18 11:00:15 +05:30
expect(shared_runner.reload.active).to eq(!active)
end
it 'runner tag list' do
update_runner(shared_runner.id, admin, tag_list: ['ruby2.1', 'pgsql', 'mysql'])
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-11-18 11:00:15 +05:30
expect(shared_runner.reload.tag_list).to include('ruby2.1', 'pgsql', 'mysql')
end
it 'runner untagged flag' do
# Ensure tag list is non-empty before setting untagged to false.
update_runner(shared_runner.id, admin, tag_list: ['ruby2.1', 'pgsql', 'mysql'])
update_runner(shared_runner.id, admin, run_untagged: 'false')
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-11-18 11:00:15 +05:30
expect(shared_runner.reload.run_untagged?).to be(false)
end
it 'runner unlocked flag' do
update_runner(shared_runner.id, admin, locked: 'true')
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-11-18 11:00:15 +05:30
expect(shared_runner.reload.locked?).to be(true)
end
it 'runner access level' do
update_runner(shared_runner.id, admin, access_level: 'ref_protected')
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-11-18 11:00:15 +05:30
expect(shared_runner.reload.ref_protected?).to be_truthy
end
it 'runner maximum timeout' do
update_runner(shared_runner.id, admin, maximum_timeout: 1234)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-11-18 11:00:15 +05:30
expect(shared_runner.reload.maximum_timeout).to eq(1234)
end
it 'fails with no parameters' do
put api("/runners/#{shared_runner.id}", admin)
shared_runner.reload
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2018-11-18 11:00:15 +05:30
end
end
2016-04-02 18:10:28 +05:30
context 'when runner is shared' do
2016-09-13 17:45:13 +05:30
it 'updates runner' do
2016-04-02 18:10:28 +05:30
description = shared_runner.description
active = shared_runner.active
2017-08-17 22:00:37 +05:30
runner_queue_value = shared_runner.ensure_runner_queue_value
2016-04-02 18:10:28 +05:30
2016-06-02 11:05:42 +05:30
update_runner(shared_runner.id, admin, description: "#{description}_updated",
active: !active,
tag_list: ['ruby2.1', 'pgsql', 'mysql'],
2016-06-22 15:30:34 +05:30
run_untagged: 'false',
2018-03-17 18:26:18 +05:30
locked: 'true',
2018-05-09 12:01:36 +05:30
access_level: 'ref_protected',
maximum_timeout: 1234)
2016-04-02 18:10:28 +05:30
shared_runner.reload
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2016-04-02 18:10:28 +05:30
expect(shared_runner.description).to eq("#{description}_updated")
expect(shared_runner.active).to eq(!active)
expect(shared_runner.tag_list).to include('ruby2.1', 'pgsql', 'mysql')
2016-06-22 15:30:34 +05:30
expect(shared_runner.run_untagged?).to be(false)
expect(shared_runner.locked?).to be(true)
2018-03-17 18:26:18 +05:30
expect(shared_runner.ref_protected?).to be_truthy
2017-08-17 22:00:37 +05:30
expect(shared_runner.ensure_runner_queue_value)
.not_to eq(runner_queue_value)
2018-05-09 12:01:36 +05:30
expect(shared_runner.maximum_timeout).to eq(1234)
2016-04-02 18:10:28 +05:30
end
end
context 'when runner is not shared' do
2016-09-13 17:45:13 +05:30
it 'updates runner' do
2018-10-15 14:42:47 +05:30
description = project_runner.description
runner_queue_value = project_runner.ensure_runner_queue_value
2017-08-17 22:00:37 +05:30
2018-10-15 14:42:47 +05:30
update_runner(project_runner.id, admin, description: 'test')
project_runner.reload
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-10-15 14:42:47 +05:30
expect(project_runner.description).to eq('test')
expect(project_runner.description).not_to eq(description)
expect(project_runner.ensure_runner_queue_value)
2017-08-17 22:00:37 +05:30
.not_to eq(runner_queue_value)
2016-04-02 18:10:28 +05:30
end
end
2020-07-28 23:09:34 +05:30
it 'returns 404 if runner does not exist' do
2019-07-07 11:18:12 +05:30
update_runner(0, admin, description: 'test')
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2016-04-02 18:10:28 +05:30
end
2016-06-02 11:05:42 +05:30
def update_runner(id, user, args)
2019-02-15 15:39:39 +05:30
put api("/runners/#{id}", user), params: args
2016-06-02 11:05:42 +05:30
end
2016-04-02 18:10:28 +05:30
end
context 'authorized user' do
context 'when runner is shared' do
2016-09-13 17:45:13 +05:30
it 'does not update runner' do
2019-02-15 15:39:39 +05:30
put api("/runners/#{shared_runner.id}", user), params: { description: 'test' }
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2016-04-02 18:10:28 +05:30
end
end
context 'when runner is not shared' do
2018-10-15 14:42:47 +05:30
it 'does not update project runner without access to it' do
2019-02-15 15:39:39 +05:30
put api("/runners/#{project_runner.id}", user2), params: { description: 'test' }
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2016-04-02 18:10:28 +05:30
end
2018-10-15 14:42:47 +05:30
it 'updates project runner with access to it' do
description = project_runner.description
2019-02-15 15:39:39 +05:30
put api("/runners/#{project_runner.id}", admin), params: { description: 'test' }
2018-10-15 14:42:47 +05:30
project_runner.reload
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-10-15 14:42:47 +05:30
expect(project_runner.description).to eq('test')
expect(project_runner.description).not_to eq(description)
2016-04-02 18:10:28 +05:30
end
end
end
context 'unauthorized user' do
2018-10-15 14:42:47 +05:30
it 'does not delete project runner' do
put api("/runners/#{project_runner.id}")
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:unauthorized)
2016-04-02 18:10:28 +05:30
end
end
end
describe 'DELETE /runners/:id' do
context 'admin user' do
context 'when runner is shared' do
2016-09-13 17:45:13 +05:30
it 'deletes runner' do
2016-04-02 18:10:28 +05:30
expect do
delete api("/runners/#{shared_runner.id}", admin)
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:no_content)
2020-07-28 23:09:34 +05:30
end.to change { ::Ci::Runner.instance_type.count }.by(-1)
2018-03-17 18:26:18 +05:30
end
it_behaves_like '412 response' do
let(:request) { api("/runners/#{shared_runner.id}", admin) }
2016-04-02 18:10:28 +05:30
end
end
context 'when runner is not shared' do
2018-10-15 14:42:47 +05:30
it 'deletes used project runner' do
2016-04-02 18:10:28 +05:30
expect do
2018-10-15 14:42:47 +05:30
delete api("/runners/#{project_runner.id}", admin)
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:no_content)
2020-07-28 23:09:34 +05:30
end.to change { ::Ci::Runner.project_type.count }.by(-1)
2016-04-02 18:10:28 +05:30
end
end
2020-07-28 23:09:34 +05:30
it 'returns 404 if runner does not exist' do
2019-07-07 11:18:12 +05:30
delete api('/runners/0', admin)
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2016-04-02 18:10:28 +05:30
end
end
context 'authorized user' do
context 'when runner is shared' do
2016-09-13 17:45:13 +05:30
it 'does not delete runner' do
2016-04-02 18:10:28 +05:30
delete api("/runners/#{shared_runner.id}", user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2016-04-02 18:10:28 +05:30
end
end
context 'when runner is not shared' do
2016-09-13 17:45:13 +05:30
it 'does not delete runner without access to it' do
2018-10-15 14:42:47 +05:30
delete api("/runners/#{project_runner.id}", user2)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2016-04-02 18:10:28 +05:30
end
2018-10-15 14:42:47 +05:30
it 'does not delete project runner with more than one associated project' do
2016-04-02 18:10:28 +05:30
delete api("/runners/#{two_projects_runner.id}", user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2016-04-02 18:10:28 +05:30
end
2018-10-15 14:42:47 +05:30
it 'deletes project runner for one owned project' do
2016-04-02 18:10:28 +05:30
expect do
2018-10-15 14:42:47 +05:30
delete api("/runners/#{project_runner.id}", user)
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:no_content)
2020-07-28 23:09:34 +05:30
end.to change { ::Ci::Runner.project_type.count }.by(-1)
2018-03-17 18:26:18 +05:30
end
2020-04-22 19:07:51 +05:30
it 'does not delete group runner with guest access' do
delete api("/runners/#{group_runner_a.id}", group_guest)
expect(response).to have_gitlab_http_status(:forbidden)
end
it 'does not delete group runner with reporter access' do
delete api("/runners/#{group_runner_a.id}", group_reporter)
expect(response).to have_gitlab_http_status(:forbidden)
end
it 'does not delete group runner with developer access' do
delete api("/runners/#{group_runner_a.id}", group_developer)
expect(response).to have_gitlab_http_status(:forbidden)
end
2020-01-03 18:37:03 +05:30
it 'does not delete group runner with maintainer access' do
2020-04-22 19:07:51 +05:30
delete api("/runners/#{group_runner_a.id}", group_maintainer)
2020-01-03 18:37:03 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2020-01-03 18:37:03 +05:30
end
2020-04-22 19:07:51 +05:30
it 'deletes owned group runner with owner access' do
expect do
delete api("/runners/#{group_runner_a.id}", user)
expect(response).to have_gitlab_http_status(:no_content)
2020-07-28 23:09:34 +05:30
end.to change { ::Ci::Runner.group_type.count }.by(-1)
2020-04-22 19:07:51 +05:30
end
it 'deletes inherited group runner with owner access' do
2020-01-03 18:37:03 +05:30
expect do
2020-04-22 19:07:51 +05:30
delete api("/runners/#{group_runner_b.id}", user)
2020-01-03 18:37:03 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:no_content)
2020-07-28 23:09:34 +05:30
end.to change { ::Ci::Runner.group_type.count }.by(-1)
2020-01-03 18:37:03 +05:30
end
2018-03-17 18:26:18 +05:30
it_behaves_like '412 response' do
2018-10-15 14:42:47 +05:30
let(:request) { api("/runners/#{project_runner.id}", user) }
2016-04-02 18:10:28 +05:30
end
end
end
context 'unauthorized user' do
2018-10-15 14:42:47 +05:30
it 'does not delete project runner' do
delete api("/runners/#{project_runner.id}")
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:unauthorized)
2018-03-17 18:26:18 +05:30
end
end
end
describe 'GET /runners/:id/jobs' do
2020-03-13 15:44:24 +05:30
let_it_be(:job_1) { create(:ci_build) }
2020-05-24 23:13:21 +05:30
let_it_be(:job_2) { create(:ci_build, :running, runner: shared_runner, project: project) }
let_it_be(:job_3) { create(:ci_build, :failed, runner: shared_runner, project: project) }
let_it_be(:job_4) { create(:ci_build, :running, runner: project_runner, project: project) }
let_it_be(:job_5) { create(:ci_build, :failed, runner: project_runner, project: project) }
2018-03-17 18:26:18 +05:30
context 'admin user' do
context 'when runner exists' do
context 'when runner is shared' do
it 'return jobs' do
get api("/runners/#{shared_runner.id}/jobs", admin)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-03-17 18:26:18 +05:30
expect(response).to include_pagination_headers
expect(json_response).to be_an(Array)
expect(json_response.length).to eq(2)
end
end
context 'when runner is specific' do
it 'return jobs' do
2018-10-15 14:42:47 +05:30
get api("/runners/#{project_runner.id}/jobs", admin)
2018-03-17 18:26:18 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-03-17 18:26:18 +05:30
expect(response).to include_pagination_headers
expect(json_response).to be_an(Array)
expect(json_response.length).to eq(2)
end
end
context 'when valid status is provided' do
it 'return filtered jobs' do
2018-10-15 14:42:47 +05:30
get api("/runners/#{project_runner.id}/jobs?status=failed", admin)
2018-03-17 18:26:18 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-03-17 18:26:18 +05:30
expect(response).to include_pagination_headers
expect(json_response).to be_an(Array)
expect(json_response.length).to eq(1)
expect(json_response.first).to include('id' => job_5.id)
end
end
2019-09-30 21:07:59 +05:30
context 'when valid order_by is provided' do
context 'when sort order is not specified' do
it 'return jobs in descending order' do
get api("/runners/#{project_runner.id}/jobs?order_by=id", admin)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2019-09-30 21:07:59 +05:30
expect(response).to include_pagination_headers
expect(json_response).to be_an(Array)
expect(json_response.length).to eq(2)
expect(json_response.first).to include('id' => job_5.id)
end
end
context 'when sort order is specified as asc' do
it 'return jobs sorted in ascending order' do
get api("/runners/#{project_runner.id}/jobs?order_by=id&sort=asc", admin)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2019-09-30 21:07:59 +05:30
expect(response).to include_pagination_headers
expect(json_response).to be_an(Array)
expect(json_response.length).to eq(2)
expect(json_response.first).to include('id' => job_4.id)
end
end
end
2018-03-17 18:26:18 +05:30
context 'when invalid status is provided' do
it 'return 400' do
2018-10-15 14:42:47 +05:30
get api("/runners/#{project_runner.id}/jobs?status=non-existing", admin)
2018-03-17 18:26:18 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2018-03-17 18:26:18 +05:30
end
end
2019-09-30 21:07:59 +05:30
context 'when invalid order_by is provided' do
it 'return 400' do
get api("/runners/#{project_runner.id}/jobs?order_by=non-existing", admin)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2019-09-30 21:07:59 +05:30
end
end
context 'when invalid sort is provided' do
it 'return 400' do
get api("/runners/#{project_runner.id}/jobs?sort=non-existing", admin)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2019-09-30 21:07:59 +05:30
end
end
2018-03-17 18:26:18 +05:30
end
context "when runner doesn't exist" do
it 'returns 404' do
2019-07-07 11:18:12 +05:30
get api('/runners/0/jobs', admin)
2018-03-17 18:26:18 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2018-03-17 18:26:18 +05:30
end
end
end
context "runner project's administrative user" do
context 'when runner exists' do
context 'when runner is shared' do
it 'returns 403' do
get api("/runners/#{shared_runner.id}/jobs", user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2018-03-17 18:26:18 +05:30
end
end
context 'when runner is specific' do
it 'return jobs' do
2018-10-15 14:42:47 +05:30
get api("/runners/#{project_runner.id}/jobs", user)
2018-03-17 18:26:18 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-03-17 18:26:18 +05:30
expect(response).to include_pagination_headers
expect(json_response).to be_an(Array)
expect(json_response.length).to eq(2)
end
end
context 'when valid status is provided' do
it 'return filtered jobs' do
2018-10-15 14:42:47 +05:30
get api("/runners/#{project_runner.id}/jobs?status=failed", user)
2018-03-17 18:26:18 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-03-17 18:26:18 +05:30
expect(response).to include_pagination_headers
expect(json_response).to be_an(Array)
expect(json_response.length).to eq(1)
expect(json_response.first).to include('id' => job_5.id)
end
end
context 'when invalid status is provided' do
it 'return 400' do
2018-10-15 14:42:47 +05:30
get api("/runners/#{project_runner.id}/jobs?status=non-existing", user)
2018-03-17 18:26:18 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2018-03-17 18:26:18 +05:30
end
end
end
context "when runner doesn't exist" do
it 'returns 404' do
2019-07-07 11:18:12 +05:30
get api('/runners/0/jobs', user)
2018-03-17 18:26:18 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2018-03-17 18:26:18 +05:30
end
end
end
context 'other authorized user' do
it 'does not return jobs' do
2018-10-15 14:42:47 +05:30
get api("/runners/#{project_runner.id}/jobs", user2)
2018-03-17 18:26:18 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2018-03-17 18:26:18 +05:30
end
end
context 'unauthorized user' do
it 'does not return jobs' do
2018-10-15 14:42:47 +05:30
get api("/runners/#{project_runner.id}/jobs")
2018-03-17 18:26:18 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:unauthorized)
2016-04-02 18:10:28 +05:30
end
end
end
2020-04-22 19:07:51 +05:30
shared_examples_for 'unauthorized access to runners list' do
context 'authorized user without maintainer privileges' do
it "does not return group's runners" do
get api("/#{entity_type}/#{entity.id}/runners", user2)
expect(response).to have_gitlab_http_status(:forbidden)
end
end
context 'unauthorized user' do
it "does not return project's runners" do
get api("/#{entity_type}/#{entity.id}/runners")
expect(response).to have_gitlab_http_status(:unauthorized)
end
end
end
2016-04-02 18:10:28 +05:30
describe 'GET /projects/:id/runners' do
2018-11-18 11:00:15 +05:30
context 'authorized user with maintainer privileges' do
2018-12-05 23:21:45 +05:30
it 'returns response status and headers' do
get api('/runners/all', admin)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-12-05 23:21:45 +05:30
expect(response).to include_pagination_headers
end
it 'returns all runners' do
2016-04-02 18:10:28 +05:30
get api("/projects/#{project.id}/runners", user)
2018-12-05 23:21:45 +05:30
expect(json_response).to match_array [
a_hash_including('description' => 'Project runner'),
a_hash_including('description' => 'Two projects runner'),
a_hash_including('description' => 'Shared runner')
]
end
it 'filters runners by scope' do
get api("/projects/#{project.id}/runners?scope=specific", user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2017-08-17 22:00:37 +05:30
expect(response).to include_pagination_headers
2018-12-05 23:21:45 +05:30
expect(json_response).to match_array [
a_hash_including('description' => 'Project runner'),
a_hash_including('description' => 'Two projects runner')
]
end
it 'avoids filtering if scope is invalid' do
get api("/projects/#{project.id}/runners?scope=unknown", user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2018-12-05 23:21:45 +05:30
end
it 'filters runners by type' do
get api("/projects/#{project.id}/runners?type=project_type", user)
expect(json_response).to match_array [
a_hash_including('description' => 'Project runner'),
a_hash_including('description' => 'Two projects runner')
]
end
it 'does not filter by invalid type' do
get api("/projects/#{project.id}/runners?type=bogus", user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2018-12-05 23:21:45 +05:30
end
it 'filters runners by status' do
create(:ci_runner, :project, :inactive, description: 'Inactive project runner', projects: [project])
get api("/projects/#{project.id}/runners?status=paused", user)
expect(json_response).to match_array [
a_hash_including('description' => 'Inactive project runner')
]
end
it 'does not filter by invalid status' do
get api("/projects/#{project.id}/runners?status=bogus", user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2016-04-02 18:10:28 +05:30
end
2019-07-07 11:18:12 +05:30
it 'filters runners by tag_list' do
create(:ci_runner, :project, description: 'Runner tagged with tag1 and tag2', projects: [project], tag_list: %w[tag1 tag2])
create(:ci_runner, :project, description: 'Runner tagged with tag2', projects: [project], tag_list: ['tag2'])
get api("/projects/#{project.id}/runners?tag_list=tag1,tag2", user)
expect(json_response).to match_array [
a_hash_including('description' => 'Runner tagged with tag1 and tag2')
]
end
2016-04-02 18:10:28 +05:30
end
2020-04-22 19:07:51 +05:30
it_behaves_like 'unauthorized access to runners list' do
let(:entity_type) { 'projects' }
let(:entity) { project }
end
end
2016-04-02 18:10:28 +05:30
2020-04-22 19:07:51 +05:30
describe 'GET /groups/:id/runners' do
context 'authorized user with maintainer privileges' do
it 'returns all runners' do
get api("/groups/#{group.id}/runners", user)
expect(json_response).to match_array([
a_hash_including('description' => 'Group runner A')
])
2016-04-02 18:10:28 +05:30
end
2020-04-22 19:07:51 +05:30
context 'filter by type' do
it 'returns record when valid and present' do
get api("/groups/#{group.id}/runners?type=group_type", user)
2016-04-02 18:10:28 +05:30
2020-04-22 19:07:51 +05:30
expect(json_response).to match_array([
a_hash_including('description' => 'Group runner A')
])
end
it 'returns empty result when type does not match' do
get api("/groups/#{group.id}/runners?type=project_type", user)
expect(json_response).to be_empty
end
it 'does not filter by invalid type' do
get api("/groups/#{group.id}/runners?type=bogus", user)
expect(response).to have_gitlab_http_status(:bad_request)
end
2016-04-02 18:10:28 +05:30
end
2020-04-22 19:07:51 +05:30
context 'filter runners by status' do
it 'returns runners by valid status' do
create(:ci_runner, :group, :inactive, description: 'Inactive group runner', groups: [group])
get api("/groups/#{group.id}/runners?status=paused", user)
expect(json_response).to match_array([
a_hash_including('description' => 'Inactive group runner')
])
end
it 'does not filter by invalid status' do
get api("/groups/#{group.id}/runners?status=bogus", user)
expect(response).to have_gitlab_http_status(:bad_request)
end
end
it 'filters runners by tag_list' do
create(:ci_runner, :group, description: 'Runner tagged with tag1 and tag2', groups: [group], tag_list: %w[tag1 tag2])
create(:ci_runner, :group, description: 'Runner tagged with tag2', groups: [group], tag_list: %w[tag1])
get api("/groups/#{group.id}/runners?tag_list=tag1,tag2", user)
expect(json_response).to match_array([
a_hash_including('description' => 'Runner tagged with tag1 and tag2')
])
end
end
it_behaves_like 'unauthorized access to runners list' do
let(:entity_type) { 'groups' }
let(:entity) { group }
2016-04-02 18:10:28 +05:30
end
end
describe 'POST /projects/:id/runners' do
context 'authorized user' do
2020-05-24 23:13:21 +05:30
let_it_be(:project_runner2) { create(:ci_runner, :project, projects: [project2]) }
2016-04-02 18:10:28 +05:30
2016-09-13 17:45:13 +05:30
it 'enables specific runner' do
2016-04-02 18:10:28 +05:30
expect do
2019-02-15 15:39:39 +05:30
post api("/projects/#{project.id}/runners", user), params: { runner_id: project_runner2.id }
2018-03-17 18:26:18 +05:30
end.to change { project.runners.count }.by(+1)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:created)
2016-04-02 18:10:28 +05:30
end
2016-09-13 17:45:13 +05:30
it 'avoids changes when enabling already enabled runner' do
2016-04-02 18:10:28 +05:30
expect do
2019-02-15 15:39:39 +05:30
post api("/projects/#{project.id}/runners", user), params: { runner_id: project_runner.id }
2018-03-17 18:26:18 +05:30
end.to change { project.runners.count }.by(0)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2016-06-22 15:30:34 +05:30
end
2016-09-13 17:45:13 +05:30
it 'does not enable locked runner' do
2020-07-28 23:09:34 +05:30
project_runner2.update!(locked: true)
2016-06-22 15:30:34 +05:30
expect do
2019-02-15 15:39:39 +05:30
post api("/projects/#{project.id}/runners", user), params: { runner_id: project_runner2.id }
2018-03-17 18:26:18 +05:30
end.to change { project.runners.count }.by(0)
2016-06-22 15:30:34 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2016-04-02 18:10:28 +05:30
end
2016-09-13 17:45:13 +05:30
it 'does not enable shared runner' do
2019-02-15 15:39:39 +05:30
post api("/projects/#{project.id}/runners", user), params: { runner_id: shared_runner.id }
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2016-04-02 18:10:28 +05:30
end
2018-10-15 14:42:47 +05:30
it 'does not enable group runner' do
2020-04-22 19:07:51 +05:30
post api("/projects/#{project.id}/runners", user), params: { runner_id: group_runner_a.id }
2018-10-15 14:42:47 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2018-10-15 14:42:47 +05:30
end
2016-04-02 18:10:28 +05:30
context 'user is admin' do
2018-11-08 19:23:39 +05:30
context 'when project runner is used' do
let!(:new_project_runner) { create(:ci_runner, :project) }
it 'enables any specific runner' do
expect do
2019-02-15 15:39:39 +05:30
post api("/projects/#{project.id}/runners", admin), params: { runner_id: new_project_runner.id }
2018-11-08 19:23:39 +05:30
end.to change { project.runners.count }.by(+1)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:created)
2018-11-08 19:23:39 +05:30
end
2016-04-02 18:10:28 +05:30
end
2018-11-08 19:23:39 +05:30
it 'enables a instance type runner' do
expect do
2019-02-15 15:39:39 +05:30
post api("/projects/#{project.id}/runners", admin), params: { runner_id: shared_runner.id }
2018-11-08 19:23:39 +05:30
end.to change { project.runners.count }.by(1)
2016-04-02 18:10:28 +05:30
2018-11-08 19:23:39 +05:30
expect(shared_runner.reload).not_to be_instance_type
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:created)
2016-04-02 18:10:28 +05:30
end
end
2016-09-13 17:45:13 +05:30
it 'raises an error when no runner_id param is provided' do
2016-04-02 18:10:28 +05:30
post api("/projects/#{project.id}/runners", admin)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
2016-04-02 18:10:28 +05:30
end
end
2018-11-08 19:23:39 +05:30
context 'user is not admin' do
let!(:new_project_runner) { create(:ci_runner, :project) }
it 'does not enable runner without access to' do
2019-02-15 15:39:39 +05:30
post api("/projects/#{project.id}/runners", user), params: { runner_id: new_project_runner.id }
2018-11-08 19:23:39 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2018-11-08 19:23:39 +05:30
end
end
2016-04-02 18:10:28 +05:30
context 'authorized user without permissions' do
2016-09-13 17:45:13 +05:30
it 'does not enable runner' do
2016-04-02 18:10:28 +05:30
post api("/projects/#{project.id}/runners", user2)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2016-04-02 18:10:28 +05:30
end
end
context 'unauthorized user' do
2016-09-13 17:45:13 +05:30
it 'does not enable runner' do
2016-04-02 18:10:28 +05:30
post api("/projects/#{project.id}/runners")
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:unauthorized)
2016-04-02 18:10:28 +05:30
end
end
end
describe 'DELETE /projects/:id/runners/:runner_id' do
context 'authorized user' do
context 'when runner have more than one associated projects' do
2016-09-13 17:45:13 +05:30
it "disables project's runner" do
2016-04-02 18:10:28 +05:30
expect do
delete api("/projects/#{project.id}/runners/#{two_projects_runner.id}", user)
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:no_content)
2018-03-17 18:26:18 +05:30
end.to change { project.runners.count }.by(-1)
end
it_behaves_like '412 response' do
let(:request) { api("/projects/#{project.id}/runners/#{two_projects_runner.id}", user) }
2016-04-02 18:10:28 +05:30
end
end
context 'when runner have one associated projects' do
2016-09-13 17:45:13 +05:30
it "does not disable project's runner" do
2016-04-02 18:10:28 +05:30
expect do
2018-10-15 14:42:47 +05:30
delete api("/projects/#{project.id}/runners/#{project_runner.id}", user)
2018-03-17 18:26:18 +05:30
end.to change { project.runners.count }.by(0)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2016-04-02 18:10:28 +05:30
end
end
2016-09-13 17:45:13 +05:30
it 'returns 404 is runner is not found' do
2019-07-07 11:18:12 +05:30
delete api("/projects/#{project.id}/runners/0", user)
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2016-04-02 18:10:28 +05:30
end
end
context 'authorized user without permissions' do
2016-09-13 17:45:13 +05:30
it "does not disable project's runner" do
2018-10-15 14:42:47 +05:30
delete api("/projects/#{project.id}/runners/#{project_runner.id}", user2)
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2016-04-02 18:10:28 +05:30
end
end
context 'unauthorized user' do
2016-09-13 17:45:13 +05:30
it "does not disable project's runner" do
2018-10-15 14:42:47 +05:30
delete api("/projects/#{project.id}/runners/#{project_runner.id}")
2016-04-02 18:10:28 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:unauthorized)
2016-04-02 18:10:28 +05:30
end
end
end
end