Merge branch 'move-finders-into-ci-namespace' into 'master'

Move finders related to CI under the namespace

See merge request gitlab-org/gitlab!27190

app/controllers/admin/jobs_controller.rb

@@ -3,10 +3,10 @@
 class Admin::JobsController < Admin::ApplicationController
   def index
     # We need all builds for tabs counters
-    @all_builds = JobsFinder.new(current_user: current_user).execute
+    @all_builds = Ci::JobsFinder.new(current_user: current_user).execute
 
     @scope = params[:scope]
-    @builds = JobsFinder.new(current_user: current_user, params: params).execute
+    @builds = Ci::JobsFinder.new(current_user: current_user, params: params).execute
     @builds = @builds.eager_load_everything
     @builds = @builds.page(params[:page]).per(30)
   end

app/controllers/projects/jobs_controller.rb

@@ -19,10 +19,10 @@ class Projects::JobsController < Projects::ApplicationController
 
   def index
     # We need all builds for tabs counters
-    @all_builds = JobsFinder.new(current_user: current_user, project: @project).execute
+    @all_builds = Ci::JobsFinder.new(current_user: current_user, project: @project).execute
 
     @scope = params[:scope]
-    @builds = JobsFinder.new(current_user: current_user, project: @project, params: params).execute
+    @builds = Ci::JobsFinder.new(current_user: current_user, project: @project, params: params).execute
     @builds = @builds.eager_load_everything
     @builds = @builds.page(params[:page]).per(30).without_count
   end

app/controllers/projects/pipeline_schedules_controller.rb

@@ -13,8 +13,8 @@ class Projects::PipelineSchedulesController < Projects::ApplicationController
   # rubocop: disable CodeReuse/ActiveRecord
   def index
     @scope = params[:scope]
-    @all_schedules = PipelineSchedulesFinder.new(@project).execute
-    @schedules = PipelineSchedulesFinder.new(@project).execute(scope: params[:scope])
+    @all_schedules = Ci::PipelineSchedulesFinder.new(@project).execute
+    @schedules = Ci::PipelineSchedulesFinder.new(@project).execute(scope: params[:scope])
       .includes(:last_pipeline)
   end
   # rubocop: enable CodeReuse/ActiveRecord

app/controllers/projects/pipelines_controller.rb

@@ -22,7 +22,7 @@ class Projects::PipelinesController < Projects::ApplicationController
 
   def index
     @scope = params[:scope]
-    @pipelines = PipelinesFinder
+    @pipelines = Ci::PipelinesFinder
       .new(project, current_user, scope: @scope)
       .execute
       .page(params[:page])
@@ -251,7 +251,7 @@ class Projects::PipelinesController < Projects::ApplicationController
   end
 
   def limited_pipelines_count(project, scope = nil)
-    finder = PipelinesFinder.new(project, current_user, scope: scope)
+    finder = Ci::PipelinesFinder.new(project, current_user, scope: scope)
 
     view_context.limited_counter_with_delimiter(finder.execute)
   end

app/finders/ci/jobs_finder.rb

+# frozen_string_literal: true
+
+module Ci
+  class JobsFinder
+    include Gitlab::Allowable
+
+    def initialize(current_user:, project: nil, params: {})
+      @current_user = current_user
+      @project = project
+      @params = params
+    end
+
+    def execute
+      builds = init_collection.order_id_desc
+      filter_by_scope(builds)
+    rescue Gitlab::Access::AccessDeniedError
+      Ci::Build.none
+    end
+
+    private
+
+    attr_reader :current_user, :project, :params
+
+    def init_collection
+      project ? project_builds : all_builds
+    end
+
+    def all_builds
+      raise Gitlab::Access::AccessDeniedError unless current_user&.admin?
+
+      Ci::Build.all
+    end
+
+    def project_builds
+      raise Gitlab::Access::AccessDeniedError unless can?(current_user, :read_build, project)
+
+      project.builds.relevant
+    end
+
+    def filter_by_scope(builds)
+      case params[:scope]
+      when 'pending'
+        builds.pending.reverse_order
+      when 'running'
+        builds.running.reverse_order
+      when 'finished'
+        builds.finished
+      else
+        builds
+      end
+    end
+  end
+end

app/finders/ci/pipeline_schedules_finder.rb

