[JENKINS-74912] Support non-C Windows container bind mounts

Author: basil

src/main/java/org/jenkinsci/plugins/docker/workflow/client/WindowsDockerClient.java

@@ -39,8 +39,18 @@ public String run(@NonNull EnvVars launchEnv, @NonNull String image, @CheckForNu
         if (workdir != null) {
             argb.add("-w", workdir);
         }
+        Set<String> seenNonCDrives = new HashSet();
         for (Map.Entry<String, String> volume : volumes.entrySet()) {
-            argb.add("-v", volume.getKey() + ":" + volume.getValue());
+            String sourceVolume = volume.getKey();
+            String driveLetter = sourceVolume.contains(":")? sourceVolume.substring(0, sourceVolume.indexOf(":")) : "C";
+
+            if (driveLetter.equalsIgnoreCase("C")) {
+                argb.add("-v", volume.getKey() + ":" + volume.getValue());
+            } else if (seenNonCDrives.add(driveLetter)) {
+                // JENKINS-74912 Docker for windows does not support mounting non-root non-C volumes
+                LOGGER.log(Level.FINE, "Detected non-C drive \"{0}\". Mounting entire drive.", driveLetter);
+                argb.add("-v", driveLetter + ":/:" + driveLetter + ":");
+            }
         }
         for (String containerId : volumesFromContainers) {
             argb.add("--volumes-from", containerId);

src/test/java/org/jenkinsci/plugins/docker/workflow/DockerDSLTest.java

@@ -270,7 +270,7 @@ private static void grep(File dir, String text, String prefix, Set<String> match
     @Test public void buildWithMultiStage() {
         story.addStep(new Statement() {
             @Override public void evaluate() throws Throwable {
-                assumeDocker(new VersionNumber("17.05"));
+                assumeDocker(DockerTestUtil.DOCKER_OS_MODE.LINUX, new VersionNumber("17.05"));
                 WorkflowJob p = story.j.jenkins.createProject(WorkflowJob.class, "prj");
                 p.setDefinition(new CpsFlowDefinition(
                         "node {\n" +

src/test/java/org/jenkinsci/plugins/docker/workflow/DockerTestUtil.java

@@ -31,6 +31,7 @@
 import org.junit.Assume;
 
 import java.io.ByteArrayOutputStream;
+import java.io.File;
 import java.io.IOException;
 import java.util.Arrays;
 import java.util.List;
@@ -39,7 +40,6 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-import org.hamcrest.Matchers;
 import org.jenkinsci.plugins.docker.commons.tools.DockerTool;
 
 /**
@@ -58,33 +58,20 @@ public class DockerTestUtil {
         "10.0.26100.2605"  // 2025
     );
 
+    public enum DOCKER_OS_MODE {
+        LINUX,
+        WINDOWS
+    }
 
     public static void assumeDocker() throws Exception {
-        assumeDocker(new VersionNumber(DEFAULT_MINIMUM_VERSION));
+        assumeDocker(DOCKER_OS_MODE.LINUX, new VersionNumber(DEFAULT_MINIMUM_VERSION));
     }
-    
-    public static void assumeDocker(VersionNumber minimumVersion) throws Exception {
-        Launcher.LocalLauncher localLauncher = new Launcher.LocalLauncher(StreamTaskListener.NULL);
-        try {
-            int status = localLauncher
-                .launch()
-                .cmds(DockerTool.getExecutable(null, null, null, null), "ps")
-                .start()
-                .joinWithTimeout(DockerClient.CLIENT_TIMEOUT, TimeUnit.SECONDS, localLauncher.getListener());
-            Assume.assumeTrue("Docker working", status == 0);
-        } catch (IOException x) {
-            Assume.assumeNoException("have Docker installed", x);
-        }
-        DockerClient dockerClient = new DockerClient(localLauncher, null, null);
-        Assume.assumeFalse("Docker version not < " + minimumVersion.toString(), dockerClient.version().isOlderThan(minimumVersion));
+
+    public static void assumeDocker(DOCKER_OS_MODE osMode) throws Exception {
+        assumeDocker(osMode, new VersionNumber(DEFAULT_MINIMUM_VERSION));
     }
 
-    /**
-      * Used to assume docker Windows is running in a particular os mode
-      * @param os The os [windows, linux]
-      * @throws Exception
-      */
-    public static void assumeDockerServerOSMode(String os) throws Exception {
+    public static void assumeDocker(DOCKER_OS_MODE osMode, VersionNumber minimumVersion) throws Exception {
         Launcher.LocalLauncher localLauncher = new Launcher.LocalLauncher(StreamTaskListener.NULL);
         try {
             ByteArrayOutputStream out = new ByteArrayOutputStream();
@@ -94,11 +81,14 @@ public static void assumeDockerServerOSMode(String os) throws Exception {
                 .stdout(out)
                 .start()
                 .joinWithTimeout(DockerClient.CLIENT_TIMEOUT, TimeUnit.SECONDS, localLauncher.getListener());
+            DOCKER_OS_MODE cmdOsMode = DOCKER_OS_MODE.valueOf(out.toString().trim().toUpperCase());
             Assume.assumeTrue("Docker working", status == 0);
-            Assume.assumeThat("Docker running in " + os + " mode", out.toString().trim(), Matchers.equalToIgnoringCase(os));
+            Assume.assumeTrue("Docker os mode " + osMode, osMode == cmdOsMode);
         } catch (IOException x) {
-            Assume.assumeNoException("Docker retrieve OS", x);
+            Assume.assumeNoException("have Docker installed", x);
         }
+        DockerClient dockerClient = new DockerClient(localLauncher, null, null);
+        Assume.assumeFalse("Docker version not < " + minimumVersion.toString(), dockerClient.version().isOlderThan(minimumVersion));
     }
 
     public static void assumeWindows() throws Exception {
@@ -109,6 +99,10 @@ public static void assumeNotWindows() throws Exception {
         Assume.assumeFalse(System.getProperty("os.name").toLowerCase().contains("windows"));
     }
 
+    public static void assumeDrive(char drive) throws Exception {
+        Assume.assumeTrue(new File(drive + ":/").exists());
+    }
+
     public static String getWindowsKernelVersion() throws Exception {
         Launcher.LocalLauncher localLauncher = new Launcher.LocalLauncher(StreamTaskListener.NULL);
         ByteArrayOutputStream out = new ByteArrayOutputStream();

src/test/java/org/jenkinsci/plugins/docker/workflow/WithContainerStepTest.java

@@ -45,6 +45,8 @@
 import hudson.util.VersionNumber;
 import java.io.IOException;
 import java.lang.reflect.Field;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.Set;
 import java.util.concurrent.TimeUnit;
 import org.apache.commons.fileupload.FileItem;
@@ -69,6 +71,7 @@
 import org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution;
 import org.jenkinsci.plugins.workflow.test.steps.SemaphoreStep;
 import org.junit.Assume;
+import static org.junit.Assert.assertTrue;
 import static org.junit.Assume.assumeTrue;
 import org.junit.ClassRule;
 import org.junit.Ignore;
@@ -299,7 +302,7 @@ public class WithContainerStepTest {
     @Test public void cd() throws Exception {
         story.addStep(new Statement() {
             @Override public void evaluate() throws Throwable {
-                DockerTestUtil.assumeDocker(new VersionNumber("17.12"));
+                DockerTestUtil.assumeDocker(DockerTestUtil.DOCKER_OS_MODE.LINUX, new VersionNumber("17.12"));
                 WorkflowJob p = story.j.jenkins.createProject(WorkflowJob.class, "prj");
                 p.setDefinition(new CpsFlowDefinition(
                     "node {\n" +
@@ -498,8 +501,7 @@ private static final class Execution extends SynchronousNonBlockingStepExecution
         story.addStep(new Statement() {
             @Override public void evaluate() throws Throwable {
                 DockerTestUtil.assumeWindows();
-                DockerTestUtil.assumeDocker();
-                DockerTestUtil.assumeDockerServerOSMode("windows");
+                DockerTestUtil.assumeDocker(DockerTestUtil.DOCKER_OS_MODE.WINDOWS);
 
                 // Kernel must match when running Windows containers on docker on Windows
                 String releaseTag = DockerTestUtil.getWindowsImageTag();
@@ -516,4 +518,37 @@ private static final class Execution extends SynchronousNonBlockingStepExecution
             }
         });
     }
+
+    @Issue("JENKINS-74912")
+    @Test public void windowsRunningWindowsContainerAlternateDriveWorkspace() {
+        // Run with another drive ("D") if it is mounted
+        story.addStep(new Statement() {
+            @Override public void evaluate() throws Throwable {
+                DockerTestUtil.assumeWindows();
+                DockerTestUtil.assumeDocker(DockerTestUtil.DOCKER_OS_MODE.WINDOWS);
+                DockerTestUtil.assumeDrive('D');
+
+                // Manually create instead of using a Rule since not all executions will have the D drive mounted
+                Path tempDir = Files.createTempDirectory(Path.of("D:/"), "j ws");
+                tempDir.toFile().deleteOnExit();
+
+                // Kernel must match when running Windows containers on docker on Windows
+                String releaseTag = DockerTestUtil.getWindowsImageTag();
+
+                WorkflowJob p = story.j.jenkins.createProject(WorkflowJob.class, "prj");
+                p.setDefinition(new CpsFlowDefinition(
+                    "node {\n" +
+                        "  ws('" + tempDir.toString().replace("\\", "\\\\") + "') {\n" +
+                        "    withDockerContainer('mcr.microsoft.com/windows/nanoserver:" + releaseTag + "') { \n" +
+                        "      bat 'echo bar > foo.txt' \n" +
+                        "      bat 'echo ran OK' \n" +
+                        "    }\n" +
+                        "  }\n" +
+                        "}", true));
+                WorkflowRun b = story.j.assertBuildStatusSuccess(p.scheduleBuild2(0));
+                story.j.assertLogContains("ran OK", b);
+                assertTrue("Mounted workspace contains foo.txt", tempDir.resolve("foo.txt").toFile().exists());
+            }
+        });
+    }
 }

src/test/java/org/jenkinsci/plugins/docker/workflow/client/WindowsDockerClientTest.java

@@ -10,25 +10,23 @@
 import org.junit.Before;
 import org.junit.Test;
 
-import java.io.IOException;
 import java.util.Collections;
 
 public class WindowsDockerClientTest {
 
     private DockerClient dockerClient;
 
     @Before
-    public void setup() throws Exception {
-        DockerTestUtil.assumeDocker();
-
+    public void setup() {
         TaskListener taskListener = StreamTaskListener.fromStderr();
         Launcher.LocalLauncher launcher = new Launcher.LocalLauncher(taskListener);
 
         dockerClient = new WindowsDockerClient(launcher, null, null);
     }
 
     @Test
-    public void test_run() throws IOException, InterruptedException {
+    public void test_run() throws Exception {
+        DockerTestUtil.assumeDocker();
         EnvVars launchEnv = DockerTestUtil.newDockerLaunchEnv();
         String containerId = dockerClient.run(
             launchEnv,