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

197 lines
5.9 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 Jobs < Grape::API
include PaginationParams
before { authenticate! }
params do
requires :id, type: String, desc: 'The ID of a project'
end
2019-02-15 15:39:39 +05:30
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
2017-08-17 22:00:37 +05:30
helpers do
params :optional_scope do
optional :scope, types: [String, Array[String]], desc: 'The scope of builds to show',
values: ::CommitStatus::AVAILABLE_STATUSES,
coerce_with: ->(scope) {
case scope
when String
[scope]
2018-03-17 18:26:18 +05:30
when ::Hash
2017-08-17 22:00:37 +05:30
scope.values
2018-03-17 18:26:18 +05:30
when ::Array
2017-08-17 22:00:37 +05:30
scope
else
['unknown']
end
}
end
end
desc 'Get a projects jobs' do
success Entities::Job
end
params do
use :optional_scope
use :pagination
end
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2017-08-17 22:00:37 +05:30
get ':id/jobs' do
2019-01-03 12:48:30 +05:30
authorize_read_builds!
2017-08-17 22:00:37 +05:30
builds = user_project.builds.order('id DESC')
builds = filter_builds(builds, params[:scope])
2018-11-20 20:47:30 +05:30
builds = builds.preload(:user, :job_artifacts_archive, :job_artifacts, :runner, pipeline: :project)
2017-08-17 22:00:37 +05:30
present paginate(builds), with: Entities::Job
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2017-08-17 22:00:37 +05:30
desc 'Get pipeline jobs' do
success Entities::Job
end
params do
2019-03-02 22:35:43 +05:30
requires :pipeline_id, type: Integer, desc: 'The pipeline ID'
2017-08-17 22:00:37 +05:30
use :optional_scope
use :pagination
end
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2017-08-17 22:00:37 +05:30
get ':id/pipelines/:pipeline_id/jobs' do
2019-01-03 12:48:30 +05:30
authorize!(:read_pipeline, user_project)
2019-02-15 15:39:39 +05:30
pipeline = user_project.ci_pipelines.find(params[:pipeline_id])
2019-01-03 12:48:30 +05:30
authorize!(:read_build, pipeline)
2017-08-17 22:00:37 +05:30
builds = pipeline.builds
builds = filter_builds(builds, params[:scope])
2018-11-20 20:47:30 +05:30
builds = builds.preload(:job_artifacts_archive, :job_artifacts, project: [:namespace])
2017-08-17 22:00:37 +05:30
present paginate(builds), with: Entities::Job
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2017-08-17 22:00:37 +05:30
desc 'Get a specific job of a project' do
success Entities::Job
end
params do
requires :job_id, type: Integer, desc: 'The ID of a job'
end
get ':id/jobs/:job_id' do
authorize_read_builds!
2018-03-17 18:26:18 +05:30
build = find_build!(params[:job_id])
2017-08-17 22:00:37 +05:30
present build, with: Entities::Job
end
2018-05-09 12:01:36 +05:30
# TODO: We should use `present_disk_file!` and leave this implementation for backward compatibility (when build trace
2017-08-17 22:00:37 +05:30
# is saved in the DB instead of file). But before that, we need to consider how to replace the value of
# `runners_token` with some mask (like `xxxxxx`) when sending trace file directly by workhorse.
desc 'Get a trace of a specific job of a project'
params do
requires :job_id, type: Integer, desc: 'The ID of a job'
end
get ':id/jobs/:job_id/trace' do
authorize_read_builds!
2018-03-17 18:26:18 +05:30
build = find_build!(params[:job_id])
2017-08-17 22:00:37 +05:30
header 'Content-Disposition', "infile; filename=\"#{build.id}.log\""
content_type 'text/plain'
env['api.format'] = :binary
trace = build.trace.raw
body trace
end
desc 'Cancel a specific job of a project' do
success Entities::Job
end
params do
requires :job_id, type: Integer, desc: 'The ID of a job'
end
post ':id/jobs/:job_id/cancel' do
authorize_update_builds!
2018-03-17 18:26:18 +05:30
build = find_build!(params[:job_id])
2017-08-17 22:00:37 +05:30
authorize!(:update_build, build)
build.cancel
present build, with: Entities::Job
end
desc 'Retry a specific build of a project' do
success Entities::Job
end
params do
requires :job_id, type: Integer, desc: 'The ID of a build'
end
post ':id/jobs/:job_id/retry' do
authorize_update_builds!
2018-03-17 18:26:18 +05:30
build = find_build!(params[:job_id])
2017-08-17 22:00:37 +05:30
authorize!(:update_build, build)
2018-10-15 14:42:47 +05:30
break forbidden!('Job is not retryable') unless build.retryable?
2017-08-17 22:00:37 +05:30
build = Ci::Build.retry(build, current_user)
present build, with: Entities::Job
end
desc 'Erase job (remove artifacts and the trace)' do
success Entities::Job
end
params do
requires :job_id, type: Integer, desc: 'The ID of a build'
end
post ':id/jobs/:job_id/erase' do
authorize_update_builds!
2018-03-17 18:26:18 +05:30
build = find_build!(params[:job_id])
authorize!(:erase_build, build)
2018-10-15 14:42:47 +05:30
break forbidden!('Job is not erasable!') unless build.erasable?
2017-08-17 22:00:37 +05:30
build.erase(erased_by: current_user)
present build, with: Entities::Job
end
2018-12-13 13:39:08 +05:30
desc 'Trigger a actionable job (manual, delayed, etc)' do
2017-08-17 22:00:37 +05:30
success Entities::Job
detail 'This feature was added in GitLab 8.11'
end
params do
requires :job_id, type: Integer, desc: 'The ID of a Job'
end
post ":id/jobs/:job_id/play" do
authorize_read_builds!
2018-03-17 18:26:18 +05:30
build = find_build!(params[:job_id])
2017-08-17 22:00:37 +05:30
authorize!(:update_build, build)
bad_request!("Unplayable Job") unless build.playable?
build.play(current_user)
status 200
present build, with: Entities::Job
end
end
helpers do
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2017-08-17 22:00:37 +05:30
def filter_builds(builds, scope)
return builds if scope.nil? || scope.empty?
available_statuses = ::CommitStatus::AVAILABLE_STATUSES
unknown = scope - available_statuses
render_api_error!('Scope contains invalid value(s)', 400) unless unknown.empty?
builds.where(status: available_statuses && scope)
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2017-08-17 22:00:37 +05:30
end
end
end