# frozen_string_literal: true require 'spec_helper' RSpec.describe SearchService do let_it_be(:user) { create(:user) } let_it_be(:accessible_group) { create(:group, :private) } let_it_be(:inaccessible_group) { create(:group, :private) } let_it_be(:group_member) { create(:group_member, group: accessible_group, user: user) } let_it_be(:accessible_project) { create(:project, :repository, :private, name: 'accessible_project') } let_it_be(:note) { create(:note_on_issue, project: accessible_project) } let_it_be(:inaccessible_project) { create(:project, :repository, :private, name: 'inaccessible_project') } let(:snippet) { create(:snippet, author: user) } let(:group_project) { create(:project, group: accessible_group, name: 'group_project') } let(:public_project) { create(:project, :public, name: 'public_project') } let(:page) { 1 } let(:per_page) { described_class::DEFAULT_PER_PAGE } let(:valid_search) { "what is love?" } subject(:search_service) { described_class.new(user, search: search, scope: scope, page: page, per_page: per_page) } before do accessible_project.add_maintainer(user) end describe '#project' do context 'when the project is accessible' do it 'returns the project' do project = described_class.new(user, project_id: accessible_project.id, search: valid_search).project expect(project).to eq accessible_project end it 'returns the project for guests' do search_project = create :project search_project.add_guest(user) project = described_class.new(user, project_id: search_project.id, search: valid_search).project expect(project).to eq search_project end end context 'when the project is not accessible' do it 'returns nil' do project = described_class.new(user, project_id: inaccessible_project.id, search: valid_search).project expect(project).to be_nil end end context 'when there is no project_id' do it 'returns nil' do project = described_class.new(user, search: valid_search).project expect(project).to be_nil end end end describe '#group' do context 'when the group is accessible' do it 'returns the group' do group = described_class.new(user, group_id: accessible_group.id, search: valid_search).group expect(group).to eq accessible_group end end context 'when the group is not accessible' do it 'returns nil' do group = described_class.new(user, group_id: inaccessible_group.id, search: valid_search).group expect(group).to be_nil end end context 'when there is no group_id' do it 'returns nil' do group = described_class.new(user, search: valid_search).group expect(group).to be_nil end end end describe '#show_snippets?' do context 'when :snippets is \'true\'' do it 'returns true' do show_snippets = described_class.new(user, snippets: 'true').show_snippets? expect(show_snippets).to be_truthy end end context 'when :snippets is not \'true\'' do it 'returns false' do show_snippets = described_class.new(user, snippets: 'tru').show_snippets? expect(show_snippets).to be_falsey end end context 'when :snippets is missing' do it 'returns false' do show_snippets = described_class.new(user).show_snippets? expect(show_snippets).to be_falsey end end end describe '#scope' do context 'with accessible project_id' do context 'and allowed scope' do it 'returns the specified scope' do scope = described_class.new(user, project_id: accessible_project.id, scope: 'notes', search: valid_search).scope expect(scope).to eq 'notes' end end context 'and disallowed scope' do it 'returns the default scope' do scope = described_class.new(user, project_id: accessible_project.id, scope: 'projects', search: valid_search).scope expect(scope).to eq 'blobs' end end context 'and no scope' do it 'returns the default scope' do scope = described_class.new(user, project_id: accessible_project.id, search: valid_search).scope expect(scope).to eq 'blobs' end end end context 'with \'true\' snippets' do context 'and allowed scope' do it 'returns the specified scope' do scope = described_class.new(user, snippets: 'true', scope: 'snippet_titles').scope expect(scope).to eq 'snippet_titles' end end context 'and disallowed scope' do it 'returns the default scope' do scope = described_class.new(user, snippets: 'true', scope: 'projects').scope expect(scope).to eq 'snippet_titles' end end context 'and no scope' do it 'returns the default scope' do scope = described_class.new(user, snippets: 'true').scope expect(scope).to eq 'snippet_titles' end end end context 'with no project_id, no snippets' do context 'and allowed scope' do it 'returns the specified scope' do scope = described_class.new(user, scope: 'issues').scope expect(scope).to eq 'issues' end end context 'and disallowed scope' do it 'returns the default scope' do scope = described_class.new(user, scope: 'blobs').scope expect(scope).to eq 'projects' end end context 'and no scope' do it 'returns the default scope' do scope = described_class.new(user).scope expect(scope).to eq 'projects' end end end end describe '#search_results' do context 'with accessible project_id' do it 'returns an instance of Gitlab::ProjectSearchResults' do search_results = described_class.new( user, project_id: accessible_project.id, scope: 'notes', search: note.note).search_results expect(search_results).to be_a Gitlab::ProjectSearchResults end end context 'with accessible project_id and \'true\' snippets' do it 'returns an instance of Gitlab::ProjectSearchResults' do search_results = described_class.new( user, project_id: accessible_project.id, snippets: 'true', scope: 'notes', search: note.note).search_results expect(search_results).to be_a Gitlab::ProjectSearchResults end end context 'with \'true\' snippets' do it 'returns an instance of Gitlab::SnippetSearchResults' do search_results = described_class.new( user, snippets: 'true', search: snippet.title).search_results expect(search_results).to be_a Gitlab::SnippetSearchResults end end context 'with no project_id and no snippets' do it 'returns an instance of Gitlab::SearchResults' do search_results = described_class.new( user, search: public_project.name).search_results expect(search_results).to be_a Gitlab::SearchResults end end end describe '#search_objects' do let(:search) { '' } let(:scope) { nil } describe 'per_page: parameter' do context 'when nil' do let(:per_page) { nil } it "defaults to #{described_class::DEFAULT_PER_PAGE}" do expect_any_instance_of(Gitlab::SearchResults) .to receive(:objects) .with(anything, hash_including(per_page: described_class::DEFAULT_PER_PAGE)) .and_call_original subject.search_objects end end context 'when empty string' do let(:per_page) { '' } it "defaults to #{described_class::DEFAULT_PER_PAGE}" do expect_any_instance_of(Gitlab::SearchResults) .to receive(:objects) .with(anything, hash_including(per_page: described_class::DEFAULT_PER_PAGE)) .and_call_original subject.search_objects end end context 'when negative' do let(:per_page) { '-1' } it "defaults to #{described_class::DEFAULT_PER_PAGE}" do expect_any_instance_of(Gitlab::SearchResults) .to receive(:objects) .with(anything, hash_including(per_page: described_class::DEFAULT_PER_PAGE)) .and_call_original subject.search_objects end end context 'when present' do let(:per_page) { '50' } it "converts to integer and passes to search results" do expect_any_instance_of(Gitlab::SearchResults) .to receive(:objects) .with(anything, hash_including(per_page: 50)) .and_call_original subject.search_objects end end context "when greater than #{described_class::MAX_PER_PAGE}" do let(:per_page) { described_class::MAX_PER_PAGE + 1 } it "passes #{described_class::MAX_PER_PAGE}" do expect_any_instance_of(Gitlab::SearchResults) .to receive(:objects) .with(anything, hash_including(per_page: described_class::MAX_PER_PAGE)) .and_call_original subject.search_objects end end end describe 'page: parameter' do context 'when < 1' do let(:page) { 0 } it "defaults to 1" do expect_any_instance_of(Gitlab::SearchResults) .to receive(:objects) .with(anything, hash_including(page: 1)) .and_call_original subject.search_objects end end context 'when nil' do let(:page) { nil } it "defaults to 1" do expect_any_instance_of(Gitlab::SearchResults) .to receive(:objects) .with(anything, hash_including(page: 1)) .and_call_original subject.search_objects end end end context 'with accessible project_id' do it 'returns objects in the project' do search_objects = described_class.new( user, project_id: accessible_project.id, scope: 'notes', search: note.note).search_objects expect(search_objects.first).to eq note end end context 'with accessible project_id and \'true\' snippets' do it 'returns objects in the project' do search_objects = described_class.new( user, project_id: accessible_project.id, snippets: 'true', scope: 'notes', search: note.note).search_objects expect(search_objects.first).to eq note end end context 'with \'true\' snippets' do it 'returns objects in snippets' do search_objects = described_class.new( user, snippets: 'true', search: snippet.title).search_objects expect(search_objects.first).to eq snippet end end context 'with accessible group_id' do it 'returns objects in the group' do search_objects = described_class.new( user, group_id: accessible_group.id, search: group_project.name).search_objects expect(search_objects.first).to eq group_project end end context 'with no project_id, group_id or snippets' do it 'returns objects in global' do search_objects = described_class.new( user, search: public_project.name).search_objects expect(search_objects.first).to eq public_project end end it_behaves_like 'a redacted search results' end describe '#valid_request?' do let(:scope) { 'issues' } let(:search) { 'foobar' } let(:params) { instance_double(Gitlab::Search::Params) } before do allow(Gitlab::Search::Params).to receive(:new).and_return(params) allow(params).to receive(:valid?).and_return double(:valid?) end it 'is the return value of params.valid?' do expect(subject.valid_request?).to eq(params.valid?) end end describe '#abuse_messages' do let(:scope) { 'issues' } let(:search) { 'foobar' } let(:params) { instance_double(Gitlab::Search::Params) } before do allow(Gitlab::Search::Params).to receive(:new).and_return(params) end it 'returns an empty array when not abusive' do allow(params).to receive(:abusive?).and_return false expect(subject.abuse_messages).to match_array([]) end it 'calls on abuse_detection.errors.full_messages when abusive' do allow(params).to receive(:abusive?).and_return true expect(params).to receive_message_chain(:abuse_detection, :errors, :full_messages) subject.abuse_messages end end describe 'abusive search handling' do subject { described_class.new(user, raw_params) } let(:raw_params) { { search: search, scope: scope } } let(:search) { 'foobar' } let(:search_service) { double(:search_service) } before do expect(Gitlab::Search::Params).to receive(:new) .with(raw_params, detect_abuse: true).and_call_original allow(subject).to receive(:search_service).and_return search_service end context 'a search is abusive' do let(:scope) { '1;drop%20table' } it 'does NOT execute search service' do expect(search_service).not_to receive(:execute) subject.search_results end end context 'a search is NOT abusive' do let(:scope) { 'issues' } it 'executes search service' do expect(search_service).to receive(:execute) subject.search_results end end end end