Merge branch 'move-api-pipelines-to-ci-namespace' into 'master'

Move API::Pipeline and API::PipelineSchedules to Ci namespace

See merge request gitlab-org/gitlab!36381

ee/spec/requests/api/pipelines_spec.rb → ee/spec/requests/api/ci/pipelines_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-RSpec.describe API::Pipelines do
+RSpec.describe API::Ci::Pipelines do
   let(:user)    { create(:user) }
   let(:project) { create(:project, :repository, creator: user) }
 

lib/api/api.rb

@@ -133,6 +133,8 @@ module API
       mount ::API::Boards
       mount ::API::Branches
       mount ::API::BroadcastMessages
+      mount ::API::Ci::Pipelines
+      mount ::API::Ci::PipelineSchedules
       mount ::API::Ci::Runner
       mount ::API::Ci::Runners
       mount ::API::Commits
@@ -179,8 +181,6 @@ module API
       mount ::API::NotificationSettings
       mount ::API::Pages
       mount ::API::PagesDomains
-      mount ::API::Pipelines
-      mount ::API::PipelineSchedules
       mount ::API::ProjectClusters
       mount ::API::ProjectContainerRepositories
       mount ::API::ProjectEvents

lib/api/ci/pipeline_schedules.rb

+# frozen_string_literal: true
+
+module API
+  module Ci
+    class PipelineSchedules < Grape::API::Instance
+      include PaginationParams
+
+      before { authenticate! }
+
+      params do
+        requires :id, type: String, desc: 'The ID of a project'
+      end
+      resource :projects, requirements: ::API::API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
+        desc 'Get all pipeline schedules' do
+          success Entities::PipelineSchedule
+        end
+        params do
+          use :pagination
+          optional :scope,    type: String, values: %w[active inactive],
+                              desc: 'The scope of pipeline schedules'
+        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])
+          present paginate(schedules), with: Entities::PipelineSchedule
+        end
+        # rubocop: enable CodeReuse/ActiveRecord
+
+        desc 'Get a single pipeline schedule' do
+          success Entities::PipelineScheduleDetails
+        end
+        params do
+          requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id'
+        end
+        get ':id/pipeline_schedules/:pipeline_schedule_id' do
+          present pipeline_schedule, with: Entities::PipelineScheduleDetails
+        end
+
+        desc 'Create a new pipeline schedule' do
+          success Entities::PipelineScheduleDetails
+        end
+        params do
+          requires :description, type: String, desc: 'The description of pipeline schedule'
+          requires :ref, type: String, desc: 'The branch/tag name will be triggered', allow_blank: false
+          requires :cron, type: String, desc: 'The cron'
+          optional :cron_timezone, type: String, default: 'UTC', desc: 'The timezone'
+          optional :active, type: Boolean, default: true, desc: 'The activation of pipeline schedule'
+        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?
+            present pipeline_schedule, with: Entities::PipelineScheduleDetails
+          else
+            render_validation_error!(pipeline_schedule)
+          end
+        end
+
+        desc 'Edit a pipeline schedule' do
+          success Entities::PipelineScheduleDetails
+        end
+        params do
+          requires :pipeline_schedule_id, type: Integer,  desc: 'The pipeline schedule id'
+          optional :description, type: String, desc: 'The description of pipeline schedule'
+          optional :ref, type: String, desc: 'The branch/tag name will be triggered'
+          optional :cron, type: String, desc: 'The cron'
+          optional :cron_timezone, type: String, desc: 'The timezone'
+          optional :active, type: Boolean, desc: 'The activation of pipeline schedule'
+        end
+        put ':id/pipeline_schedules/:pipeline_schedule_id' do
+          authorize! :update_pipeline_schedule, pipeline_schedule
+
+          if pipeline_schedule.update(declared_params(include_missing: false))
+            present pipeline_schedule, with: Entities::PipelineScheduleDetails
+          else
+            render_validation_error!(pipeline_schedule)
+          end
+        end
+
+        desc 'Take ownership of a pipeline schedule' do
+          success Entities::PipelineScheduleDetails
+        end
+        params do
+          requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id'
+        end
+        post ':id/pipeline_schedules/:pipeline_schedule_id/take_ownership' do
+          authorize! :update_pipeline_schedule, pipeline_schedule
+
+          if pipeline_schedule.own!(current_user)
+            present pipeline_schedule, with: Entities::PipelineScheduleDetails
+          else
+            render_validation_error!(pipeline_schedule)
+          end
+        end
+
+        desc 'Delete a pipeline schedule' do
+          success Entities::PipelineScheduleDetails
+        end
+        params do
+          requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id'
+        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'
+        end
+        params do
+          requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id'
+        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
+          success Entities::Variable
+        end
+        params do
+          requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id'
+          requires :key, type: String, desc: 'The key of the variable'
+          requires :value, type: String, desc: 'The value of the variable'
+          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'
+        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?
+            present variable, with: Entities::Variable
+          else
+            render_validation_error!(variable)
+          end
+        end
+
+        desc 'Edit a pipeline schedule variable' do
+          success Entities::Variable
+        end
+        params do
+          requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id'
+          requires :key, type: String, desc: 'The key of the variable'
+          optional :value, type: String, desc: 'The value of the variable'
+          optional :variable_type, type: String, values: ::Ci::PipelineScheduleVariable.variable_types.keys, desc: 'The type of variable, must be one of env_var or file'
+        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))
+            present pipeline_schedule_variable, with: Entities::Variable
+          else
+            render_validation_error!(pipeline_schedule_variable)
+          end
+        end
+
+        desc 'Delete a pipeline schedule variable' do
+          success Entities::Variable
+        end
+        params do
+          requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id'
+          requires :key, type: String, desc: 'The key of the variable'
+        end
+        delete ':id/pipeline_schedules/:pipeline_schedule_id/variables/:key' do
+          authorize! :admin_pipeline_schedule, pipeline_schedule
+
+          status :accepted
+          present pipeline_schedule_variable.destroy, with: Entities::Variable
+        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

