493 lines
12 KiB
Go
493 lines
12 KiB
Go
package sys
|
|
|
|
import (
|
|
"embed"
|
|
"errors"
|
|
"io/fs"
|
|
"os"
|
|
"path"
|
|
"syscall"
|
|
"testing"
|
|
"testing/fstest"
|
|
|
|
"github.com/tetratelabs/wazero/internal/platform"
|
|
"github.com/tetratelabs/wazero/internal/sysfs"
|
|
testfs "github.com/tetratelabs/wazero/internal/testing/fs"
|
|
"github.com/tetratelabs/wazero/internal/testing/require"
|
|
)
|
|
|
|
//go:embed testdata
|
|
var testdata embed.FS
|
|
|
|
func TestNewFSContext(t *testing.T) {
|
|
embedFS, err := fs.Sub(testdata, "testdata")
|
|
require.NoError(t, err)
|
|
|
|
dirfs := sysfs.NewDirFS(".")
|
|
|
|
// Test various usual configuration for the file system.
|
|
tests := []struct {
|
|
name string
|
|
fs sysfs.FS
|
|
}{
|
|
{
|
|
name: "embed.FS",
|
|
fs: sysfs.Adapt(embedFS),
|
|
},
|
|
{
|
|
name: "sysfs.NewDirFS",
|
|
// Don't use "testdata" because it may not be present in
|
|
// cross-architecture (a.k.a. scratch) build containers.
|
|
fs: dirfs,
|
|
},
|
|
{
|
|
name: "sysfs.NewReadFS",
|
|
fs: sysfs.NewReadFS(dirfs),
|
|
},
|
|
{
|
|
name: "fstest.MapFS",
|
|
fs: sysfs.Adapt(fstest.MapFS{}),
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
tc := tt
|
|
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
c := Context{}
|
|
err := c.NewFSContext(nil, nil, nil, tc.fs)
|
|
require.NoError(t, err)
|
|
fsc := c.fsc
|
|
defer fsc.Close()
|
|
|
|
preopenedDir, _ := fsc.openedFiles.Lookup(FdPreopen)
|
|
require.Equal(t, tc.fs, fsc.rootFS)
|
|
require.NotNil(t, preopenedDir)
|
|
require.Equal(t, "/", preopenedDir.Name)
|
|
|
|
// Verify that each call to OpenFile returns a different file
|
|
// descriptor.
|
|
f1, errno := fsc.OpenFile(preopenedDir.FS, preopenedDir.Name, 0, 0)
|
|
require.EqualErrno(t, 0, errno)
|
|
require.NotEqual(t, FdPreopen, f1)
|
|
|
|
// Verify that file descriptors are reused.
|
|
//
|
|
// Note that this specific behavior is not required by WASI which
|
|
// only documents that file descriptor numbers will be selected
|
|
// randomly and applications should not rely on them. We added this
|
|
// test to ensure that our implementation properly reuses descriptor
|
|
// numbers but if we were to change the reuse strategy, this test
|
|
// would likely break and need to be updated.
|
|
require.EqualErrno(t, 0, fsc.CloseFile(f1))
|
|
f2, errno := fsc.OpenFile(preopenedDir.FS, preopenedDir.Name, 0, 0)
|
|
require.EqualErrno(t, 0, errno)
|
|
require.Equal(t, f1, f2)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestFSContext_CloseFile(t *testing.T) {
|
|
embedFS, err := fs.Sub(testdata, "testdata")
|
|
require.NoError(t, err)
|
|
testFS := sysfs.Adapt(embedFS)
|
|
|
|
c := Context{}
|
|
err = c.NewFSContext(nil, nil, nil, testFS)
|
|
require.NoError(t, err)
|
|
fsc := c.fsc
|
|
defer fsc.Close()
|
|
|
|
fdToClose, errno := fsc.OpenFile(testFS, "empty.txt", os.O_RDONLY, 0)
|
|
require.EqualErrno(t, 0, errno)
|
|
|
|
fdToKeep, errno := fsc.OpenFile(testFS, "test.txt", os.O_RDONLY, 0)
|
|
require.EqualErrno(t, 0, errno)
|
|
|
|
// Close
|
|
require.EqualErrno(t, 0, fsc.CloseFile(fdToClose))
|
|
|
|
// Verify fdToClose is closed and removed from the opened FDs.
|
|
_, ok := fsc.LookupFile(fdToClose)
|
|
require.False(t, ok)
|
|
|
|
// Verify fdToKeep is not closed
|
|
_, ok = fsc.LookupFile(fdToKeep)
|
|
require.True(t, ok)
|
|
|
|
t.Run("EBADF for an invalid FD", func(t *testing.T) {
|
|
require.EqualErrno(t, syscall.EBADF, fsc.CloseFile(42)) // 42 is an arbitrary invalid FD
|
|
})
|
|
t.Run("Can close a pre-open", func(t *testing.T) {
|
|
require.EqualErrno(t, 0, fsc.CloseFile(FdPreopen))
|
|
})
|
|
}
|
|
|
|
func TestUnimplementedFSContext(t *testing.T) {
|
|
c := Context{}
|
|
err := c.NewFSContext(nil, nil, nil, sysfs.UnimplementedFS{})
|
|
require.NoError(t, err)
|
|
testFS := &c.fsc
|
|
require.NoError(t, err)
|
|
|
|
expected := &FSContext{rootFS: sysfs.UnimplementedFS{}}
|
|
noopStdin, _ := stdinFile(nil)
|
|
expected.openedFiles.Insert(noopStdin)
|
|
noopStdout, _ := stdioWriterFile("stdout", nil)
|
|
expected.openedFiles.Insert(noopStdout)
|
|
noopStderr, _ := stdioWriterFile("stderr", nil)
|
|
expected.openedFiles.Insert(noopStderr)
|
|
|
|
t.Run("Close closes", func(t *testing.T) {
|
|
err := testFS.Close()
|
|
require.NoError(t, err)
|
|
|
|
// Closes opened files
|
|
require.Equal(t, &FSContext{rootFS: sysfs.UnimplementedFS{}}, testFS)
|
|
})
|
|
}
|
|
|
|
func TestCompositeFSContext(t *testing.T) {
|
|
tmpDir1 := t.TempDir()
|
|
testFS1 := sysfs.NewDirFS(tmpDir1)
|
|
|
|
tmpDir2 := t.TempDir()
|
|
testFS2 := sysfs.NewDirFS(tmpDir2)
|
|
|
|
rootFS, err := sysfs.NewRootFS([]sysfs.FS{testFS2, testFS1}, []string{"/tmp", "/"})
|
|
require.NoError(t, err)
|
|
|
|
c := Context{}
|
|
err = c.NewFSContext(nil, nil, nil, rootFS)
|
|
require.NoError(t, err)
|
|
testFS := &c.fsc
|
|
|
|
// Ensure the pre-opens have exactly the name specified, and are in order.
|
|
preopen3, ok := testFS.openedFiles.Lookup(3)
|
|
require.True(t, ok)
|
|
require.Equal(t, "/tmp", preopen3.Name)
|
|
preopen4, ok := testFS.openedFiles.Lookup(4)
|
|
require.True(t, ok)
|
|
require.Equal(t, "/", preopen4.Name)
|
|
|
|
t.Run("Close closes", func(t *testing.T) {
|
|
err := testFS.Close()
|
|
require.NoError(t, err)
|
|
|
|
// Closes opened files
|
|
require.Equal(t, &FSContext{rootFS: rootFS}, testFS)
|
|
})
|
|
}
|
|
|
|
func TestContext_Close(t *testing.T) {
|
|
testFS := sysfs.Adapt(testfs.FS{"foo": &testfs.File{}})
|
|
|
|
c := Context{}
|
|
err := c.NewFSContext(nil, nil, nil, testFS)
|
|
require.NoError(t, err)
|
|
fsc := c.fsc
|
|
|
|
// Verify base case
|
|
require.Equal(t, 1+FdPreopen, int32(fsc.openedFiles.Len()))
|
|
|
|
_, errno := fsc.OpenFile(testFS, "foo", os.O_RDONLY, 0)
|
|
require.EqualErrno(t, 0, errno)
|
|
require.Equal(t, 2+FdPreopen, int32(fsc.openedFiles.Len()))
|
|
|
|
// Closing should not err.
|
|
require.NoError(t, fsc.Close())
|
|
|
|
// Verify our intended side-effect
|
|
require.Zero(t, fsc.openedFiles.Len())
|
|
|
|
// Verify no error closing again.
|
|
require.NoError(t, fsc.Close())
|
|
}
|
|
|
|
func TestContext_Close_Error(t *testing.T) {
|
|
file := &testfs.File{CloseErr: errors.New("error closing")}
|
|
|
|
testFS := sysfs.Adapt(testfs.FS{"foo": file})
|
|
|
|
c := Context{}
|
|
err := c.NewFSContext(nil, nil, nil, testFS)
|
|
require.NoError(t, err)
|
|
fsc := c.fsc
|
|
|
|
// open another file
|
|
_, errno := fsc.OpenFile(testFS, "foo", os.O_RDONLY, 0)
|
|
require.EqualErrno(t, 0, errno)
|
|
|
|
// arbitrary errors coerce to EIO
|
|
require.EqualErrno(t, syscall.EIO, fsc.Close())
|
|
|
|
// Paths should clear even under error
|
|
require.Zero(t, fsc.openedFiles.Len(), "expected no opened files")
|
|
}
|
|
|
|
func TestFSContext_ReOpenDir(t *testing.T) {
|
|
tmpDir := t.TempDir()
|
|
dirFs := sysfs.NewDirFS(tmpDir)
|
|
|
|
const dirName = "dir"
|
|
errno := dirFs.Mkdir(dirName, 0o700)
|
|
require.EqualErrno(t, 0, errno)
|
|
|
|
c := Context{}
|
|
err := c.NewFSContext(nil, nil, nil, dirFs)
|
|
require.NoError(t, err)
|
|
fsc := c.fsc
|
|
|
|
require.NoError(t, err)
|
|
defer fsc.Close()
|
|
|
|
t.Run("ok", func(t *testing.T) {
|
|
dirFd, errno := fsc.OpenFile(dirFs, dirName, os.O_RDONLY, 0o600)
|
|
require.EqualErrno(t, 0, errno)
|
|
|
|
ent, ok := fsc.LookupFile(dirFd)
|
|
require.True(t, ok)
|
|
|
|
// Set arbitrary state.
|
|
ent.ReadDir = &ReadDir{Dirents: make([]*platform.Dirent, 10), CountRead: 12345}
|
|
|
|
// Then reopen the same file descriptor.
|
|
ent, errno = fsc.ReOpenDir(dirFd)
|
|
require.EqualErrno(t, 0, errno)
|
|
|
|
// Verify the read dir state has been reset.
|
|
require.Equal(t, &ReadDir{}, ent.ReadDir)
|
|
})
|
|
|
|
t.Run("non existing ", func(t *testing.T) {
|
|
_, errno = fsc.ReOpenDir(12345)
|
|
require.EqualErrno(t, syscall.EBADF, errno)
|
|
})
|
|
|
|
t.Run("not dir", func(t *testing.T) {
|
|
const fileName = "dog"
|
|
fd, errno := fsc.OpenFile(dirFs, fileName, os.O_CREATE, 0o600)
|
|
require.EqualErrno(t, 0, errno)
|
|
|
|
_, errno = fsc.ReOpenDir(fd)
|
|
require.EqualErrno(t, syscall.ENOTDIR, errno)
|
|
})
|
|
}
|
|
|
|
func TestFSContext_Renumber(t *testing.T) {
|
|
tmpDir := t.TempDir()
|
|
dirFs := sysfs.NewDirFS(tmpDir)
|
|
|
|
const dirName = "dir"
|
|
errno := dirFs.Mkdir(dirName, 0o700)
|
|
require.EqualErrno(t, 0, errno)
|
|
|
|
c := Context{}
|
|
err := c.NewFSContext(nil, nil, nil, dirFs)
|
|
require.NoError(t, err)
|
|
fsc := c.fsc
|
|
|
|
defer fsc.Close()
|
|
|
|
for _, toFd := range []int32{10, 100, 100} {
|
|
fromFd, errno := fsc.OpenFile(dirFs, dirName, os.O_RDONLY, 0)
|
|
require.EqualErrno(t, 0, errno)
|
|
|
|
prevDirFile, ok := fsc.LookupFile(fromFd)
|
|
require.True(t, ok)
|
|
|
|
require.EqualErrno(t, 0, fsc.Renumber(fromFd, toFd))
|
|
|
|
renumberedDirFile, ok := fsc.LookupFile(toFd)
|
|
require.True(t, ok)
|
|
|
|
require.Equal(t, prevDirFile, renumberedDirFile)
|
|
|
|
// Previous file descriptor shouldn't be used.
|
|
_, ok = fsc.LookupFile(fromFd)
|
|
require.False(t, ok)
|
|
}
|
|
|
|
t.Run("errors", func(t *testing.T) {
|
|
// Sanity check for 3 being preopen.
|
|
preopen, ok := fsc.LookupFile(3)
|
|
require.True(t, ok)
|
|
require.True(t, preopen.IsPreopen)
|
|
|
|
// From is preopen.
|
|
require.Equal(t, syscall.ENOTSUP, fsc.Renumber(3, 100))
|
|
|
|
// From does not exist.
|
|
require.Equal(t, syscall.EBADF, fsc.Renumber(12345, 3))
|
|
|
|
// Both are preopen.
|
|
require.Equal(t, syscall.ENOTSUP, fsc.Renumber(3, 3))
|
|
})
|
|
}
|
|
|
|
func TestFSContext_ChangeOpenFlag(t *testing.T) {
|
|
tmpDir := t.TempDir()
|
|
dirFs := sysfs.NewDirFS(tmpDir)
|
|
|
|
const fileName = "dir"
|
|
require.NoError(t, os.WriteFile(path.Join(tmpDir, fileName), []byte("0123456789"), 0o600))
|
|
|
|
c := Context{}
|
|
err := c.NewFSContext(nil, nil, nil, dirFs)
|
|
require.NoError(t, err)
|
|
fsc := c.fsc
|
|
|
|
defer func() {
|
|
require.NoError(t, fsc.Close())
|
|
}()
|
|
|
|
// Without APPEND.
|
|
fd, errno := fsc.OpenFile(dirFs, fileName, os.O_RDWR, 0o600)
|
|
require.EqualErrno(t, 0, errno)
|
|
|
|
f0, ok := fsc.openedFiles.Lookup(fd)
|
|
require.True(t, ok)
|
|
require.Equal(t, f0.openFlag&syscall.O_APPEND, 0)
|
|
|
|
// Set the APPEND flag.
|
|
require.EqualErrno(t, 0, fsc.ChangeOpenFlag(fd, syscall.O_APPEND))
|
|
f1, ok := fsc.openedFiles.Lookup(fd)
|
|
require.True(t, ok)
|
|
require.Equal(t, f1.openFlag&syscall.O_APPEND, syscall.O_APPEND)
|
|
|
|
// Remove the APPEND flag.
|
|
require.EqualErrno(t, 0, fsc.ChangeOpenFlag(fd, 0))
|
|
f2, ok := fsc.openedFiles.Lookup(fd)
|
|
require.True(t, ok)
|
|
require.Equal(t, f2.openFlag&syscall.O_APPEND, 0)
|
|
}
|
|
|
|
func TestStdio(t *testing.T) {
|
|
// simulate regular file attached to stdin
|
|
f, err := os.CreateTemp(t.TempDir(), "somefile")
|
|
require.NoError(t, err)
|
|
defer f.Close()
|
|
|
|
stdin, err := stdinFile(os.Stdin)
|
|
require.NoError(t, err)
|
|
stdinStat, err := os.Stdin.Stat()
|
|
require.NoError(t, err)
|
|
|
|
stdinNil, err := stdinFile(nil)
|
|
require.NoError(t, err)
|
|
|
|
stdinFile, err := stdinFile(f)
|
|
require.NoError(t, err)
|
|
|
|
stdout, err := stdioWriterFile("stdout", os.Stdout)
|
|
require.NoError(t, err)
|
|
stdoutStat, err := os.Stdout.Stat()
|
|
require.NoError(t, err)
|
|
|
|
stdoutNil, err := stdioWriterFile("stdout", nil)
|
|
require.NoError(t, err)
|
|
|
|
stdoutFile, err := stdioWriterFile("stdout", f)
|
|
require.NoError(t, err)
|
|
|
|
stderr, err := stdioWriterFile("stderr", os.Stderr)
|
|
require.NoError(t, err)
|
|
stderrStat, err := os.Stderr.Stat()
|
|
require.NoError(t, err)
|
|
|
|
stderrNil, err := stdioWriterFile("stderr", nil)
|
|
require.NoError(t, err)
|
|
|
|
stderrFile, err := stdioWriterFile("stderr", f)
|
|
require.NoError(t, err)
|
|
|
|
tests := []struct {
|
|
name string
|
|
f *FileEntry
|
|
// Depending on how the tests run, os.Stdin won't necessarily be a char
|
|
// device. We compare against an os.File, to account for this.
|
|
expectedType fs.FileMode
|
|
}{
|
|
{
|
|
name: "stdin",
|
|
f: stdin,
|
|
expectedType: stdinStat.Mode().Type(),
|
|
},
|
|
{
|
|
name: "stdin noop",
|
|
f: stdinNil,
|
|
expectedType: fs.ModeDevice,
|
|
},
|
|
{
|
|
name: "stdin file",
|
|
f: stdinFile,
|
|
expectedType: 0, // normal file
|
|
},
|
|
{
|
|
name: "stdout",
|
|
f: stdout,
|
|
expectedType: stdoutStat.Mode().Type(),
|
|
},
|
|
{
|
|
name: "stdout noop",
|
|
f: stdoutNil,
|
|
expectedType: fs.ModeDevice,
|
|
},
|
|
{
|
|
name: "stdout file",
|
|
f: stdoutFile,
|
|
expectedType: 0, // normal file
|
|
},
|
|
{
|
|
name: "stderr",
|
|
f: stderr,
|
|
expectedType: stderrStat.Mode().Type(),
|
|
},
|
|
{
|
|
name: "stderr noop",
|
|
f: stderrNil,
|
|
expectedType: fs.ModeDevice,
|
|
},
|
|
{
|
|
name: "stderr file",
|
|
f: stderrFile,
|
|
expectedType: 0, // normal file
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
tc := tt
|
|
|
|
t.Run(tc.name+" Stat", func(t *testing.T) {
|
|
st, errno := tc.f.Stat()
|
|
require.EqualErrno(t, 0, errno)
|
|
require.Equal(t, tc.expectedType, st.Mode&fs.ModeType)
|
|
require.Equal(t, uint64(1), st.Nlink)
|
|
|
|
// Fake times are needed to pass wasi-testsuite.
|
|
// See https://github.com/WebAssembly/wasi-testsuite/blob/af57727/tests/rust/src/bin/fd_filestat_get.rs#L1-L19
|
|
require.Zero(t, st.Ctim)
|
|
require.Zero(t, st.Mtim)
|
|
require.Zero(t, st.Atim)
|
|
})
|
|
|
|
buf := make([]byte, 5)
|
|
switch tc.f {
|
|
case stdinNil:
|
|
t.Run(tc.name+" returns zero on Read", func(t *testing.T) {
|
|
n, errno := tc.f.File.Read(buf)
|
|
require.EqualErrno(t, 0, errno)
|
|
require.Zero(t, n) // like reading io.EOF
|
|
})
|
|
case stdoutNil, stderrNil:
|
|
// This is important because some code will loop forever attempting
|
|
// to write data. This happened in TestShortHash.
|
|
t.Run(tc.name+" returns length on Write", func(t *testing.T) {
|
|
n, errno := tc.f.File.Write(buf)
|
|
require.EqualErrno(t, 0, errno)
|
|
require.Equal(t, len(buf), n) // like io.Discard
|
|
})
|
|
}
|
|
}
|
|
}
|