Add test case for positive HTTP action in DownloadFormListTask (#918)

Issue: #620

collect_app/src/androidTest/java/org/odk/collect/android/tasks/DownloadFormListTaskTest.java

@@ -0,0 +1,105 @@
+package org.odk.collect.android.tasks;
+
+import java.util.Map;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.odk.collect.android.logic.FormDetails;
+
+import okhttp3.mockwebserver.MockWebServer;
+import okhttp3.mockwebserver.RecordedRequest;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+import static org.odk.collect.android.test.MockedServerTestUtils.firstRequestFor;
+import static org.odk.collect.android.test.MockedServerTestUtils.mockWebServer;
+import static org.odk.collect.android.test.MockedServerTestUtils.willRespond;
+import static org.odk.collect.android.test.TestUtils.assertMatches;
+
+public class DownloadFormListTaskTest {
+    private MockWebServer server;
+
+    @Before
+    public void setUp() throws Exception {
+        server = mockWebServer();
+    }
+
+    @After
+    public void tearDown() throws Exception {
+        server.shutdown();
+    }
+
+    @Test
+    public void shouldProcessAndReturnAFormList() throws Exception {
+        // given
+        willRespond(server, RESPONSE);
+
+        // when
+        Map<String, FormDetails> fetched = new DownloadFormListTask().doInBackground();
+
+        // then
+        RecordedRequest r = firstRequestFor(server);
+        assertMatches("Dalvik/.* org.odk.collect.android/.*", r.getHeader("User-Agent"));
+        assertEquals("1.0", r.getHeader("X-OpenRosa-Version"));
+        assertEquals("gzip", r.getHeader("Accept-Encoding"));
+
+        // and
+        assertEquals(2, fetched.size());
+
+        // and
+        FormDetails f1 = fetched.get("one");
+        assertNull(f1.errorStr);
+        assertEquals("The First Form", f1.formName);
+        assertEquals("https://example.com/formXml?formId=one", f1.downloadUrl);
+        assertNull(f1.manifestUrl);
+        assertEquals("one", f1.formID);
+        assertNull(f1.formVersion);
+
+        // and
+        FormDetails f2 = fetched.get("two");
+        assertNull(f2.errorStr);
+        assertEquals("The Second Form", f2.formName);
+        assertEquals("https://example.com/formXml?formId=two", f2.downloadUrl);
+        assertNull(f2.manifestUrl);
+        assertEquals("two", f2.formID);
+        assertNull(f2.formVersion);
+    }
+
+    private static final String RESPONSE = join(
+        "HTTP/1.1 200 OK\r",
+        "X-OpenRosa-Version: 1.0\r",
+        "X-OpenRosa-Accept-Content-Length: 10485760\r",
+        "Content-Type: text/xml; charset=utf-8\r",
+        "X-Cloud-Trace-Context: cb84da0bfcb4da37910faf33b10ca190;o=1\r",
+        "Date: Tue, 18 Apr 2017 15:45:03 GMT\r",
+        "Server: Google Frontend\r",
+        "Content-Length: 2235\r",
+        "Alt-Svc: quic=\":443\"; ma=2592000; v=\"37,36,35\"\r",
+        "Connection: close\r",
+        "\r",
+        "<xforms xmlns=\"http://openrosa.org/xforms/xformsList\">",
+        "<xform><formID>one</formID>",
+        "<name>The First Form</name>",
+        "<majorMinorVersion></majorMinorVersion>",
+        "<version></version>",
+        "<hash>md5:b71c92bec48730119eab982044a8adff</hash>",
+        "<downloadUrl>https://example.com/formXml?formId=one</downloadUrl>",
+        "</xform>",
+        "<xform><formID>two</formID>",
+        "<name>The Second Form</name>",
+        "<majorMinorVersion></majorMinorVersion>",
+        "<version></version>",
+        "<hash>md5:4428adffbbec48771c9230119eab9820</hash>",
+        "<downloadUrl>https://example.com/formXml?formId=two</downloadUrl>",
+        "</xform>",
+        "</xforms>");
+
+    private static String join(String... strings) {
+        StringBuilder bob = new StringBuilder();
+        for (String s : strings) {
+            bob.append(s).append('\n');
+        }
+        return bob.toString();
+    }
+}

collect_app/src/androidTest/java/org/odk/collect/android/test/MockedServerTestUtils.java

@@ -0,0 +1,55 @@
+package org.odk.collect.android.test;
+
+import android.content.SharedPreferences.Editor;
+import android.preference.PreferenceManager;
+
+import java.util.concurrent.TimeUnit;
+
+import org.odk.collect.android.application.Collect;
+import org.odk.collect.android.preferences.PreferenceKeys;
+
+import okhttp3.mockwebserver.MockResponse;
+import okhttp3.mockwebserver.MockWebServer;
+import okhttp3.mockwebserver.RecordedRequest;
+
+public final class MockedServerTestUtils {
+    private MockedServerTestUtils() {}
+
+    public static MockWebServer mockWebServer() throws Exception {
+        MockWebServer server = new MockWebServer();
+        server.start();
+        configAppFor(server);
+        return server;
+    }
+
+    public static void willRespond(MockWebServer server, String rawResponse) {
+        MockResponse response = new MockResponse();
+
+        String[] parts = rawResponse.split("\r\n\r\n", 2);
+
+        String[] headerLines = parts[0].split("\r\n");
+
+        response.setStatus(headerLines[0]);
+
+        for (int i = 1; i < headerLines.length; ++i) {
+            String[] headerParts = headerLines[i].split(": ", 2);
+            response.addHeader(headerParts[0], headerParts[1]);
+        }
+
+        response.setBody(parts[1]);
+
+        server.enqueue(response);
+    }
+
+    public static RecordedRequest firstRequestFor(MockWebServer server) throws Exception {
+        return server.takeRequest(1, TimeUnit.MILLISECONDS);
+    }
+
+    private static void configAppFor(MockWebServer server) {
+        Editor prefs = PreferenceManager.getDefaultSharedPreferences(Collect.getInstance().getBaseContext()).edit();
+        prefs.putString(PreferenceKeys.KEY_SERVER_URL, server.url("/").toString());
+        if (!prefs.commit()) {
+            throw new RuntimeException("Failed to set up SharedPreferences for MockWebServer");
+        }
+    }
+}

collect_app/src/androidTest/java/org/odk/collect/android/test/TestUtils.java

@@ -0,0 +1,27 @@
+package org.odk.collect.android.test;
+
+public final class TestUtils {
+    private TestUtils() {}
+
+    public static void assertMatches(String expectedPattern, Object actual) {
+        if (!testMatches(expectedPattern, actual)) {
+            throw new AssertionError(String.format("Expected <%s> to match <%s>.", actual, expectedPattern));
+        }
+    }
+
+    public static void assertMatches(String message, String expectedPattern, Object actual) {
+        if (!testMatches(expectedPattern, actual)) {
+            throw new AssertionError(String.format("%s  Expected <%s> to match <%s>.", message, actual, expectedPattern));
+        }
+    }
+
+    private static boolean testMatches(String expectedPattern, Object actual) {
+        if (expectedPattern == null) {
+            throw new IllegalArgumentException("No pattern provided.");
+        }
+        if (actual == null) {
+            return false;
+        }
+        return actual.toString().matches(expectedPattern);
+    }
+}