lib/api/ci/pipelines.rb

+# frozen_string_literal: true
+
+module API
+  module Ci
+    class Pipelines < Grape::API::Instance
+      include PaginationParams
+
+      before { authenticate_non_get! }
+
+      params do
+        requires :id, type: String, desc: 'The project ID'
+      end
+      resource :projects, requirements: ::API::API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
+        desc 'Get all Pipelines of the project' do
+          detail 'This feature was introduced in GitLab 8.11.'
+          success Entities::PipelineBasic
+        end
+        params do
+          use :pagination
+          optional :scope,    type: String, values: %w[running pending finished branches tags],
+                              desc: 'The scope of pipelines'
+          optional :status,   type: String, values: ::Ci::HasStatus::AVAILABLE_STATUSES,
+                              desc: 'The status of pipelines'
+          optional :ref,      type: String, desc: 'The ref of pipelines'
+          optional :sha,      type: String, desc: 'The sha of pipelines'
+          optional :yaml_errors, type: Boolean, desc: 'Returns pipelines with invalid configurations'
+          optional :name,     type: String, desc: 'The name of the user who triggered pipelines'
+          optional :username, type: String, desc: 'The username of the user who triggered pipelines'
+          optional :updated_before, type: DateTime, desc: 'Return pipelines updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ'
+          optional :updated_after, type: DateTime, desc: 'Return pipelines updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ'
+          optional :order_by, type: String, values: ::Ci::PipelinesFinder::ALLOWED_INDEXED_COLUMNS, default: 'id',
+                              desc: 'Order pipelines'
+          optional :sort,     type: String, values: %w[asc desc], default: 'desc',
+                              desc: 'Sort pipelines'
+        end
+        get ':id/pipelines' do
+          authorize! :read_pipeline, user_project
+          authorize! :read_build, user_project
+
+          pipelines = ::Ci::PipelinesFinder.new(user_project, current_user, params).execute
+          present paginate(pipelines), with: Entities::PipelineBasic
+        end
+
+        desc 'Create a new pipeline' do
+          detail 'This feature was introduced in GitLab 8.14'
+          success Entities::Pipeline
+        end
+        params do
+          requires :ref, type: String, desc: 'Reference'
+          optional :variables, Array, desc: 'Array of variables available in the pipeline'
+        end
+        post ':id/pipeline' do
+          Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-foss/issues/42124')
+
+          authorize! :create_pipeline, user_project
+
+          pipeline_params = declared_params(include_missing: false)
+            .merge(variables_attributes: params[:variables])
+            .except(:variables)
+
+          new_pipeline = ::Ci::CreatePipelineService.new(user_project,
+                                                         current_user,
+                                                         pipeline_params)
+                             .execute(:api, ignore_skip_ci: true, save_on_errors: false)
+
+          if new_pipeline.persisted?
+            present new_pipeline, with: Entities::Pipeline
+          else
+            render_validation_error!(new_pipeline)
+          end
+        end
+
+        desc 'Gets a the latest pipeline for the project branch' do
+          detail 'This feature was introduced in GitLab 12.3'
+          success Entities::Pipeline
+        end
+        params do
+          optional :ref, type: String, desc: 'branch ref of pipeline'
+        end
+        get ':id/pipelines/latest' do
+          authorize! :read_pipeline, latest_pipeline
+
+          present latest_pipeline, with: Entities::Pipeline
+        end
+
+        desc 'Gets a specific pipeline for the project' do
+          detail 'This feature was introduced in GitLab 8.11'
+          success Entities::Pipeline
+        end
+        params do
+          requires :pipeline_id, type: Integer, desc: 'The pipeline ID'
+        end
+        get ':id/pipelines/:pipeline_id' do
+          authorize! :read_pipeline, pipeline
+
+          present pipeline, with: Entities::Pipeline
+        end
+
+        desc 'Gets the variables for a given pipeline' do
+          detail 'This feature was introduced in GitLab 11.11'
+          success Entities::Variable
+        end
+        params do
+          requires :pipeline_id, type: Integer, desc: 'The pipeline ID'
+        end
+        get ':id/pipelines/:pipeline_id/variables' do
+          authorize! :read_pipeline_variable, pipeline
+
+          present pipeline.variables, with: Entities::Variable
+        end
+
+        desc 'Gets the test report for a given pipeline' do
+          detail 'This feature was introduced in GitLab 13.0. Disabled by default behind feature flag `junit_pipeline_view`'
+          success TestReportEntity
+        end
+        params do
+          requires :pipeline_id, type: Integer, desc: 'The pipeline ID'
+        end
+        get ':id/pipelines/:pipeline_id/test_report' do
+          not_found! unless Feature.enabled?(:junit_pipeline_view, user_project)
+
+          authorize! :read_build, pipeline
+
+          present pipeline.test_reports, with: TestReportEntity, details: true
+        end
+
+        desc 'Deletes a pipeline' do
+          detail 'This feature was introduced in GitLab 11.6'
+          http_codes [[204, 'Pipeline was deleted'], [403, 'Forbidden']]
+        end
+        params do
+          requires :pipeline_id, type: Integer, desc: 'The pipeline ID'
+        end
+        delete ':id/pipelines/:pipeline_id' do
+          authorize! :destroy_pipeline, pipeline
+
+          destroy_conditionally!(pipeline) do
+            ::Ci::DestroyPipelineService.new(user_project, current_user).execute(pipeline)
+          end
+        end
+
+        desc 'Retry builds in the pipeline' do
+          detail 'This feature was introduced in GitLab 8.11.'
+          success Entities::Pipeline
+        end
+        params do
+          requires :pipeline_id, type: Integer, desc: 'The pipeline ID'
+        end
+        post ':id/pipelines/:pipeline_id/retry' do
+          authorize! :update_pipeline, pipeline
+
+          pipeline.retry_failed(current_user)
+
+          present pipeline, with: Entities::Pipeline
+        end
+
+        desc 'Cancel all builds in the pipeline' do
+          detail 'This feature was introduced in GitLab 8.11.'
+          success Entities::Pipeline
+        end
+        params do
+          requires :pipeline_id, type: Integer, desc: 'The pipeline ID'
+        end
+        post ':id/pipelines/:pipeline_id/cancel' do
+          authorize! :update_pipeline, pipeline
+
+          pipeline.cancel_running
+
+          status 200
+          present pipeline.reset, with: Entities::Pipeline
+        end
+      end
+
+      helpers do
+        def pipeline
+          strong_memoize(:pipeline) do
+            user_project.ci_pipelines.find(params[:pipeline_id])
+          end
+        end
+
+        def latest_pipeline
+          strong_memoize(:latest_pipeline) do
+            user_project.latest_pipeline_for_ref(params[:ref])
+          end
+        end
+      end
+    end
+  end
+end