+# frozen_string_literal: true
+
+module Ci
+  class PipelineSchedulesFinder
+    attr_reader :project, :pipeline_schedules
+
+    def initialize(project)
+      @project = project
+      @pipeline_schedules = project.pipeline_schedules
+    end
+
+    # rubocop: disable CodeReuse/ActiveRecord
+    def execute(scope: nil)
+      scoped_schedules =
+        case scope
+        when 'active'
+          pipeline_schedules.active
+        when 'inactive'
+          pipeline_schedules.inactive
+        else
+          pipeline_schedules
+        end
+
+      scoped_schedules.order(id: :desc)
+    end
+    # rubocop: enable CodeReuse/ActiveRecord
+  end
+end

app/finders/ci/pipelines_finder.rb

+# frozen_string_literal: true
+
+module Ci
+  class PipelinesFinder
+    attr_reader :project, :pipelines, :params, :current_user
+
+    ALLOWED_INDEXED_COLUMNS = %w[id status ref updated_at user_id].freeze
+
+    def initialize(project, current_user, params = {})
+      @project = project
+      @current_user = current_user
+      @pipelines = project.all_pipelines
+      @params = params
+    end
+
+    def execute
+      unless Ability.allowed?(current_user, :read_pipeline, project)
+        return Ci::Pipeline.none
+      end
+
+      items = pipelines.no_child
+      items = by_scope(items)
+      items = by_status(items)
+      items = by_ref(items)
+      items = by_sha(items)
+      items = by_name(items)
+      items = by_username(items)
+      items = by_yaml_errors(items)
+      items = by_updated_at(items)
+      sort_items(items)
+    end
+
+    private
+
+    # rubocop: disable CodeReuse/ActiveRecord
+    def ids_for_ref(refs)
+      pipelines.where(ref: refs).group(:ref).select('max(id)')
+    end
+    # rubocop: enable CodeReuse/ActiveRecord
+
+    # rubocop: disable CodeReuse/ActiveRecord
+    def from_ids(ids)
+      pipelines.unscoped.where(project_id: project.id, id: ids)
+    end
+    # rubocop: enable CodeReuse/ActiveRecord
+
+    def branches
+      project.repository.branch_names
+    end
+
+    def tags
+      project.repository.tag_names
+    end
+
+    def by_scope(items)
+      case params[:scope]
+      when 'running'
+        items.running
+      when 'pending'
+        items.pending
+      when 'finished'
+        items.finished
+      when 'branches'
+        from_ids(ids_for_ref(branches))
+      when 'tags'
+        from_ids(ids_for_ref(tags))
+      else
+        items
+      end
+    end
+
+    # rubocop: disable CodeReuse/ActiveRecord
+    def by_status(items)
+      return items unless HasStatus::AVAILABLE_STATUSES.include?(params[:status])
+
+      items.where(status: params[:status])
+    end
+    # rubocop: enable CodeReuse/ActiveRecord
+
+    # rubocop: disable CodeReuse/ActiveRecord
+    def by_ref(items)
+      if params[:ref].present?
+        items.where(ref: params[:ref])
+      else
+        items
+      end
+    end
+    # rubocop: enable CodeReuse/ActiveRecord
+
+    # rubocop: disable CodeReuse/ActiveRecord
+    def by_sha(items)
+      if params[:sha].present?
+        items.where(sha: params[:sha])
+      else
+        items
+      end
+    end
+    # rubocop: enable CodeReuse/ActiveRecord
+
+    # rubocop: disable CodeReuse/ActiveRecord
+    def by_name(items)
+      if params[:name].present?
+        items.joins(:user).where(users: { name: params[:name] })
+      else
+        items
+      end
+    end
+    # rubocop: enable CodeReuse/ActiveRecord
+
+    # rubocop: disable CodeReuse/ActiveRecord
+    def by_username(items)
+      if params[:username].present?
+        items.joins(:user).where(users: { username: params[:username] })
+      else
+        items
+      end
+    end
+    # rubocop: enable CodeReuse/ActiveRecord
+
+    # rubocop: disable CodeReuse/ActiveRecord
+    def by_yaml_errors(items)
+      case Gitlab::Utils.to_boolean(params[:yaml_errors])
+      when true
+        items.where("yaml_errors IS NOT NULL")
+      when false
+        items.where("yaml_errors IS NULL")
+      else
+        items
+      end
+    end
+    # rubocop: enable CodeReuse/ActiveRecord
+
+    def by_updated_at(items)
+      items = items.updated_before(params[:updated_before]) if params[:updated_before].present?
+      items = items.updated_after(params[:updated_after]) if params[:updated_after].present?
+
+      items
+    end
+
+    # rubocop: disable CodeReuse/ActiveRecord
+    def sort_items(items)
+      order_by = if ALLOWED_INDEXED_COLUMNS.include?(params[:order_by])
+                   params[:order_by]
+                 else
+                   :id
+                 end
+
+      sort = if params[:sort] =~ /\A(ASC|DESC)\z/i
+               params[:sort]
+             else
+               :desc
+             end
+
+      items.order(order_by => sort)
+    end
+    # rubocop: enable CodeReuse/ActiveRecord
+  end
+end

