[2.19] Remove commons-lang:commons-lang dependency and use gradle version catalog for commons-lang3 (#1628)

Author: owaiskazi19

build.gradle

@@ -257,10 +257,9 @@ dependencies {
     secureIntegTestPluginArchive group: 'org.opensearch.plugin', name:'opensearch-security', version: "${opensearch_build}"
     compileOnly fileTree(dir: knnJarDirectory, include: "opensearch-knn-${opensearch_build}.jar")
     compileOnly group: 'com.google.guava', name: 'guava', version:'32.1.3-jre'
-    compileOnly group: 'commons-lang', name: 'commons-lang', version: '2.6'
     api group: 'org.opensearch', name:'opensearch-ml-client', version: "${opensearch_build}"
     testFixturesImplementation "org.opensearch.test:framework:${opensearch_version}"
-    implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.14.0'
+    compileOnly group: 'org.apache.commons', name: 'commons-lang3', version: "${versions.commonslang}"
     // ml-common excluded reflection for runtime so we need to add it by ourselves.
     // https://github.com/opensearch-project/ml-commons/commit/464bfe34c66d7a729a00dd457f03587ea4e504d9
     // TODO: Remove following three lines of dependencies if ml-common include them in their jar
@@ -281,7 +280,7 @@ dependencies {
     runtimeOnly("com.fasterxml.jackson.core:jackson-annotations:${versions.jackson}")
     runtimeOnly("com.fasterxml.jackson.core:jackson-databind:${versions.jackson_databind}")
     testFixturesImplementation "org.opensearch:common-utils:${version}"
-    testFixturesImplementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.14.0'
+    testFixturesImplementation group: 'org.apache.commons', name: 'commons-lang3', version: "${versions.commonslang}"
     testFixturesCompileOnly group: 'com.google.guava', name: 'guava', version:'32.1.3-jre'
     testFixturesCompileOnly fileTree(dir: knnJarDirectory, include: "opensearch-knn-${opensearch_build}.jar")
 }

qa/build.gradle

@@ -34,7 +34,7 @@ dependencies {
     zipArchive group: 'org.opensearch.plugin', name:'opensearch-ml-plugin', version: "${opensearch_build}"
     compileOnly fileTree(dir: knnJarDirectory, include: "opensearch-knn-${opensearch_build}.jar")
     compileOnly group: 'com.google.guava', name: 'guava', version:'32.1.3-jre'
-    compileOnly group: 'commons-lang', name: 'commons-lang', version: '2.6'
+    compileOnly group: 'org.apache.commons', name: 'commons-lang3', version: "${versions.commonslang}"
     // json-path 2.9.0 depends on slf4j 2.0.11, which conflicts with the version used by OpenSearch core.
     // Excluding slf4j here since json-path is only used for testing, and logging failures in this context are acceptable.
     testRuntimeOnly('com.jayway.jsonpath:json-path:2.9.0') {

src/main/java/org/opensearch/neuralsearch/query/HybridQueryBuilder.java

@@ -12,7 +12,7 @@
 import java.util.Objects;
 import java.util.stream.Collectors;
 
-import org.apache.commons.lang.builder.EqualsBuilder;
+import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.lucene.search.BooleanClause.Occur;
 import org.apache.lucene.search.Query;
 import org.opensearch.common.lucene.search.Queries;

src/main/java/org/opensearch/neuralsearch/query/NeuralQueryBuilder.java

@@ -24,8 +24,8 @@
 import java.util.Objects;
 import java.util.function.Supplier;
 
-import org.apache.commons.lang.StringUtils;
-import org.apache.commons.lang.builder.EqualsBuilder;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.lucene.search.Query;
 import org.opensearch.common.SetOnce;
 import org.opensearch.core.ParseField;

src/main/java/org/opensearch/neuralsearch/query/NeuralSparseQueryBuilder.java

@@ -13,9 +13,9 @@
 import java.util.function.BiConsumer;
 import java.util.function.Supplier;
 
-import org.apache.commons.lang.StringUtils;
-import org.apache.commons.lang.builder.EqualsBuilder;
-import org.apache.commons.lang.builder.HashCodeBuilder;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.lang3.builder.EqualsBuilder;
+import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.apache.lucene.document.FeatureField;
 import org.apache.lucene.search.BooleanClause;
 import org.apache.lucene.search.BooleanQuery;

src/main/java/org/opensearch/neuralsearch/util/prune/PruneType.java

@@ -4,7 +4,7 @@
  */
 package org.opensearch.neuralsearch.util.prune;
 
-import org.apache.commons.lang.StringUtils;
+import org.apache.commons.lang3.StringUtils;
 
 import java.util.Locale;
 

src/test/java/org/opensearch/neuralsearch/processor/InferenceProcessorTestCase.java

@@ -5,7 +5,7 @@
 package org.opensearch.neuralsearch.processor;
 
 import com.google.common.collect.ImmutableList;
-import org.apache.commons.lang.math.RandomUtils;
+import org.apache.commons.lang3.RandomUtils;
 import org.opensearch.index.mapper.IndexFieldMapper;
 import org.opensearch.ingest.IngestDocument;
 import org.opensearch.ingest.IngestDocumentWrapper;
@@ -65,7 +65,7 @@ protected List<List<Float>> createRandomOneDimensionalMockVector(int numOfVector
         for (int i = 0; i < numOfVectors; i++) {
             List<Float> numbers = new ArrayList<>();
             for (int j = 0; j < vectorDimension; j++) {
-                Float nextFloat = RandomUtils.nextFloat() * (max - min) + min;
+                Float nextFloat = RandomUtils.nextFloat(0.0f, 1.0f) * (max - min) + min;
                 numbers.add(nextFloat);
             }
             result.add(numbers);

src/test/java/org/opensearch/neuralsearch/processor/combination/BaseScoreCombinationTechniqueTests.java

@@ -8,7 +8,7 @@
 import java.util.List;
 import java.util.function.BiFunction;
 
-import org.apache.commons.lang.ArrayUtils;
+import org.apache.commons.lang3.ArrayUtils;
 import org.opensearch.test.OpenSearchTestCase;
 
 import com.carrotsearch.randomizedtesting.RandomizedTest;

src/test/java/org/opensearch/neuralsearch/query/HybridQueryBuilderTests.java

@@ -50,7 +50,6 @@
 import org.opensearch.core.common.io.stream.NamedWriteableRegistry;
 import org.opensearch.core.index.Index;
 import org.opensearch.core.xcontent.NamedXContentRegistry;
-import org.opensearch.core.xcontent.ToXContent;
 import org.opensearch.core.xcontent.XContentBuilder;
 import org.opensearch.core.xcontent.XContentParser;
 import org.opensearch.index.IndexSettings;
@@ -154,8 +153,17 @@ public void testDoToQuery_whenOneSubquery_thenBuildSuccessfully() {
         assertNotNull(queryOnlyNeural);
         assertTrue(queryOnlyNeural instanceof HybridQuery);
         assertEquals(1, ((HybridQuery) queryOnlyNeural).getSubQueries().size());
-        assertTrue(((HybridQuery) queryOnlyNeural).getSubQueries().iterator().next() instanceof NativeEngineKnnVectorQuery);
-        KNNQuery knnQuery = ((NativeEngineKnnVectorQuery) ((HybridQuery) queryOnlyNeural).getSubQueries().iterator().next()).getKnnQuery();
+
+        // the query may be returned as KNNQuery directly instead of wrapped in NativeEngineKnnVectorQuery
+        Query subQuery = ((HybridQuery) queryOnlyNeural).getSubQueries().iterator().next();
+        KNNQuery knnQuery = null;
+        if (subQuery instanceof NativeEngineKnnVectorQuery) {
+            knnQuery = ((NativeEngineKnnVectorQuery) subQuery).getKnnQuery();
+        } else if (subQuery instanceof KNNQuery) {
+            knnQuery = (KNNQuery) subQuery;
+        } else {
+            fail("Expected NativeEngineKnnVectorQuery or KNNQuery but got " + subQuery.getClass().getName());
+        }
         assertEquals(VECTOR_FIELD_NAME, knnQuery.getField());
         assertEquals(K, knnQuery.getK());
         assertNotNull(knnQuery.getQueryVector());
@@ -203,8 +211,17 @@ public void testDoToQuery_whenMultipleSubqueries_thenBuildSuccessfully() {
         // verify knn vector query
         Iterator<Query> queryIterator = ((HybridQuery) queryTwoSubQueries).getSubQueries().iterator();
         Query firstQuery = queryIterator.next();
-        assertTrue(firstQuery instanceof NativeEngineKnnVectorQuery);
-        KNNQuery knnQuery = ((NativeEngineKnnVectorQuery) firstQuery).getKnnQuery();
+
+        // Handle both possible query types - after commons-lang3 migration,
+        // the query may be returned as KNNQuery directly instead of wrapped in NativeEngineKnnVectorQuery
+        KNNQuery knnQuery = null;
+        if (firstQuery instanceof NativeEngineKnnVectorQuery) {
+            knnQuery = ((NativeEngineKnnVectorQuery) firstQuery).getKnnQuery();
+        } else if (firstQuery instanceof KNNQuery) {
+            knnQuery = (KNNQuery) firstQuery;
+        } else {
+            fail("Expected NativeEngineKnnVectorQuery or KNNQuery but got " + firstQuery.getClass().getName());
+        }
         assertEquals(VECTOR_FIELD_NAME, knnQuery.getField());
         assertEquals(K, knnQuery.getK());
         assertNotNull(knnQuery.getQueryVector());
@@ -530,7 +547,7 @@ public void testToXContent_whenIncomingJsonIsCorrect_thenSuccessful() {
         when(mockQueryShardContext.fieldMapper(eq(TEXT_FIELD_NAME))).thenReturn(fieldType);
 
         XContentBuilder builder = XContentFactory.jsonBuilder();
-        builder = queryBuilder.toXContent(builder, ToXContent.EMPTY_PARAMS);
+        builder = queryBuilder.toXContent(builder, EMPTY_PARAMS);
         Map<String, Object> out = xContentBuilderToMap(builder);
 
         Object outer = out.get(HybridQueryBuilder.NAME);

src/test/java/org/opensearch/neuralsearch/query/HybridQueryIT.java

@@ -22,8 +22,8 @@
 import java.util.Set;
 import java.util.stream.IntStream;
 
-import org.apache.commons.lang.RandomStringUtils;
-import org.apache.commons.lang.math.RandomUtils;
+import org.apache.commons.lang3.RandomStringUtils;
+import org.apache.commons.lang3.RandomUtils;
 import org.apache.lucene.search.join.ScoreMode;
 import org.junit.Before;
 import org.opensearch.client.ResponseException;
@@ -1178,7 +1178,7 @@ private void initializeIndexIfNotExist(String indexName, int numberOfShards, int
                     indexName,
                     String.valueOf(i),
                     INTEGER_FIELD_PRICE,
-                    RandomUtils.nextInt(1000),
+                    RandomUtils.nextInt(0, 1000),
                     KEYWORD_FIELD_1,
                     RandomStringUtils.randomAlphabetic(10)
                 );