Skip to content

Commit 6823ca1

Browse files
Add toString() to MultiSearchRequest, MultiGetRequest and CreateIndexRequest classes. (#12163)
fix #12144 Signed-off-by: Guillaume Alvarez <7364145+guillaume-alvarez@users.noreply.github.com>
1 parent ef1a9c6 commit 6823ca1

File tree

7 files changed

+80
-0
lines changed

7 files changed

+80
-0
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
9595
- Add support for dependencies in plugin descriptor properties with semver range ([#11441](https://github.com/opensearch-project/OpenSearch/pull/11441))
9696
- Add community_id ingest processor ([#12121](https://github.com/opensearch-project/OpenSearch/pull/12121))
9797
- Introduce query level setting `index.query.max_nested_depth` limiting nested queries ([#3268](https://github.com/opensearch-project/OpenSearch/issues/3268)
98+
- Add toString methods to MultiSearchRequest, MultiGetRequest and CreateIndexRequest ([#12163](https://github.com/opensearch-project/OpenSearch/pull/12163))
9899

99100
### Dependencies
100101
- Bump `peter-evans/find-comment` from 2 to 3 ([#12288](https://github.com/opensearch-project/OpenSearch/pull/12288))

server/src/main/java/org/opensearch/action/admin/indices/create/CreateIndexRequest.java

+21
Original file line numberDiff line numberDiff line change
@@ -594,4 +594,25 @@ public void writeTo(StreamOutput out) throws IOException {
594594
}
595595
waitForActiveShards.writeTo(out);
596596
}
597+
598+
@Override
599+
public String toString() {
600+
return "CreateIndexRequest{"
601+
+ "cause='"
602+
+ cause
603+
+ '\''
604+
+ ", index='"
605+
+ index
606+
+ '\''
607+
+ ", settings="
608+
+ settings
609+
+ ", mappings='"
610+
+ mappings
611+
+ '\''
612+
+ ", aliases="
613+
+ aliases
614+
+ ", waitForActiveShards="
615+
+ waitForActiveShards
616+
+ '}';
617+
}
597618
}

server/src/main/java/org/opensearch/action/get/MultiGetRequest.java

+15
Original file line numberDiff line numberDiff line change
@@ -583,4 +583,19 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
583583
return builder;
584584
}
585585

586+
@Override
587+
public String toString() {
588+
return "MultiGetRequest{"
589+
+ "preference='"
590+
+ preference
591+
+ '\''
592+
+ ", realtime="
593+
+ realtime
594+
+ ", refresh="
595+
+ refresh
596+
+ ", items="
597+
+ items
598+
+ '}';
599+
}
600+
586601
}

server/src/main/java/org/opensearch/action/search/MultiSearchRequest.java

+12
Original file line numberDiff line numberDiff line change
@@ -398,4 +398,16 @@ public boolean shouldCancelChildrenOnCancellation() {
398398
}
399399
};
400400
}
401+
402+
@Override
403+
public String toString() {
404+
return "MultiSearchRequest{"
405+
+ "maxConcurrentSearchRequests="
406+
+ maxConcurrentSearchRequests
407+
+ ", requests="
408+
+ requests
409+
+ ", indicesOptions="
410+
+ indicesOptions
411+
+ '}';
412+
}
401413
}

server/src/test/java/org/opensearch/action/admin/indices/create/CreateIndexRequestTests.java

+15
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050
import java.util.Map;
5151
import java.util.Set;
5252

53+
import static org.hamcrest.CoreMatchers.containsString;
5354
import static org.hamcrest.CoreMatchers.equalTo;
5455

5556
public class CreateIndexRequestTests extends OpenSearchTestCase {
@@ -150,6 +151,20 @@ public void testSettingsType() throws IOException {
150151
assertThat(e.getMessage(), equalTo("key [settings] must be an object"));
151152
}
152153

154+
public void testToString() throws IOException {
155+
CreateIndexRequest request = new CreateIndexRequest("foo");
156+
String mapping = JsonXContent.contentBuilder()
157+
.startObject()
158+
.startObject(MapperService.SINGLE_MAPPING_NAME)
159+
.endObject()
160+
.endObject()
161+
.toString();
162+
request.mapping(mapping);
163+
164+
assertThat(request.toString(), containsString("index='foo'"));
165+
assertThat(request.toString(), containsString("mappings='{\"_doc\":{}}'"));
166+
}
167+
153168
public static void assertMappingsEqual(Map<String, String> expected, Map<String, String> actual) throws IOException {
154169
assertEquals(expected.keySet(), actual.keySet());
155170

server/src/test/java/org/opensearch/action/get/MultiGetRequestTests.java

+8
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232

3333
package org.opensearch.action.get;
3434

35+
import org.opensearch.action.get.MultiGetRequest.Item;
3536
import org.opensearch.common.xcontent.XContentFactory;
3637
import org.opensearch.common.xcontent.XContentType;
3738
import org.opensearch.core.common.ParsingException;
@@ -141,6 +142,13 @@ public void testXContentSerialization() throws IOException {
141142
}
142143
}
143144

145+
public void testToString() {
146+
MultiGetRequest req = createTestInstance();
147+
for (Item items : req.getItems()) {
148+
assertThat(req.toString(), containsString(items.toString()));
149+
}
150+
}
151+
144152
private MultiGetRequest createTestInstance() {
145153
int numItems = randomIntBetween(0, 128);
146154
MultiGetRequest request = new MultiGetRequest();

server/src/test/java/org/opensearch/action/search/MultiSearchRequestTests.java

+8
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@
7373
import static java.util.Collections.singletonList;
7474
import static org.opensearch.search.RandomSearchRequestGenerator.randomSearchRequest;
7575
import static org.opensearch.test.EqualsHashCodeTestUtils.checkEqualsAndHashCode;
76+
import static org.hamcrest.Matchers.containsString;
7677
import static org.hamcrest.Matchers.equalTo;
7778
import static org.hamcrest.Matchers.instanceOf;
7879
import static org.hamcrest.Matchers.is;
@@ -560,6 +561,13 @@ public void testEqualsAndHashcode() {
560561
checkEqualsAndHashCode(createMultiSearchRequest(), MultiSearchRequestTests::copyRequest, MultiSearchRequestTests::mutate);
561562
}
562563

564+
public void testToString() {
565+
MultiSearchRequest req = createMultiSearchRequest();
566+
for (SearchRequest subReq : req.requests()) {
567+
assertThat(req.toString(), containsString(subReq.toString()));
568+
}
569+
}
570+
563571
private static MultiSearchRequest mutate(MultiSearchRequest searchRequest) throws IOException {
564572
MultiSearchRequest mutation = copyRequest(searchRequest);
565573
List<CheckedRunnable<IOException>> mutators = new ArrayList<>();

0 commit comments

Comments
 (0)