app/finders/ci/runner_jobs_finder.rb

+# frozen_string_literal: true
+
+module Ci
+  class RunnerJobsFinder
+    attr_reader :runner, :params
+
+    ALLOWED_INDEXED_COLUMNS = %w[id].freeze
+
+    def initialize(runner, params = {})
+      @runner = runner
+      @params = params
+    end
+
+    def execute
+      items = @runner.builds
+      items = by_status(items)
+      sort_items(items)
+    end
+
+    private
+
+    # rubocop: disable CodeReuse/ActiveRecord
+    def by_status(items)
+      return items unless HasStatus::AVAILABLE_STATUSES.include?(params[:status])
+
+      items.where(status: params[:status])
+    end
+    # rubocop: enable CodeReuse/ActiveRecord
+
+    # rubocop: disable CodeReuse/ActiveRecord
+    def sort_items(items)
+      return items unless ALLOWED_INDEXED_COLUMNS.include?(params[:order_by])
+
+      order_by = params[:order_by]
+      sort = if /\A(ASC|DESC)\z/i.match?(params[:sort])
+               params[:sort]
+             else
+               :desc
+             end
+
+      items.order(order_by => sort)
+    end
+    # rubocop: enable CodeReuse/ActiveRecord
+  end
+end

app/finders/jobs_finder.rb

-# frozen_string_literal: true
-
-class JobsFinder
-  include Gitlab::Allowable
-
-  def initialize(current_user:, project: nil, params: {})
-    @current_user = current_user
-    @project = project
-    @params = params
-  end
-
-  def execute
-    builds = init_collection.order_id_desc
-    filter_by_scope(builds)
-  rescue Gitlab::Access::AccessDeniedError
-    Ci::Build.none
-  end
-
-  private
-
-  attr_reader :current_user, :project, :params
-
-  def init_collection
-    project ? project_builds : all_builds
-  end
-
-  def all_builds
-    raise Gitlab::Access::AccessDeniedError unless current_user&.admin?
-
-    Ci::Build.all
-  end
-
-  def project_builds
-    raise Gitlab::Access::AccessDeniedError unless can?(current_user, :read_build, project)
-
-    project.builds.relevant
-  end
-
-  def filter_by_scope(builds)
-    case params[:scope]
-    when 'pending'
-      builds.pending.reverse_order
-    when 'running'
-      builds.running.reverse_order
-    when 'finished'
-      builds.finished
-    else
-      builds
-    end
-  end
-end

app/finders/pipeline_schedules_finder.rb

-# frozen_string_literal: true
-
-class PipelineSchedulesFinder
-  attr_reader :project, :pipeline_schedules
-
-  def initialize(project)
-    @project = project
-    @pipeline_schedules = project.pipeline_schedules
-  end
-
-  # rubocop: disable CodeReuse/ActiveRecord
-  def execute(scope: nil)
-    scoped_schedules =
-      case scope
-      when 'active'
-        pipeline_schedules.active
-      when 'inactive'
-        pipeline_schedules.inactive
-      else
-        pipeline_schedules
-      end
-
-    scoped_schedules.order(id: :desc)
-  end
-  # rubocop: enable CodeReuse/ActiveRecord
-end

app/finders/pipelines_finder.rb

