Ticket #15742: v1-0004-PluginDownloadTask-add-tests-covering-behaviour-w.patch

new file test/data/__files/plugin/corrupted_plugin.jar

@@ +1 @@
+This is not a valid jar or zip file.

new file test/data/plugin/corrupted_plugin.MANIFEST.MF

@@ +1 @@
+Manifest-Version: 1.0
+Ant-Version: Apache Ant 1.10.1
+Created-By: 1.8.0_152-b16 (Oracle Corporation)
+Plugin-Mainversion: 7654
+Plugin-Version: 5432
+Plugin-Class: org.openstreetmap.josm.plugin.corrupted.CorruptedPlugin
+Plugin-Description: A plugin whose download gets corrupted.
+Plugin-Date: 2017-06-01T12:34:56.789012Z
+Author: Example Author <author@example.com>
+Plugin-Link: https://example.com/corrupted-plugin
+Plugin-Icon: images/preferences/corrupted.png
+Plugin-Canloadatruntime: false

test/unit/org/openstreetmap/josm/actions/downloadtasks/AbstractDownloadTaskTestParent.java

@@ -39 +39 @@
     protected abstract String getRemoteFile();
 
     /**
+     * Returns the {@code Content-Type} with which to serve the file referenced
+     * by {@link getRemoteFile()}
+     * @return the {@code Content-Type} string for file {@link getRemoteFile()}
+     */
+    protected String getRemoteContentType() {
+        return "text/xml";
+    };
+
+    /**
      * Returns the http URL to remote test file to download.
      * @return the http URL to remote test file to download
      */
@@ -53 +62 @@
         wireMockRule.stubFor(get(urlEqualTo("/" + getRemoteFile()))
                 .willReturn(aResponse()
                     .withStatus(200)
-                    .withHeader("Content-Type", "text/xml")
+                    .withHeader("Content-Type", getRemoteContentType())
                     .withBodyFile(getRemoteFile())));
     }
 }

new file test/unit/org/openstreetmap/josm/actions/downloadtasks/PluginDownloadTaskTest.java

