debian-mirror-gitlab/lib/api/ci/pipeline_schedules.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

299 lines
13 KiB
Ruby
Raw Normal View History

2020-07-28 23:09:34 +05:30
# frozen_string_literal: true
module API
module Ci
2021-01-03 14:25:43 +05:30
class PipelineSchedules < ::API::Base
2020-07-28 23:09:34 +05:30
include PaginationParams
before { authenticate! }
2021-01-29 00:20:46 +05:30
feature_category :continuous_integration
2022-07-16 23:28:13 +05:30
urgency :low
2021-01-29 00:20:46 +05:30
2020-07-28 23:09:34 +05:30
params do
2023-01-13 00:05:48 +05:30
requires :id, types: [String, Integer], desc: 'The ID or URL-encoded path of the project',
documentation: { example: 18 }
2020-07-28 23:09:34 +05:30
end
resource :projects, requirements: ::API::API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
desc 'Get all pipeline schedules' do
2023-01-13 00:05:48 +05:30
success code: 200, model: Entities::Ci::PipelineSchedule
failure [
{ code: 401, message: 'Unauthorized' },
{ code: 403, message: 'Forbidden' },
{ code: 404, message: 'Not found' }
]
is_array true
2020-07-28 23:09:34 +05:30
end
params do
use :pagination
optional :scope, type: String, values: %w[active inactive],
2023-01-13 00:05:48 +05:30
desc: 'The scope of pipeline schedules',
documentation: { example: 'active' }
2020-07-28 23:09:34 +05:30
end
# rubocop: disable CodeReuse/ActiveRecord
get ':id/pipeline_schedules' do
authorize! :read_pipeline_schedule, user_project
schedules = ::Ci::PipelineSchedulesFinder.new(user_project).execute(scope: params[:scope])
.preload([:owner, :last_pipeline])
2020-10-24 23:57:45 +05:30
present paginate(schedules), with: Entities::Ci::PipelineSchedule
2020-07-28 23:09:34 +05:30
end
# rubocop: enable CodeReuse/ActiveRecord
desc 'Get a single pipeline schedule' do
2023-01-13 00:05:48 +05:30
success code: 200, model: Entities::Ci::PipelineScheduleDetails
failure [
{ code: 401, message: 'Unauthorized' },
{ code: 403, message: 'Forbidden' },
{ code: 404, message: 'Not found' }
]
2020-07-28 23:09:34 +05:30
end
params do
2023-01-13 00:05:48 +05:30
requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id', documentation: { example: 13 }
2020-07-28 23:09:34 +05:30
end
get ':id/pipeline_schedules/:pipeline_schedule_id' do
2020-11-05 12:06:23 +05:30
present pipeline_schedule, with: Entities::Ci::PipelineScheduleDetails, user: current_user
2020-07-28 23:09:34 +05:30
end
2022-08-27 11:52:29 +05:30
desc 'Get all pipelines triggered from a pipeline schedule' do
2023-01-13 00:05:48 +05:30
success code: 200, model: Entities::Ci::PipelineBasic
failure [
{ code: 401, message: 'Unauthorized' },
{ code: 403, message: 'Forbidden' },
{ code: 404, message: 'Not found' }
]
is_array true
2022-08-27 11:52:29 +05:30
end
params do
2023-01-13 00:05:48 +05:30
requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule ID', documentation: { example: 13 }
2022-08-27 11:52:29 +05:30
end
get ':id/pipeline_schedules/:pipeline_schedule_id/pipelines' do
present paginate(pipeline_schedule.pipelines), with: Entities::Ci::PipelineBasic
end
2020-07-28 23:09:34 +05:30
desc 'Create a new pipeline schedule' do
2023-01-13 00:05:48 +05:30
success code: 201, model: Entities::Ci::PipelineScheduleDetails
failure [
{ code: 400, message: 'Bad request' },
{ code: 401, message: 'Unauthorized' },
{ code: 403, message: 'Forbidden' },
{ code: 404, message: 'Not found' }
]
2020-07-28 23:09:34 +05:30
end
params do
2023-01-13 00:05:48 +05:30
requires :description, type: String, desc: 'The description of pipeline schedule', documentation: { example: 'Test schedule pipeline' }
requires :ref, type: String, desc: 'The branch/tag name will be triggered', allow_blank: false, documentation: { example: 'develop' }
requires :cron, type: String, desc: 'The cron', documentation: { example: '* * * * *' }
optional :cron_timezone, type: String, default: 'UTC', desc: 'The timezone', documentation: { example: 'Asia/Tokyo' }
optional :active, type: Boolean, default: true, desc: 'The activation of pipeline schedule', documentation: { example: true }
2020-07-28 23:09:34 +05:30
end
post ':id/pipeline_schedules' do
authorize! :create_pipeline_schedule, user_project
pipeline_schedule = ::Ci::CreatePipelineScheduleService
.new(user_project, current_user, declared_params(include_missing: false))
.execute
if pipeline_schedule.persisted?
2020-10-24 23:57:45 +05:30
present pipeline_schedule, with: Entities::Ci::PipelineScheduleDetails
2020-07-28 23:09:34 +05:30
else
render_validation_error!(pipeline_schedule)
end
end
desc 'Edit a pipeline schedule' do
2023-01-13 00:05:48 +05:30
success code: 200, model: Entities::Ci::PipelineScheduleDetails
failure [
{ code: 400, message: 'Bad request' },
{ code: 401, message: 'Unauthorized' },
{ code: 403, message: 'Forbidden' },
{ code: 404, message: 'Not found' }
]
2020-07-28 23:09:34 +05:30
end
params do
2023-01-13 00:05:48 +05:30
requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id', documentation: { example: 13 }
optional :description, type: String, desc: 'The description of pipeline schedule', documentation: { example: 'Test schedule pipeline' }
optional :ref, type: String, desc: 'The branch/tag name will be triggered', documentation: { example: 'develop' }
optional :cron, type: String, desc: 'The cron', documentation: { example: '* * * * *' }
optional :cron_timezone, type: String, desc: 'The timezone', documentation: { example: 'Asia/Tokyo' }
optional :active, type: Boolean, desc: 'The activation of pipeline schedule', documentation: { example: true }
2020-07-28 23:09:34 +05:30
end
put ':id/pipeline_schedules/:pipeline_schedule_id' do
authorize! :update_pipeline_schedule, pipeline_schedule
if pipeline_schedule.update(declared_params(include_missing: false))
2020-10-24 23:57:45 +05:30
present pipeline_schedule, with: Entities::Ci::PipelineScheduleDetails
2020-07-28 23:09:34 +05:30
else
render_validation_error!(pipeline_schedule)
end
end
desc 'Take ownership of a pipeline schedule' do
2023-01-13 00:05:48 +05:30
success code: 201, model: Entities::Ci::PipelineScheduleDetails
failure [
{ code: 400, message: 'Bad request' },
{ code: 401, message: 'Unauthorized' },
{ code: 403, message: 'Forbidden' },
{ code: 404, message: 'Not found' }
]
2020-07-28 23:09:34 +05:30
end
params do
2023-01-13 00:05:48 +05:30
requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id', documentation: { example: 13 }
2020-07-28 23:09:34 +05:30
end
post ':id/pipeline_schedules/:pipeline_schedule_id/take_ownership' do
2022-05-03 16:02:30 +05:30
authorize! :take_ownership_pipeline_schedule, pipeline_schedule
2020-07-28 23:09:34 +05:30
if pipeline_schedule.own!(current_user)
2020-10-24 23:57:45 +05:30
present pipeline_schedule, with: Entities::Ci::PipelineScheduleDetails
2020-07-28 23:09:34 +05:30
else
render_validation_error!(pipeline_schedule)
end
end
desc 'Delete a pipeline schedule' do
2023-01-13 00:05:48 +05:30
success code: 204
failure [
{ code: 401, message: 'Unauthorized' },
{ code: 403, message: 'Forbidden' },
{ code: 404, message: 'Not found' },
{ code: 412, message: 'Precondition Failed' }
]
2020-07-28 23:09:34 +05:30
end
params do
2023-01-13 00:05:48 +05:30
requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id', documentation: { example: 13 }
2020-07-28 23:09:34 +05:30
end
delete ':id/pipeline_schedules/:pipeline_schedule_id' do
authorize! :admin_pipeline_schedule, pipeline_schedule
destroy_conditionally!(pipeline_schedule)
end
desc 'Play a scheduled pipeline immediately' do
detail 'This feature was added in GitLab 12.8'
2023-01-13 00:05:48 +05:30
success code: 201
failure [
{ code: 401, message: 'Unauthorized' },
{ code: 403, message: 'Forbidden' },
{ code: 404, message: 'Not found' }
]
2020-07-28 23:09:34 +05:30
end
params do
2023-01-13 00:05:48 +05:30
requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id', documentation: { example: 13 }
2020-07-28 23:09:34 +05:30
end
post ':id/pipeline_schedules/:pipeline_schedule_id/play' do
authorize! :play_pipeline_schedule, pipeline_schedule
job_id = RunPipelineScheduleWorker # rubocop:disable CodeReuse/Worker
.perform_async(pipeline_schedule.id, current_user.id)
if job_id
created!
else
render_api_error!('Unable to schedule pipeline run immediately', 500)
end
end
desc 'Create a new pipeline schedule variable' do
2023-01-13 00:05:48 +05:30
success code: 201, model: Entities::Ci::Variable
failure [
{ code: 400, message: 'Bad request' },
{ code: 401, message: 'Unauthorized' },
{ code: 403, message: 'Forbidden' },
{ code: 404, message: 'Not found' }
]
2020-07-28 23:09:34 +05:30
end
params do
2023-01-13 00:05:48 +05:30
requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id', documentation: { example: 13 }
requires :key, type: String, desc: 'The key of the variable', documentation: { example: 'NEW_VARIABLE' }
requires :value, type: String, desc: 'The value of the variable', documentation: { example: 'new value' }
optional :variable_type, type: String, values: ::Ci::PipelineScheduleVariable.variable_types.keys, desc: 'The type of variable, must be one of env_var or file. Defaults to env_var',
documentation: { default: 'env_var' }
2020-07-28 23:09:34 +05:30
end
post ':id/pipeline_schedules/:pipeline_schedule_id/variables' do
authorize! :update_pipeline_schedule, pipeline_schedule
variable_params = declared_params(include_missing: false)
variable = pipeline_schedule.variables.create(variable_params)
if variable.persisted?
2020-10-24 23:57:45 +05:30
present variable, with: Entities::Ci::Variable
2020-07-28 23:09:34 +05:30
else
render_validation_error!(variable)
end
end
desc 'Edit a pipeline schedule variable' do
2023-01-13 00:05:48 +05:30
success code: 200, model: Entities::Ci::Variable
failure [
{ code: 400, message: 'Bad request' },
{ code: 401, message: 'Unauthorized' },
{ code: 403, message: 'Forbidden' },
{ code: 404, message: 'Not found' }
]
2020-07-28 23:09:34 +05:30
end
params do
2023-01-13 00:05:48 +05:30
requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id', documentation: { example: 13 }
requires :key, type: String, desc: 'The key of the variable', documentation: { example: 'NEW_VARIABLE' }
optional :value, type: String, desc: 'The value of the variable', documentation: { example: 'new value' }
optional :variable_type, type: String, values: ::Ci::PipelineScheduleVariable.variable_types.keys, desc: 'The type of variable, must be one of env_var or file',
documentation: { default: 'env_var' }
2020-07-28 23:09:34 +05:30
end
put ':id/pipeline_schedules/:pipeline_schedule_id/variables/:key' do
authorize! :update_pipeline_schedule, pipeline_schedule
if pipeline_schedule_variable.update(declared_params(include_missing: false))
2020-10-24 23:57:45 +05:30
present pipeline_schedule_variable, with: Entities::Ci::Variable
2020-07-28 23:09:34 +05:30
else
render_validation_error!(pipeline_schedule_variable)
end
end
desc 'Delete a pipeline schedule variable' do
2023-01-13 00:05:48 +05:30
success code: 202, model: Entities::Ci::Variable
failure [
{ code: 401, message: 'Unauthorized' },
{ code: 403, message: 'Forbidden' },
{ code: 404, message: 'Not found' }
]
2020-07-28 23:09:34 +05:30
end
params do
2023-01-13 00:05:48 +05:30
requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id', documentation: { example: 13 }
requires :key, type: String, desc: 'The key of the variable', documentation: { example: 'NEW_VARIABLE' }
2020-07-28 23:09:34 +05:30
end
delete ':id/pipeline_schedules/:pipeline_schedule_id/variables/:key' do
authorize! :admin_pipeline_schedule, pipeline_schedule
status :accepted
2020-10-24 23:57:45 +05:30
present pipeline_schedule_variable.destroy, with: Entities::Ci::Variable
2020-07-28 23:09:34 +05:30
end
end
helpers do
# rubocop: disable CodeReuse/ActiveRecord
def pipeline_schedule
@pipeline_schedule ||=
user_project
.pipeline_schedules
.preload(:owner, :last_pipeline)
.find_by(id: params.delete(:pipeline_schedule_id)).tap do |pipeline_schedule|
unless can?(current_user, :read_pipeline_schedule, pipeline_schedule)
not_found!('Pipeline Schedule')
end
end
end
# rubocop: enable CodeReuse/ActiveRecord
# rubocop: disable CodeReuse/ActiveRecord
def pipeline_schedule_variable
@pipeline_schedule_variable ||=
pipeline_schedule.variables.find_by(key: params[:key]).tap do |pipeline_schedule_variable|
unless pipeline_schedule_variable
not_found!('Pipeline Schedule Variable')
end
end
end
# rubocop: enable CodeReuse/ActiveRecord
end
end
end
end