From df00d455e393fec6c3106918903d2e27efb7bf90 Mon Sep 17 00:00:00 2001 From: Heemin Kim Date: Mon, 7 Aug 2023 15:51:00 -0700 Subject: [PATCH] [Refactor] Strings utility methods to core library (#379) Signed-off-by: Heemin Kim --- CHANGELOG.md | 1 + .../ip2geo/action/RestGetDatasourceHandler.java | 2 +- .../ip2geo/common/ParameterValidator.java | 2 +- .../geospatial/GeospatialRestTestCase.java | 12 ++++++------ .../upload/geojson/UploadGeoJSONResponseTests.java | 2 +- .../query/xyshape/XYShapeQueryBuilderTests.java | 13 +++++-------- .../ip2geo/action/GetDatasourceResponseTests.java | 3 +-- .../ip2geo/common/InputFormatValidatorTests.java | 2 +- .../geospatial/ip2geo/dao/GeoIpDataDaoTests.java | 3 +-- .../stats/upload/TotalUploadStatsTests.java | 13 ++++++------- .../geospatial/stats/upload/UploadMetricTests.java | 2 +- .../stats/upload/UploadStatsResponseTests.java | 9 ++++----- .../stats/upload/UploadStatsServiceTests.java | 13 ++++++------- .../geospatial/stats/upload/UploadStatsTests.java | 3 +-- 14 files changed, 36 insertions(+), 44 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1767c20c..2619a8f1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,4 +24,5 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ### Maintenance * Change package for Strings.hasText ([#314](https://github.com/opensearch-project/geospatial/pull/314)) * Refactor LifecycleComponent package path ([#377](https://github.com/opensearch-project/geospatial/pull/377)) +* [Refactor] Strings utility methods to core library ([#379](https://github.com/opensearch-project/geospatial/pull/379)) ### Refactoring diff --git a/src/main/java/org/opensearch/geospatial/ip2geo/action/RestGetDatasourceHandler.java b/src/main/java/org/opensearch/geospatial/ip2geo/action/RestGetDatasourceHandler.java index 2c9379b5..0a51660d 100644 --- a/src/main/java/org/opensearch/geospatial/ip2geo/action/RestGetDatasourceHandler.java +++ b/src/main/java/org/opensearch/geospatial/ip2geo/action/RestGetDatasourceHandler.java @@ -12,7 +12,7 @@ import java.util.List; import org.opensearch.client.node.NodeClient; -import org.opensearch.common.Strings; +import org.opensearch.core.common.Strings; import org.opensearch.rest.BaseRestHandler; import org.opensearch.rest.RestRequest; import org.opensearch.rest.action.RestToXContentListener; diff --git a/src/main/java/org/opensearch/geospatial/ip2geo/common/ParameterValidator.java b/src/main/java/org/opensearch/geospatial/ip2geo/common/ParameterValidator.java index 56a2ea1d..deccbf21 100644 --- a/src/main/java/org/opensearch/geospatial/ip2geo/common/ParameterValidator.java +++ b/src/main/java/org/opensearch/geospatial/ip2geo/common/ParameterValidator.java @@ -11,7 +11,7 @@ import java.util.Locale; import org.apache.commons.lang3.StringUtils; -import org.opensearch.common.Strings; +import org.opensearch.core.common.Strings; /** * Parameter validator for IP2Geo APIs diff --git a/src/test/java/org/opensearch/geospatial/GeospatialRestTestCase.java b/src/test/java/org/opensearch/geospatial/GeospatialRestTestCase.java index deae4225..62654f52 100644 --- a/src/test/java/org/opensearch/geospatial/GeospatialRestTestCase.java +++ b/src/test/java/org/opensearch/geospatial/GeospatialRestTestCase.java @@ -101,7 +101,7 @@ protected static Response createPipeline(String name, Optional descripti builder.endObject(); Request request = new Request("PUT", buildPipelinePath(name)); - request.setJsonEntity(org.opensearch.common.Strings.toString(builder)); + request.setJsonEntity(builder.toString()); return client().performRequest(request); } @@ -118,7 +118,7 @@ protected Response createDatasource(final String name, Map prope builder.endObject(); Request request = new Request(PUT, buildDatasourcePath(name)); - request.setJsonEntity(org.opensearch.common.Strings.toString(builder)); + request.setJsonEntity(builder.toString()); return client().performRequest(request); } @@ -178,7 +178,7 @@ protected Response updateDatasource(final String name, Map prope builder.endObject(); Request request = new Request(PUT, String.join(URL_DELIMITER, buildDatasourcePath(name), SETTINGS)); - request.setJsonEntity(org.opensearch.common.Strings.toString(builder)); + request.setJsonEntity(builder.toString()); return client().performRequest(request); } @@ -188,7 +188,7 @@ protected Map simulatePipeline(final String name, List d builder.endObject(); Request request = new Request(GET, String.join(URL_DELIMITER, buildPipelinePath(name), SIMULATE)); - request.setJsonEntity(org.opensearch.common.Strings.toString(builder)); + request.setJsonEntity(builder.toString()); Response response = client().performRequest(request); return createParser(XContentType.JSON.xContent(), EntityUtils.toString(response.getEntity())).map(); } @@ -199,7 +199,7 @@ protected static void createIndex(String name, Settings settings, Map XContentBuilder builder = JsonXContent.contentBuilder().startObject(); build.accept(builder); builder.endObject(); - return org.opensearch.common.Strings.toString(builder); + return builder.toString(); } public String buildSearchAggregationsBodyAsString(CheckedConsumer aggregationsBuilder) diff --git a/src/test/java/org/opensearch/geospatial/action/upload/geojson/UploadGeoJSONResponseTests.java b/src/test/java/org/opensearch/geospatial/action/upload/geojson/UploadGeoJSONResponseTests.java index 30d63ce0..0f7feb4d 100644 --- a/src/test/java/org/opensearch/geospatial/action/upload/geojson/UploadGeoJSONResponseTests.java +++ b/src/test/java/org/opensearch/geospatial/action/upload/geojson/UploadGeoJSONResponseTests.java @@ -6,8 +6,8 @@ package org.opensearch.geospatial.action.upload.geojson; import org.opensearch.action.bulk.BulkResponse; -import org.opensearch.common.Strings; import org.opensearch.common.xcontent.XContentType; +import org.opensearch.core.common.Strings; import org.opensearch.geospatial.GeospatialTestHelper; import org.opensearch.test.OpenSearchTestCase; diff --git a/src/test/java/org/opensearch/geospatial/index/query/xyshape/XYShapeQueryBuilderTests.java b/src/test/java/org/opensearch/geospatial/index/query/xyshape/XYShapeQueryBuilderTests.java index 60103866..4da130fc 100644 --- a/src/test/java/org/opensearch/geospatial/index/query/xyshape/XYShapeQueryBuilderTests.java +++ b/src/test/java/org/opensearch/geospatial/index/query/xyshape/XYShapeQueryBuilderTests.java @@ -27,7 +27,6 @@ import org.opensearch.action.admin.indices.mapping.put.PutMappingRequest; import org.opensearch.action.get.GetRequest; import org.opensearch.action.get.GetResponse; -import org.opensearch.common.Strings; import org.opensearch.common.compress.CompressedXContent; import org.opensearch.common.geo.GeoJson; import org.opensearch.common.geo.ShapeRelation; @@ -92,12 +91,10 @@ protected void initializeAdditionalMappings(MapperService mapperService) throws mapperService.merge( DOC_TYPE, new CompressedXContent( - Strings.toString( - PutMappingRequest.simpleMapping( - XY_SHAPE_FIELD_NAME, - String.format(Locale.ROOT, "%s=%s", MAPPING_FIELD_TYPE_KEY, XYShapeQueryBuilder.NAME) - ) - ) + PutMappingRequest.simpleMapping( + XY_SHAPE_FIELD_NAME, + String.format(Locale.ROOT, "%s=%s", MAPPING_FIELD_TYPE_KEY, XYShapeQueryBuilder.NAME) + ).toString() ), MapperService.MergeReason.MAPPING_UPDATE ); @@ -120,7 +117,7 @@ protected GetResponse executeGet(GetRequest getRequest) { builder.field(expectedShapePath, (contentBuilder, params) -> GeoJson.toXContent(indexedShapeToReturn, contentBuilder, params)); builder.field(randomAlphaOfLengthBetween(10, 20), randomLowerCaseString()); builder.endObject(); - json = Strings.toString(builder); + json = builder.toString(); } catch (IOException ex) { throw new OpenSearchException(ex); } diff --git a/src/test/java/org/opensearch/geospatial/ip2geo/action/GetDatasourceResponseTests.java b/src/test/java/org/opensearch/geospatial/ip2geo/action/GetDatasourceResponseTests.java index f1efad93..00b6f801 100644 --- a/src/test/java/org/opensearch/geospatial/ip2geo/action/GetDatasourceResponseTests.java +++ b/src/test/java/org/opensearch/geospatial/ip2geo/action/GetDatasourceResponseTests.java @@ -9,7 +9,6 @@ import java.util.List; import java.util.Locale; -import org.opensearch.common.Strings; import org.opensearch.common.io.stream.BytesStreamOutput; import org.opensearch.common.xcontent.json.JsonXContent; import org.opensearch.core.common.io.stream.BytesStreamInput; @@ -35,7 +34,7 @@ public void testStreamInOut_whenValidInput_thenSucceed() throws Exception { public void testToXContent_whenValidInput_thenSucceed() throws Exception { List datasourceList = Arrays.asList(randomDatasource(), randomDatasource()); GetDatasourceResponse response = new GetDatasourceResponse(datasourceList); - String json = Strings.toString(response.toXContent(JsonXContent.contentBuilder(), null)); + String json = response.toXContent(JsonXContent.contentBuilder(), null).toString(); for (Datasource datasource : datasourceList) { assertTrue(json.contains(String.format(Locale.ROOT, "\"name\":\"%s\"", datasource.getName()))); assertTrue(json.contains(String.format(Locale.ROOT, "\"state\":\"%s\"", datasource.getState()))); diff --git a/src/test/java/org/opensearch/geospatial/ip2geo/common/InputFormatValidatorTests.java b/src/test/java/org/opensearch/geospatial/ip2geo/common/InputFormatValidatorTests.java index b9139a84..247585d2 100644 --- a/src/test/java/org/opensearch/geospatial/ip2geo/common/InputFormatValidatorTests.java +++ b/src/test/java/org/opensearch/geospatial/ip2geo/common/InputFormatValidatorTests.java @@ -10,7 +10,7 @@ import java.util.Map; import org.opensearch.common.Randomness; -import org.opensearch.common.Strings; +import org.opensearch.core.common.Strings; import org.opensearch.geospatial.GeospatialTestHelper; import org.opensearch.geospatial.ip2geo.Ip2GeoTestCase; diff --git a/src/test/java/org/opensearch/geospatial/ip2geo/dao/GeoIpDataDaoTests.java b/src/test/java/org/opensearch/geospatial/ip2geo/dao/GeoIpDataDaoTests.java index 0e7a1a26..3a985db1 100644 --- a/src/test/java/org/opensearch/geospatial/ip2geo/dao/GeoIpDataDaoTests.java +++ b/src/test/java/org/opensearch/geospatial/ip2geo/dao/GeoIpDataDaoTests.java @@ -42,7 +42,6 @@ import org.opensearch.action.search.SearchResponse; import org.opensearch.action.support.master.AcknowledgedResponse; import org.opensearch.cluster.routing.Preference; -import org.opensearch.common.Strings; import org.opensearch.common.SuppressForbidden; import org.opensearch.core.common.bytes.BytesReference; import org.opensearch.geospatial.GeospatialTestHelper; @@ -101,7 +100,7 @@ public void testCreateDocument_whenBlankValue_thenDoNotAdd() { String[] values = { "1.0.0.0/25", "USA", " ", "Seattle" }; assertEquals( "{\"_cidr\":\"1.0.0.0/25\",\"_data\":{\"country\":\"USA\",\"city\":\"Seattle\"}}", - Strings.toString(noOpsGeoIpDataDao.createDocument(names, values)) + noOpsGeoIpDataDao.createDocument(names, values).toString() ); } diff --git a/src/test/java/org/opensearch/geospatial/stats/upload/TotalUploadStatsTests.java b/src/test/java/org/opensearch/geospatial/stats/upload/TotalUploadStatsTests.java index 2775e9b7..2c26df9b 100644 --- a/src/test/java/org/opensearch/geospatial/stats/upload/TotalUploadStatsTests.java +++ b/src/test/java/org/opensearch/geospatial/stats/upload/TotalUploadStatsTests.java @@ -12,7 +12,6 @@ import java.util.Collections; import java.util.List; -import org.opensearch.common.Strings; import org.opensearch.common.xcontent.XContentType; import org.opensearch.core.xcontent.MediaTypeRegistry; import org.opensearch.core.xcontent.ToXContent; @@ -47,7 +46,7 @@ public void testToXContentWithEmptyUploadStats() throws IOException { contentBuilder.startObject(); totalUploadStats.toXContent(contentBuilder, ToXContent.EMPTY_PARAMS); contentBuilder.endObject(); - String summary = Strings.toString(contentBuilder); + String summary = contentBuilder.toString(); assertNotNull(summary); String expectedEmptyContent = "{\"total\":{}}"; assertEquals(expectedEmptyContent, summary); @@ -62,7 +61,7 @@ public void testToXContentWithRequestAPICount() throws IOException { contentBuilder.startObject(); totalUploadStats.toXContent(contentBuilder, ToXContent.EMPTY_PARAMS); contentBuilder.endObject(); - String summary = Strings.toString(contentBuilder); + String summary = contentBuilder.toString(); assertNotNull(summary); assertTrue(summary.contains(buildFieldNameValuePair(TotalUploadStats.FIELDS.REQUEST_COUNT.toString(), expectedSum))); } @@ -78,7 +77,7 @@ public void testToXContentWithUploadCount() throws IOException { contentBuilder.startObject(); totalUploadStats.toXContent(contentBuilder, ToXContent.EMPTY_PARAMS); contentBuilder.endObject(); - String summary = Strings.toString(contentBuilder); + String summary = contentBuilder.toString(); assertNotNull(summary); assertTrue(summary.contains(buildFieldNameValuePair(TotalUploadStats.FIELDS.UPLOAD.toString(), expectedSum))); } @@ -94,7 +93,7 @@ public void testToXContentWithSuccessCount() throws IOException { contentBuilder.startObject(); totalUploadStats.toXContent(contentBuilder, ToXContent.EMPTY_PARAMS); contentBuilder.endObject(); - String summary = Strings.toString(contentBuilder); + String summary = contentBuilder.toString(); assertNotNull(summary); assertTrue(summary.contains(buildFieldNameValuePair(TotalUploadStats.FIELDS.SUCCESS.toString(), expectedSum))); } @@ -110,7 +109,7 @@ public void testToXContentWithFailedCount() throws IOException { contentBuilder.startObject(); totalUploadStats.toXContent(contentBuilder, ToXContent.EMPTY_PARAMS); contentBuilder.endObject(); - String summary = Strings.toString(contentBuilder); + String summary = contentBuilder.toString(); assertNotNull(summary); assertTrue(summary.contains(buildFieldNameValuePair(TotalUploadStats.FIELDS.FAILED.toString(), expectedSum))); } @@ -126,7 +125,7 @@ public void testToXContentWithDuration() throws IOException { contentBuilder.startObject(); totalUploadStats.toXContent(contentBuilder, ToXContent.EMPTY_PARAMS); contentBuilder.endObject(); - String summary = Strings.toString(contentBuilder); + String summary = contentBuilder.toString(); assertNotNull(summary); assertTrue(summary.contains(buildFieldNameValuePair(TotalUploadStats.FIELDS.DURATION.toString(), expectedSum))); } diff --git a/src/test/java/org/opensearch/geospatial/stats/upload/UploadMetricTests.java b/src/test/java/org/opensearch/geospatial/stats/upload/UploadMetricTests.java index c69ca8e3..f9b0df14 100644 --- a/src/test/java/org/opensearch/geospatial/stats/upload/UploadMetricTests.java +++ b/src/test/java/org/opensearch/geospatial/stats/upload/UploadMetricTests.java @@ -11,9 +11,9 @@ import java.io.IOException; -import org.opensearch.common.Strings; import org.opensearch.common.io.stream.BytesStreamOutput; import org.opensearch.common.xcontent.XContentType; +import org.opensearch.core.common.Strings; import org.opensearch.core.common.io.stream.StreamInput; import org.opensearch.geospatial.GeospatialTestHelper; import org.opensearch.test.OpenSearchTestCase; diff --git a/src/test/java/org/opensearch/geospatial/stats/upload/UploadStatsResponseTests.java b/src/test/java/org/opensearch/geospatial/stats/upload/UploadStatsResponseTests.java index e6fec0aa..3b43f7f2 100644 --- a/src/test/java/org/opensearch/geospatial/stats/upload/UploadStatsResponseTests.java +++ b/src/test/java/org/opensearch/geospatial/stats/upload/UploadStatsResponseTests.java @@ -18,7 +18,6 @@ import java.util.stream.Collectors; import org.opensearch.cluster.ClusterName; -import org.opensearch.common.Strings; import org.opensearch.common.io.stream.BytesStreamOutput; import org.opensearch.common.xcontent.XContentFactory; import org.opensearch.core.common.io.stream.StreamInput; @@ -38,7 +37,7 @@ public void testXContentWithMetrics() throws IOException { ); final XContentBuilder serviceContentBuilder = jsonBuilder(); uploadStatsResponse.toXContent(serviceContentBuilder, ToXContent.EMPTY_PARAMS); - String nodesResponseAsString = Strings.toString(serviceContentBuilder); + String nodesResponseAsString = serviceContentBuilder.toString(); assertNotNull(nodesResponseAsString); final List uploadMetrics = getUploadMetrics(nodeResponse); @@ -46,7 +45,7 @@ public void testXContentWithMetrics() throws IOException { XContentBuilder metricContent = XContentFactory.jsonBuilder().startObject(); metric.toXContent(metricContent, ToXContent.EMPTY_PARAMS); metricContent.endObject(); - final String metricAsString = Strings.toString(metricContent); + final String metricAsString = metricContent.toString(); assertNotNull(metricAsString); assertTrue(nodesResponseAsString.contains(removeStartAndEndObject(metricAsString))); } @@ -62,14 +61,14 @@ public void testXContentWithTotalUploads() throws IOException { ); final XContentBuilder serviceContentBuilder = jsonBuilder(); uploadStatsResponse.toXContent(serviceContentBuilder, ToXContent.EMPTY_PARAMS); - String nodesResponseAsString = Strings.toString(serviceContentBuilder); + String nodesResponseAsString = serviceContentBuilder.toString(); assertNotNull(nodesResponseAsString); TotalUploadStats totalUploadStats = new TotalUploadStats(getUploadStats(nodeResponse)); XContentBuilder totalUploadStatsContent = XContentFactory.jsonBuilder().startObject(); totalUploadStats.toXContent(totalUploadStatsContent, ToXContent.EMPTY_PARAMS); totalUploadStatsContent.endObject(); - final String totalUploadStatsAsString = Strings.toString(totalUploadStatsContent); + final String totalUploadStatsAsString = totalUploadStatsContent.toString(); assertNotNull(totalUploadStatsAsString); assertTrue(nodesResponseAsString.contains(removeStartAndEndObject(totalUploadStatsAsString))); } diff --git a/src/test/java/org/opensearch/geospatial/stats/upload/UploadStatsServiceTests.java b/src/test/java/org/opensearch/geospatial/stats/upload/UploadStatsServiceTests.java index e0583a70..8098ea35 100644 --- a/src/test/java/org/opensearch/geospatial/stats/upload/UploadStatsServiceTests.java +++ b/src/test/java/org/opensearch/geospatial/stats/upload/UploadStatsServiceTests.java @@ -15,7 +15,6 @@ import java.util.List; import java.util.Map; -import org.opensearch.common.Strings; import org.opensearch.core.xcontent.ToXContent; import org.opensearch.core.xcontent.XContentBuilder; import org.opensearch.geospatial.GeospatialTestHelper; @@ -43,7 +42,7 @@ public void testXContentWithNodeID() throws IOException { UploadStatsService service = new UploadStatsService(randomMap); final XContentBuilder serviceContentBuilder = jsonBuilder(); service.toXContent(serviceContentBuilder, ToXContent.EMPTY_PARAMS); - String content = Strings.toString(serviceContentBuilder); + String content = serviceContentBuilder.toString(); assertNotNull(content); for (String nodeID : randomMap.keySet()) { assertTrue(nodeID + " is missing", content.contains(buildFieldNameValuePair(UploadStatsService.NODE_ID, nodeID))); @@ -55,7 +54,7 @@ public void testXContentWithEmptyStats() throws IOException { final XContentBuilder contentBuilder = jsonBuilder(); service.toXContent(contentBuilder, ToXContent.EMPTY_PARAMS); String emptyContent = "{\"total\":{},\"metrics\":[]}"; - assertEquals(emptyContent, Strings.toString(contentBuilder)); + assertEquals(emptyContent, contentBuilder.toString()); } public void testXContentWithTotalUploadStats() throws IOException { @@ -68,14 +67,14 @@ public void testXContentWithTotalUploadStats() throws IOException { UploadStatsService service = new UploadStatsService(randomMap); final XContentBuilder serviceContentBuilder = jsonBuilder(); service.toXContent(serviceContentBuilder, ToXContent.EMPTY_PARAMS); - String content = Strings.toString(serviceContentBuilder); + String content = serviceContentBuilder.toString(); assertNotNull(content); final XContentBuilder summary = jsonBuilder().startObject(); TotalUploadStats expectedSummary = new TotalUploadStats(uploadStats); expectedSummary.toXContent(summary, ToXContent.EMPTY_PARAMS); summary.endObject(); - final String totalUploadStatsSummary = Strings.toString(summary); + final String totalUploadStatsSummary = summary.toString(); assertNotNull(totalUploadStatsSummary); assertTrue(content.contains(removeStartAndEndObject(totalUploadStatsSummary))); } @@ -91,14 +90,14 @@ public void testXContentWithMetrics() throws IOException { UploadStatsService service = new UploadStatsService(randomMap); final XContentBuilder serviceContentBuilder = jsonBuilder(); service.toXContent(serviceContentBuilder, ToXContent.EMPTY_PARAMS); - String content = Strings.toString(serviceContentBuilder); + String content = serviceContentBuilder.toString(); assertNotNull(content); for (UploadMetric metric : randomMetrics) { XContentBuilder metricsAsContent = jsonBuilder().startObject(); metric.toXContent(metricsAsContent, ToXContent.EMPTY_PARAMS); metricsAsContent.endObject(); - final String metricsAsString = Strings.toString(metricsAsContent); + final String metricsAsString = metricsAsContent.toString(); assertNotNull(metricsAsString); assertTrue(content.contains(removeStartAndEndObject(metricsAsString))); } diff --git a/src/test/java/org/opensearch/geospatial/stats/upload/UploadStatsTests.java b/src/test/java/org/opensearch/geospatial/stats/upload/UploadStatsTests.java index 4177d5e4..4f982cbe 100644 --- a/src/test/java/org/opensearch/geospatial/stats/upload/UploadStatsTests.java +++ b/src/test/java/org/opensearch/geospatial/stats/upload/UploadStatsTests.java @@ -13,7 +13,6 @@ import java.util.Set; import java.util.stream.IntStream; -import org.opensearch.common.Strings; import org.opensearch.common.io.stream.BytesStreamOutput; import org.opensearch.common.xcontent.XContentFactory; import org.opensearch.core.common.io.stream.StreamInput; @@ -91,7 +90,7 @@ public void testStreams() throws IOException { public void testToXContent() throws IOException { UploadStats stats = UploadStatsBuilder.randomUploadStats(); XContentBuilder statsContent = XContentFactory.jsonBuilder().startObject(); - String statsAsString = Strings.toString(stats.toXContent(statsContent, ToXContent.EMPTY_PARAMS).endObject()); + String statsAsString = stats.toXContent(statsContent, ToXContent.EMPTY_PARAMS).endObject().toString(); assertNotNull(statsAsString); assertTrue(statsAsString.contains(buildFieldNameValuePair(UploadStats.FIELDS.REQUEST_COUNT.toString(), stats.getTotalAPICount()))); stats.getMetrics().forEach(uploadMetric -> {