JENKINS-28646 - Add support for removing volumes while removing a con…

…tainer Add checkbox to remove volumes, default is unchecked Build steps: RemoveContainer and RemoveAllContainers Post build steps: Stop and remove container.
jenkinsci · May 29, 2015 · fae73c3 · fae73c3
1 parent 3c2295f
commit fae73c3
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 7 deletions.
diff --git a/src/main/java/org/jenkinsci/plugins/dockerbuildstep/DockerPostBuilder.java b/src/main/java/org/jenkinsci/plugins/dockerbuildstep/DockerPostBuilder.java
@@ -48,10 +48,12 @@ public String getDisplayName() {
 	public static class DockerPostBuildStep extends Recorder {
 
 	    private final String containerIds;
+		private final boolean removeVolumes;
 
 	    @DataBoundConstructor
-	    public DockerPostBuildStep(String containerIds) {
-	        this.containerIds = containerIds;
+	    public DockerPostBuildStep(String containerIds, boolean removeVolumes) {
+			this.containerIds = containerIds;
+			this.removeVolumes = removeVolumes;
 	    }
 
 		public BuildStepMonitor getRequiredMonitorService() {
@@ -81,7 +83,7 @@ public boolean perform(@SuppressWarnings("rawtypes") AbstractBuild build, Launch
 				}
 			}			
 
-			RemoveCommand removeCommand = new RemoveCommand(containerIds, true);
+			RemoveCommand removeCommand = new RemoveCommand(containerIds, true, removeVolumes);
 			removeCommand.execute(build, clog);
 
 			return true;

diff --git a/src/main/java/org/jenkinsci/plugins/dockerbuildstep/cmd/RemoveAllCommand.java b/src/main/java/org/jenkinsci/plugins/dockerbuildstep/cmd/RemoveAllCommand.java
@@ -20,8 +20,11 @@
  */
 public class RemoveAllCommand extends DockerCommand {
 
+    private final boolean removeVolumes;
+
     @DataBoundConstructor
-    public RemoveAllCommand() {
+    public RemoveAllCommand(boolean removeVolumes) {
+        this.removeVolumes = removeVolumes;
     }
 
     @Override
@@ -31,7 +34,7 @@ public void execute(@SuppressWarnings("rawtypes") AbstractBuild build, ConsoleLo
         List<Container> containers = client.listContainersCmd().withShowAll(true).exec();
         for (Container container : containers) {
             client.killContainerCmd(container.getId()).exec();
-            client.removeContainerCmd((container.getId())).exec();
+            client.removeContainerCmd((container.getId())).withRemoveVolumes(removeVolumes).exec();
             console.logInfo("removed container id " + container.getId());
         }
     }

diff --git a/src/main/java/org/jenkinsci/plugins/dockerbuildstep/cmd/RemoveCommand.java b/src/main/java/org/jenkinsci/plugins/dockerbuildstep/cmd/RemoveCommand.java
@@ -1,11 +1,13 @@
 package org.jenkinsci.plugins.dockerbuildstep.cmd;
 
+import com.github.dockerjava.api.command.RemoveContainerCmd;
 import hudson.Extension;
 import hudson.model.AbstractBuild;
 
 import java.util.Arrays;
 import java.util.List;
 
+import org.apache.commons.lang.StringUtils;
 import org.jenkinsci.plugins.dockerbuildstep.log.ConsoleLogger;
 import org.jenkinsci.plugins.dockerbuildstep.util.Resolver;
 import org.kohsuke.stapler.DataBoundConstructor;
@@ -26,11 +28,13 @@ public class RemoveCommand extends DockerCommand {
 
     private final String containerIds;
     private final boolean ignoreIfNotFound;
+    private final boolean removeVolumes;
 
     @DataBoundConstructor
-    public RemoveCommand(String containerIds, boolean ignoreIfNotFound) {
+    public RemoveCommand(String containerIds, boolean ignoreIfNotFound, boolean removeVolumes) {
         this.containerIds = containerIds;
         this.ignoreIfNotFound = ignoreIfNotFound;
+        this.removeVolumes = removeVolumes;
     }
 
     public String getContainerIds() {
@@ -41,6 +45,10 @@ public boolean getIgnoreIfNotFound() {
         return ignoreIfNotFound;
     }
 
+    public boolean getRemoveVolumes() {
+        return removeVolumes;
+    }
+
     @Override
     public void execute(@SuppressWarnings("rawtypes") AbstractBuild build, ConsoleLogger console)
             throws DockerException {
@@ -57,7 +65,7 @@ public void execute(@SuppressWarnings("rawtypes") AbstractBuild build, ConsoleLo
         	id = id.trim();
             try {
             	client.killContainerCmd(id).exec();
-                client.removeContainerCmd(id).exec();
+                client.removeContainerCmd(id).withRemoveVolumes(removeVolumes).exec();
                 console.logInfo("removed container id " + id);
             } catch (NotFoundException e) {
                 if (!ignoreIfNotFound) {

diff --git a/src/main/resources/org/jenkinsci/plugins/dockerbuildstep/DockerPostBuilder/config.jelly b/src/main/resources/org/jenkinsci/plugins/dockerbuildstep/DockerPostBuilder/config.jelly
@@ -5,4 +5,10 @@
         <f:textbox />
     </f:entry>
 
+    <f:advanced>
+        <f:entry field="removeVolumes" title="Remove volumes" description="Remove the volumes associated with the container." >
+            <f:checkbox />
+        </f:entry>
+    </f:advanced>
+
 </j:jelly>
diff --git a/.../resources/org/jenkinsci/plugins/dockerbuildstep/cmd/RemoveAllCommand/config-detail.jelly b/.../resources/org/jenkinsci/plugins/dockerbuildstep/cmd/RemoveAllCommand/config-detail.jelly
@@ -5,4 +5,9 @@
         Kill and remove all conatiners
     </f:entry>
 
+    <f:advanced>
+        <f:entry field="removeVolumes" title="Remove volumes" description="Remove the volumes associated with the container." >
+            <f:checkbox />
+        </f:entry>
+    </f:advanced>
 </j:jelly>
diff --git a/...ain/resources/org/jenkinsci/plugins/dockerbuildstep/cmd/RemoveCommand/config-detail.jelly b/...ain/resources/org/jenkinsci/plugins/dockerbuildstep/cmd/RemoveCommand/config-detail.jelly
@@ -9,6 +9,10 @@
         <f:entry field="ignoreIfNotFound" title="Ignore if not found" description="Do not fail this step if any of the containers are not found." >
             <f:checkbox />
         </f:entry>
+
+        <f:entry field="removeVolumes" title="Remove volumes" description="Remove the volumes associated with the container." >
+            <f:checkbox />
+        </f:entry>
     </f:advanced>
 
 </j:jelly>