embulk-input-jira 0.2.5 → 0.2.6

data/src/test/java/org/embulk/input/jira/util/JiraUtilTest.java

@@ -0,0 +1,318 @@
+package org.embulk.input.jira.util;
+
+import com.google.gson.JsonObject;
+
+import org.embulk.config.ConfigException;
+import org.embulk.config.ConfigSource;
+import org.embulk.input.jira.Issue;
+import org.embulk.input.jira.JiraInputPlugin.PluginTask;
+import org.embulk.input.jira.TestHelpers;
+import org.embulk.spi.Column;
+import org.embulk.spi.PageBuilder;
+import org.embulk.spi.Schema;
+import org.embulk.spi.json.JsonParser;
+import org.embulk.spi.time.Timestamp;
+import org.embulk.spi.time.TimestampParser;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.mockito.Mockito;
+import org.msgpack.value.Value;
+
+import java.io.IOException;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
+public class JiraUtilTest
+{
+    private static JsonObject data;
+    private static PluginTask pluginTask;
+    private static Schema schema;
+    private static Column booleanColumn;
+    private static Column longColumn;
+    private static Column doubleColumn;
+    private static Column stringColumn;
+    private static Column dateColumn;
+    private static Column jsonColumn;
+
+    @BeforeClass
+    public static void setUp() throws IOException
+    {
+        data = TestHelpers.getJsonFromFile("jira_util.json");
+        pluginTask = TestHelpers.config().loadConfig(PluginTask.class);
+        schema = pluginTask.getColumns().toSchema();
+        booleanColumn = schema.getColumn(0);
+        longColumn = schema.getColumn(1);
+        doubleColumn = schema.getColumn(2);
+        stringColumn = schema.getColumn(3);
+        dateColumn = schema.getColumn(4);
+        jsonColumn = schema.getColumn(5);
+    }
+    @Test
+    public void test_calculateTotalPage()
+    {
+        int resultPerPage = 50;
+        int expected = 0;
+        int totalCount = 0;
+        int actual = JiraUtil.calculateTotalPage(totalCount, resultPerPage);
+        assertEquals(expected, actual);
+
+        expected = 1;
+        totalCount = resultPerPage - 1;
+        actual = JiraUtil.calculateTotalPage(totalCount, resultPerPage);
+        assertEquals(expected, actual);
+
+        expected = 1;
+        totalCount = resultPerPage;
+        actual = JiraUtil.calculateTotalPage(totalCount, resultPerPage);
+        assertEquals(expected, actual);
+
+        expected = 2;
+        totalCount = resultPerPage + 1;
+        actual = JiraUtil.calculateTotalPage(totalCount, resultPerPage);
+        assertEquals(expected, actual);
+    }
+
+    @Test
+    public void test_buildPermissionUrl()
+    {
+        String url = "https://example.com";
+        String expected = "https://example.com/rest/api/latest/myself";
+        String actual = JiraUtil.buildPermissionUrl(url);
+        assertEquals(expected, actual);
+
+        url = "https://example.com/";
+        expected = "https://example.com/rest/api/latest/myself";
+        actual = JiraUtil.buildPermissionUrl(url);
+        assertEquals(expected, actual);
+
+        url = "https://example.com//";
+        expected = "https://example.com//rest/api/latest/myself";
+        actual = JiraUtil.buildPermissionUrl(url);
+        assertEquals(expected, actual);
+
+        url = "https://example.com/sub/subsub";
+        expected = "https://example.com/sub/subsub/rest/api/latest/myself";
+        actual = JiraUtil.buildPermissionUrl(url);
+        assertEquals(expected, actual);
+    }
+
+    @Test
+    public void test_buildSearchUrl() throws IOException
+    {
+        PluginTask task = TestHelpers.config().loadConfig(PluginTask.class);
+        String expected = "https://example.com/rest/api/latest/search";
+        String actual = JiraUtil.buildSearchUrl(task.getUri());
+        assertEquals(expected, actual);
+    }
+
+    @Test
+    public void test_validateTaskConfig() throws IOException
+    {
+        // Happy case
+        ConfigSource configSource = TestHelpers.config();
+        PluginTask task = configSource.loadConfig(PluginTask.class);
+        Exception exception = null;
+        try {
+            JiraUtil.validateTaskConfig(task);
+        }
+        catch (Exception e) {
+            exception = e;
+        }
+        assertNull(exception);
+
+        // empty username
+        configSource = TestHelpers.config();
+        configSource.set("username", "");
+        task = configSource.loadConfig(PluginTask.class);
+        exception = null;
+        try {
+            JiraUtil.validateTaskConfig(task);
+        }
+        catch (Exception e) {
+            exception = e;
+        }
+        assertNotNull(exception);
+        assertTrue(exception instanceof ConfigException);
+        assertEquals("Username or email could not be empty", exception.getMessage());
+
+        // empty password
+        configSource = TestHelpers.config();
+        configSource.set("password", "");
+        task = configSource.loadConfig(PluginTask.class);
+        exception = null;
+        try {
+            JiraUtil.validateTaskConfig(task);
+        }
+        catch (Exception e) {
+            exception = e;
+        }
+        assertNotNull(exception);
+        assertTrue(exception instanceof ConfigException);
+        assertEquals("Password could not be empty", exception.getMessage());
+
+        // empty uri
+        configSource = TestHelpers.config();
+        configSource.set("uri", "");
+        task = configSource.loadConfig(PluginTask.class);
+        exception = null;
+        try {
+            JiraUtil.validateTaskConfig(task);
+        }
+        catch (Exception e) {
+            exception = e;
+        }
+        assertNotNull(exception);
+        assertTrue(exception instanceof ConfigException);
+        assertEquals("JIRA API endpoint could not be empty", exception.getMessage());
+
+        // invalid uri
+        configSource = TestHelpers.config();
+        configSource.set("uri", "https://not-existed-domain");
+        task = configSource.loadConfig(PluginTask.class);
+        exception = null;
+        try {
+            JiraUtil.validateTaskConfig(task);
+        }
+        catch (Exception e) {
+            exception = e;
+        }
+        assertNotNull(exception);
+        assertTrue(exception instanceof ConfigException);
+        assertEquals("JIRA API endpoint is incorrect or not available", exception.getMessage());
+
+        // empty jql
+        configSource = TestHelpers.config();
+        configSource.set("jql", "");
+        task = configSource.loadConfig(PluginTask.class);
+        exception = null;
+        try {
+            JiraUtil.validateTaskConfig(task);
+        }
+        catch (Exception e) {
+            exception = e;
+        }
+        assertNotNull(exception);
+        assertTrue(exception instanceof ConfigException);
+        assertEquals("JQL could not be empty", exception.getMessage());
+
+        // initial_retry_interval_millis = 0
+        configSource = TestHelpers.config();
+        configSource.set("initial_retry_interval_millis", 0);
+        task = configSource.loadConfig(PluginTask.class);
+        exception = null;
+        try {
+            JiraUtil.validateTaskConfig(task);
+        }
+        catch (Exception e) {
+            exception = e;
+        }
+        assertNotNull(exception);
+        assertTrue(exception instanceof ConfigException);
+        assertEquals("Initial retry delay should be equal or greater than 1", exception.getMessage());
+
+        // retry_limit = -1
+        configSource = TestHelpers.config();
+        configSource.set("retry_limit", -1);
+        task = configSource.loadConfig(PluginTask.class);
+        exception = null;
+        try {
+            JiraUtil.validateTaskConfig(task);
+        }
+        catch (Exception e) {
+            exception = e;
+        }
+        assertNotNull(exception);
+        assertTrue(exception instanceof ConfigException);
+        assertEquals("Retry limit should between 0 and 10", exception.getMessage());
+
+        // retry_limit = 100
+        configSource = TestHelpers.config();
+        configSource.set("retry_limit", 100);
+        task = configSource.loadConfig(PluginTask.class);
+        exception = null;
+        try {
+            JiraUtil.validateTaskConfig(task);
+        }
+        catch (Exception e) {
+            exception = e;
+        }
+        assertNotNull(exception);
+        assertTrue(exception instanceof ConfigException);
+        assertEquals("Retry limit should between 0 and 10", exception.getMessage());
+    }
+
+    @Test
+    public void test_addRecord_allRight()
+    {
+        String testName = "allRight";
+        Issue issue = new Issue(data.get(testName).getAsJsonObject());
+        PageBuilder mock = Mockito.mock(PageBuilder.class);
+
+        Boolean boolValue = Boolean.TRUE;
+        Long longValue = Long.valueOf(1);
+        Double doubleValue = Double.valueOf(1);
+        String stringValue = "string";
+        Timestamp dateValue = TimestampParser.of("%Y-%m-%dT%H:%M:%S.%L%z", "UTC").parse("2019-01-01T00:00:00.000Z");
+        Value jsonValue = new JsonParser().parse("{}");
+
+        JiraUtil.addRecord(issue, schema, pluginTask, mock);
+
+        verify(mock, times(1)).setBoolean(booleanColumn, boolValue);
+        verify(mock, times(1)).setLong(longColumn, longValue);
+        verify(mock, times(1)).setDouble(doubleColumn, doubleValue);
+        verify(mock, times(1)).setString(stringColumn, stringValue);
+        verify(mock, times(1)).setTimestamp(dateColumn, dateValue);
+        verify(mock, times(1)).setJson(jsonColumn, jsonValue);
+    }
+
+    @Test
+    public void test_addRecord_allWrong()
+    {
+        String testName = "allWrong";
+        Issue issue = new Issue(data.get(testName).getAsJsonObject());
+        PageBuilder mock = Mockito.mock(PageBuilder.class);
+
+        String stringValue = "{}";
+        Value jsonValue = new JsonParser().parse("{}");
+
+        JiraUtil.addRecord(issue, schema, pluginTask, mock);
+
+        verify(mock, times(1)).setNull(booleanColumn);
+        verify(mock, times(1)).setNull(longColumn);
+        verify(mock, times(1)).setNull(doubleColumn);
+        verify(mock, times(1)).setString(stringColumn, stringValue);
+        verify(mock, times(1)).setNull(dateColumn);
+        verify(mock, times(1)).setJson(jsonColumn, jsonValue);
+    }
+
+    @Test
+    public void test_addRecord_allMissing()
+    {
+        String testName = "allMissing";
+        Issue issue = new Issue(data.get(testName).getAsJsonObject());
+        PageBuilder mock = Mockito.mock(PageBuilder.class);
+
+        JiraUtil.addRecord(issue, schema, pluginTask, mock);
+
+        verify(mock, times(6)).setNull(Mockito.any(Column.class));
+    }
+
+    @Test
+    public void test_addRecord_arrayAsString()
+    {
+        String testName = "arrayAsString";
+        Issue issue = new Issue(data.get(testName).getAsJsonObject());
+        PageBuilder mock = Mockito.mock(PageBuilder.class);
+
+        String stringValue = "1,{},[]";
+
+        JiraUtil.addRecord(issue, schema, pluginTask, mock);
+
+        verify(mock, times(1)).setString(stringColumn, stringValue);
+    }
+}

