Java api: implement toString in CountRequestBuilder

Similarly to what SearchRequestBuilder does, we print out a string representation of the query that the count request builder holds.

Closes #5555
This commit is contained in:
javanna 2015-03-02 12:40:05 +01:00 committed by Luca Cavanna
parent 78608536e2
commit 371bc5a6b3
3 changed files with 156 additions and 0 deletions

View File

@ -19,12 +19,14 @@
package org.elasticsearch.action.count; package org.elasticsearch.action.count;
import org.elasticsearch.ExceptionsHelper;
import org.elasticsearch.action.ActionListener; import org.elasticsearch.action.ActionListener;
import org.elasticsearch.action.support.QuerySourceBuilder; import org.elasticsearch.action.support.QuerySourceBuilder;
import org.elasticsearch.action.support.broadcast.BroadcastOperationRequestBuilder; import org.elasticsearch.action.support.broadcast.BroadcastOperationRequestBuilder;
import org.elasticsearch.client.Client; import org.elasticsearch.client.Client;
import org.elasticsearch.common.bytes.BytesReference; import org.elasticsearch.common.bytes.BytesReference;
import org.elasticsearch.common.xcontent.XContentBuilder; import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.common.xcontent.XContentHelper;
import org.elasticsearch.index.query.QueryBuilder; import org.elasticsearch.index.query.QueryBuilder;
/** /**
@ -144,4 +146,19 @@ public class CountRequestBuilder extends BroadcastOperationRequestBuilder<CountR
} }
return sourceBuilder; return sourceBuilder;
} }
@Override
public String toString() {
if (sourceBuilder != null) {
return sourceBuilder.toString();
}
if (request.source() != null) {
try {
return XContentHelper.convertToJson(request.source().toBytesArray(), false, true);
} catch(Exception e) {
return "{ \"error\" : \"" + ExceptionsHelper.detailedMessage(e) + "\"}";
}
}
return new QuerySourceBuilder().toString();
}
} }

View File

@ -19,6 +19,7 @@
package org.elasticsearch.action.support; package org.elasticsearch.action.support;
import org.elasticsearch.ExceptionsHelper;
import org.elasticsearch.common.bytes.BytesReference; import org.elasticsearch.common.bytes.BytesReference;
import org.elasticsearch.common.xcontent.ToXContent; import org.elasticsearch.common.xcontent.ToXContent;
import org.elasticsearch.common.xcontent.XContentBuilder; import org.elasticsearch.common.xcontent.XContentBuilder;
@ -74,4 +75,15 @@ public class QuerySourceBuilder implements ToXContent {
throw new SearchSourceBuilderException("Failed to build search source", e); throw new SearchSourceBuilderException("Failed to build search source", e);
} }
} }
@Override
public String toString() {
try {
XContentBuilder builder = XContentFactory.contentBuilder(XContentType.JSON).prettyPrint();
toXContent(builder, ToXContent.EMPTY_PARAMS);
return builder.string();
} catch (Exception e) {
return "{ \"error\" : \"" + ExceptionsHelper.detailedMessage(e) + "\"}";
}
}
} }

View File

@ -0,0 +1,127 @@
/*
* 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.
*/
package org.elasticsearch.action.count;
import org.elasticsearch.action.support.QuerySourceBuilder;
import org.elasticsearch.client.Client;
import org.elasticsearch.client.transport.TransportClient;
import org.elasticsearch.common.bytes.BytesArray;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.common.xcontent.XContentFactory;
import org.elasticsearch.common.xcontent.XContentHelper;
import org.elasticsearch.common.xcontent.XContentType;
import org.elasticsearch.index.query.QueryBuilders;
import org.elasticsearch.test.ElasticsearchTestCase;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;
import java.io.IOException;
import static org.hamcrest.CoreMatchers.equalTo;
public class CountRequestBuilderTests extends ElasticsearchTestCase {
private static Client client;
@BeforeClass
public static void initClient() {
//this client will not be hit by any request, but it needs to be a non null proper client
//that is why we create it but we don't add any transport address to it
client = new TransportClient();
}
@AfterClass
public static void closeClient() {
client.close();
client = null;
}
@Test
public void testEmptySourceToString() {
CountRequestBuilder countRequestBuilder = new CountRequestBuilder(client);
assertThat(countRequestBuilder.toString(), equalTo(new QuerySourceBuilder().toString()));
}
@Test
public void testQueryBuilderQueryToString() {
CountRequestBuilder countRequestBuilder = new CountRequestBuilder(client);
countRequestBuilder.setQuery(QueryBuilders.matchAllQuery());
assertThat(countRequestBuilder.toString(), equalTo(new QuerySourceBuilder().setQuery(QueryBuilders.matchAllQuery()).toString()));
}
@Test
public void testStringQueryToString() {
CountRequestBuilder countRequestBuilder = new CountRequestBuilder(client);
String query = "{ \"match_all\" : {} }";
countRequestBuilder.setQuery(new BytesArray(query));
assertThat(countRequestBuilder.toString(), equalTo("{\n \"query\":{ \"match_all\" : {} }\n}"));
}
@Test
public void testXContentBuilderQueryToString() throws IOException {
CountRequestBuilder countRequestBuilder = new CountRequestBuilder(client);
XContentBuilder xContentBuilder = XContentFactory.contentBuilder(randomFrom(XContentType.values()));
xContentBuilder.startObject();
xContentBuilder.startObject("match_all");
xContentBuilder.endObject();
xContentBuilder.endObject();
countRequestBuilder.setQuery(xContentBuilder);
assertThat(countRequestBuilder.toString(), equalTo(new QuerySourceBuilder().setQuery(xContentBuilder.bytes()).toString()));
}
@Test
public void testStringSourceToString() {
CountRequestBuilder countRequestBuilder = new CountRequestBuilder(client);
String query = "{ \"query\": { \"match_all\" : {} } }";
countRequestBuilder.setSource(new BytesArray(query));
assertThat(countRequestBuilder.toString(), equalTo("{ \"query\": { \"match_all\" : {} } }"));
}
@Test
public void testXContentBuilderSourceToString() throws IOException {
CountRequestBuilder countRequestBuilder = new CountRequestBuilder(client);
XContentBuilder xContentBuilder = XContentFactory.contentBuilder(randomFrom(XContentType.values()));
xContentBuilder.startObject();
xContentBuilder.startObject("match_all");
xContentBuilder.endObject();
xContentBuilder.endObject();
countRequestBuilder.setSource(xContentBuilder.bytes());
assertThat(countRequestBuilder.toString(), equalTo(XContentHelper.convertToJson(xContentBuilder.bytes(), false, true)));
}
@Test
public void testThatToStringDoesntWipeSource() {
String source = "{\n" +
" \"query\" : {\n" +
" \"match\" : {\n" +
" \"field\" : {\n" +
" \"query\" : \"value\"" +
" }\n" +
" }\n" +
" }\n" +
" }";
CountRequestBuilder countRequestBuilder = new CountRequestBuilder(client).setSource(new BytesArray(source));
String preToString = countRequestBuilder.request().source().toUtf8();
assertThat(countRequestBuilder.toString(), equalTo(source));
String postToString = countRequestBuilder.request().source().toUtf8();
assertThat(preToString, equalTo(postToString));
}
}