Add ability to skip removal of container after docker stop (#189)

Co-authored-by: Jon Sten <jons@axis.com>
jenkinsci · Aug 28, 2020 · eb0b0db · eb0b0db
1 parent 04719f7
commit eb0b0db
Showing 1 changed file with 12 additions and 2 deletions.
diff --git a/src/main/java/org/jenkinsci/plugins/docker/workflow/client/DockerClient.java b/src/main/java/org/jenkinsci/plugins/docker/workflow/client/DockerClient.java
@@ -76,6 +76,13 @@ public class DockerClient {
     @Restricted(NoExternalUse.class)
     public static int CLIENT_TIMEOUT = Integer.getInteger(DockerClient.class.getName() + ".CLIENT_TIMEOUT", 180); // TODO 2.4+ SystemProperties
 
+    /**
+     * Skip removal of container after a container has been stopped.
+     */
+    @SuppressFBWarnings(value="MS_SHOULD_BE_FINAL", justification="mutable for scripts")
+    @Restricted(NoExternalUse.class)
+    public static boolean SKIP_RM_ON_STOP = Boolean.getBoolean(DockerClient.class.getName() + ".SKIP_RM_ON_STOP");
+
     // e.g. 2015-04-09T13:40:21.981801679Z
     public static final String DOCKER_DATE_TIME_FORMAT = "yyyy-MM-dd'T'HH:mm:ss";
 
@@ -165,7 +172,8 @@ public List<String> listProcess(@Nonnull EnvVars launchEnv, @Nonnull String cont
      * Stop a container.
      * 
      * <p>                              
-     * Also removes ({@link #rm(EnvVars, String)}) the container.
+     * Also removes ({@link #rm(EnvVars, String)}) the container if property
+     * SKIP_RM_ON_STOP is unset or equals false.
      * 
      * @param launchEnv Docker client launch environment.
      * @param containerId The container ID.
@@ -175,7 +183,9 @@ public void stop(@Nonnull EnvVars launchEnv, @Nonnull String containerId) throws
         if (result.getStatus() != 0) {
             throw new IOException(String.format("Failed to kill container '%s'.", containerId));
         }
-        rm(launchEnv, containerId);
+        if (!SKIP_RM_ON_STOP) {
+            rm(launchEnv, containerId);
+        }
     }
 
     /**