Add text field for passing custom arguments to docker run

pom.xml

@@ -9,7 +9,7 @@
   <groupId>com.cloudbees.jenkins.plugins</groupId>
   <artifactId>docker-custom-build-environment</artifactId>
   <name>Docker Custom Build Environment Plugin</name>
-  <version>1.7.4-SNAPSHOT</version>
+  <version>1.7.5-jeznach</version>
   <packaging>hpi</packaging>
   <url>https://wiki.jenkins.io/display/JENKINS/Docker+Custom+Build+Environment+Plugin</url>
 

src/main/java/com/cloudbees/jenkins/plugins/docker_build_env/BuiltInContainer.java

@@ -52,6 +52,16 @@ public String getImage() {
         return image;
     }
 
+    public String getImageName() {
+        if (image == null) {
+            return "";
+        }
+        if (image.indexOf('/') < 0) {
+            return image;
+        }
+        return image.split("/")[1];
+    }
+
     public String getDisplayName() {
         return "built inside docker container";
     }
@@ -82,6 +92,14 @@ public void buildEnvVars(AbstractBuild<?, ?> build, EnvVars env) {
         if (enable && container != null) {
             env.put("BUILD_CONTAINER_ID", container);
         }
+
+        if (docker != null && docker.getDockerHostName() != null) {
+            env.put("BUILD_DOCKER_HOST", docker.getDockerHostName());
+        }
+
+        if (image != null) {
+            env.put("BUILD_DOCKER_IMAGE", image);
+        }
     }
 
     public void bindMount(String path) {

src/main/java/com/cloudbees/jenkins/plugins/docker_build_env/Docker.java

@@ -42,6 +42,7 @@ public class Docker implements Closeable {
     private final TaskListener listener;
     private final String dockerExecutable;
     private final DockerServerEndpoint dockerHost;
+    private final String dockerHostName;
     private final DockerRegistryEndpoint registryEndpoint;
     private final boolean verbose;
     private final boolean privileged;
@@ -50,6 +51,7 @@ public class Docker implements Closeable {
 
     public Docker(DockerServerEndpoint dockerHost, String dockerInstallation, String credentialsId, AbstractBuild build, Launcher launcher, TaskListener listener, boolean verbose, boolean privileged) throws IOException, InterruptedException {
         this.dockerHost = dockerHost;
+        this.dockerHostName = Computer.currentComputer().getHostName();
         this.dockerExecutable = DockerTool.getExecutable(dockerInstallation, Computer.currentComputer().getNode(), listener, build.getEnvironment(listener));
         this.registryEndpoint = new DockerRegistryEndpoint(null, credentialsId);
         this.launcher = launcher;
@@ -123,7 +125,9 @@ public String buildImage(FilePath workspace, String dockerfile, boolean forcePul
         args.add("--file", dockerfile)
             .add(workspace.getRemote());
 
-        args.add("--label", "jenkins-project=" + this.build.getProject().getName());
+        String projectName = this.build.getProject().getName();
+        projectName = projectName.replaceAll("[^a-zA-Z0-9_.-]", "__");
+        args.add("--label", "jenkins-project=" + projectName);
         args.add("--label", "jenkins-build-number=" + this.build.getNumber());
 
         OutputStream logOutputStream = listener.getLogger();
@@ -184,17 +188,18 @@ public void kill(String container) throws IOException, InterruptedException {
             listener.getLogger().println("Failed to remove docker container "+container);
     }
 
-    public String runDetached(String image, String workdir, Map<String, String> volumes, Map<Integer, Integer> ports, Map<String, String> links, EnvVars environment, Set sensitiveBuildVariables, String net, String memory, String cpu, String... command) throws IOException, InterruptedException {
+    public String runDetached(String image, String workdir, Map<String, String> volumes, Map<Integer, Integer> ports, Map<String, String> links, EnvVars environment, Set sensitiveBuildVariables, String net, String memory, String cpu, String extraArgs, String... command) throws IOException, InterruptedException {
 
         String docker0 = getDocker0Ip(launcher, image);
-
+        String projectName = this.build.getProject().getName();
+        projectName = projectName.replaceAll("[^a-zA-Z0-9_.-]", "__");
 
         ArgumentListBuilder args = dockerCommand()
             .add("run", "--tty", "--detach");
-        args.add("--name", this.build.getProject().getName() + "-" + this.build.getNumber());
+        args.add("--name", projectName + "-" + this.build.getNumber());
 
         if (privileged) {
-            args.add( "--privileged");
+            args.add("--privileged");
         }
         args.add("--workdir", workdir);
         for (Map.Entry<String, String> volume : volumes.entrySet()) {
@@ -219,6 +224,14 @@ public String runDetached(String image, String workdir, Map<String, String> volu
             args.add("--cpu-shares", cpu);
         }
 
+        if (StringUtils.isNotBlank(extraArgs)) {
+            String[] splittedArgs = extraArgs.split("\\s+");
+
+            for (String aSplited : splittedArgs) {
+                args.add(aSplited);
+            }
+        }
+
         if (!"host".equals(net)){
             //--add-host and --net=host are incompatible
             args.add("--add-host", "dockerhost:"+docker0);
@@ -362,6 +375,10 @@ public void executeIn(String container, String userId, Launcher.ProcStarter star
         starter.envs(getEnvVars());
     }
 
+    public String getDockerHostName() {
+        return dockerHostName;
+    }
+
     private ArgumentListBuilder dockerCommand() {
         ArgumentListBuilder args = new ArgumentListBuilder();
         for (String s : dockerCommandArgs()) {

src/main/java/com/cloudbees/jenkins/plugins/docker_build_env/DockerBuildWrapper.java

@@ -73,13 +73,14 @@ public class DockerBuildWrapper extends BuildWrapper {
 
     private String cpu;
 
+    private String extraArgs;
     private final boolean noCache;
 
     @DataBoundConstructor
     public DockerBuildWrapper(DockerImageSelector selector, String dockerInstallation, DockerServerEndpoint dockerHost, String dockerRegistryCredentials, boolean verbose, boolean privileged,
                               List<Volume> volumes, String group, String command,
                               boolean forcePull,
-                              String net, String memory, String cpu, boolean noCache) {
+                              String net, String memory, String cpu, String extraArgs, boolean noCache) {
         this.selector = selector;
         this.dockerInstallation = dockerInstallation;
         this.dockerHost = dockerHost;
@@ -93,6 +94,7 @@ public DockerBuildWrapper(DockerImageSelector selector, String dockerInstallatio
         this.net = net;
         this.memory = memory;
         this.cpu = cpu;
+        this.extraArgs = extraArgs;
         this.noCache = noCache;
     }
 
@@ -141,6 +143,8 @@ public boolean isForcePull() {
     public String getMemory() { return memory;}
 
     public String getCpu() { return cpu;}
+
+    public String getExtraArgs() { return extraArgs; }
 
     public boolean isNoCache() {
         return noCache;
@@ -219,6 +223,7 @@ private String startBuildContainer(BuiltInContainer runInContainer, AbstractBuil
             return runInContainer.getDocker().runDetached(runInContainer.image, workdir,
                     runInContainer.getVolumes(build), runInContainer.getPortsMap(), links,
                     environment, build.getSensitiveBuildVariables(), net, memory, cpu,
+		            extraArgs,
                     command); // Command expected to hung until killed
 
         } catch (InterruptedException e) {

src/main/resources/com/cloudbees/jenkins/plugins/docker_build_env/BuiltInContainer/badge.jelly

@@ -24,6 +24,6 @@ THE SOFTWARE.
 -->
 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
-   <img title="Built inside Docker container"
+   <img title="Built inside Docker container, using image ${it.image}"
         src="${rootURL}/plugin/docker-custom-build-environment/images/docker-badge.png"/>
 </j:jelly>

src/main/resources/com/cloudbees/jenkins/plugins/docker_build_env/BuiltInContainer/summary.jelly

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
+    <t:summary icon="docker-logo.png">
+        Built in docker container using image ${it.image}
+    </t:summary>
+</j:jelly>

src/main/resources/com/cloudbees/jenkins/plugins/docker_build_env/DockerBuildWrapper/config.jelly

@@ -70,7 +70,9 @@ THE SOFTWARE.
           <f:entry field="cpu" title="CPU shares">
             <f:textbox/>
           </f:entry>
+	      <f:entry field="extraArgs" title="Extra arguments">
+	        <f:textbox/>
+	      </f:entry>
         </f:advanced>
-
     </f:nested>
 </j:jelly>

src/main/resources/com/cloudbees/jenkins/plugins/docker_build_env/DockerBuildWrapper/help-extraArgs.html

@@ -0,0 +1,7 @@
+<div>
+    Add extra arguments to docker run command.
+    <p>
+        This is advanced option, get familiar with <a href="https://docs.docker.com/engine/reference/run/">documentation</a>
+        for more details.
+    </p>
+</div>

src/test/java/com/cloudbees/jenkins/plugins/docker_build_env/FunctionalTests.java

@@ -33,7 +33,7 @@ public void run_inside_pulled_container() throws Exception {
         project.getBuildWrappersList().add(
             new DockerBuildWrapper(
                 new PullDockerImageSelector("ubuntu:14.04"),
-                "", new DockerServerEndpoint("", ""), "", true, false, Collections.<Volume>emptyList(), null, "cat", false, "bridge", null, null, false)
+                "", new DockerServerEndpoint("", ""), "", true, false, Collections.<Volume>emptyList(), null, "cat", false, "bridge", null, null, null, false)
         );
         project.getBuildersList().add(new Shell("lsb_release  -a"));
 
@@ -52,7 +52,7 @@ public void run_inside_built_container() throws Exception {
         project.getBuildWrappersList().add(
                 new DockerBuildWrapper(
                         new DockerfileImageSelector(".", "Dockerfile"),
-                        "", new DockerServerEndpoint("", ""), "", true, false, Collections.<Volume>emptyList(), null, "cat", false, "bridge", null, null, true)
+                        "", new DockerServerEndpoint("", ""), "", true, false, Collections.<Volume>emptyList(), null, "cat", false, "bridge", null, null, null, true)
         );
         project.getBuildersList().add(new Shell("lsb_release  -a"));
 
@@ -77,7 +77,7 @@ public void run_inside_built_python_pip_container() throws Exception {
         project.getBuildWrappersList().add(
                 new DockerBuildWrapper(
                         new DockerfileImageSelector(".", "Dockerfile"),
-                        "", new DockerServerEndpoint("", ""), "", true, false, Collections.<Volume>emptyList(), null, "cat", false, "bridge", null, null, true)
+                        "", new DockerServerEndpoint("", ""), "", true, false, Collections.<Volume>emptyList(), null, "cat", false, "bridge", null, null, null, true)
         );
         project.getBuildersList().add(new Shell("python -V"));