add parsing tests

Author: Crim

src/main/java/org/sourcelab/kafka/connect/apiclient/request/dto/ConnectorDefinition.java

@@ -12,10 +12,17 @@ public class ConnectorDefinition {
     private Map<String, String> config;
     private List<TaskDefinition> tasks;
 
+    /**
+     * Default constructor.
+     */
     public ConnectorDefinition() {
-
     }
 
+    /**
+     * Constructor
+     * @param name Name of Connector.
+     * @param config Configuration values for connector.
+     */
     public ConnectorDefinition(final String name, final Map<String, String> config) {
         this.name = name;
         this.config = Collections.unmodifiableMap(new HashMap<>(config));

src/test/java/org/sourcelab/kafka/connect/apiclient/ApiClientTest.java

@@ -12,7 +12,8 @@
 /**
  * Integration test over ApiClient.
  *
- * Assumes kafka-connect is running at localhost.
+ * Assumes kafka-connect is running at localhost.  More or less a sanity test
+ * rather than checking assertions.
  */
 public class ApiClientTest {
     private static final Logger logger = LoggerFactory.getLogger(ApiClientTest.class);
@@ -30,26 +31,46 @@ public void setup() {
         this.apiClient = new ApiClient(new Configuration(apiHost));
     }
 
+    /**
+     * Tests retrieving all connectors deployed.
+     * https://docs.confluent.io/current/connect/restapi.html#get--connectors
+     */
     @Test
     public void testGetConnectors() {
         logger.info("Result: {}", apiClient.getConnectors());
     }
 
+    /**
+     * Test getting a specific connector.
+     * https://docs.confluent.io/current/connect/restapi.html#get--connectors-(string-name)
+     */
     @Test
     public void testGetConnector() {
         logger.info("Result: {}", apiClient.getConnector("My Test Connector"));
     }
 
+    /**
+     * Test getting a specific connectors config.
+     * https://docs.confluent.io/current/connect/restapi.html#get--connectors-(string-name)
+     */
     @Test
     public void testGetConnectorConfig() {
         logger.info("Result: {}", apiClient.getConnectorConfig("My Test Connector"));
     }
 
+    /**
+     * Test getting the status of a specific connector.
+     * https://docs.confluent.io/current/connect/restapi.html#get--connectors-(string-name)
+     */
     @Test
     public void testGetConnectorStatus() {
         logger.info("Result: {}", apiClient.getConnectorStatus("My Test Connector"));
     }
 
+    /**
+     * Test adding a connector.
+     * https://docs.confluent.io/current/connect/restapi.html#get--connectors-(string-name)
+     */
     @Test
     public void testAddConnector() {
         apiClient.addConnector(ConnectorDefinition.newBuilder()
@@ -61,6 +82,10 @@ public void testAddConnector() {
         );
     }
 
+    /**
+     * Test updating a connector's config.
+     * https://docs.confluent.io/current/connect/restapi.html#get--connectors-(string-name)
+     */
     @Test
     public void testUpdateConnectorConfig() {
         final Map<String, String> config = new HashMap<>();

src/test/java/org/sourcelab/kafka/connect/apiclient/request/AbstractRequestTest.java

@@ -0,0 +1,31 @@
+package org.sourcelab.kafka.connect.apiclient.request;
+
+import org.apache.commons.io.IOUtils;
+import org.junit.Test;
+
+import java.io.IOException;
+import java.net.URL;
+import java.nio.charset.StandardCharsets;
+
+/**
+ * Abstract / Base Request Test Class.
+ */
+abstract public class AbstractRequestTest {
+
+    /**
+     * Test Parsing response.
+     */
+    @Test
+    public abstract void testParseResponse() throws Exception;
+
+    /**
+     * Utility method to help load mock responses from resources.
+     * @param fileName file name to load from resources
+     * @return The contents of the file, as a UTF-8 string.
+     * @throws IOException on error reading from resource file.
+     */
+    protected String readFile(final String fileName) throws IOException {
+        final URL inputFile = getClass().getClassLoader().getResource("mockResponses/" + fileName);
+        return IOUtils.toString(inputFile, StandardCharsets.UTF_8);
+    }
+}

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

@@ -0,0 +1,25 @@
+package org.sourcelab.kafka.connect.apiclient.request.get.connector;
+
+import org.sourcelab.kafka.connect.apiclient.request.AbstractRequestTest;
+
+import java.util.Map;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+public class GetConnectorConfigTest extends AbstractRequestTest {
+
+    @Override
+    public void testParseResponse() throws Exception {
+        final String mockResponse = readFile("getConnectorConfig.json");
+        final Map<String, String> result = new GetConnectorConfig("Test Name").parseResponse(mockResponse);
+
+        // validate config
+        assertNotNull("Should not be null", result);
+        assertEquals("Should have 4 entries", 4, result.size());
+        assertEquals("org.apache.kafka.connect.tools.MockConnector", result.get("connector.class"));
+        assertEquals("10", result.get("tasks.max"));
+        assertEquals("test-topic", result.get("topics"));
+        assertEquals("My Test Connector", result.get("name"));
+    }
+}

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

@@ -0,0 +1,27 @@
+package org.sourcelab.kafka.connect.apiclient.request.get.connector;
+
+import org.sourcelab.kafka.connect.apiclient.request.AbstractRequestTest;
+import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorDefinition;
+
+import static org.junit.Assert.*;
+
+public class GetConnectorStatusTest extends AbstractRequestTest {
+
+    @Override
+    public void testParseResponse() throws Exception {
+        final String mockResponse = readFile("getConnectorStatus.json");
+        final ConnectorDefinition result = new GetConnector("My Test Connector").parseResponse(mockResponse);
+
+        // Validate
+        assertNotNull("Should not be null", result);
+        assertEquals("My Test Connector", result.getName());
+        assertEquals("unknown", result.getType());
+
+        // validate config
+        assertNull("Should be null", result.getConfig());
+
+        // Validate tasks
+        assertNotNull("Should not be null", result.getTasks());
+        assertTrue("Should be empty", result.getTasks().isEmpty());
+    }
+}

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

@@ -0,0 +1,32 @@
+package org.sourcelab.kafka.connect.apiclient.request.get.connector;
+
+import org.sourcelab.kafka.connect.apiclient.request.AbstractRequestTest;
+import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorDefinition;
+
+import static org.junit.Assert.*;
+
+public class GetConnectorTest extends AbstractRequestTest {
+
+    @Override
+    public void testParseResponse() throws Exception {
+        final String mockResponse = readFile("getConnector.json");
+        final ConnectorDefinition result = new GetConnector("My Test Connector").parseResponse(mockResponse);
+
+        // Validate
+        assertNotNull("Should not be null", result);
+        assertEquals("My Test Connector", result.getName());
+        assertEquals("unknown", result.getType());
+
+        // validate config
+        assertNotNull("Should not be null", result.getConfig());
+        assertEquals("Should have 4 entries", 4, result.getConfig().size());
+        assertEquals("org.apache.kafka.connect.tools.MockConnector", result.getConfig().get("connector.class"));
+        assertEquals("10", result.getConfig().get("tasks.max"));
+        assertEquals("test-topic", result.getConfig().get("topics"));
+        assertEquals("My Test Connector", result.getConfig().get("name"));
+
+        // Validate tasks
+        assertNotNull("Should not be null", result.getTasks());
+        assertTrue("Should be empty", result.getTasks().isEmpty());
+    }
+}

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

@@ -0,0 +1,30 @@
+package org.sourcelab.kafka.connect.apiclient.request.get.connector;
+
+import org.junit.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.sourcelab.kafka.connect.apiclient.request.AbstractRequestTest;
+
+import java.io.IOException;
+import java.util.Collection;
+
+import static org.junit.Assert.*;
+
+public class GetConnectorsTest extends AbstractRequestTest {
+    private static final Logger logger = LoggerFactory.getLogger(GetConnectorsTest.class);
+
+    /**
+     * Test Parsing GET /connectors response.
+     */
+    @Test
+    public void testParseResponse() throws IOException {
+        final String mockResponse = readFile("getConnectors.json");
+        final Collection<String> result = new GetConnectors().parseResponse(mockResponse);
+
+        // Validate
+        assertNotNull("Should not be null", result);
+        assertEquals("Should have two entries", 2, result.size());
+        assertTrue("Should have connector", result.contains("My Test Connector"));
+        assertTrue("Should have connector", result.contains("My Other Test Connector"));
+    }
+}

src/test/java/org/sourcelab/kafka/connect/apiclient/request/put/connector/PutConnectorConfigTest.java

@@ -0,0 +1,33 @@
+package org.sourcelab.kafka.connect.apiclient.request.put.connector;
+
+import org.sourcelab.kafka.connect.apiclient.request.AbstractRequestTest;
+import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorDefinition;
+import org.sourcelab.kafka.connect.apiclient.request.get.connector.GetConnector;
+
+import static org.junit.Assert.*;
+
+public class PutConnectorConfigTest extends AbstractRequestTest {
+
+    @Override
+    public void testParseResponse() throws Exception {
+        final String mockResponse = readFile("putConnector.json");
+        final ConnectorDefinition result = new GetConnector("My Test Connector").parseResponse(mockResponse);
+
+        // Validate
+        assertNotNull("Should not be null", result);
+        assertEquals("My Test Connector", result.getName());
+        assertEquals("unknown", result.getType());
+
+        // validate config
+        assertNotNull("Should not be null", result.getConfig());
+        assertEquals("Should have 4 entries", 4, result.getConfig().size());
+        assertEquals("org.apache.kafka.connect.tools.MockConnector", result.getConfig().get("connector.class"));
+        assertEquals("10", result.getConfig().get("tasks.max"));
+        assertEquals("test-topic", result.getConfig().get("topics"));
+        assertEquals("My Test Connector", result.getConfig().get("name"));
+
+        // Validate tasks
+        assertNotNull("Should not be null", result.getTasks());
+        assertTrue("Should be empty", result.getTasks().isEmpty());
+    }
+}

src/test/resources/mockResponses/getConnector.json

@@ -0,0 +1,11 @@
+{
+  "name": "My Test Connector",
+  "config": {
+    "connector.class": "org.apache.kafka.connect.tools.MockConnector",
+    "tasks.max": "10",
+    "topics": "test-topic",
+    "name": "My Test Connector"
+  },
+  "tasks": [],
+  "type": "unknown"
+}

src/test/resources/mockResponses/getConnectorConfig.json

@@ -0,0 +1,6 @@
+{
+  "connector.class": "org.apache.kafka.connect.tools.MockConnector",
+  "tasks.max": "10",
+  "topics": "test-topic",
+  "name": "My Test Connector"
+}