data/src/test/resources/config.yml

@@ -0,0 +1,13 @@
+type: jira
+username: example@example.com
+password: XXXXXXXXXXXXXXXXX
+uri: "https://example.com/"
+jql: project = example
+retry_limit: 3
+columns:
+  - {name: boolean, type: boolean}
+  - {name: long, type: long}
+  - {name: double, type: double}
+  - {name: string, type: string}
+  - {name: date, type: timestamp, format: '%Y-%m-%dT%H:%M:%S.%L%z'}
+  - {name: json, type: json}

data/src/test/resources/issue_flatten.json

@@ -0,0 +1,129 @@
+{
+    "simple": {
+        "primitive": 1,
+        "string": "string",
+        "array": [],
+        "object": {},
+        "null": null
+    },
+    "twoLevels": {
+        "1stLevel": {
+            "2ndLevelPrimitive": 1,
+            "2ndLevelString": "string",
+            "2ndLevelArray": [],
+            "2ndLevelObject": {},
+            "2ndLevelNull": null
+        }
+    },
+    "threeLevels": {
+        "1stLevel": {
+            "2ndLevel": {
+                "3rdLevelPrimitive": 1,
+                "3rdLevelString": "string",
+                "3rdLevelArray": [],
+                "3rdLevelObject": {},
+                "3rdLevelNull": null
+            }
+        }
+    },
+    "threeLevelsWithoutKeys": {
+        "1stLevel": {
+            "2ndLevel": {
+                "3rdLevelPrimitive": 1,
+                "3rdLevelString": "string",
+                "3rdLevelArray": [],
+                "3rdLevelObject": {
+                    "notKey": "notKey"
+                },
+                "3rdLevelNull": null
+            }
+        }
+    },
+    "threeLevelsWithKeys": {
+        "1stLevel": {
+            "2ndLevel": {
+                "3rdLevelPrimitive": 1,
+                "3rdLevelString": "string",
+                "3rdLevelArray": [],
+                "3rdLevelObject": {
+                    "id": "id",
+                    "name": "name",
+                    "key": "key",
+                    "notKey": "notKey"
+                },
+                "3rdLevelNull": null
+            }
+        }
+    },
+    "threeLevelsWithNullKeys": {
+        "1stLevel": {
+            "2ndLevel": {
+                "3rdLevelPrimitive": 1,
+                "3rdLevelString": "string",
+                "3rdLevelArray": [],
+                "3rdLevelObject": {
+                    "id": "id",
+                    "name": "name",
+                    "key": null
+                },
+                "3rdLevelNull": null
+            }
+        }
+    },
+    "arrayWithAllJsonObjectWithSameKeysAndEmptyObject": {
+        "array": [
+            {
+                "primitive": 1,
+                "string": "string",
+                "array": [],
+                "object": {},
+                "null": null
+            },
+            {
+                "primitive": 2,
+                "string": "string2",
+                "array": [],
+                "object": {},
+                "null": null
+            }
+        ]
+    },
+    "arrayWithAllJsonObjectWithSameKeysAndNotEmptyObject": {
+        "array": [
+            {
+                "primitive": 1,
+                "string": "string",
+                "array": [],
+                "object": {
+                    "primitive": 1
+                },
+                "null": null
+            },
+            {
+                "primitive": 2,
+                "string": "string2",
+                "array": [],
+                "object": {},
+                "null": null
+            }
+        ]
+    },
+    "arrayWithAllJsonObjectWithoutSameKeys": {
+        "array": [
+            {
+                "primitive": 1,
+                "string": "string",
+                "array": [],
+                "object": {},
+                "null": null
+            },
+            {
+                "primitive1": 2,
+                "string1": "string2",
+                "array1": [],
+                "object1": {},
+                "null1": null
+            }
+        ]
+    }
+}