org.opensearch.indices.analysis.AnalysisFactoryTestCase Maven / Gradle / Ivy
Show all versions of framework Show documentation
/*
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
/*
* 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.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/
package org.opensearch.indices.analysis;
import org.apache.lucene.analysis.TokenFilterFactory;
import org.apache.lucene.analysis.TokenizerFactory;
import org.opensearch.common.collect.MapBuilder;
import org.opensearch.index.analysis.HunspellTokenFilterFactory;
import org.opensearch.index.analysis.ShingleTokenFilterFactory;
import org.opensearch.index.analysis.StandardTokenizerFactory;
import org.opensearch.index.analysis.StopTokenFilterFactory;
import org.opensearch.plugins.AnalysisPlugin;
import org.opensearch.test.OpenSearchTestCase;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.TreeSet;
import java.util.stream.Collectors;
import static java.util.Collections.emptyMap;
/**
* Alerts us if new analysis components are added to Lucene, so we don't miss them.
*
* If we don't want to expose one for a specific reason, just map it to Void.
* The deprecated ones can be mapped to Deprecated.class.
*/
public abstract class AnalysisFactoryTestCase extends OpenSearchTestCase {
private static final Map> KNOWN_TOKENIZERS = new MapBuilder>()
// exposed in OpenSearch
.put("classic", MovedToAnalysisCommon.class)
.put("edgengram", MovedToAnalysisCommon.class)
.put("keyword", MovedToAnalysisCommon.class)
.put("letter", MovedToAnalysisCommon.class)
.put("ngram", MovedToAnalysisCommon.class)
.put("pathhierarchy", MovedToAnalysisCommon.class)
.put("pattern", MovedToAnalysisCommon.class)
.put("simplepattern", MovedToAnalysisCommon.class)
.put("simplepatternsplit", MovedToAnalysisCommon.class)
.put("standard", StandardTokenizerFactory.class)
.put("thai", MovedToAnalysisCommon.class)
.put("uax29urlemail", MovedToAnalysisCommon.class)
.put("whitespace", MovedToAnalysisCommon.class)
// this one "seems to mess up offsets". probably shouldn't be a tokenizer...
.put("wikipedia", Void.class)
.immutableMap();
static final Map> KNOWN_TOKENFILTERS = new MapBuilder>()
// exposed in OpenSearch
.put("apostrophe", MovedToAnalysisCommon.class)
.put("arabicnormalization", MovedToAnalysisCommon.class)
.put("arabicstem", MovedToAnalysisCommon.class)
.put("asciifolding", MovedToAnalysisCommon.class)
.put("bengalinormalization", MovedToAnalysisCommon.class)
.put("bengalistem", MovedToAnalysisCommon.class)
.put("brazilianstem", MovedToAnalysisCommon.class)
.put("bulgarianstem", MovedToAnalysisCommon.class)
.put("cjkbigram", MovedToAnalysisCommon.class)
.put("cjkwidth", MovedToAnalysisCommon.class)
.put("classic", MovedToAnalysisCommon.class)
.put("commongrams", MovedToAnalysisCommon.class)
.put("commongramsquery", MovedToAnalysisCommon.class)
.put("czechstem", MovedToAnalysisCommon.class)
.put("decimaldigit", MovedToAnalysisCommon.class)
.put("delimitedpayload", MovedToAnalysisCommon.class)
.put("delimitedtermfrequency", MovedToAnalysisCommon.class)
.put("dictionarycompoundword", MovedToAnalysisCommon.class)
.put("edgengram", MovedToAnalysisCommon.class)
.put("elision", MovedToAnalysisCommon.class)
.put("englishminimalstem", MovedToAnalysisCommon.class)
.put("englishpossessive", MovedToAnalysisCommon.class)
.put("finnishlightstem", MovedToAnalysisCommon.class)
.put("fixedshingle", MovedToAnalysisCommon.class)
.put("frenchlightstem", MovedToAnalysisCommon.class)
.put("frenchminimalstem", MovedToAnalysisCommon.class)
.put("galicianminimalstem", MovedToAnalysisCommon.class)
.put("galicianstem", MovedToAnalysisCommon.class)
.put("germanstem", MovedToAnalysisCommon.class)
.put("germanlightstem", MovedToAnalysisCommon.class)
.put("germanminimalstem", MovedToAnalysisCommon.class)
.put("germannormalization", MovedToAnalysisCommon.class)
.put("greeklowercase", MovedToAnalysisCommon.class)
.put("greekstem", MovedToAnalysisCommon.class)
.put("hindinormalization", MovedToAnalysisCommon.class)
.put("hindistem", MovedToAnalysisCommon.class)
.put("hungarianlightstem", MovedToAnalysisCommon.class)
.put("hunspellstem", HunspellTokenFilterFactory.class)
.put("hyphenationcompoundword", MovedToAnalysisCommon.class)
.put("indicnormalization", MovedToAnalysisCommon.class)
.put("irishlowercase", MovedToAnalysisCommon.class)
.put("indonesianstem", MovedToAnalysisCommon.class)
.put("italianlightstem", MovedToAnalysisCommon.class)
.put("keepword", MovedToAnalysisCommon.class)
.put("keywordmarker", MovedToAnalysisCommon.class)
.put("kstem", MovedToAnalysisCommon.class)
.put("latvianstem", MovedToAnalysisCommon.class)
.put("length", MovedToAnalysisCommon.class)
.put("limittokencount", MovedToAnalysisCommon.class)
.put("lowercase", MovedToAnalysisCommon.class)
.put("ngram", MovedToAnalysisCommon.class)
.put("norwegianlightstem", MovedToAnalysisCommon.class)
.put("norwegianminimalstem", MovedToAnalysisCommon.class)
.put("norwegiannormalization", MovedToAnalysisCommon.class)
.put("patterncapturegroup", MovedToAnalysisCommon.class)
.put("patternreplace", MovedToAnalysisCommon.class)
.put("persiannormalization", MovedToAnalysisCommon.class)
.put("persianstem", MovedToAnalysisCommon.class)
.put("porterstem", MovedToAnalysisCommon.class)
.put("portuguesestem", MovedToAnalysisCommon.class)
.put("portugueselightstem", MovedToAnalysisCommon.class)
.put("portugueseminimalstem", MovedToAnalysisCommon.class)
.put("reversestring", MovedToAnalysisCommon.class)
.put("russianlightstem", MovedToAnalysisCommon.class)
.put("scandinavianfolding", MovedToAnalysisCommon.class)
.put("scandinaviannormalization", MovedToAnalysisCommon.class)
.put("serbiannormalization", MovedToAnalysisCommon.class)
.put("shingle", ShingleTokenFilterFactory.class)
.put("minhash", MovedToAnalysisCommon.class)
.put("snowballporter", MovedToAnalysisCommon.class)
.put("soraninormalization", MovedToAnalysisCommon.class)
.put("soranistem", MovedToAnalysisCommon.class)
.put("spanishlightstem", MovedToAnalysisCommon.class)
.put("stemmeroverride", MovedToAnalysisCommon.class)
.put("stop", StopTokenFilterFactory.class)
.put("swedishlightstem", MovedToAnalysisCommon.class)
.put("swedishminimalstem", MovedToAnalysisCommon.class)
.put("synonym", MovedToAnalysisCommon.class)
.put("synonymgraph", MovedToAnalysisCommon.class)
.put("telugunormalization", MovedToAnalysisCommon.class)
.put("telugustem", MovedToAnalysisCommon.class)
.put("trim", MovedToAnalysisCommon.class)
.put("truncate", MovedToAnalysisCommon.class)
.put("turkishlowercase", MovedToAnalysisCommon.class)
.put("type", MovedToAnalysisCommon.class)
.put("uppercase", MovedToAnalysisCommon.class)
.put("worddelimiter", MovedToAnalysisCommon.class)
.put("worddelimitergraph", MovedToAnalysisCommon.class)
.put("flattengraph", MovedToAnalysisCommon.class)
// TODO: these tokenfilters are not yet exposed: useful?
// suggest stop
.put("suggeststop", Void.class)
// capitalizes tokens
.put("capitalization", Void.class)
// like length filter (but codepoints)
.put("codepointcount", Void.class)
// puts hyphenated words back together
.put("hyphenatedwords", Void.class)
// repeats anything marked as keyword
.put("keywordrepeat", Void.class)
// like limittokencount, but by offset
.put("limittokenoffset", Void.class)
// like limittokencount, but by position
.put("limittokenposition", Void.class)
// ???
.put("numericpayload", Void.class)
// removes duplicates at the same position (this should be used by the existing factory)
.put("removeduplicates", Void.class)
// ???
.put("tokenoffsetpayload", Void.class)
// puts the type into the payload
.put("typeaspayload", Void.class)
// puts the type as a synonym
.put("typeassynonym", Void.class)
// fingerprint
.put("fingerprint", Void.class)
// for tee-sinks
.put("daterecognizer", Void.class)
// for token filters that generate bad offsets, which are now rejected since Lucene 7
.put("fixbrokenoffsets", Void.class)
// LUCENE-8273: ProtectedTermFilterFactory allows analysis chains to skip
// particular token filters based on the attributes of the current token.
.put("protectedterm", Void.class)
// LUCENE-8332
.put("concatenategraph", Void.class)
// LUCENE-8936
.put("spanishminimalstem", Void.class)
.put("delimitedboost", Void.class)
// LUCENE-9574: test flags on tokens vs a bitmask and drops tokens that have all specified flags
.put("dropifflagged", Void.class)
.put("japanesecompletion", Void.class)
// LUCENE-9575: recognize arbitrary patterns that include punctuation
.put("patterntyping", Void.class)
// LUCENE-10248
.put("spanishpluralstem", Void.class)
// LUCENE-10352
.put("daitchmokotoffsoundex", Void.class)
// https://github.com/apache/lucene/pull/12169
.put("word2vecsynonym", Void.class)
// https://github.com/apache/lucene/pull/12915
.put("japanesehiraganauppercase", Void.class)
.put("japanesekatakanauppercase", Void.class)
.immutableMap();
static final Map> KNOWN_CHARFILTERS = new MapBuilder>()
// exposed in ES
.put("htmlstrip", MovedToAnalysisCommon.class)
.put("mapping", MovedToAnalysisCommon.class)
.put("patternreplace", MovedToAnalysisCommon.class)
// TODO: these charfilters are not yet exposed: useful?
// handling of zwnj for persian
.put("persian", Void.class)
.put("cjkwidth", Void.class)
.immutableMap();
/**
* The plugin being tested. Core uses an "empty" plugin so we don't have to throw null checks all over the place.
*/
private final AnalysisPlugin plugin;
public AnalysisFactoryTestCase(AnalysisPlugin plugin) {
this.plugin = Objects.requireNonNull(plugin, "plugin is required. use an empty plugin for core");
}
protected Map> getCharFilters() {
return KNOWN_CHARFILTERS;
}
protected Map> getTokenFilters() {
return KNOWN_TOKENFILTERS;
}
protected Map> getTokenizers() {
return KNOWN_TOKENIZERS;
}
/**
* Map containing pre-configured token filters that should be available
* after installing this plugin. The map is from the name of the token
* filter to the class of the Lucene {@link TokenFilterFactory} that it
* is emulating. If the Lucene {@linkplain TokenFilterFactory} is
* {@code null} then the test will look it up for you from the name. If
* there is no Lucene {@linkplain TokenFilterFactory} then the right
* hand side should be {@link Void}.
*/
protected Map> getPreConfiguredTokenFilters() {
Map> filters = new HashMap<>();
filters.put("lowercase", null);
// for old indices
filters.put("standard", Void.class);
return filters;
}
/**
* Map containing pre-configured tokenizers that should be available
* after installing this plugin. The map is from the name of the token
* filter to the class of the Lucene {@link TokenizerFactory} that it
* is emulating. If the Lucene {@linkplain TokenizerFactory} is
* {@code null} then the test will look it up for you from the name.
* If there is no Lucene {@linkplain TokenizerFactory} then the right
* hand side should be {@link Void}.
*/
protected Map> getPreConfiguredTokenizers() {
Map> tokenizers = new HashMap<>();
// TODO drop this temporary shim when all the old style tokenizers have been migrated to new style
for (PreBuiltTokenizers tokenizer : PreBuiltTokenizers.values()) {
tokenizers.put(tokenizer.name().toLowerCase(Locale.ROOT), null);
}
return tokenizers;
}
public Map> getPreConfiguredCharFilters() {
return emptyMap();
}
public void testTokenizers() {
Set missing = new TreeSet();
missing.addAll(
org.apache.lucene.analysis.TokenizerFactory.availableTokenizers()
.stream()
.map(key -> key.toLowerCase(Locale.ROOT))
.collect(Collectors.toSet())
);
missing.removeAll(getTokenizers().keySet());
assertTrue("new tokenizers found, please update KNOWN_TOKENIZERS: " + missing.toString(), missing.isEmpty());
}
public void testCharFilters() {
Set missing = new TreeSet();
missing.addAll(
org.apache.lucene.analysis.CharFilterFactory.availableCharFilters()
.stream()
.map(key -> key.toLowerCase(Locale.ROOT))
.collect(Collectors.toSet())
);
missing.removeAll(getCharFilters().keySet());
assertTrue("new charfilters found, please update KNOWN_CHARFILTERS: " + missing.toString(), missing.isEmpty());
}
public void testTokenFilters() {
Set missing = new TreeSet();
missing.addAll(
org.apache.lucene.analysis.TokenFilterFactory.availableTokenFilters()
.stream()
.map(key -> key.toLowerCase(Locale.ROOT))
.collect(Collectors.toSet())
);
missing.removeAll(getTokenFilters().keySet());
assertTrue("new tokenfilters found, please update KNOWN_TOKENFILTERS: " + missing.toString(), missing.isEmpty());
}
/**
* Marker class for components that have moved to the analysis-common modules. This will be
* removed when the module is complete and these analysis components aren't available to core.
*/
protected static final class MovedToAnalysisCommon {
private MovedToAnalysisCommon() {}
}
}