path: root/spec/finders/ci/runners_finder_spec.rb

# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Ci::RunnersFinder, feature_category: :fleet_visibility do
  context 'admin' do
    let_it_be(:admin) { create(:user, :admin) }

    describe '#execute' do
      shared_examples 'executes as admin' do
        context 'with 2 runners' do
          let_it_be(:runner1) { create(:ci_runner, active: true) }
          let_it_be(:runner2) { create(:ci_runner, active: false) }

          context 'with empty params' do
            it 'returns all runners' do
              expect(Ci::Runner).to receive(:with_tags).and_call_original
              expect(described_class.new(current_user: admin, params: {}).execute).to match_array [runner1, runner2]
            end
          end

          context 'with nil group' do
            it 'returns all runners' do
              expect(Ci::Runner).to receive(:with_tags).and_call_original
              expect(described_class.new(current_user: admin, params: { group: nil }).execute).to match_array [runner1, runner2]
            end
          end

          context 'with preload param set to :tag_name true' do
            it 'requests tags' do
              expect(Ci::Runner).to receive(:with_tags).and_call_original
              expect(described_class.new(current_user: admin, params: { preload: { tag_name: true } }).execute).to match_array [runner1, runner2]
            end
          end

          context 'with preload param set to :tag_name false' do
            it 'does not request tags' do
              expect(Ci::Runner).not_to receive(:with_tags)
              expect(described_class.new(current_user: admin, params: { preload: { tag_name: false } }).execute).to match_array [runner1, runner2]
            end
          end
        end

        context 'filtering' do
          context 'by search term' do
            it 'calls Ci::Runner.search' do
              expect(Ci::Runner).to receive(:search).with('term').and_call_original

              described_class.new(current_user: admin, params: { search: 'term' }).execute
            end
          end

          context 'by upgrade status' do
            let(:upgrade_status) {}

            let_it_be(:runner1) { create(:ci_runner, version: 'a') }
            let_it_be(:runner2) { create(:ci_runner, version: 'b') }
            let_it_be(:runner3) { create(:ci_runner, version: 'c') }
            let_it_be(:runner_version_recommended) do
              create(:ci_runner_version, version: 'a', status: :recommended)
            end

            let_it_be(:runner_version_unavailable) do
              create(:ci_runner_version, version: 'b', status: :unavailable)
            end

            let_it_be(:runner_version_available) do
              create(:ci_runner_version, version: 'c', status: :available)
            end

            def execute
              described_class.new(current_user: admin, params: { upgrade_status: upgrade_status }).execute
            end

            Ci::RunnerVersion.statuses.keys.map(&:to_sym).each do |status|
              context "set to :#{status}" do
                let(:upgrade_status) { status }

                it "calls with_upgrade_status scope with corresponding :#{status} status" do
                  if [:available, :unavailable, :recommended].include?(status)
                    expected_result = Ci::Runner.with_upgrade_status(status)
                  end

                  expect(Ci::Runner).to receive(:with_upgrade_status).with(status).and_call_original

                  result = execute

                  expect(result).to match_array(expected_result) if expected_result
                end
              end
            end

            context 'set to an invalid value' do
              let(:upgrade_status) { :some_invalid_status }

              it 'raises ArgumentError' do
                expect { execute }.to raise_error(ArgumentError)
              end
            end

            context 'set to nil' do
              let(:upgrade_status) { nil }

              it 'does not call with_upgrade_status' do
                expect(Ci::Runner).not_to receive(:with_upgrade_status)

                expect(execute).to match_array(Ci::Runner.all)
              end
            end
          end

          context 'by status' do
            Ci::Runner::AVAILABLE_STATUSES.each do |status|
              it "calls the corresponding :#{status} scope on Ci::Runner" do
                expect(Ci::Runner).to receive(:with_status).with(status).and_call_original

                described_class.new(current_user: admin, params: { status_status: status }).execute
              end
            end
          end

          context 'by active status' do
            it 'with active set as false calls the corresponding scope on Ci::Runner with false' do
              expect(Ci::Runner).to receive(:active).with(false).and_call_original

              described_class.new(current_user: admin, params: { active: false }).execute
            end

            it 'with active set as true calls the corresponding scope on Ci::Runner with true' do
              expect(Ci::Runner).to receive(:active).with(true).and_call_original

              described_class.new(current_user: admin, params: { active: true }).execute
            end
          end

          context 'by runner type' do
            Ci::Runner.runner_types.each_key do |runner_type|
              context "when runner type is #{runner_type}" do
                it "calls the corresponding scope on Ci::Runner" do
                  expect(Ci::Runner).to receive(:with_runner_type).with(runner_type).and_call_original

                  described_class.new(current_user: admin, params: { type_type: runner_type }).execute
                end
              end
            end
          end

          context 'by tag_name' do
            it 'calls the corresponding scope on Ci::Runner' do
              expect(Ci::Runner).to receive(:tagged_with).with(%w[tag1 tag2]).and_call_original

              described_class.new(current_user: admin, params: { tag_name: %w[tag1 tag2] }).execute
            end
          end

          context 'by creator' do
            it 'calls the corresponding scope on Ci::Runner' do
              expect(Ci::Runner).to receive(:with_creator_id).with('1').and_call_original

              described_class.new(current_user: admin, params: { creator_id: '1' }).execute
            end
          end

          context 'by version' do
            it 'calls the corresponding scope on Ci::Runner' do
              expect(Ci::Runner).to receive(:with_version_prefix).with('15.').and_call_original

              described_class.new(current_user: admin, params: { version_prefix: '15.' }).execute
            end
          end
        end

        context 'sorting' do
          let_it_be(:runner1) { create :ci_runner, created_at: '2018-07-12 07:00', contacted_at: 1.minute.ago, token_expires_at: '2022-02-15 07:00' }
          let_it_be(:runner2) { create :ci_runner, created_at: '2018-07-12 08:00', contacted_at: 3.minutes.ago, token_expires_at: '2022-02-15 06:00' }
          let_it_be(:runner3) { create :ci_runner, created_at: '2018-07-12 09:00', contacted_at: 2.minutes.ago }

          subject do
            described_class.new(current_user: admin, params: params).execute
          end

          shared_examples 'sorts by created_at descending' do
            it 'sorts by created_at descending' do
              is_expected.to eq [runner3, runner2, runner1]
            end
          end

          context 'without sort param' do
            let(:params) { {} }

            it_behaves_like 'sorts by created_at descending'
          end

          %w[created_date created_at_desc].each do |sort|
            context "with sort param equal to #{sort}" do
              let(:params) { { sort: sort } }

              it_behaves_like 'sorts by created_at descending'
            end
          end

          context 'with sort param equal to created_at_asc' do
            let(:params) { { sort: 'created_at_asc' } }

            it 'sorts by created_at ascending' do
              is_expected.to eq [runner1, runner2, runner3]
            end
          end

          context 'with sort param equal to contacted_asc' do
            let(:params) { { sort: 'contacted_asc' } }

            it 'sorts by contacted_at ascending' do
              is_expected.to eq [runner2, runner3, runner1]
            end
          end

          context 'with sort param equal to contacted_desc' do
            let(:params) { { sort: 'contacted_desc' } }

            it 'sorts by contacted_at descending' do
              is_expected.to eq [runner1, runner3, runner2]
            end
          end

          context 'with sort param equal to token_expires_at_asc' do
            let(:params) { { sort: 'token_expires_at_asc' } }

            it 'sorts by contacted_at ascending' do
              is_expected.to eq [runner2, runner1, runner3]
            end
          end

          context 'with sort param equal to token_expires_at_desc' do
            let(:params) { { sort: 'token_expires_at_desc' } }

            it 'sorts by contacted_at descending' do
              is_expected.to eq [runner3, runner1, runner2]
            end
          end
        end
      end

      shared_examples 'executes as normal user' do
        it 'raises Gitlab::Access::AccessDeniedError' do
          user = create :user
          create :ci_runner, active: true
          create :ci_runner, active: false

          expect do
            described_class.new(current_user: user, params: {}).execute
          end.to raise_error(Gitlab::Access::AccessDeniedError)
        end
      end

      context 'when admin mode setting is disabled', :do_not_mock_admin_mode_setting do
        it_behaves_like 'executes as admin'
      end

      context 'when admin mode setting is enabled' do
        context 'when in admin mode', :enable_admin_mode do
          it_behaves_like 'executes as admin'
        end

        context 'when not in admin mode' do
          it_behaves_like 'executes as normal user'
        end
      end

      context 'by non admin user' do
        it_behaves_like 'executes as normal user'
      end

      context 'when user is nil' do
        it 'raises Gitlab::Access::AccessDeniedError' do
          user = nil
          create :ci_runner, active: true
          create :ci_runner, active: false

          expect do
            described_class.new(current_user: user, params: {}).execute
          end.to raise_error(Gitlab::Access::AccessDeniedError)
        end
      end
    end
  end

  context 'group' do
    let_it_be(:user) { create(:user) }
    let_it_be(:group) { create(:group) }
    let_it_be(:sub_group_1) { create(:group, parent: group) }
    let_it_be(:sub_group_2) { create(:group, parent: group) }
    let_it_be(:sub_group_3) { create(:group, parent: sub_group_1) }
    let_it_be(:sub_group_4) { create(:group, parent: sub_group_3) }
    let_it_be(:project) { create(:project, group: group) }
    let_it_be(:project_2) { create(:project, group: group) }
    let_it_be(:project_3) { create(:project, group: sub_group_1) }
    let_it_be(:project_4) { create(:project, group: sub_group_2) }
    let_it_be(:project_5) { create(:project, group: sub_group_3) }
    let_it_be(:project_6) { create(:project, group: sub_group_4) }
    let_it_be(:runner_instance) { create(:ci_runner, :instance, contacted_at: 13.minutes.ago) }
    let_it_be(:runner_group) { create(:ci_runner, :group, contacted_at: 12.minutes.ago) }
    let_it_be(:runner_sub_group_1) { create(:ci_runner, :group, active: false, contacted_at: 11.minutes.ago) }
    let_it_be(:runner_sub_group_2) { create(:ci_runner, :group, contacted_at: 10.minutes.ago) }
    let_it_be(:runner_sub_group_3) { create(:ci_runner, :group, contacted_at: 9.minutes.ago) }
    let_it_be(:runner_sub_group_4) { create(:ci_runner, :group, contacted_at: 8.minutes.ago) }
    let_it_be(:runner_project_1) { create(:ci_runner, :project, contacted_at: 7.minutes.ago, projects: [project]) }
    let_it_be(:runner_project_2) { create(:ci_runner, :project, contacted_at: 6.minutes.ago, projects: [project_2]) }
    let_it_be(:runner_project_3) { create(:ci_runner, :project, contacted_at: 5.minutes.ago, description: 'runner_project_search', projects: [project, project_2]) }
    let_it_be(:runner_project_4) { create(:ci_runner, :project, contacted_at: 4.minutes.ago, projects: [project_3]) }
    let_it_be(:runner_project_5) { create(:ci_runner, :project, contacted_at: 3.minutes.ago, tag_list: %w[runner_tag], projects: [project_4]) }
    let_it_be(:runner_project_6) { create(:ci_runner, :project, contacted_at: 2.minutes.ago, projects: [project_5]) }
    let_it_be(:runner_project_7) { create(:ci_runner, :project, contacted_at: 1.minute.ago, projects: [project_6]) }
    let_it_be(:runner_manager_1) { create(:ci_runner_machine, runner: runner_sub_group_1, version: '15.11.0') }
    let_it_be(:runner_manager_2) { create(:ci_runner_machine, runner: runner_sub_group_2, version: '15.11.1') }
    let_it_be(:runner_manager_3) { create(:ci_runner_machine, runner: runner_sub_group_3, version: '15.10.1') }

    let(:target_group) { nil }
    let(:membership) { nil }
    let(:extra_params) { {} }
    let(:params) { { group: target_group, membership: membership }.merge(extra_params).reject { |_, v| v.nil? } }

    before do
      group.runners << runner_group
      sub_group_1.runners << runner_sub_group_1
      sub_group_2.runners << runner_sub_group_2
      sub_group_3.runners << runner_sub_group_3
      sub_group_4.runners << runner_sub_group_4
    end

    describe '#execute' do
      subject(:execute) { described_class.new(current_user: user, params: params).execute }

      shared_examples 'membership equal to :descendants' do
        it 'returns all descendant runners' do
          is_expected.to contain_exactly(
            runner_project_7, runner_project_6, runner_project_5,
            runner_project_4, runner_project_3, runner_project_2,
            runner_project_1, runner_sub_group_4, runner_sub_group_3,
            runner_sub_group_2, runner_sub_group_1, runner_group)
        end
      end

      context 'with user is group maintainer or owner' do
        where(:user_role) do
          [GroupMember::OWNER, GroupMember::MAINTAINER]
        end

        with_them do
          before do
            group.add_member(user, user_role)
          end

          context 'with :group as target group' do
            let(:target_group) { group }

            context 'passing no membership params' do
              it_behaves_like 'membership equal to :descendants'
            end

            context 'with :descendants membership' do
              let(:membership) { :descendants }

              it_behaves_like 'membership equal to :descendants'
            end

            context 'with :direct membership' do
              let(:membership) { :direct }

              it 'returns runners belonging to group' do
                is_expected.to contain_exactly(runner_group)
              end
            end

            context 'with :all_available membership' do
              let(:membership) { :all_available }

              it 'returns runners available to group' do
                is_expected.to contain_exactly(
                  runner_project_7, runner_project_6, runner_project_5,
                  runner_project_4, runner_project_3, runner_project_2,
                  runner_project_1, runner_sub_group_4, runner_sub_group_3,
                  runner_sub_group_2, runner_sub_group_1, runner_group, runner_instance)
              end
            end

            context 'with unknown membership' do
              let(:membership) { :unsupported }

              it 'raises an error' do
                expect { subject }.to raise_error(ArgumentError, 'Invalid membership filter')
              end
            end

            context 'with nil group' do
              let(:target_group) { nil }

              it 'raises Gitlab::Access::AccessDeniedError' do
                # Query should run against all runners, however since user is not admin, we raise an error
                expect { execute }.to raise_error(Gitlab::Access::AccessDeniedError)
              end
            end

            context 'with sort param' do
              let(:extra_params) { { sort: 'contacted_asc' } }

              it 'sorts by specified attribute' do
                expect(subject).to eq([runner_group, runner_sub_group_1, runner_sub_group_2,
                                      runner_sub_group_3, runner_sub_group_4, runner_project_1,
                                      runner_project_2, runner_project_3, runner_project_4,
                                      runner_project_5, runner_project_6, runner_project_7])
              end
            end

            context 'filtering' do
              context 'by search term' do
                let(:extra_params) { { search: 'runner_project_search' } }

                it 'returns correct runner' do
                  expect(subject).to match_array([runner_project_3])
                end
              end

              context 'by active status' do
                let(:extra_params) { { active: false } }

                it 'returns correct runner' do
                  expect(subject).to match_array([runner_sub_group_1])
                end
              end

              context 'by status' do
                let(:extra_params) { { status_status: 'paused' } }

                it 'returns correct runner' do
                  expect(subject).to match_array([runner_sub_group_1])
                end
              end

              context 'by tag_name' do
                let(:extra_params) { { tag_name: %w[runner_tag] } }

                it 'returns correct runner' do
                  expect(subject).to match_array([runner_project_5])
                end
              end

              context 'by runner type' do
                let(:extra_params) { { type_type: 'project_type' } }

                it 'returns correct runners' do
                  expect(subject).to eq([runner_project_7, runner_project_6,
                                        runner_project_5, runner_project_4,
                                        runner_project_3, runner_project_2, runner_project_1])
                end
              end

              context 'by version prefix' do
                context 'search by major version' do
                  let(:extra_params) { { version_prefix: '15.' } }

                  it 'returns correct runner' do
                    is_expected.to contain_exactly(runner_sub_group_1, runner_sub_group_2, runner_sub_group_3)
                  end
                end

                context 'search by minor version' do
                  let(:extra_params) { { version_prefix: '15.11.' } }

                  it 'returns correct runner' do
                    is_expected.to contain_exactly(runner_sub_group_1, runner_sub_group_2)
                  end
                end

                context 'search by patch version' do
                  let(:extra_params) { { version_prefix: '15.11.1' } }

                  it 'returns correct runner' do
                    is_expected.to contain_exactly(runner_sub_group_2)
                  end
                end
              end
            end
          end
        end
      end

      context 'when user is group developer or below' do
        where(:user_role) do
          [GroupMember::DEVELOPER, GroupMember::REPORTER, GroupMember::GUEST]
        end

        with_them do
          before do
            group.add_member(user, user_role)
          end

          context 'with :sub_group_1 as target group' do
            let(:target_group) { sub_group_1 }

            it 'raises Gitlab::Access::AccessDeniedError' do
              expect { execute }.to raise_error(Gitlab::Access::AccessDeniedError)
            end
          end

          context 'with :group as target group' do
            let(:target_group) { group }

            it 'raises Gitlab::Access::AccessDeniedError' do
              expect { execute }.to raise_error(Gitlab::Access::AccessDeniedError)
            end

            context 'with :all_available membership' do
              let(:membership) { :all_available }

              it 'raises Gitlab::Access::AccessDeniedError' do
                expect { execute }.to raise_error(Gitlab::Access::AccessDeniedError)
              end
            end
          end
        end
      end

      context 'when user has no access' do
        it 'raises Gitlab::Access::AccessDeniedError' do
          expect { execute }.to raise_error(Gitlab::Access::AccessDeniedError)
        end
      end

      context 'when user is nil' do
        let(:user) { nil }

        it 'raises Gitlab::Access::AccessDeniedError' do
          expect { execute }.to raise_error(Gitlab::Access::AccessDeniedError)
        end
      end
    end

    describe '#sort_key' do
      subject(:sort_key) { described_class.new(current_user: user, params: params.merge(group: group)).sort_key }

      context 'without params' do
        it { is_expected.to eq('created_at_desc') }
      end

      context 'with params' do
        let(:extra_params) { { sort: 'contacted_asc' } }

        it { is_expected.to eq('contacted_asc') }
      end
    end
  end

  context 'project' do
    let_it_be(:user) { create(:user) }
    let_it_be(:group) { create(:group) }
    let_it_be(:project) { create(:project, group: group) }
    let_it_be(:other_project) { create(:project) }

    let(:extra_params) { {} }
    let(:params) { { project: project }.merge(extra_params).reject { |_, v| v.nil? } }

    describe '#execute' do
      subject(:execute) { described_class.new(current_user: user, params: params).execute }

      context 'with user as project admin' do
        before do
          project.add_maintainer(user)
        end

        context 'with project runners' do
          let_it_be(:runner_project) { create(:ci_runner, :project, contacted_at: 7.minutes.ago, projects: [project]) }

          it 'returns runners available to project' do
            is_expected.to match_array([runner_project])
          end
        end

        context 'with ancestor group runners' do
          let_it_be(:runner_instance) { create(:ci_runner, contacted_at: 13.minutes.ago) }
          let_it_be(:runner_group) { create(:ci_runner, :group, contacted_at: 12.minutes.ago, groups: [group]) }

          it 'returns runners available to project' do
            is_expected.to match_array([runner_instance, runner_group])
          end
        end

        context 'with allowed shared runners' do
          let_it_be(:runner_instance) { create(:ci_runner, :instance, contacted_at: 13.minutes.ago) }

          it 'returns runners available to project' do
            expect(subject).to match_array([runner_instance])
          end
        end

        context 'with project, ancestor group, and allowed shared runners' do
          let_it_be(:runner_project) { create(:ci_runner, :project, contacted_at: 7.minutes.ago, projects: [project]) }
          let_it_be(:runner_group) { create(:ci_runner, :group, contacted_at: 12.minutes.ago, groups: [group]) }
          let_it_be(:runner_instance) { create(:ci_runner, :instance, contacted_at: 13.minutes.ago) }

          it 'returns runners available to project' do
            expect(subject).to match_array([runner_project, runner_group, runner_instance])
          end
        end

        context 'filtering' do
          let_it_be(:runner_instance_inactive) { create(:ci_runner, :instance, active: false, contacted_at: 13.minutes.ago) }
          let_it_be(:runner_instance_active) { create(:ci_runner, :instance, active: true, contacted_at: 13.minutes.ago) }
          let_it_be(:runner_project_active) { create(:ci_runner, :project, contacted_at: 5.minutes.ago, active: true, projects: [project]) }
          let_it_be(:runner_project_inactive) { create(:ci_runner, :project, contacted_at: 5.minutes.ago, active: false, projects: [project]) }
          let_it_be(:runner_other_project_inactive) { create(:ci_runner, :project, contacted_at: 5.minutes.ago, active: false, projects: [other_project]) }
          let_it_be(:runner_manager) { create(:ci_runner_machine, runner: runner_instance_inactive, version: '15.10.0') }

          context 'by search term' do
            let_it_be(:runner_project_1) { create(:ci_runner, :project, contacted_at: 5.minutes.ago, description: 'runner_project_search', projects: [project]) }
            let_it_be(:runner_project_2) { create(:ci_runner, :project, contacted_at: 5.minutes.ago, description: 'runner_project', projects: [project]) }
            let_it_be(:runner_another_project) { create(:ci_runner, :project, contacted_at: 5.minutes.ago, description: 'runner_project_search', projects: [other_project]) }

            let(:extra_params) { { search: 'runner_project_search' } }

            it 'returns the correct runner' do
              expect(subject).to match_array([runner_project_1])
            end
          end

          context 'by active status' do
            let(:extra_params) { { active: false } }

            it 'returns the correct runners' do
              expect(subject).to match_array([runner_instance_inactive, runner_project_inactive])
            end
          end

          context 'by status' do
            let(:extra_params) { { status_status: 'paused' } }

            it 'returns correct runner' do
              expect(subject).to match_array([runner_instance_inactive, runner_project_inactive])
            end
          end

          context 'by tag_name' do
            let_it_be(:runner_project_1) { create(:ci_runner, :project, contacted_at: 3.minutes.ago, tag_list: %w[runner_tag], projects: [project]) }
            let_it_be(:runner_project_2) { create(:ci_runner, :project, contacted_at: 3.minutes.ago, tag_list: %w[other_tag], projects: [project]) }
            let_it_be(:runner_other_project) { create(:ci_runner, :project, contacted_at: 3.minutes.ago, tag_list: %w[runner_tag], projects: [other_project]) }

            let(:extra_params) { { tag_name: %w[runner_tag] } }

            it 'returns correct runner' do
              expect(subject).to match_array([runner_project_1])
            end
          end

          context 'by runner type' do
            let(:extra_params) { { type_type: 'project_type' } }

            it 'returns correct runners' do
              expect(subject).to match_array([runner_project_active, runner_project_inactive])
            end
          end

          context 'by creator' do
            let_it_be(:creator) { create(:user) }
            let_it_be(:runner_with_creator) { create(:ci_runner, creator: creator) }

            let(:extra_params) { { creator_id: creator.id } }

            it 'returns correct runners' do
              is_expected.to contain_exactly(runner_with_creator)
            end
          end

          context 'by version prefix' do
            let(:extra_params) { { version_prefix: '15.' } }

            it 'returns correct runners' do
              is_expected.to contain_exactly(runner_instance_inactive)
            end
          end
        end
      end

      context 'with user as project developer' do
        let(:user) { create(:user) }

        before do
          project.add_developer(user)
        end

        it 'raises Gitlab::Access::AccessDeniedError' do
          expect { execute }.to raise_error(Gitlab::Access::AccessDeniedError)
        end
      end

      context 'when user is nil' do
        let_it_be(:user) { nil }

        it 'raises Gitlab::Access::AccessDeniedError' do
          expect { execute }.to raise_error(Gitlab::Access::AccessDeniedError)
        end
      end

      context 'with nil project_full_path' do
        let(:project_full_path) { nil }

        it 'raises Gitlab::Access::AccessDeniedError' do
          expect { execute }.to raise_error(Gitlab::Access::AccessDeniedError)
        end
      end
    end
  end
end