// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.prelude.searcher.test;

import com.yahoo.component.ComponentId;
import com.yahoo.component.chain.Chain;
import com.yahoo.config.subscription.ConfigGetter;
import com.yahoo.prelude.fastsearch.FastHit;
import com.yahoo.prelude.hitfield.HitField;
import com.yahoo.prelude.searcher.QrQuotetableConfig;
import com.yahoo.prelude.searcher.QuotingSearcher;
import com.yahoo.search.Query;
import com.yahoo.search.Result;
import com.yahoo.search.Searcher;
import com.yahoo.search.result.Hit;
import com.yahoo.search.result.Relevance;
import com.yahoo.search.searchchain.Execution;
import com.yahoo.search.searchchain.testutil.DocumentSourceSearcher;
import org.junit.Test;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;

/**
 * Tests hit property quoting.
 *
 * @author Steinar Knutsen
 */
public class QuotingSearcherTestCase {

    @SuppressWarnings("deprecation")
    public static QuotingSearcher createQuotingSearcher(String configId) {
        QrQuotetableConfig config = new ConfigGetter<>(QrQuotetableConfig.class).getConfig(configId);
        return new QuotingSearcher(new ComponentId("QuotingSearcher"), config);
    }

    @Test
    public void testBasicQuoting() {
        Map<Searcher, Searcher> chained = new HashMap<>();
        Searcher s = createQuotingSearcher("file:src/test/java/com/yahoo/prelude/"
                                                + "searcher/test/testquoting.cfg");
        DocumentSourceSearcher docsource = new DocumentSourceSearcher();
        chained.put(s, docsource);
        Query q = new Query("?query=a");
        Result r = new Result(q);
        Hit hit = new FastHit();
        hit.setId("http://abc.html");
        hit.setRelevance(new Relevance(1));
        hit.setField("title", "smith & jones");
        r.hits().add(hit);
        docsource.addResult(q, r);
        Result check = doSearch(s, q, 0, 10, chained);
        assertEquals("smith &amp; jones", check.hits().get(0).getField("title").toString());
        assertTrue(check.hits().get(0).fields().containsKey("title"));
    }

    @Test
    public void testBasicQuotingWithNoisyStrings() {
        Map<Searcher, Searcher> chained = new HashMap<>();
        Searcher s = createQuotingSearcher("file:src/test/java/com/yahoo/prelude/"
                                                + "searcher/test/testquoting.cfg");
        DocumentSourceSearcher docsource = new DocumentSourceSearcher();
        chained.put(s, docsource);
        Query q = new Query("?query=a");
        Result r = new Result(q);
        Hit hit = new FastHit();
        hit.setId("http://abc.html");
        hit.setRelevance(new Relevance(1));
        hit.setField("title", "&smith &jo& nes");
        r.hits().add(hit);
        docsource.addResult(q, r);
        Result check = doSearch(s, q, 0, 10, chained);
        assertEquals("&amp;smith &amp;jo&amp; nes", check.hits().get(0).getField("title").toString());
        assertTrue(check.hits().get(0).fields().containsKey("title"));
    }

    @Test
    public void testFieldQuotingWithNoisyStrings() {
        Map<Searcher, Searcher> chained = new HashMap<>();
        Searcher s = createQuotingSearcher("file:src/test/java/com/yahoo/prelude/"
                                                + "searcher/test/testquoting.cfg");
        DocumentSourceSearcher docsource = new DocumentSourceSearcher();
        chained.put(s, docsource);
        Query q = new Query("?query=a");
        Result r = new Result(q);
        Hit hit = new FastHit();
        hit.setId("http://abc.html");
        hit.setRelevance(new Relevance(1));
        hit.setField("title", new HitField("title", "&smith &jo& nes"));
        r.hits().add(hit);
        docsource.addResult(q, r);
        Result check = doSearch(s, q, 0, 10, chained);
        assertEquals("&amp;smith &amp;jo&amp; nes", check.hits().get(0).getField("title").toString());
        assertTrue(check.hits().get(0).fields().containsKey("title"));
    }


    @Test
    public void testNoQuotingWithOtherTypes() {
        Map<Searcher, Searcher> chained = new HashMap<>();
        Searcher s = createQuotingSearcher("file:src/test/java/com/yahoo/prelude/"
                                                + "searcher/test/testquoting.cfg");
        DocumentSourceSearcher docsource = new DocumentSourceSearcher();
        chained.put(s, docsource);
        Query q = new Query("?query=a");
        Result r = new Result(q);
        Hit hit = new FastHit();
        hit.setId("http://abc.html");
        hit.setRelevance(new Relevance(1));
        hit.setField("title", Integer.valueOf(42));
        r.hits().add(hit);
        docsource.addResult(q, r);
        Result check = doSearch(s, q, 0, 10, chained);
        // should not quote non-string properties
        assertEquals(Integer.valueOf(42), check.hits().get(0).getField("title"));
    }

    private Result doSearch(Searcher searcher, Query query, int offset, int hits, Map<Searcher, Searcher> chained) {
        query.setOffset(offset);
        query.setHits(hits);
        return createExecution(searcher, chained).search(query);
    }

    private Chain<Searcher> chainedAsSearchChain(Searcher topOfChain, Map<Searcher, Searcher> chained) {
        List<Searcher> searchers = new ArrayList<>();
        for (Searcher current = topOfChain; current != null; current = chained.get(current)) {
            searchers.add(current);
        }
        return new Chain<>(searchers);
    }

    private Execution createExecution(Searcher searcher, Map<Searcher, Searcher> chained) {
        return new Execution(chainedAsSearchChain(searcher, chained), Execution.Context.createContextStub());
    }

}