se.uu.ub.cora.solrsearch.SolrRecordSearchTest.java Source code

Introduction

Here is the source code for se.uu.ub.cora.solrsearch.SolrRecordSearchTest.java

Source

/*
 * Copyright 2017 Uppsala University Library
 *
 * This file is part of Cora.
 *
 *     Cora is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     Cora is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU General Public License for more details.
 *
 *     You should have received a copy of the GNU General Public License
 *     along with Cora.  If not, see <http://www.gnu.org/licenses/>.
 */

package se.uu.ub.cora.solrsearch;

import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertNotNull;
import static org.testng.Assert.assertNull;

import java.util.ArrayList;
import java.util.List;

import org.apache.solr.client.solrj.SolrQuery;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;

import se.uu.ub.cora.bookkeeper.data.DataAtomic;
import se.uu.ub.cora.bookkeeper.data.DataGroup;
import se.uu.ub.cora.solrindex.SolrClientProviderSpy;
import se.uu.ub.cora.solrindex.SolrClientSpy;
import se.uu.ub.cora.spider.data.SpiderSearchResult;

public class SolrRecordSearchTest {
    private SolrClientProviderSpy solrClientProvider;
    private SearchStorageSpy searchStorage;
    private SolrRecordSearch solrSearch;
    private SolrClientSpy solrClientSpy;
    private QueryResponseSpy queryResponse;
    private List<String> emptyList = new ArrayList<>();

    @BeforeMethod
    public void beforeMethod() {
        solrClientProvider = new SolrClientProviderSpy();
        searchStorage = new SearchStorageSpy();
        solrSearch = SolrRecordSearch
                .createSolrRecordSearchUsingSolrClientProviderAndSearchStorage(solrClientProvider, searchStorage);
        solrClientSpy = solrClientProvider.solrClientSpy;
        queryResponse = new QueryResponseSpy();
        solrClientSpy.queryResponse = queryResponse;
    }

    @Test
    public void testInit() {
        assertNotNull(solrSearch);
        SolrQuery solrQueryCreated = (SolrQuery) solrClientSpy.params;
        assertNull(solrQueryCreated);
        assertEquals(solrSearch.getSearchStorage(), searchStorage);
    }

    @Test
    public void testSearchOneParameterNoRecordType() {
        DataGroup searchData = createSearchIncludeDataWithSearchTermIdAndValue("titleSearchTerm", "A title");

        SpiderSearchResult searchResult = solrSearch.searchUsingListOfRecordTypesToSearchInAndSearchData(emptyList,
                searchData);
        assertNotNull(searchResult.listOfDataGroups);
        DataGroup firstResult = searchResult.listOfDataGroups.get(0);
        assertEquals(firstResult.getNameInData(), "book");

        SolrQuery solrQueryCreated = (SolrQuery) solrClientSpy.params;
        assertEquals(solrQueryCreated.getQuery(), "title_s:(A title)");

        assertEquals(searchStorage.searchTermIds.get(0), "titleSearchTerm");
        assertEquals(searchStorage.collectIndexTermIds.get(0), "titleIndexTerm");
    }

    private DataGroup createSearchIncludeDataWithSearchTermIdAndValue(String searchTermId, String value) {
        DataGroup searchData = createSearchDataGroupWithMinimumNecessaryParts();
        DataGroup includePart = searchData.getFirstGroupWithNameInData("include")
                .getFirstGroupWithNameInData("includePart");
        includePart.addChild(DataAtomic.withNameInDataAndValue(searchTermId, value));
        return searchData;
    }

    private DataGroup createSearchDataGroupWithMinimumNecessaryParts() {
        DataGroup searchData = DataGroup.withNameInData("bookSearch");
        DataGroup include = DataGroup.withNameInData("include");
        searchData.addChild(include);
        DataGroup includePart = DataGroup.withNameInData("includePart");
        include.addChild(includePart);
        return searchData;
    }

    @Test
    public void testIndexTypeTextGeneratesCorrectQueryParamSuffix() {
        SolrQuery solrQueryCreated = performIncludeSearchForIndexType("indexTypeText");
        String suffix = extractCreatedParameterSuffix(solrQueryCreated);
        assertEquals(suffix, "_t");
    }

    private String extractCreatedParameterSuffix(SolrQuery solrQueryCreated) {
        String query = solrQueryCreated.getQuery();
        return query.substring(query.indexOf("_"), query.indexOf(":"));
    }

    private SolrQuery performIncludeSearchForIndexType(String indexType) {
        searchStorage.indexTypeToReturn = indexType;
        DataGroup searchData = createSearchIncludeDataWithSearchTermIdAndValue("titleSearchTerm", "A title");
        solrSearch.searchUsingListOfRecordTypesToSearchInAndSearchData(emptyList, searchData);
        SolrQuery solrQueryCreated = (SolrQuery) solrClientSpy.params;
        return solrQueryCreated;
    }

