Wrap up test cases

Author: Stephen Powis

src/main/java/org/sourcelab/kafka/connect/apiclient/KafkaConnectClient.java

@@ -17,9 +17,11 @@
 
 package org.sourcelab.kafka.connect.apiclient;
 
+import com.fasterxml.jackson.databind.exc.MismatchedInputException;
 import org.apache.http.HttpStatus;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.sourcelab.kafka.connect.apiclient.exception.ResponseParseException;
 import org.sourcelab.kafka.connect.apiclient.request.JacksonFactory;
 import org.sourcelab.kafka.connect.apiclient.request.Request;
 import org.sourcelab.kafka.connect.apiclient.request.RequestErrorResponse;
@@ -340,6 +342,8 @@ private <T> T submitRequest(final Request<T> request) {
 
             try {
                 return request.parseResponse(responseStr);
+            } catch (final MismatchedInputException exception) {
+                throw new ResponseParseException(exception.getMessage(), exception);
             } catch (final IOException exception) {
                 throw new RuntimeException(exception.getMessage(), exception);
             }

src/main/java/org/sourcelab/kafka/connect/apiclient/exception/ResponseParseException.java

@@ -0,0 +1,34 @@
+/**
+ * Copyright 2018, 2019 SourceLab.org https://github.com/SourceLabOrg/kafka-connect-client
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package org.sourcelab.kafka.connect.apiclient.exception;
+
+import com.fasterxml.jackson.databind.exc.MismatchedInputException;
+
+/**
+ * Thrown when the library is unable to properly parse the response from Kafka-Connect.
+ */
+public class ResponseParseException extends RuntimeException {
+    /**
+     * Constructor.
+     * @param message error msg
+     * @param exception underlying exception, if available.
+     */
+    public ResponseParseException(final String message, final MismatchedInputException exception) {
+        super(message, exception);
+    }
+}

src/main/java/org/sourcelab/kafka/connect/apiclient/request/get/GetConnectorsExpandAllDetails.java

@@ -17,6 +17,8 @@
 
 package org.sourcelab.kafka.connect.apiclient.request.get;
 
+import com.fasterxml.jackson.databind.exc.MismatchedInputException;
+import org.sourcelab.kafka.connect.apiclient.exception.ResponseParseException;
 import org.sourcelab.kafka.connect.apiclient.request.JacksonFactory;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorsWithExpandedMetadata;
 
@@ -38,7 +40,15 @@ public String getApiEndpoint() {
 
     @Override
     public ConnectorsWithExpandedMetadata parseResponse(final String responseStr) throws IOException {
-        return JacksonFactory.newInstance().readValue(responseStr, ConnectorsWithExpandedMetadata.class);
+        try {
+            return JacksonFactory.newInstance().readValue(responseStr, ConnectorsWithExpandedMetadata.class);
+        } catch (final MismatchedInputException exception) {
+            throw new ResponseParseException(
+                "Failed to parse response. The end point you requested requires Kafka-Connect 2.3.0+..."
+                + "are you sure you're querying against the right version?",
+                exception
+            );
+        }
     }
 }
 

src/main/java/org/sourcelab/kafka/connect/apiclient/request/get/GetConnectorsExpandInfo.java

@@ -17,6 +17,8 @@
 
 package org.sourcelab.kafka.connect.apiclient.request.get;
 
+import com.fasterxml.jackson.databind.exc.MismatchedInputException;
+import org.sourcelab.kafka.connect.apiclient.exception.ResponseParseException;
 import org.sourcelab.kafka.connect.apiclient.request.JacksonFactory;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorsWithExpandedInfo;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorsWithExpandedMetadata;
@@ -37,7 +39,15 @@ public String getApiEndpoint() {
 
     @Override
     public ConnectorsWithExpandedInfo parseResponse(final String responseStr) throws IOException {
-        return JacksonFactory.newInstance().readValue(responseStr, ConnectorsWithExpandedMetadata.class);
+        try {
+            return JacksonFactory.newInstance().readValue(responseStr, ConnectorsWithExpandedMetadata.class);
+        } catch (final MismatchedInputException exception) {
+            throw new ResponseParseException(
+                "Failed to parse response. The end point you requested requires Kafka-Connect 2.3.0+..."
+                + "are you sure you're querying against the right version?",
+                exception
+            );
+        }
     }
 }
 

src/main/java/org/sourcelab/kafka/connect/apiclient/request/get/GetConnectorsExpandStatus.java

@@ -17,6 +17,8 @@
 
 package org.sourcelab.kafka.connect.apiclient.request.get;
 
+import com.fasterxml.jackson.databind.exc.MismatchedInputException;
+import org.sourcelab.kafka.connect.apiclient.exception.ResponseParseException;
 import org.sourcelab.kafka.connect.apiclient.request.JacksonFactory;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorsWithExpandedMetadata;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorsWithExpandedStatus;
@@ -37,6 +39,14 @@ public String getApiEndpoint() {
 
     @Override
     public ConnectorsWithExpandedStatus parseResponse(final String responseStr) throws IOException {
-        return JacksonFactory.newInstance().readValue(responseStr, ConnectorsWithExpandedMetadata.class);
+        try {
+            return JacksonFactory.newInstance().readValue(responseStr, ConnectorsWithExpandedMetadata.class);
+        } catch (final MismatchedInputException exception) {
+            throw new ResponseParseException(
+                "Failed to parse response. The end point you requested requires Kafka-Connect 2.3.0+..."
+                + "are you sure you're querying against the right version?",
+                exception
+            );
+        }
     }
 }

src/test/java/org/sourcelab/kafka/connect/apiclient/request/get/connector/GetConnectorsExpandAllDetailsTest.java

@@ -18,6 +18,7 @@
 package org.sourcelab.kafka.connect.apiclient.request.get.connector;
 
 import org.junit.Test;
+import org.sourcelab.kafka.connect.apiclient.exception.ResponseParseException;
 import org.sourcelab.kafka.connect.apiclient.request.AbstractRequestTest;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorDefinition;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorStatus;
@@ -75,6 +76,17 @@ public void testParseResponse() throws IOException {
         validateTestConnectorDefinition2(result.getMappedDefinitions().get("MyTestConnector2"));
     }
 
+    /**
+     * Test what happens if we get back a pre 2.3.0 response for this request.
+     *
+     * It should throw a ResponseParseException.
+     */
+    @Test(expected = ResponseParseException.class)
+    public void testParseResponseForKafkaConnectVersionEarlierThan2_3_0() throws IOException {
+        final String mockResponse = readFile("getConnector.json");
+        final ConnectorsWithExpandedMetadata result = new GetConnectorsExpandAllDetails().parseResponse(mockResponse);
+    }
+
     private void validateTestConnectorDefinition(final ConnectorDefinition connector) {
         final String expectedConnectorName = "MyTestConnector";
 

src/test/java/org/sourcelab/kafka/connect/apiclient/request/get/connector/GetConnectorsWithExpandInfoTest.java

@@ -18,6 +18,7 @@
 package org.sourcelab.kafka.connect.apiclient.request.get.connector;
 
 import org.junit.Test;
+import org.sourcelab.kafka.connect.apiclient.exception.ResponseParseException;
 import org.sourcelab.kafka.connect.apiclient.request.AbstractRequestTest;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorDefinition;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorsWithExpandedInfo;
@@ -64,6 +65,17 @@ public void testParseResponse() throws IOException {
         validateTestConnectorDefinition2(result.getMappedDefinitions().get("MyTestConnector2"));
     }
 
+    /**
+     * Test what happens if we get back a pre 2.3.0 response for this request.
+     *
+     * It should throw a ResponseParseException.
+     */
+    @Test(expected = ResponseParseException.class)
+    public void testParseResponseForKafkaConnectVersionEarlierThan2_3_0() throws IOException {
+        final String mockResponse = readFile("getConnector.json");
+        final ConnectorsWithExpandedInfo result = new GetConnectorsExpandInfo().parseResponse(mockResponse);
+    }
+
     private void validateTestConnectorDefinition(final ConnectorDefinition connector) {
         final String expectedConnectorName = "MyTestConnector";
 

src/test/java/org/sourcelab/kafka/connect/apiclient/request/get/connector/GetConnectorsWithExpandStatusTest.java

@@ -18,6 +18,7 @@
 package org.sourcelab.kafka.connect.apiclient.request.get.connector;
 
 import org.junit.Test;
+import org.sourcelab.kafka.connect.apiclient.exception.ResponseParseException;
 import org.sourcelab.kafka.connect.apiclient.request.AbstractRequestTest;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorStatus;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorsWithExpandedStatus;
@@ -63,6 +64,17 @@ public void testParseResponse() throws IOException {
         validateTestConnectorStatus2(result.getMappedStatuses().get("MyTestConnector2"));
     }
 
+    /**
+     * Test what happens if we get back a pre 2.3.0 response for this request.
+     *
+     * It should throw a ResponseParseException.
+     */
+    @Test(expected = ResponseParseException.class)
+    public void testParseResponseForKafkaConnectVersionEarlierThan2_3_0() throws IOException {
+        final String mockResponse = readFile("getConnector.json");
+        final ConnectorsWithExpandedStatus result = new GetConnectorsExpandStatus().parseResponse(mockResponse);
+    }
+
     private void validateTestConnectorStatus(final ConnectorStatus connectorStatus) {
         final String expectedConnectorName = "MyTestConnector";