moby/volume/mounts/windows_parser_test.go
Sebastiaan van Stijn d69b1fdb72
volume/mounts: cleanup tests
- don't use un-keyed structs
- user assert.Check where possible
- use consts for fixed values

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-07-27 15:00:13 +02:00

279 lines
9.2 KiB
Go

package mounts // import "github.com/docker/docker/volume/mounts"
import (
"fmt"
"strings"
"testing"
"github.com/docker/docker/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) {
cases := []struct {
bind string
driver string
expType mount.Type
expDest string
expSource string
expName string
expDriver string
expRW bool
fail bool
}{
{
bind: `c:\:d:`,
driver: "local",
expType: mount.TypeBind,
expDest: `d:`,
expSource: `c:\`,
expRW: true,
},
{
bind: `c:\:d:\`,
driver: "local",
expType: mount.TypeBind,
expDest: `d:\`,
expSource: `c:\`,
expRW: true,
},
{
bind: `c:\:d:\:ro`,
driver: "local",
expType: mount.TypeBind,
expDest: `d:\`,
expSource: `c:\`,
},
{
bind: `c:\:d:\:rw`,
driver: "local",
expType: mount.TypeBind,
expDest: `d:\`,
expSource: `c:\`,
expRW: true,
},
{
bind: `c:\:d:\:foo`,
driver: "local",
expType: mount.TypeBind,
expDest: `d:\`,
expSource: `c:\`,
fail: true,
},
{
bind: `name:d::rw`,
driver: "local",
expType: mount.TypeVolume,
expDest: `d:`,
expName: `name`,
expDriver: "local",
expRW: true,
},
{
bind: `name:d:`,
driver: "local",
expType: mount.TypeVolume,
expDest: `d:`,
expName: `name`,
expDriver: "local",
expRW: true,
},
{
bind: `name:d::ro`,
driver: "local",
expType: mount.TypeVolume,
expDest: `d:`,
expName: `name`,
expDriver: "local",
},
{
bind: `name:c:`,
expType: mount.TypeVolume,
expRW: true,
fail: true,
},
{
bind: `driver/name:c:`,
expType: mount.TypeVolume,
expRW: true,
fail: true,
},
{
bind: `\\.\pipe\foo:\\.\pipe\bar`,
driver: "local",
expType: mount.TypeNamedPipe,
expDest: `\\.\pipe\bar`,
expSource: `\\.\pipe\foo`,
expRW: true,
},
{
bind: `\\.\pipe\foo:c:\foo\bar`,
driver: "local",
expType: mount.TypeNamedPipe,
expRW: true,
fail: true,
},
{
bind: `c:\foo\bar:\\.\pipe\foo`,
driver: "local",
expType: mount.TypeNamedPipe,
expRW: true,
fail: true,
},
}
parser := NewWindowsParser()
if p, ok := parser.(*windowsParser); ok {
p.fi = mockFiProvider{}
}
for _, tc := range cases {
tc := tc
t.Run(tc.bind, func(t *testing.T) {
m, err := parser.ParseMountRaw(tc.bind, tc.driver)
if tc.fail {
assert.Check(t, is.ErrorContains(err, ""), "expected an error")
return
}
assert.Check(t, err)
assert.Check(t, is.Equal(m.Destination, tc.expDest))
assert.Check(t, is.Equal(m.Source, tc.expSource))
assert.Check(t, is.Equal(m.Name, tc.expName))
assert.Check(t, is.Equal(m.Driver, tc.expDriver))
assert.Check(t, is.Equal(m.RW, tc.expRW))
assert.Check(t, is.Equal(m.Type, tc.expType))
})
}
}
// 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 := fmt.Errorf("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())
}