lib/api/pipeline_schedules.rb

-# frozen_string_literal: true
-
-module API
-  class PipelineSchedules < Grape::API::Instance
-    include PaginationParams
-
-    before { authenticate! }
-
-    params do
-      requires :id, type: String, desc: 'The ID of a project'
-    end
-    resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
-      desc 'Get all pipeline schedules' do
-        success Entities::PipelineSchedule
-      end
-      params do
-        use :pagination
-        optional :scope,    type: String, values: %w[active inactive],
-                            desc: 'The scope of pipeline schedules'
-      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])
-        present paginate(schedules), with: Entities::PipelineSchedule
-      end
-      # rubocop: enable CodeReuse/ActiveRecord
-
-      desc 'Get a single pipeline schedule' do
-        success Entities::PipelineScheduleDetails
-      end
-      params do
-        requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id'
-      end
-      get ':id/pipeline_schedules/:pipeline_schedule_id' do
-        present pipeline_schedule, with: Entities::PipelineScheduleDetails
-      end
-
-      desc 'Create a new pipeline schedule' do
-        success Entities::PipelineScheduleDetails
-      end
-      params do
-        requires :description, type: String, desc: 'The description of pipeline schedule'
-        requires :ref, type: String, desc: 'The branch/tag name will be triggered', allow_blank: false
-        requires :cron, type: String, desc: 'The cron'
-        optional :cron_timezone, type: String, default: 'UTC', desc: 'The timezone'
-        optional :active, type: Boolean, default: true, desc: 'The activation of pipeline schedule'
-      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?
-          present pipeline_schedule, with: Entities::PipelineScheduleDetails
-        else
-          render_validation_error!(pipeline_schedule)
-        end
-      end
-
-      desc 'Edit a pipeline schedule' do
-        success Entities::PipelineScheduleDetails
-      end
-      params do
-        requires :pipeline_schedule_id, type: Integer,  desc: 'The pipeline schedule id'
-        optional :description, type: String, desc: 'The description of pipeline schedule'
-        optional :ref, type: String, desc: 'The branch/tag name will be triggered'
-        optional :cron, type: String, desc: 'The cron'
-        optional :cron_timezone, type: String, desc: 'The timezone'
-        optional :active, type: Boolean, desc: 'The activation of pipeline schedule'
-      end
-      put ':id/pipeline_schedules/:pipeline_schedule_id' do
-        authorize! :update_pipeline_schedule, pipeline_schedule
-
-        if pipeline_schedule.update(declared_params(include_missing: false))
-          present pipeline_schedule, with: Entities::PipelineScheduleDetails
-        else
-          render_validation_error!(pipeline_schedule)
-        end
-      end
-
-      desc 'Take ownership of a pipeline schedule' do
-        success Entities::PipelineScheduleDetails
-      end
-      params do
-        requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id'
-      end
-      post ':id/pipeline_schedules/:pipeline_schedule_id/take_ownership' do
-        authorize! :update_pipeline_schedule, pipeline_schedule
-
-        if pipeline_schedule.own!(current_user)
-          present pipeline_schedule, with: Entities::PipelineScheduleDetails
-        else
-          render_validation_error!(pipeline_schedule)
-        end
-      end
-
-      desc 'Delete a pipeline schedule' do
-        success Entities::PipelineScheduleDetails
-      end
-      params do
-        requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id'
-      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'
-      end
-      params do
-        requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id'
-      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
-        success Entities::Variable
-      end
-      params do
-        requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id'
-        requires :key, type: String, desc: 'The key of the variable'
-        requires :value, type: String, desc: 'The value of the variable'
-        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'
-      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?
-          present variable, with: Entities::Variable
-        else
-          render_validation_error!(variable)
-        end
-      end
-
-      desc 'Edit a pipeline schedule variable' do
-        success Entities::Variable
-      end
-      params do
-        requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id'
-        requires :key, type: String, desc: 'The key of the variable'
-        optional :value, type: String, desc: 'The value of the variable'
-        optional :variable_type, type: String, values: ::Ci::PipelineScheduleVariable.variable_types.keys, desc: 'The type of variable, must be one of env_var or file'
-      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))
-          present pipeline_schedule_variable, with: Entities::Variable
-        else
-          render_validation_error!(pipeline_schedule_variable)
-        end
-      end
-
-      desc 'Delete a pipeline schedule variable' do
-        success Entities::Variable
-      end
-      params do
-        requires :pipeline_schedule_id, type: Integer, desc: 'The pipeline schedule id'
-        requires :key, type: String, desc: 'The key of the variable'
-      end
-      delete ':id/pipeline_schedules/:pipeline_schedule_id/variables/:key' do
-        authorize! :admin_pipeline_schedule, pipeline_schedule
-
-        status :accepted
-        present pipeline_schedule_variable.destroy, with: Entities::Variable
-      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

