// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.searchdefinition.derived;

import com.yahoo.config.model.application.provider.BaseDeployLogger;
import com.yahoo.searchdefinition.Search;
import com.yahoo.searchdefinition.SearchBuilder;
import com.yahoo.searchdefinition.SchemaTestCase;
import com.yahoo.searchdefinition.parser.ParseException;
import com.yahoo.vespa.config.search.SummaryConfig;
import org.junit.Test;

import java.io.IOException;
import java.util.Iterator;

import static com.yahoo.config.model.test.TestUtil.joinLines;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;

/**
 * Tests summary extraction
 *
 * @author bratseth
 */
public class SummaryTestCase extends SchemaTestCase {

    @Test
    public void deriveRawAsBase64() throws ParseException {
        String sd = joinLines(
                "schema s {",
                "  raw-as-base64-in-summary",
                "  document s {",
                "      field raw_field type raw {",
                "          indexing: summary",
                "      }",
                "  }",
                "}");
        Search search = SearchBuilder.createFromString(sd).getSearch();
        SummaryClass summary = new SummaryClass(search, search.getSummary("default"), new BaseDeployLogger());
        assertEquals(SummaryClassField.Type.RAW, summary.getField("raw_field").getType());
    }

    @Test
    public void deriveRawAsLegacy() throws ParseException {
        String sd = joinLines(
                "schema s {",
                "  document s {",
                "      field raw_field type raw {",
                "          indexing: summary",
                "      }",
                "  }",
                "}");
        Search search = SearchBuilder.createFromString(sd).getSearch();
        SummaryClass summary = new SummaryClass(search, search.getSummary("default"), new BaseDeployLogger());
        assertEquals(SummaryClassField.Type.DATA, summary.getField("raw_field").getType());
    }

    @Test
    public void testDeriving() throws IOException, ParseException {
        Search search = SearchBuilder.buildFromFile("src/test/examples/simple.sd");
        SummaryClass summary = new SummaryClass(search, search.getSummary("default"), new BaseDeployLogger());
        assertEquals("default", summary.getName());

        Iterator<SummaryClassField> fields = summary.fieldIterator();

        SummaryClassField field;

        assertEquals(13, summary.getFieldCount());

        field = fields.next();
        assertEquals("exactemento", field.getName());
        assertEquals(SummaryClassField.Type.LONGSTRING, field.getType());

        field = fields.next();
        assertEquals("exact", field.getName());
        assertEquals(SummaryClassField.Type.LONGSTRING, field.getType());

        field = fields.next();
        assertEquals("title", field.getName());
        assertEquals(SummaryClassField.Type.LONGSTRING, field.getType());

        field = fields.next();
        assertEquals("description", field.getName());
        assertEquals(SummaryClassField.Type.LONGSTRING, field.getType());

        field = fields.next();
        assertEquals("dyndesc", field.getName());
        assertEquals(SummaryClassField.Type.LONGSTRING, field.getType());

        field = fields.next();
        assertEquals("longdesc", field.getName());
        assertEquals(SummaryClassField.Type.LONGSTRING, field.getType());

        field = fields.next();
        assertEquals("longstat", field.getName());
        assertEquals(SummaryClassField.Type.LONGSTRING, field.getType());

        field = fields.next();
        assertEquals("dynlong", field.getName());
        assertEquals(SummaryClassField.Type.LONGSTRING, field.getType());

        field = fields.next();
        assertEquals("dyndesc2", field.getName());
        assertEquals(SummaryClassField.Type.LONGSTRING, field.getType());

        field = fields.next();
        assertEquals("measurement", field.getName());
        assertEquals(SummaryClassField.Type.INTEGER, field.getType());

        field = fields.next();
        assertEquals("rankfeatures", field.getName());
        assertEquals(SummaryClassField.Type.FEATUREDATA, field.getType());

        field = fields.next();
        assertEquals("summaryfeatures", field.getName());
        assertEquals(SummaryClassField.Type.FEATUREDATA, field.getType());

        field = fields.next();
        assertEquals("documentid", field.getName());
        assertEquals(SummaryClassField.Type.LONGSTRING, field.getType());
    }

    @Test
    public void reference_fields_can_be_part_of_summary_classes() throws ParseException {
        Search adSearch = buildCampaignAdModel();

        SummaryClass defaultClass = new SummaryClass(adSearch, adSearch.getSummary("default"), new BaseDeployLogger());
        assertEquals(SummaryClassField.Type.LONGSTRING, defaultClass.getField("campaign_ref").getType());
        assertEquals(SummaryClassField.Type.LONGSTRING, defaultClass.getField("other_campaign_ref").getType());

        SummaryClass myClass = new SummaryClass(adSearch, adSearch.getSummary("my_summary"), new BaseDeployLogger());
        assertNull(myClass.getField("campaign_ref"));
        assertEquals(SummaryClassField.Type.LONGSTRING, myClass.getField("other_campaign_ref").getType());
    }

    private static Search buildCampaignAdModel() throws ParseException {
        SearchBuilder builder = new SearchBuilder();
        builder.importString("search campaign { document campaign {} }");
        builder.importString(joinLines("search ad {",
                "  document ad {",
                "    field campaign_ref type reference<campaign> {",
                "      indexing: summary | attribute",
                "    }",
                "    field other_campaign_ref type reference<campaign> {",
                "      indexing: summary | attribute",
                "    }",
                "  }",
                "  document-summary my_summary {",
                "    summary other_campaign_ref type reference<campaign> {}",
                "  }",
                "}"));
        builder.build();
        return builder.getSearch("ad");
    }

    @Test
    public void omit_summary_features_specified_for_document_summary() throws ParseException {
        String sd = joinLines(
                "schema test {",
                "  document test {",
                "    field foo type string { indexing: summary }",
                "  }",
                "  document-summary bar {",
                "    summary foo type string {}",
                "    omit-summary-features",
                "  }",
                "  document-summary baz {",
                "    summary foo type string {}",
                "  }",
                "}");
        var search = SearchBuilder.createFromString(sd).getSearch();
        assertOmitSummaryFeatures(true, search, "bar");
        assertOmitSummaryFeatures(false, search, "baz");
    }

    private void assertOmitSummaryFeatures(boolean expected, Search search, String summaryName) {
        var summary = new SummaryClass(search, search.getSummary(summaryName), new BaseDeployLogger());
        var config = new SummaryConfig.Classes(summary.getSummaryClassConfig());
        assertEquals(expected, config.omitsummaryfeatures());
    }

}