MapRouletteCommand Optional Proxy Parameter (#657)

* proxy

* logging

* one more spot

* https

* fix null

* parse string

* rm debug

* unit test

Author: Bentleysb

src/main/java/org/openstreetmap/atlas/checks/maproulette/MapRouletteClient.java

@@ -15,6 +15,7 @@
 import java.util.concurrent.ConcurrentHashMap;
 
 import org.apache.commons.lang3.StringUtils;
+import org.apache.http.HttpHost;
 import org.openstreetmap.atlas.checks.maproulette.data.Challenge;
 import org.openstreetmap.atlas.checks.maproulette.data.Project;
 import org.openstreetmap.atlas.checks.maproulette.data.ProjectConfiguration;
@@ -83,6 +84,11 @@ public MapRouletteClient(final MapRouletteConfiguration configuration)
         this(configuration, new MapRouletteConnection(configuration));
     }
 
+    public MapRouletteClient(final MapRouletteConfiguration configuration, final HttpHost proxy)
+    {
+        this(configuration, new MapRouletteConnection(configuration, proxy));
+    }
+
     MapRouletteClient(final MapRouletteConfiguration configuration, final TaskLoader taskLoader)
     {
         this.batch = new ConcurrentHashMap<>();

src/main/java/org/openstreetmap/atlas/checks/maproulette/MapRouletteCommand.java

@@ -3,8 +3,9 @@
 import java.io.UnsupportedEncodingException;
 import java.net.URISyntaxException;
 import java.util.Optional;
-import java.util.function.Function;
+import java.util.function.BiFunction;
 
+import org.apache.http.HttpHost;
 import org.openstreetmap.atlas.checks.maproulette.data.Challenge;
 import org.openstreetmap.atlas.checks.maproulette.data.ChallengeDifficulty;
 import org.openstreetmap.atlas.checks.maproulette.data.ProjectConfiguration;
@@ -36,6 +37,9 @@ public abstract class MapRouletteCommand extends AtlasLoadingCommand
     protected static final Switch<String> OUTPUT_PATH = new Switch<>("outputPath",
             "Full path to file where project id, challenge id are stored after creation in MapRoulette.",
             StringConverter.IDENTITY);
+    private static final Switch<String> PROXY = new Switch<>("proxy",
+            "scheme://hostname:port for an http proxy", StringConverter.IDENTITY,
+            Optionality.OPTIONAL);
 
     private MapRouletteClient mapRouletteClient;
 
@@ -89,14 +93,22 @@ protected int onRun(final CommandMap commandMap)
     }
 
     protected int onRun(final CommandMap commandMap,
-            final Function<MapRouletteConfiguration, MapRouletteClient> clientConstructor)
+            final BiFunction<MapRouletteConfiguration, HttpHost, MapRouletteClient> clientConstructor)
     {
         final MapRouletteConfiguration mapRoulette = this.fromCommandMap(commandMap);
+        HttpHost proxy = null;
+        final Optional<String> proxyOptional = (Optional<String>) commandMap.getOption(PROXY);
+        if (proxyOptional.isPresent())
+        {
+            logger.info("Using Proxy: {}", proxyOptional.get());
+            proxy = HttpHost.create(proxyOptional.get());
+        }
+
         if (mapRoulette != null)
         {
             try
             {
-                this.mapRouletteClient = clientConstructor.apply(mapRoulette);
+                this.mapRouletteClient = clientConstructor.apply(mapRoulette, proxy);
             }
             catch (final IllegalArgumentException e)
             {
@@ -111,7 +123,7 @@ protected int onRun(final CommandMap commandMap,
     @Override
     protected SwitchList switches()
     {
-        return super.switches().with(MAP_ROULETTE);
+        return super.switches().with(MAP_ROULETTE, PROXY);
     }
 
     protected void uploadTasks()

src/main/java/org/openstreetmap/atlas/checks/maproulette/MapRouletteConnection.java

@@ -10,6 +10,7 @@
 import java.util.List;
 import java.util.Set;
 
+import org.apache.http.HttpHost;
 import org.apache.http.HttpStatus;
 import org.apache.http.client.utils.URIBuilder;
 import org.apache.http.entity.ContentType;
@@ -48,9 +49,11 @@ public class MapRouletteConnection implements TaskLoader, Serializable
     private static final long serialVersionUID = -8227257938510897604L;
     private final MapRouletteConfiguration configuration;
     private final URIBuilder uriBuilder;
+    private final HttpHost proxy;
 
-    MapRouletteConnection(final MapRouletteConfiguration configuration)
+    MapRouletteConnection(final MapRouletteConfiguration configuration, final HttpHost proxy)
     {
+        this.proxy = proxy;
         if (configuration == null || !this.isAbleToConnectToMapRoulette(configuration))
         {
             throw new IllegalArgumentException(
@@ -61,6 +64,11 @@ public class MapRouletteConnection implements TaskLoader, Serializable
                 .setHost(this.configuration.getServer()).setPort(this.configuration.getPort());
     }
 
+    MapRouletteConnection(final MapRouletteConfiguration configuration)
+    {
+        this(configuration, null);
+    }
+
     /**
      * Will create a challenge if it has not already been created
      *
@@ -204,6 +212,7 @@ public long purgeIncompleteTasks(final long challengeID)
     public HttpResource setAuth(final HttpResource resource)
     {
         resource.setHeader(KEY_API_KEY, this.configuration.getApiKey());
+        resource.setProxy(this.proxy);
         return resource;
     }
 
@@ -260,6 +269,7 @@ private boolean isAbleToConnectToMapRoulette(final MapRouletteConfiguration conf
                             configuration.getScheme(), configuration.getServer(),
                             configuration.getPort());
                     final GetResource homepage = new GetResource(serverConnection);
+                    homepage.setProxy(this.proxy);
                     final int statusCode = homepage.getStatusCode();
                     if (statusCode != HttpStatus.SC_OK)
                     {

src/test/java/org/openstreetmap/atlas/checks/maproulette/MapRouletteUploadCommandTest.java

@@ -156,6 +156,14 @@ public void testUndiscoverableSubsetChallenges()
                 Arrays.asList("SomeOtherCheck", "AnotherCheck"));
     }
 
+    @Test
+    public void testproxy()
+    {
+        final String[] additionalArguments = { "-proxy=http://127.0.0.1:80" };
+        final TestMapRouletteConnection connection = this.run(additionalArguments);
+        Assert.assertEquals("http://127.0.0.1:80", connection.getProxy().toString());
+    }
+
     @Before
     public void writeFiles()
     {
@@ -196,13 +204,17 @@ private TestMapRouletteConnection run(final String[] additionalArguments)
         // Set up some arguments
         final MapRouletteCommand command = new MapRouletteUploadCommand();
         final String[] arguments = { String.format("-logfiles=%s", FOLDER.getPathString()),
-                MAPROULETTE_CONFIG };
+                MAPROULETTE_CONFIG, };
         final CommandMap map = command
                 .getCommandMap((String[]) ArrayUtils.addAll(arguments, additionalArguments));
         final TestMapRouletteConnection connection = new TestMapRouletteConnection();
 
         // Run the command
-        command.onRun(map, configuration -> new MapRouletteClient(configuration, connection));
+        command.onRun(map, (configuration, proxy) ->
+        {
+            connection.setProxy(proxy);
+            return new MapRouletteClient(configuration, connection);
+        });
 
         return connection;
     }

src/test/java/org/openstreetmap/atlas/checks/maproulette/TestMapRouletteConnection.java

@@ -7,6 +7,7 @@
 import java.util.Map;
 import java.util.Set;
 
+import org.apache.http.HttpHost;
 import org.openstreetmap.atlas.checks.maproulette.data.Challenge;
 import org.openstreetmap.atlas.checks.maproulette.data.Project;
 import org.openstreetmap.atlas.checks.maproulette.data.Task;
@@ -17,13 +18,15 @@
  * A stub MapRouletteConnection that doesn't actually connect to anything.
  *
  * @author nachtm
+ * @author bbreithaupt
  */
 public class TestMapRouletteConnection implements TaskLoader
 {
 
     private final Map<Project, Set<Challenge>> projectToChallenges;
     private final Map<Long, Set<Task>> challengeToTasks;
     private Map<String, Long> projectNameToId;
+    private HttpHost proxy = null;
 
     public TestMapRouletteConnection()
     {
@@ -68,6 +71,11 @@ public String getConnectionInfo()
         return "";
     }
 
+    public HttpHost getProxy()
+    {
+        return this.proxy;
+    }
+
     @Override
     public long purgeIncompleteTasks(final long challengeID) throws URISyntaxException
     {
@@ -86,6 +94,11 @@ public void setProjectNameToId(final Map<String, Long> projectIdMap)
         this.projectNameToId = projectIdMap;
     }
 
+    public void setProxy(final HttpHost proxy)
+    {
+        this.proxy = proxy;
+    }
+
     public Set<Task> tasksForChallenge(final Challenge challenge)
     {
         return this.challengeToTasks.get(challenge.getId());