debian-mirror-gitlab/lib/api/runner.rb

321 lines
13 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2017-08-17 22:00:37 +05:30
module API
class Runner < Grape::API
helpers ::API::Helpers::Runner
resource :runners do
desc 'Registers a new Runner' do
success Entities::RunnerRegistrationDetails
http_codes [[201, 'Runner was created'], [403, 'Forbidden']]
end
params do
requires :token, type: String, desc: 'Registration token'
optional :description, type: String, desc: %q(Runner's description)
optional :info, type: Hash, desc: %q(Runner's metadata)
2018-11-08 19:23:39 +05:30
optional :active, type: Boolean, desc: 'Should Runner be active'
2017-08-17 22:00:37 +05:30
optional :locked, type: Boolean, desc: 'Should Runner be locked for current project'
2019-07-31 22:56:46 +05:30
optional :access_level, type: String, values: Ci::Runner.access_levels.keys,
desc: 'The access_level of the runner'
2017-08-17 22:00:37 +05:30
optional :run_untagged, type: Boolean, desc: 'Should Runner handle untagged jobs'
optional :tag_list, type: Array[String], desc: %q(List of Runner's tags)
2018-05-09 12:01:36 +05:30
optional :maximum_timeout, type: Integer, desc: 'Maximum timeout set when this Runner will handle the job'
2017-08-17 22:00:37 +05:30
end
post '/' do
2019-07-31 22:56:46 +05:30
attributes = attributes_for_keys([:description, :active, :locked, :run_untagged, :tag_list, :access_level, :maximum_timeout])
2018-03-27 19:54:05 +05:30
.merge(get_runner_details_from_request)
2017-08-17 22:00:37 +05:30
2018-11-08 19:23:39 +05:30
attributes =
2017-08-17 22:00:37 +05:30
if runner_registration_token_valid?
# Create shared runner. Requires admin access
2018-11-08 19:23:39 +05:30
attributes.merge(runner_type: :instance_type)
2019-02-15 15:39:39 +05:30
elsif project = Project.find_by_runners_token(params[:token])
2018-10-15 14:42:47 +05:30
# Create a specific runner for the project
2018-11-08 19:23:39 +05:30
attributes.merge(runner_type: :project_type, projects: [project])
2019-02-15 15:39:39 +05:30
elsif group = Group.find_by_runners_token(params[:token])
2018-10-15 14:42:47 +05:30
# Create a specific runner for the group
2018-11-08 19:23:39 +05:30
attributes.merge(runner_type: :group_type, groups: [group])
else
forbidden!
2017-08-17 22:00:37 +05:30
end
2018-11-08 19:23:39 +05:30
runner = Ci::Runner.create(attributes)
2017-08-17 22:00:37 +05:30
2018-11-08 19:23:39 +05:30
if runner.persisted?
2017-08-17 22:00:37 +05:30
present runner, with: Entities::RunnerRegistrationDetails
else
2018-11-08 19:23:39 +05:30
render_validation_error!(runner)
2017-08-17 22:00:37 +05:30
end
end
desc 'Deletes a registered Runner' do
http_codes [[204, 'Runner was deleted'], [403, 'Forbidden']]
end
params do
requires :token, type: String, desc: %q(Runner's authentication token)
end
delete '/' do
authenticate_runner!
2018-03-17 18:26:18 +05:30
runner = Ci::Runner.find_by_token(params[:token])
destroy_conditionally!(runner)
2017-08-17 22:00:37 +05:30
end
desc 'Validates authentication credentials' do
http_codes [[200, 'Credentials are valid'], [403, 'Forbidden']]
end
params do
requires :token, type: String, desc: %q(Runner's authentication token)
end
post '/verify' do
authenticate_runner!
status 200
end
end
resource :jobs do
desc 'Request a job' do
success Entities::JobRequest::Response
http_codes [[201, 'Job was scheduled'],
[204, 'No job for Runner'],
[403, 'Forbidden']]
end
params do
requires :token, type: String, desc: %q(Runner's authentication token)
optional :last_update, type: String, desc: %q(Runner's queue last_update token)
2018-11-18 11:00:15 +05:30
optional :info, type: Hash, desc: %q(Runner's metadata) do
optional :name, type: String, desc: %q(Runner's name)
optional :version, type: String, desc: %q(Runner's version)
optional :revision, type: String, desc: %q(Runner's revision)
optional :platform, type: String, desc: %q(Runner's platform)
optional :architecture, type: String, desc: %q(Runner's architecture)
optional :executor, type: String, desc: %q(Runner's executor)
optional :features, type: Hash, desc: %q(Runner's features)
end
2018-11-08 19:23:39 +05:30
optional :session, type: Hash, desc: %q(Runner's session data) do
optional :url, type: String, desc: %q(Session's url)
optional :certificate, type: String, desc: %q(Session's certificate)
optional :authorization, type: String, desc: %q(Session's authorization)
end
2019-09-04 21:01:54 +05:30
optional :job_age, type: Integer, desc: %q(Job should be older than passed age in seconds to be ran on runner)
2017-08-17 22:00:37 +05:30
end
post '/request' do
authenticate_runner!
2018-11-08 19:23:39 +05:30
unless current_runner.active?
header 'X-GitLab-Last-Update', current_runner.ensure_runner_queue_value
break no_content!
end
runner_params = declared_params(include_missing: false)
if current_runner.runner_queue_value_latest?(runner_params[:last_update])
header 'X-GitLab-Last-Update', runner_params[:last_update]
2017-08-17 22:00:37 +05:30
Gitlab::Metrics.add_event(:build_not_found_cached)
2018-10-15 14:42:47 +05:30
break no_content!
2017-08-17 22:00:37 +05:30
end
new_update = current_runner.ensure_runner_queue_value
2018-11-08 19:23:39 +05:30
result = ::Ci::RegisterJobService.new(current_runner).execute(runner_params)
2017-08-17 22:00:37 +05:30
if result.valid?
if result.build
2018-10-15 14:42:47 +05:30
Gitlab::Metrics.add_event(:build_found)
2018-11-18 11:00:15 +05:30
present Ci::BuildRunnerPresenter.new(result.build), with: Entities::JobRequest::Response
2017-08-17 22:00:37 +05:30
else
Gitlab::Metrics.add_event(:build_not_found)
header 'X-GitLab-Last-Update', new_update
no_content!
end
else
# We received build that is invalid due to concurrency conflict
Gitlab::Metrics.add_event(:build_invalid)
conflict!
end
end
desc 'Updates a job' do
http_codes [[200, 'Job was updated'], [403, 'Forbidden']]
end
params do
requires :token, type: String, desc: %q(Runners's authentication token)
requires :id, type: Integer, desc: %q(Job's ID)
optional :trace, type: String, desc: %q(Job's full trace)
optional :state, type: String, desc: %q(Job's status: success, failed)
2018-12-13 13:39:08 +05:30
optional :failure_reason, type: String, desc: %q(Job's failure_reason)
2017-08-17 22:00:37 +05:30
end
put '/:id' do
job = authenticate_job!
2019-02-15 15:39:39 +05:30
job_forbidden!(job, 'Job is not running') unless job.running?
2017-08-17 22:00:37 +05:30
job.trace.set(params[:trace]) if params[:trace]
2018-10-15 14:42:47 +05:30
Gitlab::Metrics.add_event(:update_build)
2017-08-17 22:00:37 +05:30
case params[:state].to_s
2018-11-08 19:23:39 +05:30
when 'running'
job.touch if job.needs_touch?
2017-08-17 22:00:37 +05:30
when 'success'
2018-11-08 19:23:39 +05:30
job.success!
2017-08-17 22:00:37 +05:30
when 'failed'
2018-11-08 19:23:39 +05:30
job.drop!(params[:failure_reason] || :unknown_failure)
2017-08-17 22:00:37 +05:30
end
end
desc 'Appends a patch to the job trace' do
http_codes [[202, 'Trace was patched'],
[400, 'Missing Content-Range header'],
[403, 'Forbidden'],
[416, 'Range not satisfiable']]
end
params do
requires :id, type: Integer, desc: %q(Job's ID)
optional :token, type: String, desc: %q(Job's authentication token)
end
patch '/:id/trace' do
job = authenticate_job!
2019-02-15 15:39:39 +05:30
job_forbidden!(job, 'Job is not running') unless job.running?
2017-08-17 22:00:37 +05:30
2017-09-10 17:25:29 +05:30
error!('400 Missing header Content-Range', 400) unless request.headers.key?('Content-Range')
2017-08-17 22:00:37 +05:30
content_range = request.headers['Content-Range']
content_range = content_range.split('-')
2018-10-15 14:42:47 +05:30
# TODO:
# it seems that `Content-Range` as formatted by runner is wrong,
# the `byte_end` should point to final byte, but it points byte+1
# that means that we have to calculate end of body,
# as we cannot use `content_length[1]`
# Issue: https://gitlab.com/gitlab-org/gitlab-runner/issues/3275
body_data = request.body.read
body_start = content_range[0].to_i
body_end = body_start + body_data.bytesize
stream_size = job.trace.append(body_data, body_start)
unless stream_size == body_end
break error!('416 Range Not Satisfiable', 416, { 'Range' => "0-#{stream_size}" })
2017-08-17 22:00:37 +05:30
end
status 202
header 'Job-Status', job.status
header 'Range', "0-#{stream_size}"
end
desc 'Authorize artifacts uploading for job' do
http_codes [[200, 'Upload allowed'],
[403, 'Forbidden'],
[405, 'Artifacts support not enabled'],
[413, 'File too large']]
end
params do
requires :id, type: Integer, desc: %q(Job's ID)
optional :token, type: String, desc: %q(Job's authentication token)
optional :filesize, type: Integer, desc: %q(Artifacts filesize)
end
post '/:id/artifacts/authorize' do
not_allowed! unless Gitlab.config.artifacts.enabled
require_gitlab_workhorse!
Gitlab::Workhorse.verify_api_request!(headers)
2019-02-15 15:39:39 +05:30
job = authenticate_job!
forbidden!('Job is not running') unless job.running?
2017-08-17 22:00:37 +05:30
2019-12-21 20:55:43 +05:30
max_size = max_artifacts_size(job)
2017-08-17 22:00:37 +05:30
if params[:filesize]
file_size = params[:filesize].to_i
2019-12-21 20:55:43 +05:30
file_too_large! unless file_size < max_size
2017-08-17 22:00:37 +05:30
end
status 200
content_type Gitlab::Workhorse::INTERNAL_API_CONTENT_TYPE
2019-12-21 20:55:43 +05:30
JobArtifactUploader.workhorse_authorize(has_length: false, maximum_size: max_size)
2017-08-17 22:00:37 +05:30
end
desc 'Upload artifacts for job' do
success Entities::JobRequest::Response
http_codes [[201, 'Artifact uploaded'],
[400, 'Bad request'],
[403, 'Forbidden'],
[405, 'Artifacts support not enabled'],
[413, 'File too large']]
end
params do
requires :id, type: Integer, desc: %q(Job's ID)
optional :token, type: String, desc: %q(Job's authentication token)
optional :expire_in, type: String, desc: %q(Specify when artifacts should expire)
2018-11-18 11:00:15 +05:30
optional :artifact_type, type: String, desc: %q(The type of artifact),
default: 'archive', values: Ci::JobArtifact.file_types.keys
optional :artifact_format, type: String, desc: %q(The format of artifact),
default: 'zip', values: Ci::JobArtifact.file_formats.keys
2017-08-17 22:00:37 +05:30
optional 'file.path', type: String, desc: %q(path to locally stored body (generated by Workhorse))
optional 'file.name', type: String, desc: %q(real filename as send in Content-Disposition (generated by Workhorse))
optional 'file.type', type: String, desc: %q(real content type as send in Content-Type (generated by Workhorse))
2018-05-09 12:01:36 +05:30
optional 'file.size', type: Integer, desc: %q(real size of file (generated by Workhorse))
optional 'file.sha256', type: String, desc: %q(sha256 checksum of the file (generated by Workhorse))
2017-08-17 22:00:37 +05:30
optional 'metadata.path', type: String, desc: %q(path to locally stored body (generated by Workhorse))
optional 'metadata.name', type: String, desc: %q(filename (generated by Workhorse))
2018-05-09 12:01:36 +05:30
optional 'metadata.size', type: Integer, desc: %q(real size of metadata (generated by Workhorse))
optional 'metadata.sha256', type: String, desc: %q(sha256 checksum of metadata (generated by Workhorse))
2017-08-17 22:00:37 +05:30
end
post '/:id/artifacts' do
not_allowed! unless Gitlab.config.artifacts.enabled
require_gitlab_workhorse!
job = authenticate_job!
2019-02-15 15:39:39 +05:30
forbidden!('Job is not running!') unless job.running?
2017-08-17 22:00:37 +05:30
2018-05-09 12:01:36 +05:30
artifacts = UploadedFile.from_params(params, :file, JobArtifactUploader.workhorse_local_upload_path)
metadata = UploadedFile.from_params(params, :metadata, JobArtifactUploader.workhorse_local_upload_path)
2017-08-17 22:00:37 +05:30
bad_request!('Missing artifacts file!') unless artifacts
2019-12-21 20:55:43 +05:30
file_too_large! unless artifacts.size < max_artifacts_size(job)
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
expire_in = params['expire_in'] ||
2017-08-17 22:00:37 +05:30
Gitlab::CurrentSettings.current_application_settings.default_artifacts_expire_in
2018-11-18 11:00:15 +05:30
job.job_artifacts.build(
2018-05-09 12:01:36 +05:30
project: job.project,
file: artifacts,
2018-11-18 11:00:15 +05:30
file_type: params['artifact_type'],
file_format: params['artifact_format'],
2018-05-09 12:01:36 +05:30
file_sha256: artifacts.sha256,
expire_in: expire_in)
if metadata
2018-11-18 11:00:15 +05:30
job.job_artifacts.build(
2018-05-09 12:01:36 +05:30
project: job.project,
file: metadata,
file_type: :metadata,
2018-11-18 11:00:15 +05:30
file_format: :gzip,
2018-05-09 12:01:36 +05:30
file_sha256: metadata.sha256,
expire_in: expire_in)
end
2018-03-17 18:26:18 +05:30
2018-05-09 12:01:36 +05:30
if job.update(artifacts_expire_in: expire_in)
2018-11-18 11:00:15 +05:30
present Ci::BuildRunnerPresenter.new(job), with: Entities::JobRequest::Response
2017-08-17 22:00:37 +05:30
else
render_validation_error!(job)
end
end
desc 'Download the artifacts file for job' do
http_codes [[200, 'Upload allowed'],
[403, 'Forbidden'],
[404, 'Artifact not found']]
end
params do
requires :id, type: Integer, desc: %q(Job's ID)
optional :token, type: String, desc: %q(Job's authentication token)
2018-05-09 12:01:36 +05:30
optional :direct_download, default: false, type: Boolean, desc: %q(Perform direct download from remote storage instead of proxying artifacts)
2017-08-17 22:00:37 +05:30
end
get '/:id/artifacts' do
2019-02-15 15:39:39 +05:30
job = authenticate_job!
2017-08-17 22:00:37 +05:30
2018-05-09 12:01:36 +05:30
present_carrierwave_file!(job.artifacts_file, supports_direct_download: params[:direct_download])
2017-08-17 22:00:37 +05:30
end
end
end
end