    @Test
    public void testIndexTypeBooleanGeneratesCorrectQueryParamSuffix() {
        SolrQuery solrQueryCreated = performIncludeSearchForIndexType("indexTypeBoolean");
        String suffix = extractCreatedParameterSuffix(solrQueryCreated);
        assertEquals(suffix, "_b");
    }

    @Test
    public void testIndexTypeDateGeneratesCorrectQueryParamSuffix() {
        SolrQuery solrQueryCreated = performIncludeSearchForIndexType("indexTypeDate");
        String suffix = extractCreatedParameterSuffix(solrQueryCreated);
        assertEquals(suffix, "_dt");
    }

    @Test
    public void testIndexTypeNumberGeneratesCorrectQueryParamSuffix() {
        SolrQuery solrQueryCreated = performIncludeSearchForIndexType("indexTypeNumber");
        String suffix = extractCreatedParameterSuffix(solrQueryCreated);
        assertEquals(suffix, "_l");
    }

    @Test
    public void testReturnThreeRecords() {
        queryResponse.noOfDocumentsToReturn = 3;

        DataGroup searchData = createSearchDataGroupWithMinimumNecessaryParts();

        SpiderSearchResult searchResult = solrSearch.searchUsingListOfRecordTypesToSearchInAndSearchData(emptyList,
                searchData);
        assertEquals(searchResult.listOfDataGroups.size(), 3);
    }

    @Test(expectedExceptions = SolrSearchException.class)
    public void testSearchErrorException() {
        solrClientProvider.returnErrorThrowingClient = true;
        queryResponse.noOfDocumentsToReturn = 3;

        DataGroup searchData = createSearchDataGroupWithMinimumNecessaryParts();

        solrSearch.searchUsingListOfRecordTypesToSearchInAndSearchData(emptyList, searchData);
    }

    @Test
    public void testSearchUndefinedFieldErrorException() {
        solrClientProvider.returnErrorThrowingClient = true;
        solrClientProvider.errorMessage = "Error from server at http://localhost:8983/solr/coracore: undefined field testNewsTitleSearchTerm";

        DataGroup searchData = createSearchIncludeDataWithSearchTermIdAndValue("anUnindexedTerm", "A title");

        SpiderSearchResult searchResult = solrSearch.searchUsingListOfRecordTypesToSearchInAndSearchData(emptyList,
                searchData);
        assertEquals(searchResult.listOfDataGroups.size(), 0);
    }

    @Test
    public void testSearchOneParameterOneRecordType() {
        DataGroup searchData = createSearchIncludeDataWithSearchTermIdAndValue("titleSearchTerm", "A title");

        List<String> recordTypeList = new ArrayList<>();
        recordTypeList.add("someRecordType");
        solrSearch.searchUsingListOfRecordTypesToSearchInAndSearchData(recordTypeList, searchData);

        SolrQuery solrQueryCreated = (SolrQuery) solrClientSpy.params;
        String[] createdFilterQueries = solrQueryCreated.getFilterQueries();
        assertEquals(createdFilterQueries[0], "type:someRecordType");
    }

    @Test
    public void testSearchOneParameterTwoRecordType() {
        DataGroup searchData = createSearchIncludeDataWithSearchTermIdAndValue("titleSearchTerm", "A title");

        List<String> recordTypeList = new ArrayList<>();
        recordTypeList.add("someRecordType");
        recordTypeList.add("someOtherRecordType");
        solrSearch.searchUsingListOfRecordTypesToSearchInAndSearchData(recordTypeList, searchData);

        SolrQuery solrQueryCreated = (SolrQuery) solrClientSpy.params;
        String[] createdFilterQueries = solrQueryCreated.getFilterQueries();
        assertEquals(createdFilterQueries[0], "type:someRecordType" + " OR " + "type:someOtherRecordType");
    }

    @Test
    public void testSearchLInkedDataOneParameterOneRecordType() {
        DataGroup searchData = createSearchIncludeDataWithSearchTermIdAndValue("linkedTextSearchTerm",
                "textToSearchFor");

        List<String> recordTypeList = new ArrayList<>();
        recordTypeList.add("someRecordType");
        solrSearch.searchUsingListOfRecordTypesToSearchInAndSearchData(recordTypeList, searchData);

        SolrQuery solrQueryCreated = (SolrQuery) solrClientSpy.params;
        String[] createdFilterQueries = solrQueryCreated.getFilterQueries();
        assertEquals(createdFilterQueries[0], "type:someRecordType");
        assertEquals(solrQueryCreated.getQuery(),
                "{!join from=ids to=textId_s}swedish_t:textToSearchFor AND type:coraText");
    }

}