@@ +1 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.actions.downloadtasks;
+
+import static org.junit.Assert.assertArrayEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
+import java.util.concurrent.ExecutionException;
+import java.util.Collections;
+
+import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
+import org.openstreetmap.josm.plugins.PluginDownloadTask;
+import org.openstreetmap.josm.plugins.PluginInformation;
+import org.openstreetmap.josm.TestUtils;
+import org.openstreetmap.josm.testutils.JOSMTestRules;
+
+import org.junit.Rule;
+import org.junit.Test;
+
+import com.google.common.io.ByteStreams;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
+/**
+ * Unit tests for class {@link PluginDownloadTask}.
+ */
+public class PluginDownloadTaskTest extends AbstractDownloadTaskTestParent {
+    protected String pluginPath;
+
+    @Rule
+    @SuppressFBWarnings(value = "URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD")
+    public JOSMTestRules test = new JOSMTestRules().https().assumeRevision(
+        "Revision: 8000\n"
+    ).preferences();
+
+    protected String getRemoteContentType() {
+        return "application/java-archive";
+    };
+
+    protected String getRemoteFile() {
+        return this.pluginPath;
+    };
+
+    /**
+     * Test download task when updating a plugin that we already have in our plugins directory
+     * and the downloaded file is valid
+     */
+    @Test
+    public void testUpdatePluginValid() throws Exception {
+        this.pluginPath = "plugin/dummy_plugin.jar";
+        this.mockHttp();
+
+        final File srcPluginFile = new File(
+            new File(TestUtils.getTestDataRoot()), "__files/" + this.pluginPath
+        );
+        final File pluginDir = Main.pref.getPluginsDirectory();
+        final File pluginFile = new File(pluginDir, "dummy_plugin.jar");
+        final File pluginFileNew = new File(pluginDir, "dummy_plugin.jar.new");
+
+        // put existing "plugin file" in place
+        pluginFile.getParentFile().mkdirs();
+        final byte[] existingPluginContents = "Existing plugin contents 123".getBytes();
+        try(final FileOutputStream existingPluginOutputStream = new FileOutputStream(pluginFile)) {
+            existingPluginOutputStream.write(existingPluginContents);
+        }
+
+        // get PluginInformation from jar file
+        final PluginInformation pluginInformation = new PluginInformation(srcPluginFile);
+        // ...and grafting on the downloadlink
+        pluginInformation.downloadlink = this.getRemoteFileUrl();
+
+        final PluginDownloadTask pluginDownloadTask = new PluginDownloadTask(
+            NullProgressMonitor.INSTANCE,
+            Collections.singletonList(pluginInformation),
+            null
+        );
+        pluginDownloadTask.run();
+
+        // the ".jar.new" file should have been deleted
+        assertFalse(pluginFileNew.exists());
+        // the ".jar" file should still exist
+        assertTrue(pluginFile.exists());
+        try (
+            final FileInputStream pluginDirPluginStream = new FileInputStream(pluginFile);
+            final FileInputStream srcPluginStream = new FileInputStream(srcPluginFile);
+        ) {
+            // and its contents should equal those that were served to the task
+            assertArrayEquals(
+                ByteStreams.toByteArray(pluginDirPluginStream),
+                ByteStreams.toByteArray(srcPluginStream)
+            );
+        }
+    }
+
+    /**
+     * Test download task when updating a plugin that we already have in our plugins directory
+     * and the downloaded file is not a valid jar file.
+     */
+    @Test
+    public void testUpdatePluginCorrupt() throws Exception {
+        this.pluginPath = "plugin/corrupted_plugin.jar";
+        this.mockHttp();
+
+        final File srcPluginFile = new File(
+            new File(TestUtils.getTestDataRoot()), "__files/" + this.pluginPath
+        );
+        final File pluginDir = Main.pref.getPluginsDirectory();
+        final File pluginFile = new File(pluginDir, "corrupted_plugin.jar");
+        final File pluginFileNew = new File(pluginDir, "corrupted_plugin.jar.new");
+        // have to store this manifest externally as it clearly can't be read from our corrupted plugin
+        final File pluginManifest = new File(TestUtils.getTestDataRoot(), "plugin/corrupted_plugin.MANIFEST.MF");
+
+        pluginFile.getParentFile().mkdirs();
+        final byte[] existingPluginContents = "Existing plugin contents 123".getBytes();
+        try(final FileOutputStream existingPluginOutputStream = new FileOutputStream(pluginFile)) {
+            existingPluginOutputStream.write(existingPluginContents);
+        }
+
+        try (final FileInputStream manifestInputStream = new FileInputStream(pluginManifest)) {
+            final PluginInformation pluginInformation = new PluginInformation(
+                manifestInputStream,
+                "corrupted_plugin",
+                this.getRemoteFileUrl()
+            );
+            final PluginDownloadTask pluginDownloadTask = new PluginDownloadTask(
+                NullProgressMonitor.INSTANCE,
+                Collections.singletonList(pluginInformation),
+                null
+            );
+            pluginDownloadTask.run();
+        }
+
+        // the ".jar.new" file should exist, even though invalid
+        assertTrue(pluginFileNew.exists());
+        // the ".jar" file should still exist
+        assertTrue(pluginFile.exists());
+        try (
+            final FileInputStream pluginDirPluginNewStream = new FileInputStream(pluginFileNew);
+            final FileInputStream pluginDirPluginStream = new FileInputStream(pluginFile);
+            final FileInputStream srcPluginStream = new FileInputStream(srcPluginFile);
+        ) {
+            // the ".jar" file's contents should be as before
+            assertArrayEquals(
+                existingPluginContents,
+                ByteStreams.toByteArray(pluginDirPluginStream)
+            );
+            // just assert that the "corrupt" jar file made it through in tact
+            assertArrayEquals(
+                ByteStreams.toByteArray(pluginDirPluginNewStream),
+                ByteStreams.toByteArray(srcPluginStream)
+            );
+        }
+    }
+}