diff --git a/qa/restart-upgrade/build.gradle b/qa/restart-upgrade/build.gradle index 628b62352..f1d53b2f0 100644 --- a/qa/restart-upgrade/build.gradle +++ b/qa/restart-upgrade/build.gradle @@ -96,6 +96,16 @@ testClusters { excludeTestsMatching "org.opensearch.knn.bwc.IndexingIT.testKNNIndexLuceneForceMerge" } } + if (!(knn_bwc_version.startsWith("2.13.") || + knn_bwc_version.startsWith("2.14.") || + knn_bwc_version.startsWith("2.15.") || + knn_bwc_version.startsWith("2.16."))) { + filter { + excludeTestsMatching "org.opensearch.knn.bwc.ModelIT.testNonKNNIndex_withModelId" + excludeTestsMatching "org.opensearch.knn.bwc.PainlessScriptScoringIT.testNonKNNIndex_withMethodParams_withFaissEngine" + excludeTestsMatching "org.opensearch.knn.bwc.ScriptScoringIT.testNonKNNIndex_withMethodParams_withFaissEngine" + } + } nonInputProperties.systemProperty('tests.rest.cluster', "${-> testClusters."${baseName}".allHttpSocketURI.join(",")}") nonInputProperties.systemProperty('tests.clustername', "${-> testClusters."${baseName}".getName()}") @@ -170,6 +180,17 @@ testClusters { } } + if (!(knn_bwc_version.startsWith("2.13.") || + knn_bwc_version.startsWith("2.14.") || + knn_bwc_version.startsWith("2.15.") || + knn_bwc_version.startsWith("2.16."))) { + filter { + excludeTestsMatching "org.opensearch.knn.bwc.ModelIT.testNonKNNIndex_withModelId" + excludeTestsMatching "org.opensearch.knn.bwc.PainlessScriptScoringIT.testNonKNNIndex_withMethodParams_withFaissEngine" + excludeTestsMatching "org.opensearch.knn.bwc.ScriptScoringIT.testNonKNNIndex_withMethodParams_withFaissEngine" + } + } + nonInputProperties.systemProperty('tests.rest.cluster', "${-> testClusters."${baseName}".allHttpSocketURI.join(",")}") nonInputProperties.systemProperty('tests.clustername', "${-> testClusters."${baseName}".getName()}") systemProperty 'tests.security.manager', 'false' diff --git a/qa/restart-upgrade/src/test/java/org/opensearch/knn/bwc/AbstractRestartUpgradeTestCase.java b/qa/restart-upgrade/src/test/java/org/opensearch/knn/bwc/AbstractRestartUpgradeTestCase.java index 667a39d16..e79e2abef 100644 --- a/qa/restart-upgrade/src/test/java/org/opensearch/knn/bwc/AbstractRestartUpgradeTestCase.java +++ b/qa/restart-upgrade/src/test/java/org/opensearch/knn/bwc/AbstractRestartUpgradeTestCase.java @@ -20,9 +20,12 @@ public abstract class AbstractRestartUpgradeTestCase extends KNNRestTestCase { @Before protected void setIndex() { - // Creating index name by concatenating "knn-bwc-" prefix with test method name - // for all the tests in this sub-project - testIndex = KNN_BWC_PREFIX + getTestName().toLowerCase(Locale.ROOT); + // Creating index name by concatenating "knn-bwc-" prefix with test class name and then with method name + // for all the tests in this sub-project to generate unique index name + testIndex = new StringBuilder().append(KNN_BWC_PREFIX) + .append(getTestClass().getName().toLowerCase(Locale.ROOT)) + .append(getTestName().toLowerCase(Locale.ROOT)) + .toString(); } @Override diff --git a/qa/restart-upgrade/src/test/java/org/opensearch/knn/bwc/ModelIT.java b/qa/restart-upgrade/src/test/java/org/opensearch/knn/bwc/ModelIT.java index c2bcdbf83..29496cff9 100644 --- a/qa/restart-upgrade/src/test/java/org/opensearch/knn/bwc/ModelIT.java +++ b/qa/restart-upgrade/src/test/java/org/opensearch/knn/bwc/ModelIT.java @@ -43,6 +43,7 @@ public class ModelIT extends AbstractRestartUpgradeTestCase { private static final String TEST_MODEL_INDEX_DEFAULT = KNN_BWC_PREFIX + "test-model-index-default"; private static final String TRAINING_INDEX = KNN_BWC_PREFIX + "train-index"; private static final String TRAINING_INDEX_DEFAULT = KNN_BWC_PREFIX + "train-index-default"; + private static final String TRAINING_INDEX_FOR_NON_KNN_INDEX = KNN_BWC_PREFIX + "train-index-for-non-knn-index"; private static final String TRAINING_FIELD = "train-field"; private static final String TEST_FIELD = "test-field"; private static final int DIMENSIONS = 5; @@ -50,17 +51,19 @@ public class ModelIT extends AbstractRestartUpgradeTestCase { private static int DOC_ID_TEST_MODEL_INDEX = 0; private static int DOC_ID_TEST_MODEL_INDEX_DEFAULT = 0; private static final int DELAY_MILLI_SEC = 1000; - private static final int EXP_NUM_OF_MODELS = 2; + private static final int MIN_NUM_OF_MODELS = 2; private static final int K = 5; private static final int NUM_DOCS = 10; private static final int NUM_DOCS_TEST_MODEL_INDEX = 100; private static final int NUM_DOCS_TEST_MODEL_INDEX_DEFAULT = 100; + private static final int NUM_DOCS_TEST_MODEL_INDEX_FOR_NON_KNN_INDEX = 100; private static final int NUM_OF_ATTEMPTS = 30; private static int QUERY_COUNT = 0; private static int QUERY_COUNT_TEST_MODEL_INDEX = 0; private static int QUERY_COUNT_TEST_MODEL_INDEX_DEFAULT = 0; private static final String TEST_MODEL_ID = "test-model-id"; private static final String TEST_MODEL_ID_DEFAULT = "test-model-id-default"; + private static final String TEST_MODEL_ID_FOR_NON_KNN_INDEX = "test-model-id-for-non-knn-index"; private static final String MODEL_DESCRIPTION = "Description for train model test"; // KNN model test @@ -135,6 +138,32 @@ public void testKNNModelDefault() throws Exception { } } + public void testNonKNNIndex_withModelId() throws Exception { + if (isRunningAgainstOldCluster()) { + + // Create a training index and randomly ingest data into it + createBasicKnnIndex(TRAINING_INDEX_FOR_NON_KNN_INDEX, TRAINING_FIELD, DIMENSIONS); + bulkIngestRandomVectors(TRAINING_INDEX_FOR_NON_KNN_INDEX, TRAINING_FIELD, NUM_DOCS, DIMENSIONS); + + trainKNNModel(TEST_MODEL_ID_FOR_NON_KNN_INDEX, TRAINING_INDEX_FOR_NON_KNN_INDEX, TRAINING_FIELD, DIMENSIONS, MODEL_DESCRIPTION); + validateModelCreated(TEST_MODEL_ID_FOR_NON_KNN_INDEX); + + createKnnIndex( + testIndex, + createKNNDefaultScriptScoreSettings(), + modelIndexMapping(TEST_FIELD, TEST_MODEL_ID_FOR_NON_KNN_INDEX) + ); + addKNNDocs(testIndex, TEST_FIELD, DIMENSIONS, DOC_ID, NUM_DOCS); + } else { + Thread.sleep(1000); + DOC_ID = NUM_DOCS; + addKNNDocs(testIndex, TEST_FIELD, DIMENSIONS, DOC_ID, NUM_DOCS); + deleteKNNIndex(testIndex); + deleteKNNIndex(TRAINING_INDEX_FOR_NON_KNN_INDEX); + deleteKNNModel(TEST_MODEL_ID_FOR_NON_KNN_INDEX); + } + } + // Delete Models and ".opensearch-knn-models" index to clear cluster metadata @AfterClass public static void wipeAllModels() throws IOException { @@ -168,7 +197,7 @@ public void searchKNNModel(String testModelID) throws Exception { XContentParser parser = createParser(MediaTypeRegistry.getDefaultMediaType().xContent(), responseBody); SearchResponse searchResponse = SearchResponse.fromXContent(parser); assertNotNull(searchResponse); - assertEquals(EXP_NUM_OF_MODELS, searchResponse.getHits().getHits().length); + assertTrue(MIN_NUM_OF_MODELS <= searchResponse.getHits().getHits().length); for (SearchHit hit : searchResponse.getHits().getHits()) { assertTrue(hit.getId().startsWith(testModelID)); diff --git a/qa/restart-upgrade/src/test/java/org/opensearch/knn/bwc/PainlessScriptScoringIT.java b/qa/restart-upgrade/src/test/java/org/opensearch/knn/bwc/PainlessScriptScoringIT.java index 084938580..36bc4e7e8 100644 --- a/qa/restart-upgrade/src/test/java/org/opensearch/knn/bwc/PainlessScriptScoringIT.java +++ b/qa/restart-upgrade/src/test/java/org/opensearch/knn/bwc/PainlessScriptScoringIT.java @@ -5,6 +5,9 @@ package org.opensearch.knn.bwc; +import org.opensearch.knn.index.SpaceType; +import org.opensearch.knn.index.engine.KNNEngine; + public class PainlessScriptScoringIT extends AbstractRestartUpgradeTestCase { private static final String TEST_FIELD = "test-field"; private static final int DIMENSIONS = 5; @@ -53,4 +56,26 @@ public void testKNNL1PainlessScriptScore() throws Exception { } } + public void testNonKNNIndex_withMethodParams_withFaissEngine() throws Exception { + if (isRunningAgainstOldCluster()) { + createKnnIndex( + testIndex, + createKNNDefaultScriptScoreSettings(), + createKnnIndexMapping(TEST_FIELD, DIMENSIONS, "hnsw", KNNEngine.FAISS.getName(), SpaceType.DEFAULT.getValue(), false) + ); + addKNNDocs(testIndex, TEST_FIELD, DIMENSIONS, DOC_ID, NUM_DOCS); + } else { + DOC_ID = NUM_DOCS; + QUERY_COUNT = NUM_DOCS; + String source = createL1PainlessScriptSource(TEST_FIELD, DIMENSIONS, QUERY_COUNT); + validateKNNPainlessScriptScoreSearch(testIndex, TEST_FIELD, source, QUERY_COUNT, K); + addKNNDocs(testIndex, TEST_FIELD, DIMENSIONS, DOC_ID, NUM_DOCS); + QUERY_COUNT = QUERY_COUNT + NUM_DOCS; + source = createL1PainlessScriptSource(TEST_FIELD, DIMENSIONS, QUERY_COUNT); + validateKNNPainlessScriptScoreSearch(testIndex, TEST_FIELD, source, QUERY_COUNT, K); + forceMergeKnnIndex(testIndex, 1); + validateKNNPainlessScriptScoreSearch(testIndex, TEST_FIELD, source, QUERY_COUNT, K); + deleteKNNIndex(testIndex); + } + } } diff --git a/qa/restart-upgrade/src/test/java/org/opensearch/knn/bwc/ScriptScoringIT.java b/qa/restart-upgrade/src/test/java/org/opensearch/knn/bwc/ScriptScoringIT.java index c4fd05c03..81110611d 100644 --- a/qa/restart-upgrade/src/test/java/org/opensearch/knn/bwc/ScriptScoringIT.java +++ b/qa/restart-upgrade/src/test/java/org/opensearch/knn/bwc/ScriptScoringIT.java @@ -14,6 +14,7 @@ import org.opensearch.knn.KNNResult; import org.opensearch.knn.index.SpaceType; import org.opensearch.core.rest.RestStatus; +import org.opensearch.knn.index.engine.KNNEngine; import java.util.Collections; import java.util.HashMap; @@ -96,6 +97,25 @@ public void testKNNInnerProductScriptScore() throws Exception { } } + public void testNonKNNIndex_withMethodParams_withFaissEngine() throws Exception { + if (isRunningAgainstOldCluster()) { + createKnnIndex( + testIndex, + createKNNDefaultScriptScoreSettings(), + createKnnIndexMapping(TEST_FIELD, DIMENSIONS, "hnsw", KNNEngine.FAISS.getName(), SpaceType.DEFAULT.getValue(), false) + ); + addKNNDocs(testIndex, TEST_FIELD, DIMENSIONS, DOC_ID, NUM_DOCS); + } else { + QUERY_COUNT = NUM_DOCS; + DOC_ID = NUM_DOCS; + validateKNNScriptScoreSearch(testIndex, TEST_FIELD, DIMENSIONS, QUERY_COUNT, K, SpaceType.L2); + addKNNDocs(testIndex, TEST_FIELD, DIMENSIONS, DOC_ID, NUM_DOCS); + QUERY_COUNT = QUERY_COUNT + NUM_DOCS; + validateKNNScriptScoreSearch(testIndex, TEST_FIELD, DIMENSIONS, QUERY_COUNT, K, SpaceType.L2); + deleteKNNIndex(testIndex); + } + } + // Validate Script score search for space_type : "inner_product" private void validateKNNInnerProductScriptScoreSearch(String testIndex, String testField, int dimension, int numDocs, int k) throws Exception { @@ -121,5 +141,4 @@ private void validateKNNInnerProductScriptScoreSearch(String testIndex, String t assertEquals(expDocID, actualDocID); } } - } diff --git a/src/testFixtures/java/org/opensearch/knn/KNNRestTestCase.java b/src/testFixtures/java/org/opensearch/knn/KNNRestTestCase.java index cc575aa02..7889c7c4a 100644 --- a/src/testFixtures/java/org/opensearch/knn/KNNRestTestCase.java +++ b/src/testFixtures/java/org/opensearch/knn/KNNRestTestCase.java @@ -81,6 +81,7 @@ import static org.opensearch.knn.common.KNNConstants.METHOD_PARAMETER_NLIST; import static org.opensearch.knn.common.KNNConstants.METHOD_PARAMETER_SPACE_TYPE; import static org.opensearch.knn.common.KNNConstants.MODEL_DESCRIPTION; +import static org.opensearch.knn.common.KNNConstants.MODEL_ID; import static org.opensearch.knn.common.KNNConstants.MODEL_STATE; import static org.opensearch.knn.common.KNNConstants.TRAIN_FIELD_PARAMETER; import static org.opensearch.knn.common.KNNConstants.TRAIN_INDEX_PARAMETER; @@ -381,15 +382,15 @@ protected void putMappingRequest(String index, String mapping) throws IOExceptio } /** - * Utility to create a Knn Index Mapping + * Utility to create a Knn Index Mapping for given model id */ - protected String createKnnIndexMapping(String fieldName, Integer dimensions) throws IOException { + public String createKnnIndexMapping(String fieldName, String modelId) throws IOException { return XContentFactory.jsonBuilder() .startObject() - .startObject("properties") + .startObject(PROPERTIES) .startObject(fieldName) - .field("type", "knn_vector") - .field("dimension", dimensions.toString()) + .field(VECTOR_TYPE, KNN_VECTOR) + .field(MODEL_ID, modelId) .endObject() .endObject() .endObject() @@ -397,15 +398,15 @@ protected String createKnnIndexMapping(String fieldName, Integer dimensions) thr } /** - * Utility to create a Knn Index Mapping with model id + * Utility to create a Knn Index Mapping */ - protected String createKnnIndexMapping(String fieldName, String modelId) throws IOException { + protected String createKnnIndexMapping(String fieldName, Integer dimensions) throws IOException { return XContentFactory.jsonBuilder() .startObject() .startObject("properties") .startObject(fieldName) .field("type", "knn_vector") - .field("model_id", modelId) + .field("dimension", dimensions.toString()) .endObject() .endObject() .endObject()