FEA Option to stop instead of remove containers

Author: raydouglass

src/main/java/com/gpuopenanalytics/jenkins/remotedocker/DockerLauncher.java

@@ -289,11 +289,14 @@ public Proc dockerExec(Launcher.ProcStarter starter,
      * @throws IOException
      * @throws InterruptedException
      */
-    public void tearDown() throws IOException, InterruptedException {
-        boolean exception = false;
+    public void tearDown(boolean removeContainers) throws IOException, InterruptedException {
         for (String containerId : containerIds) {
-            ArgumentListBuilder args = new ArgumentListBuilder()
-                    .add("rm", "-f", containerId);
+            ArgumentListBuilder args = new ArgumentListBuilder();
+            if (removeContainers) {
+                args.add("rm", "-f", containerId);
+            } else {
+                args.add("stop", containerId);
+            }
 
             ByteArrayOutputStream out = new ByteArrayOutputStream();
             int status = executeCommand(args)
@@ -302,7 +305,9 @@ public void tearDown() throws IOException, InterruptedException {
                     .join();
 
             if (status != 0) {
-                listener.error("Failed to remove container %s", containerId);
+                listener.error("Failed to %s container %s",
+                               removeContainers ? "remove" : "stop",
+                               containerId);
             }
         }
         if (network.isPresent()) {

src/main/java/com/gpuopenanalytics/jenkins/remotedocker/RemoteDockerBuildWrapper.java

@@ -40,6 +40,7 @@
 import jenkins.model.Jenkins;
 import net.sf.json.JSONObject;
 import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
 import org.kohsuke.stapler.StaplerRequest;
 
 import java.io.IOException;
@@ -56,6 +57,7 @@
 public class RemoteDockerBuildWrapper extends BuildWrapper {
 
     private boolean debug;
+    private Boolean removeContainers = true;
     private AbstractDockerConfiguration dockerConfiguration;
     private List<SideDockerConfiguration> sideDockerConfigurations;
 
@@ -74,6 +76,15 @@ public boolean isDebug() {
         return debug;
     }
 
+    @DataBoundSetter
+    public void setRemoveContainers(Boolean removeContainers) {
+        this.removeContainers = removeContainers;
+    }
+
+    public Boolean isRemoveContainers() {
+        return removeContainers != null ? removeContainers : true;
+    }
+
     public AbstractDockerConfiguration getDockerConfiguration() {
         return dockerConfiguration;
     }
@@ -96,13 +107,12 @@ public Environment setUp(AbstractBuild build,
         build.addAction(new DockerAction());
         try {
             ((DockerLauncher) launcher).launchContainers();
-            return new DockerEnvironment((DockerLauncher) launcher);
+            return new DockerEnvironment((DockerLauncher) launcher, removeContainers);
         } catch (IOException | InterruptedException e) {
             //Attempt tearDown in case we partially started some containers
-            ((DockerLauncher) launcher).tearDown();
+            ((DockerLauncher) launcher).tearDown(true);
             throw e;
         }
-
     }
 
     /**
@@ -111,15 +121,17 @@ public Environment setUp(AbstractBuild build,
     private class DockerEnvironment extends BuildWrapper.Environment {
 
         private DockerLauncher launcher;
+        private boolean removeContainers;
 
-        public DockerEnvironment(DockerLauncher launcher) {
+        public DockerEnvironment(DockerLauncher launcher, boolean removeContainers) {
             this.launcher = launcher;
+            this.removeContainers=removeContainers;
         }
 
         @Override
         public boolean tearDown(AbstractBuild build,
                                 BuildListener listener) throws IOException, InterruptedException {
-            this.launcher.tearDown();
+            this.launcher.tearDown(removeContainers);
             return true;
         }
     }

src/main/resources/com/gpuopenanalytics/jenkins/remotedocker/RemoteDockerBuildWrapper/config.jelly

@@ -37,6 +37,9 @@
             <f:repeatableDeleteButton/>
         </f:repeatableProperty>
     </f:entry>
+    <f:entry title="Remove containers" field="removeContainers">
+        <f:checkbox default="true"/>
+    </f:entry>
     <f:entry title="Debug" field="debug">
         <f:checkbox/>
     </f:entry>

src/main/resources/com/gpuopenanalytics/jenkins/remotedocker/RemoteDockerBuildWrapper/help-removeContainers.html

@@ -0,0 +1,26 @@
+<!--
+  ~ The MIT License
+  ~
+  ~ Copyright (c) 2019, NVIDIA CORPORATION.
+  ~
+  ~ 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.
+  -->
+<div>
+    Whether the containers should be removed (<code>docker rm</code>) when the job completes.
+</div>