-# frozen_string_literal: true
-
-class PipelinesFinder
-  attr_reader :project, :pipelines, :params, :current_user
-
-  ALLOWED_INDEXED_COLUMNS = %w[id status ref updated_at user_id].freeze
-
-  def initialize(project, current_user, params = {})
-    @project = project
-    @current_user = current_user
-    @pipelines = project.all_pipelines
-    @params = params
-  end
-
-  def execute
-    unless Ability.allowed?(current_user, :read_pipeline, project)
-      return Ci::Pipeline.none
-    end
-
-    items = pipelines.no_child
-    items = by_scope(items)
-    items = by_status(items)
-    items = by_ref(items)
-    items = by_sha(items)
-    items = by_name(items)
-    items = by_username(items)
-    items = by_yaml_errors(items)
-    items = by_updated_at(items)
-    sort_items(items)
-  end
-
-  private
-
-  # rubocop: disable CodeReuse/ActiveRecord
-  def ids_for_ref(refs)
-    pipelines.where(ref: refs).group(:ref).select('max(id)')
-  end
-  # rubocop: enable CodeReuse/ActiveRecord
-
-  # rubocop: disable CodeReuse/ActiveRecord
-  def from_ids(ids)
-    pipelines.unscoped.where(project_id: project.id, id: ids)
-  end
-  # rubocop: enable CodeReuse/ActiveRecord
-
-  def branches
-    project.repository.branch_names
-  end
-
-  def tags
-    project.repository.tag_names
-  end
-
-  def by_scope(items)
-    case params[:scope]
-    when 'running'
-      items.running
-    when 'pending'
-      items.pending
-    when 'finished'
-      items.finished
-    when 'branches'
-      from_ids(ids_for_ref(branches))
-    when 'tags'
-      from_ids(ids_for_ref(tags))
-    else
-      items
-    end
-  end
-
-  # rubocop: disable CodeReuse/ActiveRecord
-  def by_status(items)
-    return items unless HasStatus::AVAILABLE_STATUSES.include?(params[:status])
-
-    items.where(status: params[:status])
-  end
-  # rubocop: enable CodeReuse/ActiveRecord
-
-  # rubocop: disable CodeReuse/ActiveRecord
-  def by_ref(items)
-    if params[:ref].present?
-      items.where(ref: params[:ref])
-    else
-      items
-    end
-  end
-  # rubocop: enable CodeReuse/ActiveRecord
-
-  # rubocop: disable CodeReuse/ActiveRecord
-  def by_sha(items)
-    if params[:sha].present?
-      items.where(sha: params[:sha])
-    else
-      items
-    end
-  end
-  # rubocop: enable CodeReuse/ActiveRecord
-
-  # rubocop: disable CodeReuse/ActiveRecord
-  def by_name(items)
-    if params[:name].present?
-      items.joins(:user).where(users: { name: params[:name] })
-    else
-      items
-    end
-  end
-  # rubocop: enable CodeReuse/ActiveRecord
-
-  # rubocop: disable CodeReuse/ActiveRecord
-  def by_username(items)
-    if params[:username].present?
-      items.joins(:user).where(users: { username: params[:username] })
-    else
-      items
-    end
-  end
-  # rubocop: enable CodeReuse/ActiveRecord
-
-  # rubocop: disable CodeReuse/ActiveRecord
-  def by_yaml_errors(items)
-    case Gitlab::Utils.to_boolean(params[:yaml_errors])
-    when true
-      items.where("yaml_errors IS NOT NULL")
-    when false
-      items.where("yaml_errors IS NULL")
-    else
-      items
-    end
-  end
-  # rubocop: enable CodeReuse/ActiveRecord
-
-  def by_updated_at(items)
-    items = items.updated_before(params[:updated_before]) if params[:updated_before].present?
-    items = items.updated_after(params[:updated_after]) if params[:updated_after].present?
-
-    items
-  end
-
-  # rubocop: disable CodeReuse/ActiveRecord
-  def sort_items(items)
-    order_by = if ALLOWED_INDEXED_COLUMNS.include?(params[:order_by])
-                 params[:order_by]
-               else
-                 :id
-               end
-
-    sort = if params[:sort] =~ /\A(ASC|DESC)\z/i
-             params[:sort]
-           else
-             :desc
-           end
-
-    items.order(order_by => sort)
-  end
-  # rubocop: enable CodeReuse/ActiveRecord
-end

app/finders/runner_jobs_finder.rb

