Add a checker for nightly updates.

build.gradle

@@ -43,6 +43,7 @@ dependencies {
     bundle group: 'net.kencochrane.raven', name: 'raven', version: '6.0.1-SNAPSHOT'
     bundle group: 'com.google.guava', name:'guava', version: '18.0'
     bundle group: 'net.engio', name: 'mbassador', version: '1.2.4'
+    bundle group: 'com.google.code.gson', name: 'gson', 'version': '2.5'
     bundle group: 'com.dmdirc', name: 'util', version: '+', changing: true
     bundle group: 'com.dmdirc.parser', name: 'common', version: '+', changing: true
 

src/com/dmdirc/updater/checking/NightlyChecker.java

@@ -0,0 +1,203 @@
+/*
+ * Copyright (c) 2006-2015 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.updater.checking;
+
+import com.dmdirc.config.ConfigBinding;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.updater.UpdateChannel;
+import com.dmdirc.updater.UpdateComponent;
+import com.dmdirc.updater.Version;
+import com.dmdirc.util.io.Downloader;
+
+import com.google.gson.Gson;
+import com.google.gson.reflect.TypeToken;
+
+import java.io.IOException;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+
+import javax.inject.Inject;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import static com.dmdirc.ClientModule.GlobalConfig;
+
+/**
+ * Nightly update checker.
+ */
+public class NightlyChecker implements UpdateCheckStrategy {
+
+    private static final Logger LOG = LoggerFactory.getLogger(NightlyChecker.class);
+    /** The URL to request to check for updates. */
+    private static final String UPDATE_URL = "https://nightlies.dmdirc.com/json/latest";
+    /** The update channel to check for updates on. */
+    private UpdateChannel channel;
+    /** Downloader to download files. */
+    private final Downloader downloader;
+
+    /**
+     * Creates a new instance of {@link NightlyChecker}.
+     *
+     * @param configProvider The provider to use to retrieve update channel information.
+     * @param downloader     Used to download files
+     */
+    @Inject
+    public NightlyChecker(@GlobalConfig final AggregateConfigProvider configProvider,
+            final Downloader downloader) {
+        configProvider.getBinder().bind(this, DMDircCheckStrategy.class);
+        this.downloader = downloader;
+    }
+
+    /**
+     * Sets the channel which will be used by the {@link DMDircCheckStrategy}.
+     *
+     * @param channel The new channel to use
+     */
+    @ConfigBinding(domain = "updater", key = "channel")
+    public void setChannel(final String channel) {
+        LOG.info("Changing channel to {}", channel);
+        try {
+            this.channel = UpdateChannel.valueOf(channel.toUpperCase());
+        } catch (IllegalArgumentException ex) {
+            this.channel = null;
+            LOG.warn("Unknown channel {}", channel, ex);
+        }
+    }
+
+    @Override
+    public Map<UpdateComponent, UpdateCheckResult> checkForUpdates(
+            final Collection<UpdateComponent> components) {
+        if (channel != UpdateChannel.NIGHTLY) {
+            LOG.info("Channel {} is not nightly, aborting", channel);
+            return Collections.emptyMap();
+        }
+        LOG.info("Retrieving latest versions.");
+        final List<NightlyResult> resultsList = new Gson().fromJson(getJson(),
+                new TypeToken<List<NightlyResult>>(){}.getType());
+        if (resultsList == null) {
+            return Collections.emptyMap();
+        }
+        resultsList.stream()
+                .filter(Objects::nonNull) //This is incase the JSON is broken
+                .forEach(e -> {
+            final Matcher matcher = Pattern.compile(
+                    "^(.*?)-([^-]+(-[0-9]+-g[0-9a-f]+)?)(-SNAPSHOT).jar?$").matcher(e.getName());
+            if (matcher.matches()) {
+                e.setOtherName(matcher.group(1));
+                e.setVersion(new Version(matcher.group(2)));
+                e.setUrl(UPDATE_URL + '/' + e.getName());
+            }
+        });
+        final Map<String, NightlyResult> resultsMap = resultsList.stream()
+                .collect(Collectors.toMap(NightlyResult::getOtherName, n -> n));
+        final Map<UpdateComponent, UpdateCheckResult> returns = new HashMap<>();
+        components.forEach(e -> {
+            if (resultsMap.containsKey(e.getName())) {
+                if (resultsMap.get(e.getName()).getVersion().compareTo(e.getVersion()) > 0) {
+                    final String name = e.getName();
+                    final NightlyResult result = resultsMap.get(e.getName());
+                    try {
+                        returns.put(e, new BaseDownloadableResult(e, getURL(result),
+                                result.getOtherName(), result.getVersion()));
+                    } catch (MalformedURLException e1) {
+                        LOG.error("Unable to create a URL for {}", name);
+                    }
+                }
+            }
+        });
+        return returns;
+    }
+
+    private URL getURL(final NightlyResult result) throws MalformedURLException {
+        return new URL(result.getUrl());
+    }
+
+    private String getJson() {
+        try {
+            return downloader.getPage(UPDATE_URL).stream().map(String::toString)
+                    .collect(Collectors.joining("\r\n"));
+        } catch (IOException e) {
+            LOG.warn("Error when getting update page: {}", e.getMessage());
+            return "";
+        }
+    }
+
+    /**
+     * Wrapper class for GSON to deserialise the JSON.
+     */
+    private static class NightlyResult {
+        private final String name;
+        private final String type;
+        private final String mtime;
+        private final int size;
+        private String otherName;
+        private Version version;
+        private String url;
+
+        NightlyResult(final String name, final String type, final String mtime,
+                final int size) {
+            this.name = name;
+            this.type = type;
+            this.mtime = mtime;
+            this.size = size;
+        }
+
+        String getName() {
+            return name;
+        }
+
+        String getUrl() {
+            return url;
+        }
+
+        String getOtherName() {
+            return otherName;
+        }
+
+        void setOtherName(final String otherName) {
+            this.otherName = otherName;
+        }
+
+        Version getVersion() {
+            return version;
+        }
+
+        void setVersion(final Version version) {
+            this.version = version;
+        }
+
+        void setUrl(final String url) {
+            this.url = url;
+        }
+    }
+}

test-res/com/dmdirc/updater/checking/nightlies.json

@@ -0,0 +1,6 @@
+[
+  { "name":"audio-0.8-1262-gc6376f4-SNAPSHOT.jar", "type":"file", "mtime":"Fri, 26 Feb 2016 00:13:49 GMT", "size":17861 },
+  { "name":"client-0.8.4-2046-g998b950-SNAPSHOT.jar", "type":"file", "mtime":"Fri, 26 Feb 2016 00:14:04 GMT", "size":7016852 },
+  { "name":"time-0.8-1296-ge579fda-SNAPSHOT.jar", "type":"file", "mtime":"Fri, 26 Feb 2016 00:13:45 GMT", "size":18769 },
+  { "name":"ui_swing-0.8-1314-g8583be9-SNAPSHOT.jar", "type":"file", "mtime":"Fri, 26 Feb 2016 00:13:58 GMT", "size":1038006 }
+]

test/com/dmdirc/updater/checking/NightlyCheckerTest.java

@@ -0,0 +1,128 @@
+/*
+ * Copyright (c) 2006-2015 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.updater.checking;
+
+import com.dmdirc.config.ConfigBinder;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.updater.UpdateComponent;
+import com.dmdirc.updater.Version;
+import com.dmdirc.util.io.Downloader;
+import com.dmdirc.util.io.FileUtils;
+
+import com.google.common.collect.Lists;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.util.Map;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
+
+import static org.junit.Assert.assertEquals;
+import static org.mockito.Matchers.anyString;
+import static org.mockito.Mockito.when;
+
+@RunWith(MockitoJUnitRunner.class)
+public class NightlyCheckerTest {
+
+    private NightlyChecker instance;
+    @Mock private AggregateConfigProvider config;
+    @Mock private Downloader downloader;
+    @Mock private ConfigBinder configBinder;
+    @Mock private UpdateComponent componentOne;
+    @Mock private UpdateComponent componentTwo;
+    @Mock private UpdateComponent componentThree;
+    @Mock private UpdateComponent componentFour;
+
+    @Before
+    public void setUp() throws Exception {
+        when(config.getBinder()).thenReturn(configBinder);
+        when(downloader.getPage(anyString())).thenReturn(
+                Files.readAllLines(
+                        FileUtils.getPathForResource(getClass().getResource("nightlies.json"))));
+        when(componentOne.getName()).thenReturn("ui_swing");
+        when(componentTwo.getName()).thenReturn("client");
+        when(componentThree.getName()).thenReturn("time");
+        when(componentFour.getName()).thenReturn("audio");
+        when(componentOne.getVersion()).thenReturn(new Version("1.2"));
+        when(componentTwo.getVersion()).thenReturn(new Version("4.5"));
+        when(componentThree.getVersion()).thenReturn(new Version("0.1"));
+        when(componentFour.getVersion()).thenReturn(new Version("10"));
+        instance = new NightlyChecker(config, downloader);
+        instance.setChannel("NIGHTLY");
+    }
+
+    @Test
+    public void testUnknownChannel() throws Exception {
+        instance.setChannel("RANDOM");
+        final Map<UpdateComponent, UpdateCheckResult> updates =
+                instance.checkForUpdates(Lists.newArrayList(componentThree));
+        assertEquals(0, updates.size());
+    }
+
+    @Test
+    public void testNotNightly() throws Exception {
+        instance.setChannel("STABLE");
+        final Map<UpdateComponent, UpdateCheckResult> updates =
+                instance.checkForUpdates(Lists.newArrayList(componentThree));
+    }
+
+    @Test
+    public void testNightly() throws Exception {
+        final Map<UpdateComponent, UpdateCheckResult> updates =
+                instance.checkForUpdates(Lists.newArrayList(componentThree));
+        assertEquals(1, updates.size());
+    }
+
+    @Test
+    public void testNoUpdates() throws Exception {
+        final Map<UpdateComponent, UpdateCheckResult> updates = instance.checkForUpdates(
+                Lists.newArrayList(componentOne, componentTwo));
+        assertEquals(0, updates.size());
+    }
+
+    @Test
+    public void testOneUpdate() throws Exception {
+        final Map<UpdateComponent, UpdateCheckResult> updates = instance.checkForUpdates(
+                Lists.newArrayList(componentOne, componentThree));
+        assertEquals(1, updates.size());
+    }
+
+    @Test
+    public void testMultipleUpdate() throws Exception {
+        final Map<UpdateComponent, UpdateCheckResult> updates = instance.checkForUpdates(
+                Lists.newArrayList(componentOne, componentTwo, componentThree, componentFour));
+        assertEquals(2, updates.size());
+    }
+
+    @Test
+    public void testMalformedPage() throws Exception {
+        when(downloader.getPage(anyString())).thenThrow(new IOException("Failure."));
+        final Map<UpdateComponent, UpdateCheckResult> updates =
+                instance.checkForUpdates(Lists.newArrayList(componentThree));
+        assertEquals(0, updates.size());
+    }
+}