Unit test for Downloader

Change-Id: I3b054eb2144f51bc0b5935ee24525616dc042a4e
Reviewed-on: http://gerrit.dmdirc.com/4047
Reviewed-by: Chris Smith <chris@dmdirc.com>
Automatic-Compile: DMDirc Build Manager

build.gradle

@@ -29,6 +29,7 @@ repositories.mavenCentral()
 dependencies {
     testCompile group: 'junit', name: 'junit', version: '4.11'
     testCompile group: 'org.mockito', name: 'mockito-all', version: '1.9.5'
+    testCompile group: 'com.google.jimfs', name: 'jimfs', version: '1.0'
 }
 
 publishing {

src/com/dmdirc/util/io/Downloader.java

@@ -24,8 +24,6 @@ package com.dmdirc.util.io;
 
 import java.io.BufferedReader;
 import java.io.DataOutputStream;
-import java.io.File;
-import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
@@ -33,6 +31,9 @@ import java.io.OutputStream;
 import java.net.URL;
 import java.net.URLConnection;
 import java.net.URLEncoder;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -47,7 +48,7 @@ public class Downloader {
      *
      * @param url The URL to retrieve
      * @return A list of lines received from the server
-     * @throws java.io.IOException If there's an I/O error while downloading
+     * @throws IOException If there's an I/O error while downloading
      */
     public List<String> getPage(final String url) throws IOException {
 
@@ -60,7 +61,7 @@ public class Downloader {
      * @param url The URL to retrieve
      * @param postData The raw POST data to send
      * @return A list of lines received from the server
-     * @throws java.io.IOException If there's an I/O error while downloading
+     * @throws IOException If there's an I/O error while downloading
      */
     public List<String> getPage(final String url, final String postData)
             throws IOException {
@@ -90,7 +91,7 @@ public class Downloader {
      * @param url The URL to retrieve
      * @param postData A map of post data that should be sent
      * @return A list of lines received from the server
-     * @throws java.io.IOException If there's an I/O error while downloading
+     * @throws IOException If there's an I/O error while downloading
      */
     public List<String> getPage(final String url,
             final Map<String, String> postData) throws IOException {
@@ -111,31 +112,56 @@ public class Downloader {
      *
      * @param url The URL to retrieve
      * @param file The file to save the page to
-     * @throws java.io.IOException If there's an I/O error while downloading
+     * @throws IOException If there's an I/O error while downloading
      */
-    public void downloadPage(final String url, final String file)
+    public void downloadPage(final String url, final Path file)
             throws IOException {
         downloadPage(url, file, null);
     }
 
+    /**
+     * Downloads the specified page to disk.
+     *
+     * @param url The URL to retrieve
+     * @param file The file to save the page to
+     * @throws IOException If there's an I/O error while downloading
+     */
+    @Deprecated
+    public void downloadPage(final String url, final String file)
+            throws IOException {
+        downloadPage(url, Paths.get(file), null);
+    }
+
     /**
      * Downloads the specified page to disk.
      *
      * @param url The URL to retrieve
      * @param file The file to save the page to
      * @param listener The progress listener for this download
-     * @throws java.io.IOException If there's an I/O error while downloading
+     * @throws IOException If there's an I/O error while downloading
      */
+    @Deprecated
     public void downloadPage(final String url, final String file,
             final DownloadListener listener) throws IOException {
+        downloadPage(url, Paths.get(file), listener);
+    }
+
+    /**
+     * Downloads the specified page to disk.
+     *
+     * @param url The URL to retrieve
+     * @param file The file to save the page to
+     * @param listener The progress listener for this download
+     * @throws IOException If there's an I/O error while downloading
+     */
+    public void downloadPage(final String url, final Path file,
+            final DownloadListener listener) throws IOException {
 
         final URLConnection urlConn = getConnection(url, "");
-        final File myFile = new File(file);
 
-        try (OutputStream output = new FileOutputStream(myFile);
+        try (OutputStream output = Files.newOutputStream(file);
                 InputStream input = urlConn.getInputStream()) {
             final int length = urlConn.getContentLength();
-            int current = 0;
 
             if (listener != null) {
                 listener.setIndeterminate(length == -1);
@@ -144,6 +170,7 @@ public class Downloader {
             final byte[] buffer = new byte[512];
             int count;
 
+            int current = 0;
             do {
                 count = input.read(buffer);
 
@@ -166,13 +193,12 @@ public class Downloader {
      * @param url The URL to connect to
      * @param postData The POST data to pass to the URL
      * @return An URLConnection for the specified URL/data
-     * @throws java.io.IOException If an I/O exception occurs while connecting
+     * @throws IOException If an I/O exception occurs while connecting
      */
     private URLConnection getConnection(final String url,
             final String postData)
             throws IOException {
-        final URL myUrl = new URL(url);
-        final URLConnection urlConn = myUrl.openConnection();
+        final URLConnection urlConn = getURLConnection(url);
 
         urlConn.setUseCaches(false);
         urlConn.setDoInput(true);
@@ -192,4 +218,9 @@ public class Downloader {
         return urlConn;
     }
 
+    protected URLConnection getURLConnection(final String url) throws IOException {
+        final URL myUrl = new URL(url);
+        return myUrl.openConnection();
+    }
+
 }

test/com/dmdirc/util/io/DownloaderTest.java

@@ -0,0 +1,138 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * 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 com.dmdirc.util.io;
+
+import com.google.common.collect.Lists;
+import com.google.common.collect.Maps;
+import com.google.common.jimfs.Configuration;
+import com.google.common.jimfs.Jimfs;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.net.URLConnection;
+import java.nio.file.FileSystem;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Map;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.InOrder;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Matchers.anyBoolean;
+import static org.mockito.Matchers.anyByte;
+import static org.mockito.Matchers.anyInt;
+import static org.mockito.Mockito.atLeastOnce;
+import static org.mockito.Mockito.inOrder;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+@RunWith(MockitoJUnitRunner.class)
+public class DownloaderTest {
+
+    @Mock private URLConnection mockedConnection;
+    @Mock private OutputStream os;
+    @Mock private DownloadListener listener;
+    private FileSystem fakeFS;
+
+    @Before
+    public void setup() throws IOException {
+        fakeFS = Jimfs.newFileSystem(Configuration.unix());
+        ByteArrayInputStream is = new ByteArrayInputStream(
+                "OMG IM A FAKE DOWNLOAD".getBytes("UTF-8"));
+        when(mockedConnection.getInputStream()).thenReturn(is);
+        when(mockedConnection.getOutputStream()).thenReturn(os);
+        when(mockedConnection.getLastModified()).thenReturn((Long)10L, (Long)11L);
+    }
+
+    @Test
+    public void testGetPage() throws IOException {
+        final String postData = "sdfgsdfgsdfg";
+        new TestableDownloader().getPage("rar");
+        verify(mockedConnection, never()).setRequestProperty("Content-Type",
+                "application/x-www-form-urlencoded");
+        verify(os, never()).write(anyByte());
+    }
+
+    @Test
+    public void testGetPageString() throws IOException {
+        final String postData = "sdfgsdfgsdfg";
+        new TestableDownloader().getPage("rar", postData);
+        verify(mockedConnection).setRequestProperty("Content-Type",
+                "application/x-www-form-urlencoded");
+        final InOrder order = inOrder(os);
+        for (int i=0; i < postData.length(); i++) {
+            order.verify(os).write((byte) postData.charAt(i));
+        }
+    }
+
+    @Test
+    public void testGetPageMap() throws IOException {
+        final Map<String, String> postData = Maps.newHashMap();
+        postData.put("key1", "value1");
+        postData.put("key2", "value2");
+        final String postDataString = "key1=value1&key2=value2";
+        new TestableDownloader().getPage("rar", postData);
+        verify(mockedConnection).setRequestProperty("Content-Type",
+                "application/x-www-form-urlencoded");
+        final InOrder order = inOrder(os);
+        for (int i=0; i < postDataString.length(); i++) {
+            order.verify(os).write(postDataString.charAt(i));
+        }
+    }
+
+    @Test
+    public void testDownloadPage() throws IOException {
+        final Path file = fakeFS.getPath("test.txt");
+        assertFalse(Files.exists(file));
+        new TestableDownloader().downloadPage("rar", file);
+        assertTrue(Files.exists(file));
+        assertEquals(Lists.newArrayList("OMG IM A FAKE DOWNLOAD"), Files.readAllLines(file));
+    }
+
+    @Test
+    public void testListener() throws IOException {
+        final Path file = fakeFS.getPath("test.txt");
+        assertFalse(Files.exists(file));
+        new TestableDownloader().downloadPage("rar", file, listener);
+        assertTrue(Files.exists(file));
+        assertEquals(Lists.newArrayList("OMG IM A FAKE DOWNLOAD"), Files.readAllLines(file));
+        verify(listener).setIndeterminate(anyBoolean());
+        verify(listener, atLeastOnce()).downloadProgress(anyInt());
+    }
+
+    private class TestableDownloader extends Downloader {
+        protected URLConnection getURLConnection(final String url) throws IOException {
+            return mockedConnection;
+        }
+    }
+
+}