Merge pull request #21 from raydouglass/workspace-override

[REVIEW] Workspace override

Author: raydouglass

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

@@ -136,6 +136,9 @@ public void launchContainers() throws IOException, InterruptedException {
     private ArgumentListBuilder getlaunchArgs(DockerConfiguration config,
                                               boolean isMain) throws IOException, InterruptedException {
         String workspacePath = build.getWorkspace().getRemote();
+        String workspaceTarget = Optional.ofNullable(
+                buildWrapper.getWorkspaceOverride())
+                .orElse(workspacePath);
         //Fully resolve the source workspace
         String workspaceSrc = Paths.get(workspacePath)
                 .toAbsolutePath()
@@ -160,7 +163,6 @@ private ArgumentListBuilder getlaunchArgs(DockerConfiguration config,
         ArgumentListBuilder args = new ArgumentListBuilder()
                 .add("run", "-t", "-d")
                 .add("--name", Utils.resolveVariables(this, "$BUILD_TAG"))
-                .add("--workdir", workspacePath)
                 //Add bridge network for internet access
                 .add("--network", "bridge");
         //Add inter-container network if needed
@@ -169,8 +171,9 @@ private ArgumentListBuilder getlaunchArgs(DockerConfiguration config,
         if (isMain) {
             //Start a shell to block the container, overriding the entrypoint in case the image already defines that
             args.add("--entrypoint", "/bin/sh")
-                    .add("-v", workspaceSrc + ":" + workspacePath)
-                    ////Jenkins puts scripts here
+                    .add("--workdir", workspaceTarget)
+                    .add("-v", workspaceSrc + ":" + workspaceTarget)
+                    //Jenkins puts scripts here
                     .add("-v", tmpSrc + ":" + tmpDest);
         }
         config.addCreateArgs(this, args, build);
@@ -252,7 +255,10 @@ public Proc dockerExec(Launcher.ProcStarter starter,
         ArgumentListBuilder args = new ArgumentListBuilder()
                 .add("exec");
         if (starter.pwd() != null) {
-            args.add("--workdir", starter.pwd().getRemote());
+            String path = Optional.ofNullable(
+                    buildWrapper.getWorkspaceOverride())
+                    .orElse(starter.pwd().getRemote());
+            args.add("--workdir", path);
         }
         if (addRunArgs) {
             buildWrapper.getDockerConfiguration().addRunArgs(this, args, build);
@@ -261,6 +267,10 @@ public Proc dockerExec(Launcher.ProcStarter starter,
         args.add(mainContainerId);
 
         args.add("env").add(starter.envs());
+        if (buildWrapper.getWorkspaceOverride() != null) {
+            //Override $WORKSPACE inside the container
+            args.add("WORKSPACE=" + buildWrapper.getWorkspaceOverride());
+        }
 
         List<String> originalCmds = starter.cmds();
         boolean[] originalMask = starter.masks();

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

@@ -39,6 +39,7 @@
 import hudson.tasks.BuildWrapperDescriptor;
 import jenkins.model.Jenkins;
 import net.sf.json.JSONObject;
+import org.apache.commons.lang.StringUtils;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.DataBoundSetter;
 import org.kohsuke.stapler.StaplerRequest;
@@ -56,16 +57,23 @@
  */
 public class RemoteDockerBuildWrapper extends BuildWrapper {
 
+    private static final String WORKSPACE_OVERRIDE_FIELD = "workspaceOverride";
+    private static final String WORKSPACE_OVERRIDE_OPTIONAL_FIELD = "workspaceOverrideOptional";
+
     private boolean debug;
+    private String workspaceOverride;
     private Boolean removeContainers = true;
     private AbstractDockerConfiguration dockerConfiguration;
     private List<SideDockerConfiguration> sideDockerConfigurations;
 
     @DataBoundConstructor
     public RemoteDockerBuildWrapper(boolean debug,
+                                    String workspaceOverride,
                                     AbstractDockerConfiguration dockerConfiguration,
                                     List<SideDockerConfiguration> sideDockerConfigurations) {
         this.debug = debug;
+        this.workspaceOverride = StringUtils.isNotEmpty(
+                workspaceOverride) ? workspaceOverride : null;
         this.dockerConfiguration = dockerConfiguration;
         this.sideDockerConfigurations = Optional.ofNullable(
                 sideDockerConfigurations)
@@ -76,6 +84,10 @@ public boolean isDebug() {
         return debug;
     }
 
+    public String getWorkspaceOverride() {
+        return workspaceOverride;
+    }
+
     @DataBoundSetter
     public void setRemoveContainers(Boolean removeContainers) {
         this.removeContainers = removeContainers;
@@ -93,6 +105,15 @@ public List<SideDockerConfiguration> getSideDockerConfigurations() {
         return sideDockerConfigurations;
     }
 
+    private void validate() throws Descriptor.FormException {
+        if (StringUtils.isNotEmpty(workspaceOverride)
+                && !workspaceOverride.startsWith("/")) {
+            throw new Descriptor.FormException(
+                    "Workspace override must be an absolute path",
+                    WORKSPACE_OVERRIDE_FIELD);
+        }
+    }
+
     @Override
     public Launcher decorateLauncher(AbstractBuild build,
                                      Launcher launcher,
@@ -107,7 +128,8 @@ public Environment setUp(AbstractBuild build,
         build.addAction(new DockerAction());
         try {
             ((DockerLauncher) launcher).launchContainers();
-            return new DockerEnvironment((DockerLauncher) launcher, removeContainers);
+            return new DockerEnvironment((DockerLauncher) launcher,
+                                         removeContainers);
         } catch (IOException | InterruptedException e) {
             //Attempt tearDown in case we partially started some containers
             ((DockerLauncher) launcher).tearDown(true);
@@ -123,9 +145,10 @@ private class DockerEnvironment extends BuildWrapper.Environment {
         private DockerLauncher launcher;
         private boolean removeContainers;
 
-        public DockerEnvironment(DockerLauncher launcher, boolean removeContainers) {
+        public DockerEnvironment(DockerLauncher launcher,
+                                 boolean removeContainers) {
             this.launcher = launcher;
-            this.removeContainers=removeContainers;
+            this.removeContainers = removeContainers;
         }
 
         @Override
@@ -155,8 +178,13 @@ public BuildWrapper newInstance(StaplerRequest req,
             if (formData.isNullObject()) {
                 return null;
             }
+            if (!formData.getBoolean(WORKSPACE_OVERRIDE_OPTIONAL_FIELD)) {
+                //If the box is unchecked, override whatever value might have been entered
+                formData.remove(WORKSPACE_OVERRIDE_FIELD);
+            }
             RemoteDockerBuildWrapper wrapper = (RemoteDockerBuildWrapper) super.newInstance(
                     req, formData);
+            wrapper.validate();
             wrapper.dockerConfiguration.validate();
             for (SideDockerConfiguration side : wrapper.sideDockerConfigurations) {
                 side.validate();

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

@@ -43,5 +43,10 @@
     <f:entry title="Debug" field="debug">
         <f:checkbox/>
     </f:entry>
+    <f:optionalBlock name="workspaceOverrideOptional" title="Override workspace mount" inline="true" checked="${!empty(instance.workspaceOverride)}">
+        <f:entry title="Workspace path" field="workspaceOverride">
+            <f:textbox/>
+        </f:entry>
+    </f:optionalBlock>
 
 </j:jelly>

…tractDockerConfiguration/help-debug.html …RemoteDockerBuildWrapper/help-debug.htmlsrc/main/resources/com/gpuopenanalytics/jenkins/remotedocker/job/AbstractDockerConfiguration/help-debug.html renamed to src/main/resources/com/gpuopenanalytics/jenkins/remotedocker/RemoteDockerBuildWrapper/help-debug.html src/main/resources/com/gpuopenanalytics/jenkins/remotedocker/job/AbstractDockerConfiguration/help-debug.html renamed to src/main/resources/com/gpuopenanalytics/jenkins/remotedocker/RemoteDockerBuildWrapper/help-debug.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>
+    Change where the job's workspace is mounted inside of the container. By default, the path is the same as the Jenkins agent's workspace.
+</div>