-# frozen_string_literal: true
-
-class RunnerJobsFinder
-  attr_reader :runner, :params
-
-  ALLOWED_INDEXED_COLUMNS = %w[id].freeze
-
-  def initialize(runner, params = {})
-    @runner = runner
-    @params = params
-  end
-
-  def execute
-    items = @runner.builds
-    items = by_status(items)
-    sort_items(items)
-  end
-
-  private
-
-  # rubocop: disable CodeReuse/ActiveRecord
-  def by_status(items)
-    return items unless HasStatus::AVAILABLE_STATUSES.include?(params[:status])
-
-    items.where(status: params[:status])
-  end
-  # rubocop: enable CodeReuse/ActiveRecord
-
-  # rubocop: disable CodeReuse/ActiveRecord
-  def sort_items(items)
-    return items unless ALLOWED_INDEXED_COLUMNS.include?(params[:order_by])
-
-    order_by = params[:order_by]
-    sort = if /\A(ASC|DESC)\z/i.match?(params[:sort])
-             params[:sort]
-           else
-             :desc
-           end
-
-    items.order(order_by => sort)
-  end
-  # rubocop: enable CodeReuse/ActiveRecord
-end

app/graphql/resolvers/concerns/resolves_pipelines.rb

@@ -30,6 +30,6 @@ module ResolvesPipelines
   end
 
   def resolve_pipelines(project, params = {})
-    PipelinesFinder.new(project, context[:current_user], params).execute
+    Ci::PipelinesFinder.new(project, context[:current_user], params).execute
   end
 end

lib/api/pipeline_schedules.rb

@@ -22,7 +22,7 @@ module API
       get ':id/pipeline_schedules' do
         authorize! :read_pipeline_schedule, user_project
 
-        schedules = PipelineSchedulesFinder.new(user_project).execute(scope: params[:scope])
+        schedules = Ci::PipelineSchedulesFinder.new(user_project).execute(scope: params[:scope])
           .preload([:owner, :last_pipeline])
         present paginate(schedules), with: Entities::PipelineSchedule
       end

lib/api/pipelines.rb

@@ -27,7 +27,7 @@ module API
         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: PipelinesFinder::ALLOWED_INDEXED_COLUMNS, default: 'id',
+        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'
@@ -36,7 +36,7 @@ module API
         authorize! :read_pipeline, user_project
         authorize! :read_build, user_project
 
-        pipelines = PipelinesFinder.new(user_project, current_user, params).execute
+        pipelines = Ci::PipelinesFinder.new(user_project, current_user, params).execute
         present paginate(pipelines), with: Entities::PipelineBasic
       end
 

lib/api/runners.rb

@@ -115,7 +115,7 @@ module API
       params do
         requires :id, type: Integer, desc: 'The ID of the runner'
         optional :status, type: String, desc: 'Status of the job', values: Ci::Build::AVAILABLE_STATUSES
-        optional :order_by, type: String, desc: 'Order by `id` or not', values: RunnerJobsFinder::ALLOWED_INDEXED_COLUMNS
+        optional :order_by, type: String, desc: 'Order by `id` or not', values: Ci::RunnerJobsFinder::ALLOWED_INDEXED_COLUMNS
         optional :sort, type: String, values: %w[asc desc], default: 'desc', desc: 'Sort by asc (ascending) or desc (descending)'
         use :pagination
       end
@@ -123,7 +123,7 @@ module API
         runner = get_runner(params[:id])
         authenticate_list_runners_jobs!(runner)
 
-        jobs = RunnerJobsFinder.new(runner, params).execute
+        jobs = Ci::RunnerJobsFinder.new(runner, params).execute
 
         present paginate(jobs), with: Entities::JobBasicWithProject
       end

spec/finders/jobs_finder_spec.rb → spec/finders/ci/jobs_finder_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe JobsFinder, '#execute' do
+describe Ci::JobsFinder, '#execute' do
   let_it_be(:user) { create(:user) }
   let_it_be(:admin) { create(:user, :admin) }
   let_it_be(:project) { create(:project, :private, public_builds: false) }

spec/finders/pipeline_schedules_finder_spec.rb → spec/finders/ci/pipeline_schedules_finder_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe PipelineSchedulesFinder do
+describe Ci::PipelineSchedulesFinder do
   let(:project) { create(:project) }
 
   let!(:active_schedule) { create(:ci_pipeline_schedule, project: project) }

spec/finders/pipelines_finder_spec.rb → spec/finders/ci/pipelines_finder_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe PipelinesFinder do
+describe Ci::PipelinesFinder do
   let(:project) { create(:project, :public, :repository) }
   let(:current_user) { nil }
   let(:params) { {} }

spec/finders/runner_jobs_finder_spec.rb → spec/finders/ci/runner_jobs_finder_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe RunnerJobsFinder do
+describe Ci::RunnerJobsFinder do
   let(:project) { create(:project) }
   let(:runner) { create(:ci_runner, :instance) }