Add realistic hlrc request serialization test base class and

change hlrc ccr request tests to use AbstractRequestTestCase base class.

This way the request classes are tested in a more realistic setting.
Note this change also adds a test dependency on xpack core module.

Similar to elastic#39844 but then for hlrc request serialization tests.

Relates to elastic#39745

client/rest-high-level/build.gradle

@@ -66,6 +66,9 @@ dependencies {
   testCompile "org.elasticsearch:rest-api-spec:${version}"
 
   restSpec "org.elasticsearch:rest-api-spec:${version}"
+  // Needed for serialization tests: 
+  // (In order to serialize a server side class to a client side class or the other way around)
+  testCompile "org.elasticsearch.plugin:x-pack-core:${version}"
 }
 
 //we need to copy the yaml spec so we can check naming (see RestHighlevelClientTests#testApiNamingConventions)

client/rest-high-level/src/test/java/org/elasticsearch/client/AbstractRequestTestCase.java

@@ -0,0 +1,70 @@
+/*
+ * 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.client;
+
+import org.elasticsearch.cluster.ClusterModule;
+import org.elasticsearch.common.bytes.BytesReference;
+import org.elasticsearch.common.xcontent.LoggingDeprecationHandler;
+import org.elasticsearch.common.xcontent.NamedXContentRegistry;
+import org.elasticsearch.common.xcontent.ToXContent;
+import org.elasticsearch.common.xcontent.XContent;
+import org.elasticsearch.common.xcontent.XContentFactory;
+import org.elasticsearch.common.xcontent.XContentParser;
+import org.elasticsearch.common.xcontent.XContentType;
+import org.elasticsearch.test.ESTestCase;
+
+import java.io.IOException;
+
+/**
+ * Base class for HLRC request parsing tests.
+ *
+ * This case class facilitates generating client side request test instances and
+ * verifies that they are correctly parsed into server side request instances.
+ *
+ * @param <C> The class representing the request on the client side.
+ * @param <S> The class representing the request on the server side.
+ */
+public abstract class AbstractRequestTestCase<C extends ToXContent, S> extends ESTestCase {
+
+    private static final int NUMBER_OF_TEST_RUNS = 20;
+
+    public final void testFromXContent() throws IOException {
+        for (int i = 0; i < NUMBER_OF_TEST_RUNS; i++) {
+            final C clientTestInstance = createClientTestInstance();
+
+            final XContentType xContentType = randomFrom(XContentType.values());
+            final BytesReference bytes = toShuffledXContent(clientTestInstance, xContentType, ToXContent.EMPTY_PARAMS, randomBoolean());
+
+            final XContent xContent = XContentFactory.xContent(xContentType);
+            final XContentParser parser = xContent.createParser(
+                new NamedXContentRegistry(ClusterModule.getNamedXWriteables()),
+                LoggingDeprecationHandler.INSTANCE,
+                bytes.streamInput());
+            final S serverInstance = doParseToServerInstance(parser);
+            assertInstances(serverInstance, clientTestInstance);
+        }
+    }
+
+    protected abstract C createClientTestInstance();
+
+    protected abstract S doParseToServerInstance(XContentParser parser) throws IOException;
+
+    protected abstract void assertInstances(S serverInstance, C clientTestInstance);
+
+}

client/rest-high-level/src/test/java/org/elasticsearch/client/ccr/PutAutoFollowPatternRequestTests.java

@@ -19,71 +19,24 @@
 
 package org.elasticsearch.client.ccr;
 
+import org.elasticsearch.client.AbstractRequestTestCase;
 import org.elasticsearch.common.unit.ByteSizeValue;
 import org.elasticsearch.common.unit.TimeValue;
-import org.elasticsearch.common.xcontent.ConstructingObjectParser;
-import org.elasticsearch.common.xcontent.ObjectParser;
 import org.elasticsearch.common.xcontent.XContentParser;
