path: root/spec/models/ci/catalog/listing_spec.rb

# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Ci::Catalog::Listing, feature_category: :pipeline_composition do
  let_it_be(:user) { create(:user) }
  let_it_be(:namespace) { create(:group) }
  let_it_be(:public_namespace_project) do
    create(:project, :public, namespace: namespace, name: 'A public namespace project')
  end

  let_it_be(:public_project) { create(:project, :public, name: 'B public test project') }
  let_it_be(:namespace_project_a) { create(:project, namespace: namespace, name: 'Test namespace project') }
  let_it_be(:namespace_project_b) { create(:project, namespace: namespace, name: 'X namespace Project') }
  let_it_be(:project_noaccess) { create(:project, namespace: namespace, name: 'Project with no access') }
  let_it_be(:internal_project) { create(:project, :internal, name: 'Internal project') }

  let_it_be(:private_project) do
    create(:project, namespace: namespace, name: 'B Project', description: 'Rspec test framework')
  end

  let(:list) { described_class.new(user) }

  before_all do
    namespace_project_a.add_reporter(user)
    namespace_project_b.add_reporter(user)
    public_namespace_project.add_reporter(user)
    public_project.add_reporter(user)
    internal_project.add_owner(user)
  end

  describe '#resources' do
    subject(:resources) { list.resources(**params) }

    let(:params) { {} }

    let_it_be(:public_resource_a) { create(:ci_catalog_resource, :published, project: public_namespace_project) }
    let_it_be(:public_resource_b) { create(:ci_catalog_resource, :published, project: public_project) }
    let_it_be(:internal_resource) { create(:ci_catalog_resource, :published, project: internal_project) }
    let_it_be(:private_namespace_resource) { create(:ci_catalog_resource, :published, project: namespace_project_a) }
    let_it_be(:unpublished_resource) { create(:ci_catalog_resource, project: namespace_project_b) }

    it 'by default returns all resources visible to the current user' do
      is_expected.to contain_exactly(public_resource_a, public_resource_b, private_namespace_resource,
        internal_resource)
    end

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

      it 'returns only published resources for public projects' do
        is_expected.to contain_exactly(public_resource_a, public_resource_b)
      end
    end

    context 'when search params are provided' do
      let(:params) { { search: 'test' } }

      it 'returns the resources that match the search params' do
        is_expected.to contain_exactly(public_resource_b, private_namespace_resource)
      end

      context 'when search term is too small' do
        let(:params) { { search: 'te' } }

        it { is_expected.to be_empty }
      end
    end

    context 'when the scope is :namespaces' do
      let_it_be(:public_resource_no_namespace) do
        create(:ci_catalog_resource, project: create(:project, :public, name: 'public'))
      end

      let(:params) { { scope: :namespaces } }

      context 'when the `ci_guard_query_for_catalog_resource_scope` ff is enabled' do
        it "returns the catalog resources belonging to the user's authorized namespaces" do
          is_expected.to contain_exactly(public_resource_a, public_resource_b, internal_resource,
            private_namespace_resource)
        end
      end

      context 'when the `ci_guard_query_for_catalog_resource_scope` ff is disabled' do
        before do
          stub_feature_flags(ci_guard_for_catalog_resource_scope: false)
        end

        it 'returns all resources visible to the current user' do
          is_expected.to contain_exactly(
            public_resource_a, public_resource_b, private_namespace_resource,
            internal_resource)
        end
      end
    end

    context 'with a sort parameter' do
      let_it_be(:today) { Time.zone.now }
      let_it_be(:yesterday) { today - 1.day }
      let_it_be(:tomorrow) { today + 1.day }

      let(:params) { { sort: sort } }

      before_all do
        public_resource_a.update!(created_at: today, latest_released_at: yesterday)
        public_resource_b.update!(created_at: yesterday, latest_released_at: today)
        private_namespace_resource.update!(created_at: tomorrow, latest_released_at: tomorrow)
        internal_resource.update!(created_at: tomorrow + 1)
      end

      context 'when the sort is created_at ascending' do
        let_it_be(:sort) { :created_at_asc }

        it 'contains catalog resources sorted by created_at ascending' do
          is_expected.to eq([public_resource_b, public_resource_a, private_namespace_resource, internal_resource])
        end
      end

      context 'when the sort is created_at descending' do
        let_it_be(:sort) { :created_at_desc }

        it 'contains catalog resources sorted by created_at descending' do
          is_expected.to eq([internal_resource, private_namespace_resource, public_resource_a, public_resource_b])
        end
      end

      context 'when the sort is name ascending' do
        let_it_be(:sort) { :name_asc }

        it 'contains catalog resources for projects sorted by name ascending' do
          is_expected.to eq([public_resource_a, public_resource_b, internal_resource, private_namespace_resource])
        end
      end

      context 'when the sort is name descending' do
        let_it_be(:sort) { :name_desc }

        it 'contains catalog resources for projects sorted by name descending' do
          is_expected.to eq([private_namespace_resource, internal_resource, public_resource_b, public_resource_a])
        end
      end

      context 'when the sort is latest_released_at ascending' do
        let_it_be(:sort) { :latest_released_at_asc }

        it 'contains catalog resources sorted by latest_released_at ascending with nulls last' do
          is_expected.to eq([public_resource_a, public_resource_b, private_namespace_resource, internal_resource])
        end
      end

      context 'when the sort is latest_released_at descending' do
        let_it_be(:sort) { :latest_released_at_desc }

        it 'contains catalog resources sorted by latest_released_at descending with nulls last' do
          is_expected.to eq([private_namespace_resource, public_resource_b, public_resource_a, internal_resource])
        end
      end
    end

    context 'when namespace is provided' do
      let(:params) { { namespace: namespace } }

      context 'when it is a root namespace' do
        context 'when it has catalog resources' do
          it 'returns resources in the namespace visible to the user' do
            is_expected.to contain_exactly(public_resource_a, private_namespace_resource)
          end
        end

        context 'when the namespace has no catalog resources' do
          let(:namespace) { build(:namespace) }

          it { is_expected.to be_empty }
        end
      end

      context 'when namespace is not a root namespace' do
        let_it_be(:namespace) { create(:group, :nested) }

        it 'raises an exception' do
          expect { resources }.to raise_error(ArgumentError, 'Namespace is not a root namespace')
        end
      end
    end
  end

  describe '#find_resource' do
    let_it_be(:accessible_resource) { create(:ci_catalog_resource, :published, project: public_project) }

    subject { list.find_resource(id: id) }

    context 'when the resource is published and visible to the user' do
      let(:id) { accessible_resource.id }

      it 'fetches the resource' do
        is_expected.to eq(accessible_resource)
      end
    end

    context 'when the resource is not found' do
      let(:id) { 'not-an-id' }

      it { is_expected.to be_nil }
    end

    context 'when the resource is not published' do
      let_it_be(:draft_resource) { create(:ci_catalog_resource, project: public_namespace_project, state: :draft) }

      let(:id) { draft_resource.id }

      it { is_expected.to be_nil }
    end

    context "when the current user cannot read code on the resource's project" do
      let_it_be(:inaccessible_resource) { create(:ci_catalog_resource, :published, project: project_noaccess) }

      let(:id) { inaccessible_resource.id }

      it { is_expected.to be_nil }
    end

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

      context 'when the resource is public' do
        let(:id) { accessible_resource.id }

        it 'fetches the public resource' do
          is_expected.to eq(accessible_resource)
        end
      end

      context 'when the resource is internal' do
        let(:internal_resource) { create(:ci_catalog_resource, :published, project: internal_project) }
        let(:id) { internal_resource.id }

        it { is_expected.to be_nil }
      end
    end
  end
end