Browse code

Windows: Unify workdir handling

Signed-off-by: John Howard <jhoward@microsoft.com>

Working directory processing was handled differently for Hyper-V and Windows-Server containers, as annotated in the builder documentation (updated in this PR). For Hyper-V containers, the working directory set by WORKDIR was not created. This PR makes Hyper-V containers work the same as Windows Server containers (and the same as Linux).

Example (only applies to Hyper-V containers, so not reproducible under CI environment)
Dockerfile:
FROM microsoft/nanoserver
WORKDIR c:\installer
ENV GOROOT=c:\installer
ADD go.exe .
RUN go --help
Running on Windows Server 2016, using docker master without this change, but with daemon set to --exec-opt isolation=hyperv as it would be for Client operating systems.
PS E:\go\src\github.com\docker\docker> dockerd -g c:\control --exec-opt isolation=hyperv
time="2017-02-01T15:48:09.657286100-08:00" level=info msg="Windows default isolation mode: hyperv"
time="2017-02-01T15:48:09.662720900-08:00" level=info msg="[graphdriver] using prior storage driver: windowsfilter"
time="2017-02-01T15:48:10.011588000-08:00" level=info msg="Graph migration to content-addressability took 0.00 seconds"
time="2017-02-01T15:48:10.016655800-08:00" level=info msg="Loading containers: start."
time="2017-02-01T15:48:10.460820000-08:00" level=info msg="Loading containers: done."
time="2017-02-01T15:48:10.509859600-08:00" level=info msg="Daemon has completed initialization"
time="2017-02-01T15:48:10.509859600-08:00" level=info msg="Docker daemon" commit=3c64061 graphdriver=windowsfilter version=1.14.0-dev
First with no explicit isolation:
PS E:\docker\build\unifyworkdir> docker build --no-cache .
Sending build context to Docker daemon 10.1 MB
Step 1/5 : FROM microsoft/nanoserver
---> 89b8556cb9ca
Step 2/5 : WORKDIR c:\installer
---> 7e0f41d08204
Removing intermediate container 236c7802042a
Step 3/5 : ENV GOROOT c:\installer
---> Running in 8ea5237183c1
---> 394b70435261
Removing intermediate container 8ea5237183c1
Step 4/5 : ADD go.exe .
---> e47401a1745c
Removing intermediate container 88dcc28e74b1
Step 5/5 : RUN go --help
---> Running in efe90e1b6b8b
container efe90e1b6b8b76586abc5c1dc0e2797b75adc26517c48733d90651e767c8463b encountered an error during CreateProcess: failure in a Windows system call: The directory name is invalid. (0x10b) extra info: {"ApplicationName":"","CommandLine":"cmd /S /C go --help","User":"","WorkingDirectory":"C:\\installer","Environment":{"GOROOT":"c:\\installer"},"EmulateConsole":false,"CreateStdInPipe":true,"CreateStdOutPipe":true,"CreateStdErrPipe":true,"ConsoleSize":[0,0]}
PS E:\docker\build\unifyworkdir>
Then forcing process isolation:
PS E:\docker\build\unifyworkdir> docker build --isolation=process --no-cache .
Sending build context to Docker daemon 10.1 MB
Step 1/5 : FROM microsoft/nanoserver
---> 89b8556cb9ca
Step 2/5 : WORKDIR c:\installer
---> 350c955980c8
Removing intermediate container 8339c1e9250c
Step 3/5 : ENV GOROOT c:\installer
---> Running in bde511c5e3e0
---> b8820063b5b6
Removing intermediate container bde511c5e3e0
Step 4/5 : ADD go.exe .
---> e4ac32f8902b
Removing intermediate container d586e8492eda
Step 5/5 : RUN go --help
---> Running in 9e1aa235af5f
Cannot mkdir: C:\installer is not a directory
PS E:\docker\build\unifyworkdir>
Now compare the same results after this PR. Again, first with no explicit isolation (defaulting to Hyper-V containers as that's what the daemon it set to) - note it now succeeds 😄
PS E:\docker\build\unifyworkdir> docker build --no-cache .
Sending build context to Docker daemon 10.1 MB
Step 1/5 : FROM microsoft/nanoserver
---> 89b8556cb9ca
Step 2/5 : WORKDIR c:\installer
---> 4f319f301c69
Removing intermediate container 61b9c0b1ff6f
Step 3/5 : ENV GOROOT c:\installer
---> Running in c464a1d612d8
---> 96a26ab9a7b5
Removing intermediate container c464a1d612d8
Step 4/5 : ADD go.exe .
---> 0290d61faf57
Removing intermediate container dc5a085fffe3
Step 5/5 : RUN go --help
---> Running in 60bd56042ff8
Go is a tool for managing Go source code.

Usage:

go command [arguments]

The commands are:

build compile packages and dependencies
clean remove object files
doc show documentation for package or symbol
env print Go environment information
fix run go tool fix on packages
fmt run gofmt on package sources
generate generate Go files by processing source
get download and install packages and dependencies
install compile and install packages and dependencies
list list packages
run compile and run Go program
test test packages
tool run specified go tool
version print Go version
vet run go tool vet on packages

Use "go help [command]" for more information about a command.

Additional help topics:

c calling between Go and C
buildmode description of build modes
filetype file types
gopath GOPATH environment variable
environment environment variables
importpath import path syntax
packages description of package lists
testflag description of testing flags
testfunc description of testing functions

Use "go help [topic]" for more information about that topic.

The command 'cmd /S /C go --help' returned a non-zero code: 2
And the same with forcing process isolation. Also works 😄
PS E:\docker\build\unifyworkdir> docker build --isolation=process --no-cache .
Sending build context to Docker daemon 10.1 MB
Step 1/5 : FROM microsoft/nanoserver
---> 89b8556cb9ca
Step 2/5 : WORKDIR c:\installer
---> f423b9cc3e78
Removing intermediate container 41330c88893d
Step 3/5 : ENV GOROOT c:\installer
---> Running in 0b99a2d7bf19
---> e051144bf8ec
Removing intermediate container 0b99a2d7bf19
Step 4/5 : ADD go.exe .
---> 7072e32b7c37
Removing intermediate container a7a97aa37fd1
Step 5/5 : RUN go --help
---> Running in 7097438a54e5
Go is a tool for managing Go source code.

Usage:

go command [arguments]

The commands are:

build compile packages and dependencies
clean remove object files
doc show documentation for package or symbol
env print Go environment information
fix run go tool fix on packages
fmt run gofmt on package sources
generate generate Go files by processing source
get download and install packages and dependencies
install compile and install packages and dependencies
list list packages
run compile and run Go program
test test packages
tool run specified go tool
version print Go version
vet run go tool vet on packages

Use "go help [command]" for more information about a command.

Additional help topics:

c calling between Go and C
buildmode description of build modes
filetype file types
gopath GOPATH environment variable
environment environment variables
importpath import path syntax
packages description of package lists
testflag description of testing flags
testfunc description of testing functions

Use "go help [topic]" for more information about that topic.

The command 'cmd /S /C go --help' returned a non-zero code: 2
PS E:\docker\build\unifyworkdir>

John Howard authored on 2017/02/02 07:56:19
Showing 6 changed files
... ...
@@ -221,12 +221,6 @@ func (container *Container) SetupWorkingDirectory(rootUID, rootGID int) error {
221 221
 
222 222
 	container.Config.WorkingDir = filepath.Clean(container.Config.WorkingDir)
223 223
 
224
-	// If can't mount container FS at this point (e.g. Hyper-V Containers on
225
-	// Windows) bail out now with no action.
226
-	if !container.canMountFS() {
227
-		return nil
228
-	}
229
-
230 224
 	pth, err := container.GetResourcePath(container.Config.WorkingDir)
231 225
 	if err != nil {
232 226
 		return err
... ...
@@ -439,12 +439,6 @@ func cleanResourcePath(path string) string {
439 439
 	return filepath.Join(string(os.PathSeparator), path)
440 440
 }
441 441
 
442
-// canMountFS determines if the file system for the container
443
-// can be mounted locally. A no-op on non-Windows platforms
444
-func (container *Container) canMountFS() bool {
445
-	return true
446
-}
447
-
448 442
 // EnableServiceDiscoveryOnDefaultNetwork Enable service discovery on default network
449 443
 func (container *Container) EnableServiceDiscoveryOnDefaultNetwork() bool {
450 444
 	return false
... ...
@@ -104,13 +104,6 @@ func (container *Container) BuildHostnameFile() error {
104 104
 	return nil
105 105
 }
106 106
 
107
-// canMountFS determines if the file system for the container
108
-// can be mounted locally. In the case of Windows, this is not possible
109
-// for Hyper-V containers during WORKDIR execution for example.
110
-func (container *Container) canMountFS() bool {
111
-	return !containertypes.Isolation.IsHyperV(container.HostConfig.Isolation)
112
-}
113
-
114 107
 // EnableServiceDiscoveryOnDefaultNetwork Enable service discovery on default network
115 108
 func (container *Container) EnableServiceDiscoveryOnDefaultNetwork() bool {
116 109
 	return true
... ...
@@ -18,9 +18,9 @@ func (daemon *Daemon) createSpec(c *container.Container) (*specs.Spec, error) {
18 18
 		return nil, err
19 19
 	}
20 20
 
21
-	if err := c.SetupWorkingDirectory(0, 0); err != nil {
22
-		return nil, err
23
-	}
21
+	// Note, unlike Unix, we do NOT call into SetupWorkingDirectory as
22
+	// this is done in VMCompute. Further, we couldn't do it for Hyper-V
23
+	// containers anyway.
24 24
 
25 25
 	// In base spec
26 26
 	s.Hostname = c.FullHostname()
... ...
@@ -1270,19 +1270,6 @@ For example:
1270 1270
 The output of the final `pwd` command in this `Dockerfile` would be
1271 1271
 `/path/$DIRNAME`
1272 1272
 
1273
-On Windows, `WORKDIR` behaves differently depending on whether using Windows
1274
-Server containers or Hyper-V containers. For Hyper-V containers, the engine
1275
-is, for architectural reasons, unable to create the directory if it does not
1276
-previously exist. For Windows Server containers, the directory is created
1277
-if it does not exist. Hence, for consistency between Windows Server and 
1278
-Hyper-V containers, it is strongly recommended to include an explicit instruction
1279
-to create the directory in the Dockerfile. For example:
1280
-
1281
-    # escape=`
1282
-    FROM microsoft/nanoserver
1283
-    RUN mkdir c:\myapp
1284
-    WORKDIR c:\myapp
1285
-
1286 1273
 ## ARG
1287 1274
 
1288 1275
     ARG <name>[=<default value>]
... ...
@@ -1717,7 +1717,7 @@ func (s *DockerSuite) TestRunWorkdirExistsAndIsFile(c *check.C) {
1717 1717
 	expected := "not a directory"
1718 1718
 	if testEnv.DaemonPlatform() == "windows" {
1719 1719
 		existingFile = `\windows\system32\ntdll.dll`
1720
-		expected = `Cannot mkdir: \windows\system32\ntdll.dll is not a directory.`
1720
+		expected = `The directory name is invalid.`
1721 1721
 	}
1722 1722
 
1723 1723
 	out, exitCode, err := dockerCmdWithError("run", "-w", existingFile, "busybox")