Merge pull request #34 from paypal/easier-docker-pull-skip

make it easier to skip docker pull.

Author: myohn-paypal

src/main/java/com/paypal/heapdumptool/Application.java

@@ -39,6 +39,11 @@ public class Application {
 
     // Stay with "String[] args". vararg "String... args" causes weird failure with mockito in Java 11
     public static void main(final String[] args) throws Exception {
+        run(args, VersionProvider.versionResource);
+    }
+
+    public static void run(final String[] args, final String versionResource) throws Exception {
+        VersionProvider.versionResource = versionResource;
         final Escalation escalation = escalatePrivilegesIfNeeded(args);
         if (escalation == ESCALATED) {
             return;
@@ -60,14 +65,16 @@ static void systemExit(final int exitCode) {
 
     public static class VersionProvider implements IVersionProvider {
 
+        static String versionResource = System.getProperty("heap-dump-tool.version-resource", "/git-heap-dump-tool.properties");
+
         public static void printVersion() throws IOException {
             final String[] versionInfo = new VersionProvider().getVersion();
             InternalLogger.getLogger(Application.class).info(versionInfo[0]);
         }
 
         @Override
         public String[] getVersion() throws IOException {
-            final byte[] bytes = resourceToByteArray("/git-heap-dump-tool.properties");
+            final byte[] bytes = resourceToByteArray(versionResource);
             final Properties gitProperties = new Properties();
             gitProperties.load(new ByteArrayInputStream(bytes));
             gitProperties.put("appId", APP_ID);

src/main/java/com/paypal/heapdumptool/capture/CaptureCommand.java

@@ -24,9 +24,13 @@
 public class CaptureCommand extends SanitizeOrCaptureCommandBase implements CliCommand {
 
     static final String DOCKER_REGISTRY_OPTION = "--docker-registry";
+    static final String SKIP_DOCKER_PULL = "--skip-docker-pull";
 
     // to allow field injection from picocli, these variables can't be final
 
+    @Option(names = {SKIP_DOCKER_PULL}, description = "skip pulling latest docker image")
+    private boolean skipDockerPull;
+
     @Parameters(index = "0", description = "Container name")
     private String containerName;
 

src/main/java/com/paypal/heapdumptool/capture/PrivilegeEscalator.java

@@ -8,13 +8,15 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Optional;
 import java.util.concurrent.Callable;
 import java.util.stream.Stream;
 
 import static com.paypal.heapdumptool.capture.CaptureCommand.DOCKER_REGISTRY_OPTION;
+import static com.paypal.heapdumptool.capture.CaptureCommand.SKIP_DOCKER_PULL;
 import static com.paypal.heapdumptool.capture.PrivilegeEscalator.Escalation.ESCALATED;
 import static com.paypal.heapdumptool.capture.PrivilegeEscalator.Escalation.PRIVILEGED_ALREADY;
 import static com.paypal.heapdumptool.utils.CallableTool.callQuietlyWithDefault;
@@ -93,11 +95,14 @@ private static Map<String, String> buildTemplateParams(final String... args) {
                 ? "FORCED_DOCKER_REGISTRY"
                 : "DOCKER_REGISTRY";
 
+        final boolean skipDockerPull = Arrays.asList(args).contains(SKIP_DOCKER_PULL);
+
         final Map<String, String> params = new HashMap<>();
         params.put("IMAGE_NAME", IMAGE_NAME);
         params.put("ARGS", quotedArgs);
         params.put("DEFAULT_REGISTRY", defaultRegistry);
         params.put("DOCKER_REGISTRY_ENV_NAME", dockerRegistryEnvName);
+        params.put("SKIP_DOCKER_PULL", Boolean.toString(skipDockerPull));
 
         return params;
     }

src/main/resources/privilege-escalate.sh.tmpl

@@ -9,8 +9,8 @@
 set -euo pipefail
 FQ_IMAGE="${__DOCKER_REGISTRY_ENV_NAME__:-__DEFAULT_REGISTRY__}/__IMAGE_NAME__"
 
-if [ "$FQ_IMAGE" != "local/__IMAGE_NAME__" ]; then
-    docker pull $FQ_IMAGE
+if [[ "${SKIP_DOCKER_PULL:-__SKIP_DOCKER_PULL__}" == "false" && "$FQ_IMAGE" != "local/__IMAGE_NAME__" ]]; then
+    docker pull "$FQ_IMAGE"
 fi
 
 TMPDIR="${TMPDIR:-/tmp/}"

src/test/java/com/paypal/heapdumptool/ApplicationTest.java

@@ -31,7 +31,7 @@ public void testMainHelp(final CapturedOutput output) throws Exception {
         assertThat(exitCode).isEqualTo(0);
 
         final String expectedOutput = contentOf(getClass(), "help.txt");
-        assertThat(output).isEqualTo(expectedOutput);
+        assertThat(output.getOut()).isEqualTo(expectedOutput);
     }
 
     @Test

src/test/java/com/paypal/heapdumptool/ApplicationTestSupport.java

@@ -23,6 +23,9 @@ public static int runApplication(final String... args) throws Exception {
             applicationMock.when(() -> Application.main(args))
                            .thenCallRealMethod();
 
+            applicationMock.when(() -> Application.run(args, Application.VersionProvider.versionResource))
+                           .thenCallRealMethod();
+
             Application.main(args);
         }