diff options
Diffstat (limited to 'spec/requests/api/runner_spec.rb')
| -rw-r--r-- | spec/requests/api/runner_spec.rb | 2375 |
1 files changed, 0 insertions, 2375 deletions
diff --git a/spec/requests/api/runner_spec.rb b/spec/requests/api/runner_spec.rb deleted file mode 100644 index 774615757b9..00000000000 --- a/spec/requests/api/runner_spec.rb +++ /dev/null @@ -1,2375 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -describe API::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 - - describe 'DELETE /api/v4/runners' do - context 'when no token is provided' do - it 'returns 400 error' do - delete 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 - delete api('/runners'), params: { token: 'invalid' } - - expect(response).to have_gitlab_http_status(:forbidden) - end - end - - context 'when valid token is provided' do - let(:runner) { create(:ci_runner) } - - it 'deletes Runner' do - delete api('/runners'), params: { token: runner.token } - - expect(response).to have_gitlab_http_status(:no_content) - expect(Ci::Runner.count).to eq(0) - end - - it_behaves_like '412 response' do - let(:request) { api('/runners') } - let(:params) { { token: runner.token } } - end - end - end - - describe 'POST /api/v4/runners/verify' do - let(:runner) { create(:ci_runner) } - - context 'when no token is provided' do - it 'returns 400 error' do - post api('/runners/verify') - - 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/verify'), params: { token: 'invalid-token' } - - expect(response).to have_gitlab_http_status(:forbidden) - end - end - - context 'when valid token is provided' do - it 'verifies Runner credentials' do - post api('/runners/verify'), params: { token: runner.token } - - expect(response).to have_gitlab_http_status(:ok) - end - end - end - end - - describe '/api/v4/jobs' do - shared_examples 'application context metadata' do |api_route| - it 'contains correct context metadata' do - # Avoids popping the context from the thread so we can - # check its content after the request. - allow(Labkit::Context).to receive(:pop) - - send_request - - Labkit::Context.with_context do |context| - expected_context = { - 'meta.caller_id' => api_route, - 'meta.user' => job.user.username, - 'meta.project' => job.project.full_path, - 'meta.root_namespace' => job.project.full_path_components.first - } - - expect(context.to_h).to include(expected_context) - end - end - end - - let(:root_namespace) { create(:namespace) } - let(:namespace) { create(:namespace, parent: root_namespace) } - let(:project) { create(:project, namespace: namespace, shared_runners_enabled: false) } - let(:pipeline) { create(:ci_pipeline, project: project, ref: 'master') } - let(:runner) { create(:ci_runner, :project, projects: [project]) } - let(:user) { create(:user) } - let(:job) do - create(:ci_build, :artifacts, :extended_options, - pipeline: pipeline, name: 'spinach', stage: 'test', stage_idx: 0) - end - - describe 'POST /api/v4/jobs/request' do - let!(:last_update) {} - let!(:new_update) { } - let(:user_agent) { 'gitlab-runner 9.0.0 (9-0-stable; go1.7.4; linux/amd64)' } - - before do - job - stub_container_registry_config(enabled: false) - end - - shared_examples 'no jobs available' do - before do - request_job - end - - context 'when runner sends version in User-Agent' do - context 'for stable version' do - it 'gives 204 and set X-GitLab-Last-Update' do - expect(response).to have_gitlab_http_status(:no_content) - expect(response.header).to have_key('X-GitLab-Last-Update') - end - end - - context 'when last_update is up-to-date' do - let(:last_update) { runner.ensure_runner_queue_value } - - it 'gives 204 and set the same X-GitLab-Last-Update' do - expect(response).to have_gitlab_http_status(:no_content) - expect(response.header['X-GitLab-Last-Update']).to eq(last_update) - end - end - - context 'when last_update is outdated' do - let(:last_update) { runner.ensure_runner_queue_value } - let(:new_update) { runner.tick_runner_queue } - - it 'gives 204 and set a new X-GitLab-Last-Update' do - expect(response).to have_gitlab_http_status(:no_content) - expect(response.header['X-GitLab-Last-Update']).to eq(new_update) - end - end - - context 'when beta version is sent' do - let(:user_agent) { 'gitlab-runner 9.0.0~beta.167.g2b2bacc (master; go1.7.4; linux/amd64)' } - - it { expect(response).to have_gitlab_http_status(:no_content) } - end - - context 'when pre-9-0 version is sent' do - let(:user_agent) { 'gitlab-ci-multi-runner 1.6.0 (1-6-stable; go1.6.3; linux/amd64)' } - - it { expect(response).to have_gitlab_http_status(:no_content) } - end - - context 'when pre-9-0 beta version is sent' do - let(:user_agent) { 'gitlab-ci-multi-runner 1.6.0~beta.167.g2b2bacc (master; go1.6.3; linux/amd64)' } - - it { expect(response).to have_gitlab_http_status(:no_content) } - end - end - end - - context 'when no token is provided' do - it 'returns 400 error' do - post api('/jobs/request') - - 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('/jobs/request'), params: { token: 'invalid' } - - expect(response).to have_gitlab_http_status(:forbidden) - end - end - - context 'when valid token is provided' do - context 'when Runner is not active' do - let(:runner) { create(:ci_runner, :inactive) } - let(:update_value) { runner.ensure_runner_queue_value } - - it 'returns 204 error' do - request_job - - expect(response).to have_gitlab_http_status(:no_content) - expect(response.header['X-GitLab-Last-Update']).to eq(update_value) - end - end - - context 'when jobs are finished' do - before do - job.success - end - - it_behaves_like 'no jobs available' - end - - context 'when other projects have pending jobs' do - before do - job.success - create(:ci_build, :pending) - end - - it_behaves_like 'no jobs available' - end - - context 'when shared runner requests job for project without shared_runners_enabled' do - let(:runner) { create(:ci_runner, :instance) } - - it_behaves_like 'no jobs available' - end - - context 'when there is a pending job' do - let(:expected_job_info) do - { 'name' => job.name, - 'stage' => job.stage, - 'project_id' => job.project.id, - 'project_name' => job.project.name } - end - - let(:expected_git_info) do - { 'repo_url' => job.repo_url, - 'ref' => job.ref, - 'sha' => job.sha, - 'before_sha' => job.before_sha, - 'ref_type' => 'branch', - 'refspecs' => ["+refs/pipelines/#{pipeline.id}:refs/pipelines/#{pipeline.id}", - "+refs/heads/#{job.ref}:refs/remotes/origin/#{job.ref}"], - 'depth' => project.ci_default_git_depth } - end - - let(:expected_steps) do - [{ 'name' => 'script', - 'script' => %w(echo), - 'timeout' => job.metadata_timeout, - 'when' => 'on_success', - 'allow_failure' => false }, - { 'name' => 'after_script', - 'script' => %w(ls date), - 'timeout' => job.metadata_timeout, - 'when' => 'always', - 'allow_failure' => true }] - end - - let(:expected_variables) do - [{ 'key' => 'CI_JOB_NAME', 'value' => 'spinach', 'public' => true, 'masked' => false }, - { 'key' => 'CI_JOB_STAGE', 'value' => 'test', 'public' => true, 'masked' => false }, - { 'key' => 'DB_NAME', 'value' => 'postgres', 'public' => true, 'masked' => false }] - end - - let(:expected_artifacts) do - [{ 'name' => 'artifacts_file', - 'untracked' => false, - 'paths' => %w(out/), - 'when' => 'always', - 'expire_in' => '7d', - "artifact_type" => "archive", - "artifact_format" => "zip" }] - end - - let(:expected_cache) do - [{ 'key' => 'cache_key', - 'untracked' => false, - 'paths' => ['vendor/*'], - 'policy' => 'pull-push' }] - end - - let(:expected_features) { { 'trace_sections' => true } } - - it 'picks a job' do - request_job info: { platform: :darwin } - - expect(response).to have_gitlab_http_status(:created) - expect(response.headers).not_to have_key('X-GitLab-Last-Update') - expect(runner.reload.platform).to eq('darwin') - expect(json_response['id']).to eq(job.id) - expect(json_response['token']).to eq(job.token) - expect(json_response['job_info']).to eq(expected_job_info) - expect(json_response['git_info']).to eq(expected_git_info) - expect(json_response['image']).to eq({ 'name' => 'ruby:2.7', 'entrypoint' => '/bin/sh', 'ports' => [] }) - expect(json_response['services']).to eq([{ 'name' => 'postgres', 'entrypoint' => nil, - 'alias' => nil, 'command' => nil, 'ports' => [] }, - { 'name' => 'docker:stable-dind', 'entrypoint' => '/bin/sh', - 'alias' => 'docker', 'command' => 'sleep 30', 'ports' => [] }]) - expect(json_response['steps']).to eq(expected_steps) - expect(json_response['artifacts']).to eq(expected_artifacts) - expect(json_response['cache']).to eq(expected_cache) - expect(json_response['variables']).to include(*expected_variables) - expect(json_response['features']).to eq(expected_features) - end - - it 'creates persistent ref' do - expect_any_instance_of(Ci::PersistentRef).to receive(:create_ref) - .with(job.sha, "refs/#{Repository::REF_PIPELINES}/#{job.commit_id}") - - request_job info: { platform: :darwin } - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['id']).to eq(job.id) - end - - context 'when job is made for tag' do - let!(:job) { create(:ci_build, :tag, pipeline: pipeline, name: 'spinach', stage: 'test', stage_idx: 0) } - - it 'sets branch as ref_type' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['git_info']['ref_type']).to eq('tag') - end - - context 'when GIT_DEPTH is specified' do - before do - create(:ci_pipeline_variable, key: 'GIT_DEPTH', value: 1, pipeline: pipeline) - end - - it 'specifies refspecs' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['git_info']['refspecs']).to include("+refs/tags/#{job.ref}:refs/tags/#{job.ref}") - end - end - - context 'when GIT_DEPTH is not specified and there is no default git depth for the project' do - before do - project.update!(ci_default_git_depth: nil) - end - - it 'specifies refspecs' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['git_info']['refspecs']) - .to contain_exactly("+refs/pipelines/#{pipeline.id}:refs/pipelines/#{pipeline.id}", - '+refs/tags/*:refs/tags/*', - '+refs/heads/*:refs/remotes/origin/*') - end - end - end - - context 'when job filtered by job_age' do - let!(:job) { create(:ci_build, :tag, pipeline: pipeline, name: 'spinach', stage: 'test', stage_idx: 0, queued_at: 60.seconds.ago) } - - context 'job is queued less than job_age parameter' do - let(:job_age) { 120 } - - it 'gives 204' do - request_job(job_age: job_age) - - expect(response).to have_gitlab_http_status(:no_content) - end - end - - context 'job is queued more than job_age parameter' do - let(:job_age) { 30 } - - it 'picks a job' do - request_job(job_age: job_age) - - expect(response).to have_gitlab_http_status(:created) - end - end - end - - context 'when job is made for branch' do - it 'sets tag as ref_type' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['git_info']['ref_type']).to eq('branch') - end - - context 'when GIT_DEPTH is specified' do - before do - create(:ci_pipeline_variable, key: 'GIT_DEPTH', value: 1, pipeline: pipeline) - end - - it 'specifies refspecs' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['git_info']['refspecs']).to include("+refs/heads/#{job.ref}:refs/remotes/origin/#{job.ref}") - end - end - - context 'when GIT_DEPTH is not specified and there is no default git depth for the project' do - before do - project.update!(ci_default_git_depth: nil) - end - - it 'specifies refspecs' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['git_info']['refspecs']) - .to contain_exactly("+refs/pipelines/#{pipeline.id}:refs/pipelines/#{pipeline.id}", - '+refs/tags/*:refs/tags/*', - '+refs/heads/*:refs/remotes/origin/*') - end - end - end - - context 'when job is for a release' do - let!(:job) { create(:ci_build, :release_options, pipeline: pipeline) } - - context 'when `release_steps` is passed by the runner' do - it 'exposes release info' do - request_job info: { features: { release_steps: true } } - - expect(response).to have_gitlab_http_status(:created) - expect(response.headers).not_to have_key('X-GitLab-Last-Update') - expect(json_response['steps']).to eq([ - { - "name" => "script", - "script" => ["make changelog | tee release_changelog.txt"], - "timeout" => 3600, - "when" => "on_success", - "allow_failure" => false - }, - { - "name" => "release", - "script" => - "release-cli create --ref \"$CI_COMMIT_SHA\" --name \"Release $CI_COMMIT_SHA\" --tag-name \"release-$CI_COMMIT_SHA\" --description \"Created using the release-cli $EXTRA_DESCRIPTION\"", - "timeout" => 3600, - "when" => "on_success", - "allow_failure" => false - } - ]) - end - end - - context 'when `release_steps` is not passed by the runner' do - it 'drops the job' do - request_job - - expect(response).to have_gitlab_http_status(:no_content) - end - end - end - - context 'when job is made for merge request' do - let(:pipeline) { create(:ci_pipeline, source: :merge_request_event, project: project, ref: 'feature', merge_request: merge_request) } - let!(:job) { create(:ci_build, pipeline: pipeline, name: 'spinach', ref: 'feature', stage: 'test', stage_idx: 0) } - let(:merge_request) { create(:merge_request) } - - it 'sets branch as ref_type' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['git_info']['ref_type']).to eq('branch') - end - - context 'when GIT_DEPTH is specified' do - before do - create(:ci_pipeline_variable, key: 'GIT_DEPTH', value: 1, pipeline: pipeline) - end - - it 'returns the overwritten git depth for merge request refspecs' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['git_info']['depth']).to eq(1) - end - end - end - - it 'updates runner info' do - expect { request_job }.to change { runner.reload.contacted_at } - end - - %w(version revision platform architecture).each do |param| - context "when info parameter '#{param}' is present" do - let(:value) { "#{param}_value" } - - it "updates provided Runner's parameter" do - request_job info: { param => value } - - expect(response).to have_gitlab_http_status(:created) - expect(runner.reload.read_attribute(param.to_sym)).to eq(value) - end - end - end - - it "sets the runner's ip_address" do - post api('/jobs/request'), - params: { token: runner.token }, - headers: { 'User-Agent' => user_agent, 'X-Forwarded-For' => '123.222.123.222' } - - expect(response).to have_gitlab_http_status(:created) - expect(runner.reload.ip_address).to eq('123.222.123.222') - end - - it "handles multiple X-Forwarded-For addresses" do - post api('/jobs/request'), - params: { token: runner.token }, - headers: { 'User-Agent' => user_agent, 'X-Forwarded-For' => '123.222.123.222, 127.0.0.1' } - - expect(response).to have_gitlab_http_status(:created) - expect(runner.reload.ip_address).to eq('123.222.123.222') - end - - context 'when concurrently updating a job' do - before do - expect_any_instance_of(Ci::Build).to receive(:run!) - .and_raise(ActiveRecord::StaleObjectError.new(nil, nil)) - end - - it 'returns a conflict' do - request_job - - expect(response).to have_gitlab_http_status(:conflict) - expect(response.headers).not_to have_key('X-GitLab-Last-Update') - end - end - - context 'when project and pipeline have multiple jobs' do - let!(:job) { create(:ci_build, :tag, pipeline: pipeline, name: 'spinach', stage: 'test', stage_idx: 0) } - let!(:job2) { create(:ci_build, :tag, pipeline: pipeline, name: 'rubocop', stage: 'test', stage_idx: 0) } - let!(:test_job) { create(:ci_build, pipeline: pipeline, name: 'deploy', stage: 'deploy', stage_idx: 1) } - - before do - job.success - job2.success - end - - it 'returns dependent jobs' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['id']).to eq(test_job.id) - expect(json_response['dependencies'].count).to eq(2) - expect(json_response['dependencies']).to include( - { 'id' => job.id, 'name' => job.name, 'token' => job.token }, - { 'id' => job2.id, 'name' => job2.name, 'token' => job2.token }) - end - end - - context 'when pipeline have jobs with artifacts' do - let!(:job) { create(:ci_build, :tag, :artifacts, pipeline: pipeline, name: 'spinach', stage: 'test', stage_idx: 0) } - let!(:test_job) { create(:ci_build, pipeline: pipeline, name: 'deploy', stage: 'deploy', stage_idx: 1) } - - before do - job.success - end - - it 'returns dependent jobs' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['id']).to eq(test_job.id) - expect(json_response['dependencies'].count).to eq(1) - expect(json_response['dependencies']).to include( - { 'id' => job.id, 'name' => job.name, 'token' => job.token, - 'artifacts_file' => { 'filename' => 'ci_build_artifacts.zip', 'size' => 107464 } }) - end - end - - context 'when explicit dependencies are defined' do - let!(:job) { create(:ci_build, :tag, pipeline: pipeline, name: 'spinach', stage: 'test', stage_idx: 0) } - let!(:job2) { create(:ci_build, :tag, pipeline: pipeline, name: 'rubocop', stage: 'test', stage_idx: 0) } - let!(:test_job) do - create(:ci_build, pipeline: pipeline, token: 'test-job-token', name: 'deploy', - stage: 'deploy', stage_idx: 1, - options: { script: ['bash'], dependencies: [job2.name] }) - end - - before do - job.success - job2.success - end - - it 'returns dependent jobs' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['id']).to eq(test_job.id) - expect(json_response['dependencies'].count).to eq(1) - expect(json_response['dependencies'][0]).to include('id' => job2.id, 'name' => job2.name, 'token' => job2.token) - end - end - - context 'when dependencies is an empty array' do - let!(:job) { create(:ci_build, :tag, pipeline: pipeline, name: 'spinach', stage: 'test', stage_idx: 0) } - let!(:job2) { create(:ci_build, :tag, pipeline: pipeline, name: 'rubocop', stage: 'test', stage_idx: 0) } - let!(:empty_dependencies_job) do - create(:ci_build, pipeline: pipeline, token: 'test-job-token', name: 'empty_dependencies_job', - stage: 'deploy', stage_idx: 1, - options: { script: ['bash'], dependencies: [] }) - end - - before do - job.success - job2.success - end - - it 'returns an empty array' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['id']).to eq(empty_dependencies_job.id) - expect(json_response['dependencies'].count).to eq(0) - end - end - - context 'when job has no tags' do - before do - job.update(tags: []) - end - - context 'when runner is allowed to pick untagged jobs' do - before do - runner.update_column(:run_untagged, true) - end - - it 'picks job' do - request_job - - expect(response).to have_gitlab_http_status(:created) - end - end - - context 'when runner is not allowed to pick untagged jobs' do - before do - runner.update_column(:run_untagged, false) - end - - it_behaves_like 'no jobs available' - end - end - - context 'when triggered job is available' do - let(:expected_variables) do - [{ 'key' => 'CI_JOB_NAME', 'value' => 'spinach', 'public' => true, 'masked' => false }, - { 'key' => 'CI_JOB_STAGE', 'value' => 'test', 'public' => true, 'masked' => false }, - { 'key' => 'CI_PIPELINE_TRIGGERED', 'value' => 'true', 'public' => true, 'masked' => false }, - { 'key' => 'DB_NAME', 'value' => 'postgres', 'public' => true, 'masked' => false }, - { 'key' => 'SECRET_KEY', 'value' => 'secret_value', 'public' => false, 'masked' => false }, - { 'key' => 'TRIGGER_KEY_1', 'value' => 'TRIGGER_VALUE_1', 'public' => false, 'masked' => false }] - end - - let(:trigger) { create(:ci_trigger, project: project) } - let!(:trigger_request) { create(:ci_trigger_request, pipeline: pipeline, builds: [job], trigger: trigger) } - - before do - project.variables << Ci::Variable.new(key: 'SECRET_KEY', value: 'secret_value') - end - - shared_examples 'expected variables behavior' do - it 'returns variables for triggers' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['variables']).to include(*expected_variables) - end - end - - context 'when variables are stored in trigger_request' do - before do - trigger_request.update_attribute(:variables, { TRIGGER_KEY_1: 'TRIGGER_VALUE_1' } ) - end - - it_behaves_like 'expected variables behavior' - end - - context 'when variables are stored in pipeline_variables' do - before do - create(:ci_pipeline_variable, pipeline: pipeline, key: :TRIGGER_KEY_1, value: 'TRIGGER_VALUE_1') - end - - it_behaves_like 'expected variables behavior' - end - end - - describe 'registry credentials support' do - let(:registry_url) { 'registry.example.com:5005' } - let(:registry_credentials) do - { 'type' => 'registry', - 'url' => registry_url, - 'username' => 'gitlab-ci-token', - 'password' => job.token } - end - - context 'when registry is enabled' do - before do - stub_container_registry_config(enabled: true, host_port: registry_url) - end - - it 'sends registry credentials key' do - request_job - - expect(json_response).to have_key('credentials') - expect(json_response['credentials']).to include(registry_credentials) - end - end - - context 'when registry is disabled' do - before do - stub_container_registry_config(enabled: false, host_port: registry_url) - end - - it 'does not send registry credentials' do - request_job - - expect(json_response).to have_key('credentials') - expect(json_response['credentials']).not_to include(registry_credentials) - end - end - end - - describe 'timeout support' do - context 'when project specifies job timeout' do - let(:project) { create(:project, shared_runners_enabled: false, build_timeout: 1234) } - - it 'contains info about timeout taken from project' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['runner_info']).to include({ 'timeout' => 1234 }) - end - - context 'when runner specifies lower timeout' do - let(:runner) { create(:ci_runner, :project, maximum_timeout: 1000, projects: [project]) } - - it 'contains info about timeout overridden by runner' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['runner_info']).to include({ 'timeout' => 1000 }) - end - end - - context 'when runner specifies bigger timeout' do - let(:runner) { create(:ci_runner, :project, maximum_timeout: 2000, projects: [project]) } - - it 'contains info about timeout not overridden by runner' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response['runner_info']).to include({ 'timeout' => 1234 }) - end - end - end - end - end - - describe 'port support' do - let(:job) { create(:ci_build, pipeline: pipeline, options: options) } - - context 'when job image has ports' do - let(:options) do - { - image: { - name: 'ruby', - ports: [80] - }, - services: ['mysql'] - } - end - - it 'returns the image ports' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response).to include( - 'id' => job.id, - 'image' => a_hash_including('name' => 'ruby', 'ports' => [{ 'number' => 80, 'protocol' => 'http', 'name' => 'default_port' }]), - 'services' => all(a_hash_including('name' => 'mysql'))) - end - end - - context 'when job services settings has ports' do - let(:options) do - { - image: 'ruby', - services: [ - { - name: 'tomcat', - ports: [{ number: 8081, protocol: 'http', name: 'custom_port' }] - } - ] - } - end - - it 'returns the service ports' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response).to include( - 'id' => job.id, - 'image' => a_hash_including('name' => 'ruby'), - 'services' => all(a_hash_including('name' => 'tomcat', 'ports' => [{ 'number' => 8081, 'protocol' => 'http', 'name' => 'custom_port' }]))) - end - end - end - - describe 'a job with excluded artifacts' do - context 'when excluded paths are defined' do - let(:job) do - create(:ci_build, pipeline: pipeline, token: 'test-job-token', name: 'test', - stage: 'deploy', stage_idx: 1, - options: { artifacts: { paths: ['abc'], exclude: ['cde'] } }) - end - - context 'when a runner supports this feature' do - it 'exposes excluded paths when the feature is enabled' do - stub_feature_flags(ci_artifacts_exclude: true) - - request_job info: { features: { artifacts_exclude: true } } - - expect(response).to have_gitlab_http_status(:created) - expect(json_response.dig('artifacts').first).to include('exclude' => ['cde']) - end - - it 'does not expose excluded paths when the feature is disabled' do - stub_feature_flags(ci_artifacts_exclude: false) - - request_job info: { features: { artifacts_exclude: true } } - - expect(response).to have_gitlab_http_status(:created) - expect(json_response.dig('artifacts').first).not_to have_key('exclude') - end - end - - context 'when a runner does not support this feature' do - it 'does not expose the build at all' do - stub_feature_flags(ci_artifacts_exclude: true) - - request_job - - expect(response).to have_gitlab_http_status(:no_content) - end - end - end - - it 'does not expose excluded paths when these are empty' do - request_job - - expect(response).to have_gitlab_http_status(:created) - expect(json_response.dig('artifacts').first).not_to have_key('exclude') - end - end - - def request_job(token = runner.token, **params) - new_params = params.merge(token: token, last_update: last_update) - post api('/jobs/request'), params: new_params, headers: { 'User-Agent' => user_agent } - end - end - - context 'for web-ide job' do - let_it_be(:user) { create(:user) } - let_it_be(:project) { create(:project, :repository) } - - let(:runner) { create(:ci_runner, :project, projects: [project]) } - let(:service) { Ci::CreateWebIdeTerminalService.new(project, user, ref: 'master').execute } - let(:pipeline) { service[:pipeline] } - let(:build) { pipeline.builds.first } - let(:job) { {} } - let(:config_content) do - 'terminal: { image: ruby, services: [mysql], before_script: [ls], tags: [tag-1], variables: { KEY: value } }' - end - - before do - stub_webide_config_file(config_content) - project.add_maintainer(user) - - pipeline - end - - context 'when runner has matching tag' do - before do - runner.update!(tag_list: ['tag-1']) - end - - it 'successfully picks job' do - request_job - - build.reload - - expect(build).to be_running - expect(build.runner).to eq(runner) - - expect(response).to have_gitlab_http_status(:created) - expect(json_response).to include( - "id" => build.id, - "variables" => include("key" => 'KEY', "value" => 'value', "public" => true, "masked" => false), - "image" => a_hash_including("name" => 'ruby'), - "services" => all(a_hash_including("name" => 'mysql')), - "job_info" => a_hash_including("name" => 'terminal', "stage" => 'terminal')) - end - end - - context 'when runner does not have matching tags' do - it 'does not pick a job' do - request_job - - build.reload - - expect(build).to be_pending - expect(response).to have_gitlab_http_status(:no_content) - end - end - - def request_job(token = runner.token, **params) - post api('/jobs/request'), params: params.merge(token: token) - end - end - end - - describe 'PUT /api/v4/jobs/:id' do - let(:job) do - create(:ci_build, :pending, :trace_live, pipeline: pipeline, project: project, user: user, runner_id: runner.id) - end - - before do - job.run! - end - - it_behaves_like 'application context metadata', '/api/:version/jobs/:id' do - let(:send_request) { update_job(state: 'success') } - end - - it 'updates runner info' do - expect { update_job(state: 'success') }.to change { runner.reload.contacted_at } - end - - context 'when status is given' do - it 'mark job as succeeded' do - update_job(state: 'success') - - job.reload - expect(job).to be_success - end - - it 'mark job as failed' do - update_job(state: 'failed') - - job.reload - expect(job).to be_failed - expect(job).to be_unknown_failure - end - - context 'when failure_reason is script_failure' do - before do - update_job(state: 'failed', failure_reason: 'script_failure') - job.reload - end - - it { expect(job).to be_script_failure } - end - - context 'when failure_reason is runner_system_failure' do - before do - update_job(state: 'failed', failure_reason: 'runner_system_failure') - job.reload - end - - it { expect(job).to be_runner_system_failure } - end - - context 'when failure_reason is unrecognized value' do - before do - update_job(state: 'failed', failure_reason: 'what_is_this') - job.reload - end - - it { expect(job).to be_unknown_failure } - end - - context 'when failure_reason is job_execution_timeout' do - before do - update_job(state: 'failed', failure_reason: 'job_execution_timeout') - job.reload - end - - it { expect(job).to be_job_execution_timeout } - end - - context 'when failure_reason is unmet_prerequisites' do - before do - update_job(state: 'failed', failure_reason: 'unmet_prerequisites') - job.reload - end - - it { expect(job).to be_unmet_prerequisites } - end - end - - context 'when trace is given' do - it 'creates a trace artifact' do - allow(BuildFinishedWorker).to receive(:perform_async).with(job.id) do - ArchiveTraceWorker.new.perform(job.id) - end - - update_job(state: 'success', trace: 'BUILD TRACE UPDATED') - - job.reload - expect(response).to have_gitlab_http_status(:ok) - expect(job.trace.raw).to eq 'BUILD TRACE UPDATED' - expect(job.job_artifacts_trace.open.read).to eq 'BUILD TRACE UPDATED' - end - - context 'when concurrent update of trace is happening' do - before do - job.trace.write('wb') do - update_job(state: 'success', trace: 'BUILD TRACE UPDATED') - end - end - - it 'returns that operation conflicts' do - expect(response).to have_gitlab_http_status(:conflict) - end - end - end - - context 'when no trace is given' do - it 'does not override trace information' do - update_job - - expect(job.reload.trace.raw).to eq 'BUILD TRACE' - end - - context 'when running state is sent' do - it 'updates update_at value' do - expect { update_job_after_time }.to change { job.reload.updated_at } - end - end - - context 'when other state is sent' do - it "doesn't update update_at value" do - expect { update_job_after_time(20.minutes, state: 'success') }.not_to change { job.reload.updated_at } - end - end - end - - context 'when job has been erased' do - let(:job) { create(:ci_build, runner_id: runner.id, erased_at: Time.now) } - - it 'responds with forbidden' do - update_job - - expect(response).to have_gitlab_http_status(:forbidden) - end - end - - context 'when job has already been finished' do - before do - job.trace.set('Job failed') - job.drop!(:script_failure) - end - - it 'does not update job status and job trace' do - update_job(state: 'success', trace: 'BUILD TRACE UPDATED') - - job.reload - expect(response).to have_gitlab_http_status(:forbidden) - expect(response.header['Job-Status']).to eq 'failed' - expect(job.trace.raw).to eq 'Job failed' - expect(job).to be_failed - end - end - - def update_job(token = job.token, **params) - new_params = params.merge(token: token) - put api("/jobs/#{job.id}"), params: new_params - end - - def update_job_after_time(update_interval = 20.minutes, state = 'running') - Timecop.travel(job.updated_at + update_interval) do - update_job(job.token, state: state) - end - end - end - - describe 'PATCH /api/v4/jobs/:id/trace' do - let(:job) do - create(:ci_build, :running, :trace_live, - project: project, user: user, runner_id: runner.id, pipeline: pipeline) - end - let(:headers) { { API::Helpers::Runner::JOB_TOKEN_HEADER => job.token, 'Content-Type' => 'text/plain' } } - let(:headers_with_range) { headers.merge({ 'Content-Range' => '11-20' }) } - let(:update_interval) { 10.seconds.to_i } - - before do - initial_patch_the_trace - end - - it_behaves_like 'application context metadata', '/api/:version/jobs/:id/trace' do - let(:send_request) { patch_the_trace } - end - - it 'updates runner info' do - runner.update!(contacted_at: 1.year.ago) - - expect { patch_the_trace }.to change { runner.reload.contacted_at } - end - - context 'when request is valid' do - it 'gets correct response' do - expect(response).to have_gitlab_http_status(:accepted) - expect(job.reload.trace.raw).to eq 'BUILD TRACE appended' - expect(response.header).to have_key 'Range' - expect(response.header).to have_key 'Job-Status' - expect(response.header).to have_key 'X-GitLab-Trace-Update-Interval' - end - - context 'when job has been updated recently' do - it { expect { patch_the_trace }.not_to change { job.updated_at }} - - it "changes the job's trace" do - patch_the_trace - - expect(job.reload.trace.raw).to eq 'BUILD TRACE appended appended' - end - - context 'when Runner makes a force-patch' do - it { expect { force_patch_the_trace }.not_to change { job.updated_at }} - - it "doesn't change the build.trace" do - force_patch_the_trace - - expect(job.reload.trace.raw).to eq 'BUILD TRACE appended' - end - end - end - - context 'when job was not updated recently' do - let(:update_interval) { 15.minutes.to_i } - - it { expect { patch_the_trace }.to change { job.updated_at } } - - it 'changes the job.trace' do - patch_the_trace - - expect(job.reload.trace.raw).to eq 'BUILD TRACE appended appended' - end - - context 'when Runner makes a force-patch' do - it { expect { force_patch_the_trace }.to change { job.updated_at } } - - it "doesn't change the job.trace" do - force_patch_the_trace - - expect(job.reload.trace.raw).to eq 'BUILD TRACE appended' - end - end - end - - context 'when project for the build has been deleted' do - let(:job) do - create(:ci_build, :running, :trace_live, runner_id: runner.id, pipeline: pipeline) do |job| - job.project.update(pending_delete: true) - end - end - - it 'responds with forbidden' do - expect(response).to have_gitlab_http_status(:forbidden) - end - end - - context 'when trace is patched' do - before do - patch_the_trace - end - - it 'has valid trace' do - expect(response).to have_gitlab_http_status(:accepted) - expect(job.reload.trace.raw).to eq 'BUILD TRACE appended appended' - end - - context 'when job is cancelled' do - before do - job.cancel - end - - context 'when trace is patched' do - before do - patch_the_trace - end - - it 'returns Forbidden ' do - expect(response).to have_gitlab_http_status(:forbidden) - end - end - end - - context 'when redis data are flushed' do - before do - redis_shared_state_cleanup! - end - - it 'has empty trace' do - expect(job.reload.trace.raw).to eq '' - end - - context 'when we perform partial patch' do - before do - patch_the_trace('hello', headers.merge({ 'Content-Range' => "28-32/5" })) - end - - it 'returns an error' do - expect(response).to have_gitlab_http_status(:range_not_satisfiable) - expect(response.header['Range']).to eq('0-0') - end - end - - context 'when we resend full trace' do - before do - patch_the_trace('BUILD TRACE appended appended hello', headers.merge({ 'Content-Range' => "0-34/35" })) - end - - it 'succeeds with updating trace' do - expect(response).to have_gitlab_http_status(:accepted) - expect(job.reload.trace.raw).to eq 'BUILD TRACE appended appended hello' - end - end - end - end - - context 'when concurrent update of trace is happening' do - before do - job.trace.write('wb') do - patch_the_trace - end - end - - it 'returns that operation conflicts' do - expect(response).to have_gitlab_http_status(:conflict) - end - end - - context 'when the job is canceled' do - before do - job.cancel - patch_the_trace - end - - it 'receives status in header' do - expect(response.header['Job-Status']).to eq 'canceled' - end - end - - context 'when build trace is being watched' do - before do - job.trace.being_watched! - end - - it 'returns X-GitLab-Trace-Update-Interval as 3' do - patch_the_trace - - expect(response).to have_gitlab_http_status(:accepted) - expect(response.header['X-GitLab-Trace-Update-Interval']).to eq('3') - end - end - - context 'when build trace is not being watched' do - it 'returns X-GitLab-Trace-Update-Interval as 30' do - patch_the_trace - - expect(response).to have_gitlab_http_status(:accepted) - expect(response.header['X-GitLab-Trace-Update-Interval']).to eq('30') - end - end - end - - context 'when Runner makes a force-patch' do - before do - force_patch_the_trace - end - - it 'gets correct response' do - expect(response).to have_gitlab_http_status(:accepted) - expect(job.reload.trace.raw).to eq 'BUILD TRACE appended' - expect(response.header).to have_key 'Range' - expect(response.header).to have_key 'Job-Status' - end - end - - context 'when content-range start is too big' do - let(:headers_with_range) { headers.merge({ 'Content-Range' => '15-20/6' }) } - - it 'gets 416 error response with range headers' do - expect(response).to have_gitlab_http_status(:range_not_satisfiable) - expect(response.header).to have_key 'Range' - expect(response.header['Range']).to eq '0-11' - end - end - - context 'when content-range start is too small' do - let(:headers_with_range) { headers.merge({ 'Content-Range' => '8-20/13' }) } - - it 'gets 416 error response with range headers' do - expect(response).to have_gitlab_http_status(:range_not_satisfiable) - expect(response.header).to have_key 'Range' - expect(response.header['Range']).to eq '0-11' - end - end - - context 'when Content-Range header is missing' do - let(:headers_with_range) { headers } - - it { expect(response).to have_gitlab_http_status(:bad_request) } - end - - context 'when job has been errased' do - let(:job) { create(:ci_build, runner_id: runner.id, erased_at: Time.now) } - - it { expect(response).to have_gitlab_http_status(:forbidden) } - end - - def patch_the_trace(content = ' appended', request_headers = nil) - unless request_headers - job.trace.read do |stream| - offset = stream.size - limit = offset + content.length - 1 - request_headers = headers.merge({ 'Content-Range' => "#{offset}-#{limit}" }) - end - end - - Timecop.travel(job.updated_at + update_interval) do - patch api("/jobs/#{job.id}/trace"), params: content, headers: request_headers - job.reload - end - end - - def initial_patch_the_trace - patch_the_trace(' appended', headers_with_range) - end - - def force_patch_the_trace - 2.times { patch_the_trace('') } - end - end - - describe 'artifacts' do - let(:job) { create(:ci_build, :pending, user: user, project: project, pipeline: pipeline, runner_id: runner.id) } - let(:jwt) { JWT.encode({ 'iss' => 'gitlab-workhorse' }, Gitlab::Workhorse.secret, 'HS256') } - let(:headers) { { 'GitLab-Workhorse' => '1.0', Gitlab::Workhorse::INTERNAL_API_REQUEST_HEADER => jwt } } - let(:headers_with_token) { headers.merge(API::Helpers::Runner::JOB_TOKEN_HEADER => job.token) } - let(:file_upload) { fixture_file_upload('spec/fixtures/banana_sample.gif', 'image/gif') } - let(:file_upload2) { fixture_file_upload('spec/fixtures/dk.png', 'image/gif') } - - before do - stub_artifacts_object_storage - job.run! - end - - describe 'POST /api/v4/jobs/:id/artifacts/authorize' do - context 'when using token as parameter' do - context 'posting artifacts to running job' do - subject do - authorize_artifacts_with_token_in_params - end - - it_behaves_like 'application context metadata', '/api/:version/jobs/:id/artifacts/authorize' do - let(:send_request) { subject } - end - - it 'updates runner info' do - expect { subject }.to change { runner.reload.contacted_at } - end - - shared_examples 'authorizes local file' do - it 'succeeds' do - subject - - expect(response).to have_gitlab_http_status(:ok) - expect(response.media_type).to eq(Gitlab::Workhorse::INTERNAL_API_CONTENT_TYPE) - expect(json_response['TempPath']).to eq(JobArtifactUploader.workhorse_local_upload_path) - expect(json_response['RemoteObject']).to be_nil - end - end - - context 'when using local storage' do - it_behaves_like 'authorizes local file' - end - - context 'when using remote storage' do - context 'when direct upload is enabled' do - before do - stub_artifacts_object_storage(enabled: true, direct_upload: true) - end - - it 'succeeds' do - subject - - expect(response).to have_gitlab_http_status(:ok) - expect(response.media_type).to eq(Gitlab::Workhorse::INTERNAL_API_CONTENT_TYPE) - expect(json_response).not_to have_key('TempPath') - expect(json_response['RemoteObject']).to have_key('ID') - expect(json_response['RemoteObject']).to have_key('GetURL') - expect(json_response['RemoteObject']).to have_key('StoreURL') - expect(json_response['RemoteObject']).to have_key('DeleteURL') - expect(json_response['RemoteObject']).to have_key('MultipartUpload') - end - end - - context 'when direct upload is disabled' do - before do - stub_artifacts_object_storage(enabled: true, direct_upload: false) - end - - it_behaves_like 'authorizes local file' - end - end - end - - context 'when artifact is too large' do - let(:sample_max_size) { 100 } - - shared_examples_for 'rejecting too large artifacts' do - it 'fails to post' do - authorize_artifacts_with_token_in_params(filesize: sample_max_size.megabytes.to_i) - - expect(response).to have_gitlab_http_status(:payload_too_large) - end - end - - context 'based on application setting' do - before do - stub_application_setting(max_artifacts_size: sample_max_size) - end - - it_behaves_like 'rejecting too large artifacts' - end - - context 'based on root namespace setting' do - before do - stub_application_setting(max_artifacts_size: 200) - root_namespace.update!(max_artifacts_size: sample_max_size) - end - - it_behaves_like 'rejecting too large artifacts' - end - - context 'based on child namespace setting' do - before do - stub_application_setting(max_artifacts_size: 200) - root_namespace.update!(max_artifacts_size: 200) - namespace.update!(max_artifacts_size: sample_max_size) - end - - it_behaves_like 'rejecting too large artifacts' - end - - context 'based on project setting' do - before do - stub_application_setting(max_artifacts_size: 200) - root_namespace.update!(max_artifacts_size: 200) - namespace.update!(max_artifacts_size: 200) - project.update!(max_artifacts_size: sample_max_size) - end - - it_behaves_like 'rejecting too large artifacts' - end - end - end - - context 'when using token as header' do - it 'authorizes posting artifacts to running job' do - authorize_artifacts_with_token_in_headers - - expect(response).to have_gitlab_http_status(:ok) - expect(response.media_type).to eq(Gitlab::Workhorse::INTERNAL_API_CONTENT_TYPE) - expect(json_response['TempPath']).not_to be_nil - end - - it 'fails to post too large artifact' do - stub_application_setting(max_artifacts_size: 0) - - authorize_artifacts_with_token_in_headers(filesize: 100) - - expect(response).to have_gitlab_http_status(:payload_too_large) - end - end - - context 'when using runners token' do - it 'fails to authorize artifacts posting' do - authorize_artifacts(token: job.project.runners_token) - - expect(response).to have_gitlab_http_status(:forbidden) - end - end - - it 'reject requests that did not go through gitlab-workhorse' do - headers.delete(Gitlab::Workhorse::INTERNAL_API_REQUEST_HEADER) - - authorize_artifacts - - expect(response).to have_gitlab_http_status(:forbidden) - end - - context 'authorization token is invalid' do - it 'responds with forbidden' do - authorize_artifacts(token: 'invalid', filesize: 100 ) - - expect(response).to have_gitlab_http_status(:forbidden) - end - end - - context 'authorize uploading of an lsif artifact' do - before do - stub_feature_flags(code_navigation: job.project) - end - - it 'adds ProcessLsif header' do - authorize_artifacts_with_token_in_headers(artifact_type: :lsif) - - expect(response).to have_gitlab_http_status(:ok) - expect(json_response['ProcessLsif']).to be_truthy - end - - it 'fails to authorize too large artifact' do - authorize_artifacts_with_token_in_headers(artifact_type: :lsif, filesize: 30.megabytes) - - expect(response).to have_gitlab_http_status(:payload_too_large) - end - - context 'code_navigation feature flag is disabled' do - it 'does not add ProcessLsif header' do - stub_feature_flags(code_navigation: false) - - authorize_artifacts_with_token_in_headers(artifact_type: :lsif) - - expect(response).to have_gitlab_http_status(:forbidden) - end - end - end - - def authorize_artifacts(params = {}, request_headers = headers) - post api("/jobs/#{job.id}/artifacts/authorize"), params: params, headers: request_headers - end - - def authorize_artifacts_with_token_in_params(params = {}, request_headers = headers) - params = params.merge(token: job.token) - authorize_artifacts(params, request_headers) - end - - def authorize_artifacts_with_token_in_headers(params = {}, request_headers = headers_with_token) - authorize_artifacts(params, request_headers) - end - end - - describe 'POST /api/v4/jobs/:id/artifacts' do - it_behaves_like 'application context metadata', '/api/:version/jobs/:id/artifacts' do - let(:send_request) do - upload_artifacts(file_upload, headers_with_token) - end - end - - it 'updates runner info' do - expect { upload_artifacts(file_upload, headers_with_token) }.to change { runner.reload.contacted_at } - end - - context 'when artifacts are being stored inside of tmp path' do - before do - # by configuring this path we allow to pass temp file from any path - allow(JobArtifactUploader).to receive(:workhorse_upload_path).and_return('/') - end - - context 'when job has been erased' do - let(:job) { create(:ci_build, erased_at: Time.now) } - - before do - upload_artifacts(file_upload, headers_with_token) - end - - it 'responds with forbidden' do - upload_artifacts(file_upload, headers_with_token) - - expect(response).to have_gitlab_http_status(:forbidden) - end - end - - context 'when job is running' do - shared_examples 'successful artifacts upload' do - it 'updates successfully' do - expect(response).to have_gitlab_http_status(:created) - end - end - - context 'when uses accelerated file post' do - context 'for file stored locally' do - before do - upload_artifacts(file_upload, headers_with_token) - end - - it_behaves_like 'successful artifacts upload' - end - - context 'for file stored remotely' do - let!(:fog_connection) do - stub_artifacts_object_storage(direct_upload: true) - end - let(:object) do - fog_connection.directories.new(key: 'artifacts').files.create( - key: 'tmp/uploads/12312300', - body: 'content' - ) - end - let(:file_upload) { fog_to_uploaded_file(object) } - - before do - upload_artifacts(file_upload, headers_with_token, 'file.remote_id' => remote_id) - end - - context 'when valid remote_id is used' do - let(:remote_id) { '12312300' } - - it_behaves_like 'successful artifacts upload' - end - - context 'when invalid remote_id is used' do - let(:remote_id) { 'invalid id' } - - it 'responds with bad request' do - expect(response).to have_gitlab_http_status(:internal_server_error) - expect(json_response['message']).to eq("Missing file") - end - end - end - end - - context 'when using runners token' do - it 'responds with forbidden' do - upload_artifacts(file_upload, headers.merge(API::Helpers::Runner::JOB_TOKEN_HEADER => job.project.runners_token)) - - expect(response).to have_gitlab_http_status(:forbidden) - end - end - end - - context 'when artifacts file is too large' do - it 'fails to post too large artifact' do - stub_application_setting(max_artifacts_size: 0) - - upload_artifacts(file_upload, headers_with_token) - - expect(response).to have_gitlab_http_status(:payload_too_large) - end - end - - context 'when artifacts post request does not contain file' do - it 'fails to post artifacts without file' do - post api("/jobs/#{job.id}/artifacts"), params: {}, headers: headers_with_token - - expect(response).to have_gitlab_http_status(:bad_request) - end - end - - context 'GitLab Workhorse is not configured' do - it 'fails to post artifacts without GitLab-Workhorse' do - post api("/jobs/#{job.id}/artifacts"), params: { token: job.token }, headers: {} - - expect(response).to have_gitlab_http_status(:bad_request) - end - end - - context 'Is missing GitLab Workhorse token headers' do - let(:jwt) { JWT.encode({ 'iss' => 'invalid-header' }, Gitlab::Workhorse.secret, 'HS256') } - - it 'fails to post artifacts without GitLab-Workhorse' do - expect(Gitlab::ErrorTracking).to receive(:track_exception).once - - upload_artifacts(file_upload, headers_with_token) - - expect(response).to have_gitlab_http_status(:forbidden) - end - end - - context 'when setting an expire date' do - let(:default_artifacts_expire_in) {} - let(:post_data) do - { file: file_upload, - expire_in: expire_in } - end - - before do - stub_application_setting(default_artifacts_expire_in: default_artifacts_expire_in) - - upload_artifacts(file_upload, headers_with_token, post_data) - end - - context 'when an expire_in is given' do - let(:expire_in) { '7 days' } - - it 'updates when specified' do - expect(response).to have_gitlab_http_status(:created) - expect(job.reload.artifacts_expire_at).to be_within(5.minutes).of(7.days.from_now) - end - end - - context 'when no expire_in is given' do - let(:expire_in) { nil } - - it 'ignores if not specified' do - expect(response).to have_gitlab_http_status(:created) - expect(job.reload.artifacts_expire_at).to be_nil - end - - context 'with application default' do - context 'when default is 5 days' do - let(:default_artifacts_expire_in) { '5 days' } - - it 'sets to application default' do - expect(response).to have_gitlab_http_status(:created) - expect(job.reload.artifacts_expire_at).to be_within(5.minutes).of(5.days.from_now) - end - end - - context 'when default is 0' do - let(:default_artifacts_expire_in) { '0' } - - it 'does not set expire_in' do - expect(response).to have_gitlab_http_status(:created) - expect(job.reload.artifacts_expire_at).to be_nil - end - end - end - end - end - - context 'posts artifacts file and metadata file' do - let!(:artifacts) { file_upload } - let!(:artifacts_sha256) { Digest::SHA256.file(artifacts.path).hexdigest } - let!(:metadata) { file_upload2 } - let!(:metadata_sha256) { Digest::SHA256.file(metadata.path).hexdigest } - - let(:stored_artifacts_file) { job.reload.artifacts_file } - let(:stored_metadata_file) { job.reload.artifacts_metadata } - let(:stored_artifacts_size) { job.reload.artifacts_size } - let(:stored_artifacts_sha256) { job.reload.job_artifacts_archive.file_sha256 } - let(:stored_metadata_sha256) { job.reload.job_artifacts_metadata.file_sha256 } - let(:file_keys) { post_data.keys } - let(:send_rewritten_field) { true } - - before do - workhorse_finalize_with_multiple_files( - api("/jobs/#{job.id}/artifacts"), - method: :post, - file_keys: file_keys, - params: post_data, - headers: headers_with_token, - send_rewritten_field: send_rewritten_field - ) - end - - context 'when posts data accelerated by workhorse is correct' do - let(:post_data) { { file: artifacts, metadata: metadata } } - - it 'stores artifacts and artifacts metadata' do - expect(response).to have_gitlab_http_status(:created) - expect(stored_artifacts_file.filename).to eq(artifacts.original_filename) - expect(stored_metadata_file.filename).to eq(metadata.original_filename) - expect(stored_artifacts_size).to eq(artifacts.size) - expect(stored_artifacts_sha256).to eq(artifacts_sha256) - expect(stored_metadata_sha256).to eq(metadata_sha256) - end - end - - context 'with a malicious file.path param' do - let(:post_data) { {} } - let(:tmp_file) { Tempfile.new('crafted.file.path') } - let(:url) { "/jobs/#{job.id}/artifacts?file.path=#{tmp_file.path}" } - - it 'rejects the request' do - expect(response).to have_gitlab_http_status(:bad_request) - expect(stored_artifacts_size).to be_nil - end - end - - context 'when workhorse header is missing' do - let(:post_data) { { file: artifacts, metadata: metadata } } - let(:send_rewritten_field) { false } - - it 'rejects the request' do - expect(response).to have_gitlab_http_status(:bad_request) - expect(stored_artifacts_size).to be_nil - end - end - - context 'when there is no artifacts file in post data' do - let(:post_data) do - { metadata: metadata } - end - - it 'is expected to respond with bad request' do - expect(response).to have_gitlab_http_status(:bad_request) - end - - it 'does not store metadata' do - expect(stored_metadata_file).to be_nil - end - end - end - - context 'when artifact_type is archive' do - context 'when artifact_format is zip' do - let(:params) { { artifact_type: :archive, artifact_format: :zip } } - - it 'stores junit test report' do - upload_artifacts(file_upload, headers_with_token, params) - - expect(response).to have_gitlab_http_status(:created) - expect(job.reload.job_artifacts_archive).not_to be_nil - end - end - - context 'when artifact_format is gzip' do - let(:params) { { artifact_type: :archive, artifact_format: :gzip } } - - it 'returns an error' do - upload_artifacts(file_upload, headers_with_token, params) - - expect(response).to have_gitlab_http_status(:bad_request) - expect(job.reload.job_artifacts_archive).to be_nil - end - end - end - - context 'when artifact_type is junit' do - context 'when artifact_format is gzip' do - let(:file_upload) { fixture_file_upload('spec/fixtures/junit/junit.xml.gz') } - let(:params) { { artifact_type: :junit, artifact_format: :gzip } } - - it 'stores junit test report' do - upload_artifacts(file_upload, headers_with_token, params) - - expect(response).to have_gitlab_http_status(:created) - expect(job.reload.job_artifacts_junit).not_to be_nil - end - end - - context 'when artifact_format is raw' do - let(:file_upload) { fixture_file_upload('spec/fixtures/junit/junit.xml.gz') } - let(:params) { { artifact_type: :junit, artifact_format: :raw } } - - it 'returns an error' do - upload_artifacts(file_upload, headers_with_token, params) - - expect(response).to have_gitlab_http_status(:bad_request) - expect(job.reload.job_artifacts_junit).to be_nil - end - end - end - - context 'when artifact_type is metrics_referee' do - context 'when artifact_format is gzip' do - let(:file_upload) { fixture_file_upload('spec/fixtures/referees/metrics_referee.json.gz') } - let(:params) { { artifact_type: :metrics_referee, artifact_format: :gzip } } - - it 'stores metrics_referee data' do - upload_artifacts(file_upload, headers_with_token, params) - - expect(response).to have_gitlab_http_status(:created) - expect(job.reload.job_artifacts_metrics_referee).not_to be_nil - end - end - - context 'when artifact_format is raw' do - let(:file_upload) { fixture_file_upload('spec/fixtures/referees/metrics_referee.json.gz') } - let(:params) { { artifact_type: :metrics_referee, artifact_format: :raw } } - - it 'returns an error' do - upload_artifacts(file_upload, headers_with_token, params) - - expect(response).to have_gitlab_http_status(:bad_request) - expect(job.reload.job_artifacts_metrics_referee).to be_nil - end - end - end - - context 'when artifact_type is network_referee' do - context 'when artifact_format is gzip' do - let(:file_upload) { fixture_file_upload('spec/fixtures/referees/network_referee.json.gz') } - let(:params) { { artifact_type: :network_referee, artifact_format: :gzip } } - - it 'stores network_referee data' do - upload_artifacts(file_upload, headers_with_token, params) - - expect(response).to have_gitlab_http_status(:created) - expect(job.reload.job_artifacts_network_referee).not_to be_nil - end - end - - context 'when artifact_format is raw' do - let(:file_upload) { fixture_file_upload('spec/fixtures/referees/network_referee.json.gz') } - let(:params) { { artifact_type: :network_referee, artifact_format: :raw } } - - it 'returns an error' do - upload_artifacts(file_upload, headers_with_token, params) - - expect(response).to have_gitlab_http_status(:bad_request) - expect(job.reload.job_artifacts_network_referee).to be_nil - end - end - end - - context 'when artifact_type is dotenv' do - context 'when artifact_format is gzip' do - let(:file_upload) { fixture_file_upload('spec/fixtures/build.env.gz') } - let(:params) { { artifact_type: :dotenv, artifact_format: :gzip } } - - it 'stores dotenv file' do - upload_artifacts(file_upload, headers_with_token, params) - - expect(response).to have_gitlab_http_status(:created) - expect(job.reload.job_artifacts_dotenv).not_to be_nil - end - - it 'parses dotenv file' do - expect do - upload_artifacts(file_upload, headers_with_token, params) - end.to change { job.job_variables.count }.from(0).to(2) - end - - context 'when parse error happens' do - let(:file_upload) { fixture_file_upload('spec/fixtures/ci_build_artifacts_metadata.gz') } - - it 'returns an error' do - upload_artifacts(file_upload, headers_with_token, params) - - expect(response).to have_gitlab_http_status(:bad_request) - expect(json_response['message']).to eq('Invalid Format') - end - end - end - - context 'when artifact_format is raw' do - let(:file_upload) { fixture_file_upload('spec/fixtures/build.env.gz') } - let(:params) { { artifact_type: :dotenv, artifact_format: :raw } } - - it 'returns an error' do - upload_artifacts(file_upload, headers_with_token, params) - - expect(response).to have_gitlab_http_status(:bad_request) - expect(job.reload.job_artifacts_dotenv).to be_nil - end - end - end - end - - context 'when artifacts already exist for the job' do - let(:params) do - { - artifact_type: :archive, - artifact_format: :zip, - 'file.sha256' => uploaded_sha256 - } - end - - let(:existing_sha256) { '0' * 64 } - - let!(:existing_artifact) do - create(:ci_job_artifact, :archive, file_sha256: existing_sha256, job: job) - end - - context 'when sha256 is the same of the existing artifact' do - let(:uploaded_sha256) { existing_sha256 } - - it 'ignores the new artifact' do - upload_artifacts(file_upload, headers_with_token, params) - - expect(response).to have_gitlab_http_status(:created) - expect(job.reload.job_artifacts_archive).to eq(existing_artifact) - end - end - - context 'when sha256 is different than the existing artifact' do - let(:uploaded_sha256) { '1' * 64 } - - it 'logs and returns an error' do - expect(Gitlab::ErrorTracking).to receive(:track_exception) - - upload_artifacts(file_upload, headers_with_token, params) - - expect(response).to have_gitlab_http_status(:bad_request) - expect(job.reload.job_artifacts_archive).to eq(existing_artifact) - end - end - end - - context 'when object storage throws errors' do - let(:params) { { artifact_type: :archive, artifact_format: :zip } } - - it 'does not store artifacts' do - allow_next_instance_of(JobArtifactUploader) do |uploader| - allow(uploader).to receive(:store!).and_raise(Errno::EIO) - end - - upload_artifacts(file_upload, headers_with_token, params) - - expect(response).to have_gitlab_http_status(:service_unavailable) - expect(job.reload.job_artifacts_archive).to be_nil - end - end - - context 'when artifacts are being stored outside of tmp path' do - let(:new_tmpdir) { Dir.mktmpdir } - - before do - # init before overwriting tmp dir - file_upload - - # by configuring this path we allow to pass file from @tmpdir only - # but all temporary files are stored in system tmp directory - allow(Dir).to receive(:tmpdir).and_return(new_tmpdir) - end - - after do - FileUtils.remove_entry(new_tmpdir) - end - - it' "fails to post artifacts for outside of tmp path"' do - upload_artifacts(file_upload, headers_with_token) - - expect(response).to have_gitlab_http_status(:bad_request) - end - end - - def upload_artifacts(file, headers = {}, params = {}) - workhorse_finalize( - api("/jobs/#{job.id}/artifacts"), - method: :post, - file_key: :file, - params: params.merge(file: file), - headers: headers, - send_rewritten_field: true - ) - end - end - - describe 'GET /api/v4/jobs/:id/artifacts' do - let(:token) { job.token } - - it_behaves_like 'application context metadata', '/api/:version/jobs/:id/artifacts' do - let(:send_request) { download_artifact } - end - - it 'updates runner info' do - expect { download_artifact }.to change { runner.reload.contacted_at } - end - - context 'when job has artifacts' do - let(:job) { create(:ci_build) } - let(:store) { JobArtifactUploader::Store::LOCAL } - - before do - create(:ci_job_artifact, :archive, file_store: store, job: job) - end - - context 'when using job token' do - context 'when artifacts are stored locally' do - let(:download_headers) do - { 'Content-Transfer-Encoding' => 'binary', - 'Content-Disposition' => %q(attachment; filename="ci_build_artifacts.zip"; filename*=UTF-8''ci_build_artifacts.zip) } - end - - before do - download_artifact - end - - it 'download artifacts' do - expect(response).to have_gitlab_http_status(:ok) - expect(response.headers.to_h).to include download_headers - end - end - - context 'when artifacts are stored remotely' do - let(:store) { JobArtifactUploader::Store::REMOTE } - let!(:job) { create(:ci_build) } - - context 'when proxy download is being used' do - before do - download_artifact(direct_download: false) - end - - it 'uses workhorse send-url' do - expect(response).to have_gitlab_http_status(:ok) - expect(response.headers.to_h).to include( - 'Gitlab-Workhorse-Send-Data' => /send-url:/) - end - end - - context 'when direct download is being used' do - before do - download_artifact(direct_download: true) - end - - it 'receive redirect for downloading artifacts' do - expect(response).to have_gitlab_http_status(:found) - expect(response.headers).to include('Location') - end - end - end - end - - context 'when using runnners token' do - let(:token) { job.project.runners_token } - - before do - download_artifact - end - - it 'responds with forbidden' do - expect(response).to have_gitlab_http_status(:forbidden) - end - end - end - - context 'when job does not have artifacts' do - it 'responds with not found' do - download_artifact - - expect(response).to have_gitlab_http_status(:not_found) - end - end - - def download_artifact(params = {}, request_headers = headers) - params = params.merge(token: token) - job.reload - - get api("/jobs/#{job.id}/artifacts"), params: params, headers: request_headers - end - end - end - end -end |