lib/api/pipelines.rb

-# frozen_string_literal: true
-
-module API
-  class Pipelines < Grape::API::Instance
-    include PaginationParams
-
-    before { authenticate_non_get! }
-
-    params do
-      requires :id, type: String, desc: 'The project ID'
-    end
-    resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
-      desc 'Get all Pipelines of the project' do
-        detail 'This feature was introduced in GitLab 8.11.'
-        success Entities::PipelineBasic
-      end
-      params do
-        use :pagination
-        optional :scope,    type: String, values: %w[running pending finished branches tags],
-                            desc: 'The scope of pipelines'
-        optional :status,   type: String, values: ::Ci::HasStatus::AVAILABLE_STATUSES,
-                            desc: 'The status of pipelines'
-        optional :ref,      type: String, desc: 'The ref of pipelines'
-        optional :sha,      type: String, desc: 'The sha of pipelines'
-        optional :yaml_errors, type: Boolean, desc: 'Returns pipelines with invalid configurations'
-        optional :name,     type: String, desc: 'The name of the user who triggered pipelines'
-        optional :username, type: String, desc: 'The username of the user who triggered pipelines'
-        optional :updated_before, type: DateTime, desc: 'Return pipelines updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ'
-        optional :updated_after, type: DateTime, desc: 'Return pipelines updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ'
-        optional :order_by, type: String, values: ::Ci::PipelinesFinder::ALLOWED_INDEXED_COLUMNS, default: 'id',
-                            desc: 'Order pipelines'
-        optional :sort,     type: String, values: %w[asc desc], default: 'desc',
-                            desc: 'Sort pipelines'
-      end
-      get ':id/pipelines' do
-        authorize! :read_pipeline, user_project
-        authorize! :read_build, user_project
-
-        pipelines = ::Ci::PipelinesFinder.new(user_project, current_user, params).execute
-        present paginate(pipelines), with: Entities::PipelineBasic
-      end
-
-      desc 'Create a new pipeline' do
-        detail 'This feature was introduced in GitLab 8.14'
-        success Entities::Pipeline
-      end
-      params do
-        requires :ref, type: String, desc: 'Reference'
-        optional :variables, Array, desc: 'Array of variables available in the pipeline'
-      end
-      post ':id/pipeline' do
-        Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-foss/issues/42124')
-
-        authorize! :create_pipeline, user_project
-
-        pipeline_params = declared_params(include_missing: false)
-          .merge(variables_attributes: params[:variables])
-          .except(:variables)
-
-        new_pipeline = ::Ci::CreatePipelineService.new(user_project,
-                                                       current_user,
-                                                       pipeline_params)
-                           .execute(:api, ignore_skip_ci: true, save_on_errors: false)
-
-        if new_pipeline.persisted?
-          present new_pipeline, with: Entities::Pipeline
-        else
-          render_validation_error!(new_pipeline)
-        end
-      end
-
-      desc 'Gets a the latest pipeline for the project branch' do
-        detail 'This feature was introduced in GitLab 12.3'
-        success Entities::Pipeline
-      end
-      params do
-        optional :ref, type: String, desc: 'branch ref of pipeline'
-      end
-      get ':id/pipelines/latest' do
-        authorize! :read_pipeline, latest_pipeline
-
-        present latest_pipeline, with: Entities::Pipeline
-      end
-
-      desc 'Gets a specific pipeline for the project' do
-        detail 'This feature was introduced in GitLab 8.11'
-        success Entities::Pipeline
-      end
-      params do
-        requires :pipeline_id, type: Integer, desc: 'The pipeline ID'
-      end
-      get ':id/pipelines/:pipeline_id' do
-        authorize! :read_pipeline, pipeline
-
-        present pipeline, with: Entities::Pipeline
-      end
-
-      desc 'Gets the variables for a given pipeline' do
-        detail 'This feature was introduced in GitLab 11.11'
-        success Entities::Variable
-      end
-      params do
-        requires :pipeline_id, type: Integer, desc: 'The pipeline ID'
-      end
-      get ':id/pipelines/:pipeline_id/variables' do
-        authorize! :read_pipeline_variable, pipeline
-
-        present pipeline.variables, with: Entities::Variable
-      end
-
-      desc 'Gets the test report for a given pipeline' do
-        detail 'This feature was introduced in GitLab 13.0. Disabled by default behind feature flag `junit_pipeline_view`'
-        success TestReportEntity
-      end
-      params do
-        requires :pipeline_id, type: Integer, desc: 'The pipeline ID'
-      end
-      get ':id/pipelines/:pipeline_id/test_report' do
-        not_found! unless Feature.enabled?(:junit_pipeline_view, user_project)
-
-        authorize! :read_build, pipeline
-
-        present pipeline.test_reports, with: TestReportEntity, details: true
-      end
-
-      desc 'Deletes a pipeline' do
-        detail 'This feature was introduced in GitLab 11.6'
-        http_codes [[204, 'Pipeline was deleted'], [403, 'Forbidden']]
-      end
-      params do
-        requires :pipeline_id, type: Integer, desc: 'The pipeline ID'
-      end
-      delete ':id/pipelines/:pipeline_id' do
-        authorize! :destroy_pipeline, pipeline
-
-        destroy_conditionally!(pipeline) do
-          ::Ci::DestroyPipelineService.new(user_project, current_user).execute(pipeline)
-        end
-      end
-
-      desc 'Retry builds in the pipeline' do
-        detail 'This feature was introduced in GitLab 8.11.'
-        success Entities::Pipeline
-      end
-      params do
-        requires :pipeline_id, type: Integer, desc: 'The pipeline ID'
-      end
-      post ':id/pipelines/:pipeline_id/retry' do
-        authorize! :update_pipeline, pipeline
-
-        pipeline.retry_failed(current_user)
-
-        present pipeline, with: Entities::Pipeline
-      end
-
-      desc 'Cancel all builds in the pipeline' do
-        detail 'This feature was introduced in GitLab 8.11.'
-        success Entities::Pipeline
-      end
-      params do
-        requires :pipeline_id, type: Integer, desc: 'The pipeline ID'
-      end
-      post ':id/pipelines/:pipeline_id/cancel' do
-        authorize! :update_pipeline, pipeline
-
-        pipeline.cancel_running
-
-        status 200
-        present pipeline.reset, with: Entities::Pipeline
-      end
-    end
-
-    helpers do
-      def pipeline
-        strong_memoize(:pipeline) do
-          user_project.ci_pipelines.find(params[:pipeline_id])
-        end
-      end
-
-      def latest_pipeline
-        strong_memoize(:latest_pipeline) do
-          user_project.latest_pipeline_for_ref(params[:ref])
-        end
-      end
-    end
-  end
-end

spec/requests/api/pipeline_schedules_spec.rb → spec/requests/api/ci/pipeline_schedules_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-RSpec.describe API::PipelineSchedules do
+RSpec.describe API::Ci::PipelineSchedules do
   let_it_be(:developer) { create(:user) }
   let_it_be(:user) { create(:user) }
   let_it_be(:project) { create(:project, :repository, public_builds: false) }
@@ -24,7 +24,7 @@ RSpec.describe API::PipelineSchedules do
           .each do |pipeline_schedule|
           create(:user).tap do |user|
             project.add_developer(user)
-            pipeline_schedule.update(owner: user)
+            pipeline_schedule.update!(owner: user)
           end
           pipeline_schedule.pipelines << build(:ci_pipeline, project: project)
         end

spec/requests/api/pipelines_spec.rb → spec/requests/api/ci/pipelines_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-RSpec.describe API::Pipelines do
+RSpec.describe API::Ci::Pipelines do
   let_it_be(:user) { create(:user) }
   let_it_be(:non_member) { create(:user) }