-import org.elasticsearch.test.AbstractXContentTestCase;
+import org.elasticsearch.xpack.core.ccr.action.PutAutoFollowPatternAction;
 
 import java.io.IOException;
 import java.util.Arrays;
-import java.util.List;
 
-public class PutAutoFollowPatternRequestTests extends AbstractXContentTestCase<PutAutoFollowPatternRequest> {
+import static org.elasticsearch.client.ccr.PutFollowRequestTests.assertFollowConfig;
+import static org.hamcrest.Matchers.equalTo;
 
-    @SuppressWarnings("unchecked")
-    private static final ConstructingObjectParser<PutAutoFollowPatternRequest, Void> PARSER = new ConstructingObjectParser<>("test_parser",
-        true, (args) -> new PutAutoFollowPatternRequest("name", (String) args[0], (List<String>) args[1]));
-
-    static {
-        PARSER.declareString(ConstructingObjectParser.constructorArg(), PutFollowRequest.REMOTE_CLUSTER_FIELD);
-        PARSER.declareStringArray(ConstructingObjectParser.constructorArg(), PutAutoFollowPatternRequest.LEADER_PATTERNS_FIELD);
-        PARSER.declareString(PutAutoFollowPatternRequest::setFollowIndexNamePattern, PutAutoFollowPatternRequest.FOLLOW_PATTERN_FIELD);
-        PARSER.declareInt(PutAutoFollowPatternRequest::setMaxReadRequestOperationCount, FollowConfig.MAX_READ_REQUEST_OPERATION_COUNT);
-        PARSER.declareField(
-            PutAutoFollowPatternRequest::setMaxReadRequestSize,
-            (p, c) -> ByteSizeValue.parseBytesSizeValue(p.text(), FollowConfig.MAX_READ_REQUEST_SIZE.getPreferredName()),
-            PutFollowRequest.MAX_READ_REQUEST_SIZE,
-            ObjectParser.ValueType.STRING);
-        PARSER.declareInt(PutAutoFollowPatternRequest::setMaxOutstandingReadRequests, FollowConfig.MAX_OUTSTANDING_READ_REQUESTS);
-        PARSER.declareInt(PutAutoFollowPatternRequest::setMaxWriteRequestOperationCount, FollowConfig.MAX_WRITE_REQUEST_OPERATION_COUNT);
-        PARSER.declareField(
-            PutAutoFollowPatternRequest::setMaxWriteRequestSize,
-            (p, c) -> ByteSizeValue.parseBytesSizeValue(p.text(), FollowConfig.MAX_WRITE_REQUEST_SIZE.getPreferredName()),
-            PutFollowRequest.MAX_WRITE_REQUEST_SIZE,
-            ObjectParser.ValueType.STRING);
-        PARSER.declareInt(PutAutoFollowPatternRequest::setMaxOutstandingWriteRequests, FollowConfig.MAX_OUTSTANDING_WRITE_REQUESTS);
-        PARSER.declareInt(PutAutoFollowPatternRequest::setMaxWriteBufferCount, FollowConfig.MAX_WRITE_BUFFER_COUNT);
-        PARSER.declareField(
-            PutAutoFollowPatternRequest::setMaxWriteBufferSize,
-            (p, c) -> ByteSizeValue.parseBytesSizeValue(p.text(), FollowConfig.MAX_WRITE_BUFFER_SIZE.getPreferredName()),
-            PutFollowRequest.MAX_WRITE_BUFFER_SIZE,
-            ObjectParser.ValueType.STRING);
-        PARSER.declareField(
-            PutAutoFollowPatternRequest::setMaxRetryDelay,
-            (p, c) -> TimeValue.parseTimeValue(p.text(), FollowConfig.MAX_RETRY_DELAY_FIELD.getPreferredName()),
-            PutFollowRequest.MAX_RETRY_DELAY_FIELD,
-            ObjectParser.ValueType.STRING);
-        PARSER.declareField(
-            PutAutoFollowPatternRequest::setReadPollTimeout,
-            (p, c) -> TimeValue.parseTimeValue(p.text(), FollowConfig.READ_POLL_TIMEOUT.getPreferredName()),
-            PutFollowRequest.READ_POLL_TIMEOUT,
-            ObjectParser.ValueType.STRING);
-    }
-
-    @Override
-    protected PutAutoFollowPatternRequest doParseInstance(XContentParser parser) throws IOException {
-        return PARSER.apply(parser, null);
-    }
-
-    @Override
-    protected boolean supportsUnknownFields() {
-        return true;
-    }
+public class PutAutoFollowPatternRequestTests extends AbstractRequestTestCase<
+    PutAutoFollowPatternRequest,
+    PutAutoFollowPatternAction.Request> {
 
     @Override
-    protected PutAutoFollowPatternRequest createTestInstance() {
+    protected PutAutoFollowPatternRequest createClientTestInstance() {
         // Name isn't serialized, because it specified in url path, so no need to randomly generate it here.
         PutAutoFollowPatternRequest putAutoFollowPatternRequest = new PutAutoFollowPatternRequest("name",
             randomAlphaOfLength(4), Arrays.asList(generateRandomStringArray(4, 4, false)));
@@ -123,4 +76,18 @@ protected PutAutoFollowPatternRequest createTestInstance() {
         return putAutoFollowPatternRequest;
     }
 
+    @Override
+    protected PutAutoFollowPatternAction.Request doParseToServerInstance(XContentParser parser) throws IOException {
+        return PutAutoFollowPatternAction.Request.fromXContent(parser, "name");
+    }
+
+    @Override
+    protected void assertInstances(PutAutoFollowPatternAction.Request serverInstance, PutAutoFollowPatternRequest clientTestInstance) {
+        assertThat(serverInstance.getName(), equalTo(clientTestInstance.getName()));
+        assertThat(serverInstance.getRemoteCluster(), equalTo(clientTestInstance.getRemoteCluster()));
+        assertThat(serverInstance.getLeaderIndexPatterns(), equalTo(clientTestInstance.getLeaderIndexPatterns()));
+        assertThat(serverInstance.getFollowIndexNamePattern(), equalTo(clientTestInstance.getFollowIndexNamePattern()));
+        assertFollowConfig(serverInstance.getParameters(), clientTestInstance);
+    }
+
 }

client/rest-high-level/src/test/java/org/elasticsearch/client/ccr/PutFollowRequestTests.java

@@ -19,67 +19,22 @@
 
 package org.elasticsearch.client.ccr;
 
+import org.elasticsearch.action.support.ActiveShardCount;
+import org.elasticsearch.client.AbstractRequestTestCase;
 import org.elasticsearch.common.unit.ByteSizeValue;
 import org.elasticsearch.common.unit.TimeValue;
-import org.elasticsearch.common.xcontent.ConstructingObjectParser;
-import org.elasticsearch.common.xcontent.ObjectParser;
 import org.elasticsearch.common.xcontent.XContentParser;
-import org.elasticsearch.test.AbstractXContentTestCase;
+import org.elasticsearch.xpack.core.ccr.action.FollowParameters;
+import org.elasticsearch.xpack.core.ccr.action.PutFollowAction;
 
 import java.io.IOException;
 
-public class PutFollowRequestTests extends AbstractXContentTestCase<PutFollowRequest> {
+import static org.hamcrest.Matchers.equalTo;
 
-    private static final ConstructingObjectParser<PutFollowRequest, Void> PARSER = new ConstructingObjectParser<>("test_parser",
-        true, (args) -> new PutFollowRequest((String) args[0], (String) args[1], "followerIndex"));
-
-    static {
-        PARSER.declareString(ConstructingObjectParser.constructorArg(), PutFollowRequest.REMOTE_CLUSTER_FIELD);
-        PARSER.declareString(ConstructingObjectParser.constructorArg(), PutFollowRequest.LEADER_INDEX_FIELD);
-        PARSER.declareInt(PutFollowRequest::setMaxReadRequestOperationCount, PutFollowRequest.MAX_READ_REQUEST_OPERATION_COUNT);
-        PARSER.declareField(
-            PutFollowRequest::setMaxReadRequestSize,
-            (p, c) -> ByteSizeValue.parseBytesSizeValue(p.text(), PutFollowRequest.MAX_READ_REQUEST_SIZE.getPreferredName()),
-            PutFollowRequest.MAX_READ_REQUEST_SIZE,
-            ObjectParser.ValueType.STRING);
-        PARSER.declareInt(PutFollowRequest::setMaxOutstandingReadRequests, PutFollowRequest.MAX_OUTSTANDING_READ_REQUESTS);
-        PARSER.declareInt(PutFollowRequest::setMaxWriteRequestOperationCount, PutFollowRequest.MAX_WRITE_REQUEST_OPERATION_COUNT);
-        PARSER.declareField(
-            PutFollowRequest::setMaxWriteRequestSize,
-            (p, c) -> ByteSizeValue.parseBytesSizeValue(p.text(), PutFollowRequest.MAX_WRITE_REQUEST_SIZE.getPreferredName()),
-            PutFollowRequest.MAX_WRITE_REQUEST_SIZE,
-            ObjectParser.ValueType.STRING);
-        PARSER.declareInt(PutFollowRequest::setMaxOutstandingWriteRequests, PutFollowRequest.MAX_OUTSTANDING_WRITE_REQUESTS);
-        PARSER.declareInt(PutFollowRequest::setMaxWriteBufferCount, PutFollowRequest.MAX_WRITE_BUFFER_COUNT);
-        PARSER.declareField(
-            PutFollowRequest::setMaxWriteBufferSize,
-            (p, c) -> ByteSizeValue.parseBytesSizeValue(p.text(), PutFollowRequest.MAX_WRITE_BUFFER_SIZE.getPreferredName()),
-            PutFollowRequest.MAX_WRITE_BUFFER_SIZE,
-            ObjectParser.ValueType.STRING);
-        PARSER.declareField(
-            PutFollowRequest::setMaxRetryDelay,
-            (p, c) -> TimeValue.parseTimeValue(p.text(), PutFollowRequest.MAX_RETRY_DELAY_FIELD.getPreferredName()),
-            PutFollowRequest.MAX_RETRY_DELAY_FIELD,
-            ObjectParser.ValueType.STRING);
-        PARSER.declareField(
-            PutFollowRequest::setReadPollTimeout,
-            (p, c) -> TimeValue.parseTimeValue(p.text(), PutFollowRequest.READ_POLL_TIMEOUT.getPreferredName()),
-            PutFollowRequest.READ_POLL_TIMEOUT,
-            ObjectParser.ValueType.STRING);
-    }
-
-    @Override
-    protected PutFollowRequest doParseInstance(XContentParser parser) throws IOException {
-        return PARSER.apply(parser, null);
-    }
-
-    @Override
-    protected boolean supportsUnknownFields() {
-        return false;
-    }
+public class PutFollowRequestTests extends AbstractRequestTestCase<PutFollowRequest, PutFollowAction.Request> {
 
     @Override
-    protected PutFollowRequest createTestInstance() {
+    protected PutFollowRequest createClientTestInstance() {
         PutFollowRequest putFollowRequest =
             new PutFollowRequest(randomAlphaOfLength(4), randomAlphaOfLength(4), "followerIndex");
         if (randomBoolean()) {
@@ -115,4 +70,30 @@ protected PutFollowRequest createTestInstance() {
         return putFollowRequest;
     }
 
+    @Override
+    protected PutFollowAction.Request doParseToServerInstance(XContentParser parser) throws IOException {
+        return PutFollowAction.Request.fromXContent(parser, "followerIndex", ActiveShardCount.DEFAULT);
+    }
+
+    @Override
+    protected void assertInstances(PutFollowAction.Request serverInstance, PutFollowRequest clientTestInstance) {
+        assertThat(serverInstance.getRemoteCluster(), equalTo(clientTestInstance.getRemoteCluster()));
+        assertThat(serverInstance.getLeaderIndex(), equalTo(clientTestInstance.getLeaderIndex()));
+        assertThat(serverInstance.getFollowerIndex(), equalTo(clientTestInstance.getFollowerIndex()));
+        assertFollowConfig(serverInstance.getParameters(), clientTestInstance);
+    }
+
+    static void assertFollowConfig(FollowParameters serverParameters, FollowConfig clientConfig) {
+        assertThat(serverParameters.getMaxReadRequestOperationCount(), equalTo(clientConfig.getMaxReadRequestOperationCount()));
+        assertThat(serverParameters.getMaxWriteRequestOperationCount(), equalTo(clientConfig.getMaxWriteRequestOperationCount()));
+        assertThat(serverParameters.getMaxOutstandingReadRequests(), equalTo(clientConfig.getMaxOutstandingReadRequests()));
+        assertThat(serverParameters.getMaxOutstandingWriteRequests(), equalTo(clientConfig.getMaxOutstandingWriteRequests()));
+        assertThat(serverParameters.getMaxReadRequestSize(), equalTo(clientConfig.getMaxReadRequestSize()));
+        assertThat(serverParameters.getMaxWriteRequestSize(), equalTo(clientConfig.getMaxWriteRequestSize()));
+        assertThat(serverParameters.getMaxWriteBufferCount(), equalTo(clientConfig.getMaxWriteBufferCount()));
+        assertThat(serverParameters.getMaxWriteBufferSize(), equalTo(clientConfig.getMaxWriteBufferSize()));
+        assertThat(serverParameters.getMaxRetryDelay(), equalTo(clientConfig.getMaxRetryDelay()));
+        assertThat(serverParameters.getReadPollTimeout(), equalTo(clientConfig.getReadPollTimeout()));
+    }
+
 }

client/rest-high-level/src/test/java/org/elasticsearch/client/ccr/ResumeFollowRequestTests.java

@@ -19,64 +19,21 @@
 
 package org.elasticsearch.client.ccr;
 
+import org.elasticsearch.client.AbstractRequestTestCase;
 import org.elasticsearch.common.unit.ByteSizeValue;
 import org.elasticsearch.common.unit.TimeValue;
-import org.elasticsearch.common.xcontent.ObjectParser;
 import org.elasticsearch.common.xcontent.XContentParser;
-import org.elasticsearch.test.AbstractXContentTestCase;
+import org.elasticsearch.xpack.core.ccr.action.ResumeFollowAction;
 
 import java.io.IOException;
 
-public class ResumeFollowRequestTests extends AbstractXContentTestCase<ResumeFollowRequest> {
+import static org.elasticsearch.client.ccr.PutFollowRequestTests.assertFollowConfig;
+import static org.hamcrest.Matchers.equalTo;
 
-    private static final ObjectParser<ResumeFollowRequest, Void> PARSER = new ObjectParser<>("test_parser",
-        true, () -> new ResumeFollowRequest("followerIndex"));
-
-    static {
-        PARSER.declareInt(ResumeFollowRequest::setMaxReadRequestOperationCount, FollowConfig.MAX_READ_REQUEST_OPERATION_COUNT);
-        PARSER.declareField(
-            ResumeFollowRequest::setMaxReadRequestSize,
-            (p, c) -> ByteSizeValue.parseBytesSizeValue(p.text(), FollowConfig.MAX_READ_REQUEST_SIZE.getPreferredName()),
-            PutFollowRequest.MAX_READ_REQUEST_SIZE,
-            ObjectParser.ValueType.STRING);
-        PARSER.declareInt(ResumeFollowRequest::setMaxOutstandingReadRequests, FollowConfig.MAX_OUTSTANDING_READ_REQUESTS);
-        PARSER.declareInt(ResumeFollowRequest::setMaxWriteRequestOperationCount, FollowConfig.MAX_WRITE_REQUEST_OPERATION_COUNT);
-        PARSER.declareField(
-            ResumeFollowRequest::setMaxWriteRequestSize,
-            (p, c) -> ByteSizeValue.parseBytesSizeValue(p.text(), FollowConfig.MAX_WRITE_REQUEST_SIZE.getPreferredName()),
-            PutFollowRequest.MAX_WRITE_REQUEST_SIZE,
-            ObjectParser.ValueType.STRING);
-        PARSER.declareInt(ResumeFollowRequest::setMaxOutstandingWriteRequests, FollowConfig.MAX_OUTSTANDING_WRITE_REQUESTS);
-        PARSER.declareInt(ResumeFollowRequest::setMaxWriteBufferCount, FollowConfig.MAX_WRITE_BUFFER_COUNT);
-        PARSER.declareField(
-            ResumeFollowRequest::setMaxWriteBufferSize,
-            (p, c) -> ByteSizeValue.parseBytesSizeValue(p.text(), FollowConfig.MAX_WRITE_BUFFER_SIZE.getPreferredName()),
-            PutFollowRequest.MAX_WRITE_BUFFER_SIZE,
-            ObjectParser.ValueType.STRING);
-        PARSER.declareField(
-            ResumeFollowRequest::setMaxRetryDelay,
-            (p, c) -> TimeValue.parseTimeValue(p.text(), FollowConfig.MAX_RETRY_DELAY_FIELD.getPreferredName()),
-            PutFollowRequest.MAX_RETRY_DELAY_FIELD,
-            ObjectParser.ValueType.STRING);
-        PARSER.declareField(
-            ResumeFollowRequest::setReadPollTimeout,
-            (p, c) -> TimeValue.parseTimeValue(p.text(), FollowConfig.READ_POLL_TIMEOUT.getPreferredName()),
-            PutFollowRequest.READ_POLL_TIMEOUT,
-            ObjectParser.ValueType.STRING);
-    }
-
-    @Override
-    protected ResumeFollowRequest doParseInstance(XContentParser parser) throws IOException {
-        return PARSER.apply(parser, null);
-    }
-
-    @Override
-    protected boolean supportsUnknownFields() {
-        return true;
-    }
+public class ResumeFollowRequestTests extends AbstractRequestTestCase<ResumeFollowRequest, ResumeFollowAction.Request> {
 
     @Override
-    protected ResumeFollowRequest createTestInstance() {
+    protected ResumeFollowRequest createClientTestInstance() {
         ResumeFollowRequest resumeFollowRequest = new ResumeFollowRequest("followerIndex");
         if (randomBoolean()) {
             resumeFollowRequest.setMaxOutstandingReadRequests(randomIntBetween(0, Integer.MAX_VALUE));
@@ -111,4 +68,15 @@ protected ResumeFollowRequest createTestInstance() {
         return resumeFollowRequest;
     }
 
+    @Override
+    protected ResumeFollowAction.Request doParseToServerInstance(XContentParser parser) throws IOException {
+        return ResumeFollowAction.Request.fromXContent(parser, "followerIndex");
+    }
+
+    @Override
+    protected void assertInstances(ResumeFollowAction.Request serverInstance, ResumeFollowRequest clientTestInstance) {
+        assertThat(serverInstance.getFollowerIndex(), equalTo(clientTestInstance.getFollowerIndex()));
+        assertFollowConfig(serverInstance.getParameters(), clientTestInstance);
+    }
+
 }