Files
moby/daemon/volume/mounts/windows_parser_test.go
Shane St Savage beeacde4b2 Remove restriction on anonymous read-only volumes
Restriction on anonymouse read-only volumes is currently preventing
the use of pre-populated volumes that should be accessed in a read-only manner in a container
(e.g. an NFS volume containing data to be processed or served).

According to @neersighted the restriction may have originally been put
in place with the assumption that pre-populated volumes would be
exposed as a named volume by the volume driver.

In practice, NFS volumes are mounted using the docker `local` driver
by supplying driver opts. Example that fails when `readonly` is specified but works without:

```
docker run --rm -it \
 --mount 'readonly,type=volume,dst=/data/dest,volume-driver=local,volume-opt=type=nfs,volume-opt=device=:/export/some-share,"volume-opt=o=nfsvers=4,addr=some.server"' \
  debian
```

Fixes #45297

Signed-off-by: Shane St Savage <shane@axds.co>
2025-12-18 16:08:31 -08:00

404 lines
12 KiB
Go

package mounts
import (
"errors"
"strings"
"testing"
"github.com/google/go-cmp/cmp/cmpopts"
"github.com/moby/moby/api/types/mount"
"gotest.tools/v3/assert"
is "gotest.tools/v3/assert/cmp"
)
func TestWindowsParseMountRaw(t *testing.T) {
valid := []string{
`d:\`,
`d:`,
`d:\path`,
`d:\path with space`,
`c:\:d:\`,
`c:\windows\:d:`,
`c:\windows:d:\s p a c e`,
`c:\windows:d:\s p a c e:RW`,
`c:\program files:d:\s p a c e i n h o s t d i r`,
`0123456789name:d:`,
`MiXeDcAsEnAmE:d:`,
`test-aux-volume:d:`, // includes reserved word, but is not one itself
`name:D:`,
`name:D::rW`,
`name:D::RW`,
`name:D::RO`,
`c:/:d:/forward/slashes/are/good/too`,
`c:/:d:/including with/spaces:ro`,
`c:\Windows`, // With capital
`c:\Program Files (x86)`, // With capitals and brackets
`\\?\c:\windows\:d:`, // Long path handling (source)
`c:\windows\:\\?\d:\`, // Long path handling (target)
`\\.\pipe\foo:\\.\pipe\foo`, // named pipe
`//./pipe/foo://./pipe/foo`, // named pipe forward slashes
}
invalid := map[string]string{
``: "invalid volume specification: ",
`.`: "invalid volume specification: ",
`..\`: "invalid volume specification: ",
`c:\:..\`: "invalid volume specification: ",
`c:\:d:\:xyzzy`: "invalid volume specification: ",
`c:`: "cannot be 'c:'",
`c:\`: "cannot be 'c:'",
`c:\notexist:d:`: `source path does not exist: c:\notexist`,
`c:\windows\system32\ntdll.dll:d:`: `source path must be a directory`,
`name<:d:`: `invalid volume specification`,
`name>:d:`: `invalid volume specification`,
`name::d:`: `invalid volume specification`,
`name":d:`: `invalid volume specification`,
`name\:d:`: `invalid volume specification`,
`name*:d:`: `invalid volume specification`,
`name|:d:`: `invalid volume specification`,
`name?:d:`: `invalid volume specification`,
`name/:d:`: `invalid volume specification`,
`d:\pathandmode:rw`: `invalid volume specification`,
`d:\pathandmode:ro`: `invalid volume specification`,
`con:d:`: `cannot be a reserved word for Windows filenames`,
`PRN:d:`: `cannot be a reserved word for Windows filenames`,
`aUx:d:`: `cannot be a reserved word for Windows filenames`,
`nul:d:`: `cannot be a reserved word for Windows filenames`,
`com1:d:`: `cannot be a reserved word for Windows filenames`,
`com2:d:`: `cannot be a reserved word for Windows filenames`,
`com3:d:`: `cannot be a reserved word for Windows filenames`,
`com4:d:`: `cannot be a reserved word for Windows filenames`,
`com5:d:`: `cannot be a reserved word for Windows filenames`,
`com6:d:`: `cannot be a reserved word for Windows filenames`,
`com7:d:`: `cannot be a reserved word for Windows filenames`,
`com8:d:`: `cannot be a reserved word for Windows filenames`,
`com9:d:`: `cannot be a reserved word for Windows filenames`,
`lpt1:d:`: `cannot be a reserved word for Windows filenames`,
`lpt2:d:`: `cannot be a reserved word for Windows filenames`,
`lpt3:d:`: `cannot be a reserved word for Windows filenames`,
`lpt4:d:`: `cannot be a reserved word for Windows filenames`,
`lpt5:d:`: `cannot be a reserved word for Windows filenames`,
`lpt6:d:`: `cannot be a reserved word for Windows filenames`,
`lpt7:d:`: `cannot be a reserved word for Windows filenames`,
`lpt8:d:`: `cannot be a reserved word for Windows filenames`,
`lpt9:d:`: `cannot be a reserved word for Windows filenames`,
`c:\windows\system32\ntdll.dll`: `Only directories can be mapped on this platform`,
`\\.\pipe\foo:c:\pipe`: `'c:\pipe' is not a valid pipe path`,
}
parser := NewWindowsParser()
if p, ok := parser.(*windowsParser); ok {
p.fi = mockFiProvider{}
}
for _, path := range valid {
if _, err := parser.ParseMountRaw(path, "local"); err != nil {
t.Errorf("ParseMountRaw(%q) should succeed: error %q", path, err)
}
}
for path, expectedError := range invalid {
if mp, err := parser.ParseMountRaw(path, "local"); err == nil {
t.Errorf("ParseMountRaw(%q) should have failed validation. Err '%v' - MP: %v", path, err, mp)
} else {
if !strings.Contains(err.Error(), expectedError) {
t.Errorf("ParseMountRaw(%q) error should contain %q, got %v", path, expectedError, err.Error())
}
}
}
}
func TestWindowsParseMountRawSplit(t *testing.T) {
tests := []struct {
bind string
driver string
expected *MountPoint
expErr string
}{
{
bind: `c:\:d:`,
driver: "local",
expected: &MountPoint{
Source: `c:\`,
Destination: `d:`,
RW: true,
Type: mount.TypeBind,
Spec: mount.Mount{
Source: `c:\`,
Target: `d:`,
ReadOnly: false,
Type: mount.TypeBind,
},
},
},
{
bind: `c:\:d:\`,
driver: "local",
expected: &MountPoint{
Source: `c:\`,
Destination: `d:\`,
RW: true,
Type: mount.TypeBind,
Spec: mount.Mount{
Source: `c:\`,
Target: `d:\`,
ReadOnly: false,
Type: mount.TypeBind,
},
},
},
{
bind: `c:\:d:\:ro`,
expected: &MountPoint{
Source: `c:\`,
Destination: `d:\`,
RW: false,
Type: mount.TypeBind,
Mode: "ro",
Spec: mount.Mount{
Source: `c:\`,
Target: `d:\`,
ReadOnly: true,
Type: mount.TypeBind,
// BindOptions: &mount.BindOptions{},
},
},
},
{
bind: `c:\:d:\:rw`,
expected: &MountPoint{
Source: `c:\`,
Destination: `d:\`,
RW: true,
Type: mount.TypeBind,
Mode: "rw",
Spec: mount.Mount{
Source: `c:\`,
Target: `d:\`,
ReadOnly: false,
Type: mount.TypeBind,
},
},
},
{
bind: `c:\:d:\:foo`,
expErr: `invalid volume specification: 'c:\:d:\:foo'`,
},
{
bind: `name:d::rw`,
driver: "local",
expected: &MountPoint{
Destination: `d:`,
RW: true,
Name: `name`,
Driver: `local`,
Type: mount.TypeVolume,
Mode: `rw`,
Spec: mount.Mount{
Source: `name`,
Target: `d:`,
ReadOnly: false,
Type: mount.TypeVolume,
VolumeOptions: &mount.VolumeOptions{DriverConfig: &mount.Driver{Name: "local"}},
},
},
},
{
bind: `name:d:`,
driver: "local",
expected: &MountPoint{
Destination: `d:`,
RW: true,
Name: `name`,
Driver: `local`,
Type: mount.TypeVolume,
Mode: ``, // FIXME(thaJeztah): why is this different than an explicit "rw" ?
Spec: mount.Mount{
Source: `name`,
Target: `d:`,
ReadOnly: false,
Type: mount.TypeVolume,
VolumeOptions: &mount.VolumeOptions{DriverConfig: &mount.Driver{Name: "local"}},
},
},
},
{
bind: `name:d::ro`,
driver: "local",
expected: &MountPoint{
Destination: `d:`,
RW: false,
Name: `name`,
Driver: `local`,
Type: mount.TypeVolume,
Mode: `ro`,
Spec: mount.Mount{
Source: `name`,
Target: `d:`,
ReadOnly: true,
Type: mount.TypeVolume,
VolumeOptions: &mount.VolumeOptions{DriverConfig: &mount.Driver{Name: "local"}},
},
},
},
{
bind: `name:c:`,
expErr: `invalid volume specification: 'name:c:': invalid mount config for type "volume": destination path (c:) cannot be 'c:' or 'c:\'`,
},
{
bind: `driver/name:c:`,
expErr: `invalid volume specification: 'driver/name:c:'`,
},
{
bind: `\\.\pipe\foo:\\.\pipe\bar`,
expected: &MountPoint{
Source: `\\.\pipe\foo`,
Destination: `\\.\pipe\bar`,
RW: true,
Type: mount.TypeNamedPipe,
Spec: mount.Mount{
Source: `\\.\pipe\foo`,
Target: `\\.\pipe\bar`,
ReadOnly: false,
Type: mount.TypeNamedPipe,
},
},
},
{
bind: `\\.\pipe\foo:c:\foo\bar`,
expErr: `invalid volume specification: '\\.\pipe\foo:c:\foo\bar': invalid mount config for type "npipe": 'c:\foo\bar' is not a valid pipe path`,
},
{
bind: `c:\foo\bar:\\.\pipe\foo`,
expErr: `invalid volume specification: 'c:\foo\bar:\\.\pipe\foo': invalid mount config for type "bind": bind source path does not exist: c:\foo\bar`,
},
}
parser := NewWindowsParser()
if p, ok := parser.(*windowsParser); ok {
p.fi = mockFiProvider{}
}
for _, tc := range tests {
t.Run(tc.bind, func(t *testing.T) {
m, err := parser.ParseMountRaw(tc.bind, tc.driver)
if tc.expErr != "" {
assert.Check(t, is.Nil(m))
assert.Check(t, is.Error(err, tc.expErr))
return
}
assert.NilError(t, err)
assert.Check(t, is.DeepEqual(*m, *tc.expected, cmpopts.IgnoreUnexported(MountPoint{})))
})
}
}
func TestWindowsValidateMounts(t *testing.T) {
tests := []struct {
mount mount.Mount
expected *MountPoint
expErr string
}{
{
mount: mount.Mount{
Source: `c:\`,
Target: `d:\mount`,
Type: mount.TypeBind,
},
expected: &MountPoint{
Source: `c:\`,
Destination: `d:\mount`,
RW: true,
Type: mount.TypeBind,
Spec: mount.Mount{
Source: `c:\`,
Target: `d:\mount`,
Type: mount.TypeBind,
},
},
},
{
mount: mount.Mount{
Target: `c:/data/anonymous-read-only-volume`,
ReadOnly: true,
Type: mount.TypeVolume,
},
expected: &MountPoint{
Destination: `c:\data\anonymous-read-only-volume`,
Type: mount.TypeVolume,
Spec: mount.Mount{
Target: `c:/data/anonymous-read-only-volume`,
ReadOnly: true,
Type: mount.TypeVolume,
},
},
},
{
mount: mount.Mount{
Source: "c:/bad/path",
Target: "d:/data/anonymous-read-only-volume",
Type: mount.TypeBind,
},
expErr: `invalid mount config for type "bind": bind source path does not exist: c:/bad/path`,
},
{
mount: mount.Mount{
Target: "d:/data/invalid-type",
Type: "invalid",
},
expErr: `invalid mount config for type "invalid": mount type unknown`,
},
}
parser := NewWindowsParser()
if p, ok := parser.(*windowsParser); ok {
p.fi = mockFiProvider{}
}
for _, tc := range tests {
m, err := parser.ParseMountSpec(tc.mount)
if tc.expErr != "" {
assert.Check(t, is.Nil(m))
assert.Check(t, is.Error(err, tc.expErr))
continue
}
assert.NilError(t, err)
assert.Check(t, is.DeepEqual(*m, *tc.expected, cmpopts.IgnoreUnexported(MountPoint{})))
}
}
// TestWindowsParseMountSpecBindWithFileinfoError makes sure that the parser returns
// the error produced by the fileinfo provider.
//
// Some extra context for the future in case of changes and possible wtf are we
// testing this for:
//
// Currently this "fileInfoProvider" returns (bool, bool, error)
// The 1st bool is "does this path exist"
// The 2nd bool is "is this path a dir"
// Then of course the error is an error.
//
// The issue is the parser was ignoring the error and only looking at the
// "does this path exist" boolean, which is always false if there is an error.
// Then the error returned to the caller was a (slightly, maybe) friendlier
// error string than what comes from `os.Stat`
// So ...the caller was always getting an error saying the path doesn't exist
// even if it does exist but got some other error (like a permission error).
// This is confusing to users.
func TestWindowsParseMountSpecBindWithFileinfoError(t *testing.T) {
parser := NewWindowsParser()
testErr := errors.New("some crazy error")
if pr, ok := parser.(*windowsParser); ok {
pr.fi = &mockFiProviderWithError{err: testErr}
}
_, err := parser.ParseMountSpec(mount.Mount{
Type: mount.TypeBind,
Source: `c:\bananas`,
Target: `c:\bananas`,
})
assert.ErrorContains(t, err, testErr.Error())
}