/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.elasticsearch.search.fetch.subphase.highlight;
import org.elasticsearch.action.search.SearchResponse;
import org.elasticsearch.index.query.QueryBuilders;
import org.elasticsearch.plugins.Plugin;
import org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder;
import org.elasticsearch.test.ESIntegTestCase;
import org.elasticsearch.test.ESIntegTestCase.ClusterScope;
import org.elasticsearch.test.ESIntegTestCase.Scope;
import org.junit.Before;
import java.io.IOException;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import static org.elasticsearch.test.hamcrest.ElasticsearchAssertions.assertHighlight;
import static org.hamcrest.Matchers.equalTo;
/**
* Integration test for highlighters registered by a plugin.
*/
@ClusterScope(scope = Scope.SUITE, supportsDedicatedMasters = false, numDataNodes = 1)
public class CustomHighlighterSearchIT extends ESIntegTestCase {
@Override
protected Collection<Class<? extends Plugin>> nodePlugins() {
return Arrays.asList(CustomHighlighterPlugin.class);
}
@Before
protected void setup() throws Exception{
indexRandom(true,
client().prepareIndex("test", "test", "1").setSource(
"name", "arbitrary content", "other_name", "foo", "other_other_name", "bar"),
client().prepareIndex("test", "test", "2").setSource(
"other_name", "foo", "other_other_name", "bar"));
}
public void testThatCustomHighlightersAreSupported() throws IOException {
SearchResponse searchResponse = client().prepareSearch("test").setTypes("test")
.setQuery(QueryBuilders.matchAllQuery())
.highlighter(new HighlightBuilder().field("name").highlighterType("test-custom"))
.execute().actionGet();
assertHighlight(searchResponse, 0, "name", 0, equalTo("standard response for name at position 1"));
}
public void testThatCustomHighlighterCanBeConfiguredPerField() throws Exception {
HighlightBuilder.Field highlightConfig = new HighlightBuilder.Field("name");
highlightConfig.highlighterType("test-custom");
Map<String, Object> options = new HashMap<>();
options.put("myFieldOption", "someValue");
highlightConfig.options(options);
SearchResponse searchResponse = client().prepareSearch("test").setTypes("test")
.setQuery(QueryBuilders.matchAllQuery())
.highlighter(new HighlightBuilder().field(highlightConfig))
.execute().actionGet();
assertHighlight(searchResponse, 0, "name", 0, equalTo("standard response for name at position 1"));
assertHighlight(searchResponse, 0, "name", 1, equalTo("field:myFieldOption:someValue"));
}
public void testThatCustomHighlighterCanBeConfiguredGlobally() throws Exception {
Map<String, Object> options = new HashMap<>();
options.put("myGlobalOption", "someValue");
SearchResponse searchResponse = client().prepareSearch("test").setTypes("test").setQuery(QueryBuilders.matchAllQuery())
.highlighter(new HighlightBuilder().field("name").highlighterType("test-custom").options(options))
.execute().actionGet();
assertHighlight(searchResponse, 0, "name", 0, equalTo("standard response for name at position 1"));
assertHighlight(searchResponse, 0, "name", 1, equalTo("field:myGlobalOption:someValue"));
}
public void testThatCustomHighlighterReceivesFieldsInOrder() throws Exception {
SearchResponse searchResponse = client().prepareSearch("test").setTypes("test")
.setQuery(QueryBuilders.boolQuery().must(QueryBuilders.matchAllQuery()).should(QueryBuilders
.termQuery("name", "arbitrary")))
.highlighter(
new HighlightBuilder().highlighterType("test-custom").field("name").field("other_name").field("other_other_name")
.useExplicitFieldOrder(true))
.get();
assertHighlight(searchResponse, 0, "name", 0, equalTo("standard response for name at position 1"));
assertHighlight(searchResponse, 0, "other_name", 0, equalTo("standard response for other_name at position 2"));
assertHighlight(searchResponse, 0, "other_other_name", 0, equalTo("standard response for other_other_name at position 3"));
assertHighlight(searchResponse, 1, "name", 0, equalTo("standard response for name at position 1"));
assertHighlight(searchResponse, 1, "other_name", 0, equalTo("standard response for other_name at position 2"));
assertHighlight(searchResponse, 1, "other_other_name", 0, equalTo("standard response for other_other_name at position 3"));
}
}