Files
visor/runsc/container/container_test.go
Alexander CuevaandgVisor bot e11d0a7b1c Add block, goroutine, mutex, and trace subcommands to runsc profile
Implement the remaining runtime profiling subcommands for `runsc profile`:
- `goroutine`: Dumps the current stack traces of all running goroutines
in Sentry.
- `block`: Collects a goroutine blocking contention profile.
- `mutex`: Collects a mutex contention profile.
- `trace`: Collects an execution trace.

PiperOrigin-RevId: 978048587
2026-09-08 12:20:09 -07:00

6514 lines
193 KiB
Go

// Copyright 2018 The gVisor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package container
import (
"bufio"
"bytes"
"encoding/base64"
"fmt"
"io"
"math"
"math/rand"
"net"
"os"
"os/exec"
"path"
"path/filepath"
"reflect"
"runtime"
"slices"
"strconv"
"strings"
"testing"
"time"
"github.com/cenkalti/backoff"
specs "github.com/opencontainers/runtime-spec/specs-go"
"golang.org/x/sys/unix"
"gvisor.dev/gvisor/pkg/abi/linux"
"gvisor.dev/gvisor/pkg/cleanup"
"gvisor.dev/gvisor/pkg/hostos"
"gvisor.dev/gvisor/pkg/log"
"gvisor.dev/gvisor/pkg/sentry/control"
"gvisor.dev/gvisor/pkg/sentry/fsimpl/erofs"
"gvisor.dev/gvisor/pkg/sentry/kernel"
"gvisor.dev/gvisor/pkg/sentry/kernel/auth"
"gvisor.dev/gvisor/pkg/sentry/platform"
"gvisor.dev/gvisor/pkg/state/statefile"
"gvisor.dev/gvisor/pkg/sync"
"gvisor.dev/gvisor/pkg/test/testutil"
"gvisor.dev/gvisor/runsc/boot"
"gvisor.dev/gvisor/runsc/cgroup"
"gvisor.dev/gvisor/runsc/config"
"gvisor.dev/gvisor/runsc/flag"
"gvisor.dev/gvisor/runsc/sandbox"
"gvisor.dev/gvisor/runsc/specutils"
)
const pollTimeout = 90 * time.Second
func TestMain(m *testing.M) {
config.RegisterFlags(flag.CommandLine)
log.SetLevel(log.Debug)
if err := testutil.ConfigureExePath(); err != nil {
panic(err.Error())
}
if err := specutils.MaybeRunAsRoot(); err != nil {
fmt.Fprintf(os.Stderr, "Error running as root: %v", err)
os.Exit(123)
}
os.Exit(m.Run())
}
func execute(conf *config.Config, cont *Container, name string, arg ...string) (unix.WaitStatus, error) {
args := &control.ExecArgs{
Filename: name,
Argv: append([]string{name}, arg...),
}
return cont.executeSync(conf, args)
}
// executeCombinedOutput executes a process in the container and captures
// stdout and stderr. If execFile is supplied, a host file will be executed.
// Otherwise, the name argument is used to resolve the executable in the guest.
func executeCombinedOutputWithStatus(conf *config.Config, cont *Container, execFile *os.File, name string, arg ...string) ([]byte, int, error) {
r, w, err := os.Pipe()
if err != nil {
return nil, 0, err
}
defer r.Close()
// Unset the filename when we execute via FD.
if execFile != nil {
name = ""
}
args := &control.ExecArgs{
Filename: name,
Argv: append([]string{name}, arg...),
FilePayload: control.NewFilePayload(map[int]*os.File{
0: os.Stdin, 1: w, 2: w,
}, execFile),
}
ws, err := cont.executeSync(conf, args)
w.Close()
if err != nil {
return nil, 0, err
}
if !ws.Exited() {
return nil, 0, fmt.Errorf("process did not exit properly")
}
status := ws.ExitStatus()
out, err := io.ReadAll(r)
if err != nil {
return nil, status, err
}
return out, status, err
}
// executeCombinedOutput executes a process in the container and captures
// stdout and stderr. If execFile is supplied, a host file will be executed.
// Otherwise, the name argument is used to resolve the executable in the guest.
func executeCombinedOutput(conf *config.Config, cont *Container, execFile *os.File, name string, arg ...string) ([]byte, error) {
out, status, err := executeCombinedOutputWithStatus(conf, cont, execFile, name, arg...)
if status != 0 && err != nil {
err = fmt.Errorf("exec failed, status: %v, err: %v", status, err)
} else if status != 0 {
err = fmt.Errorf("exec failed, status: %v", status)
}
return out, err
}
// executeSync synchronously executes a new process.
func (c *Container) executeSync(conf *config.Config, args *control.ExecArgs) (unix.WaitStatus, error) {
pid, err := c.Execute(conf, args)
if err != nil {
return 0, fmt.Errorf("error executing: %v", err)
}
ws, err := c.WaitPID(pid)
if err != nil {
return 0, fmt.Errorf("error waiting: %v", err)
}
return ws, nil
}
// waitForProcessList waits for the given process list to show up in the container.
func waitForProcessList(cont *Container, want []*control.Process) error {
cb := func() error {
got, err := cont.Processes()
if err != nil {
err = fmt.Errorf("error getting process data from container: %w", err)
return &backoff.PermanentError{Err: err}
}
if !procListsEqual(got, want) {
return fmt.Errorf("container got process list: %s, want: %s", procListToString(got), procListToString(want))
}
return nil
}
// Gives plenty of time as tests can run slow under --race.
return testutil.Poll(cb, pollTimeout)
}
// waitForProcess waits for the given process to show up in the container.
func waitForProcess(cont *Container, want *control.Process) error {
cb := func() error {
gots, err := cont.Processes()
if err != nil {
err = fmt.Errorf("error getting process data from container: %w", err)
return &backoff.PermanentError{Err: err}
}
for _, got := range gots {
if procEqual(got, want) {
return nil
}
}
return fmt.Errorf("container got process list: %s, want: %+v", procListToString(gots), want)
}
// Gives plenty of time as tests can run slow under --race.
return testutil.Poll(cb, pollTimeout)
}
func waitForProcessCount(cont *Container, want int) error {
cb := func() error {
pss, err := cont.Processes()
if err != nil {
err = fmt.Errorf("error getting process data from container: %w", err)
return &backoff.PermanentError{Err: err}
}
if got := len(pss); got != want {
log.Infof("Waiting for process count to reach %d. Current: %d", want, got)
return fmt.Errorf("wrong process count, got: %d, want: %d", got, want)
}
return nil
}
// Gives plenty of time as tests can run slow under --race.
return testutil.Poll(cb, pollTimeout)
}
// waitForStableProcessList waits for the container to have exactly want
// processes and returns them. The same PIDs must be observed in two
// consecutive poll samples: a single sample can count a transient task in
// place of a process that has not been forked yet.
func waitForStableProcessList(cont *Container, want int) ([]*control.Process, error) {
var prev []kernel.ThreadID
var procs []*control.Process
cb := func() error {
var err error
procs, err = cont.Processes()
if err != nil {
err = fmt.Errorf("error getting process data from container: %w", err)
return &backoff.PermanentError{Err: err}
}
// Processes() returns the list sorted by PID.
pids := make([]kernel.ThreadID, 0, len(procs))
for _, p := range procs {
pids = append(pids, p.PID)
}
stable := slices.Equal(pids, prev)
prev = pids
if len(pids) != want || !stable {
return fmt.Errorf("waiting for a stable list of %d processes, got %v", want, pids)
}
return nil
}
if err := testutil.Poll(cb, pollTimeout); err != nil {
return nil, err
}
return procs, nil
}
func blockUntilWaitable(pid int) error {
_, _, err := specutils.RetryEintr(func() (uintptr, uintptr, error) {
var err error
_, _, err1 := unix.Syscall6(unix.SYS_WAITID, 1, uintptr(pid), 0, unix.WEXITED|unix.WNOWAIT, 0, 0)
if err1 != 0 {
err = err1
}
return 0, 0, err
})
return err
}
// execPS executes `ps` inside the container and return the processes.
func execPS(conf *config.Config, c *Container) ([]*control.Process, error) {
out, err := executeCombinedOutput(conf, c, nil, "/bin/ps", "-e")
if err != nil {
return nil, err
}
lines := strings.Split(string(out), "\n")
if len(lines) < 1 {
return nil, fmt.Errorf("missing header: %q", lines)
}
procs := make([]*control.Process, 0, len(lines)-1)
for _, line := range lines[1:] {
if len(line) == 0 {
continue
}
fields := strings.Fields(line)
if len(fields) != 4 {
return nil, fmt.Errorf("malformed line: %s", line)
}
pid, err := strconv.Atoi(fields[0])
if err != nil {
return nil, err
}
cmd := fields[3]
// Fill only the fields we need thus far.
procs = append(procs, &control.Process{
PID: kernel.ThreadID(pid),
Cmd: cmd,
})
}
return procs, nil
}
// procListsEqual is used to check whether 2 Process lists are equal. Fields
// set to -1 in wants are ignored. Timestamp and threads fields are always
// ignored.
func procListsEqual(gots, wants []*control.Process) bool {
if len(gots) != len(wants) {
return false
}
for i := range gots {
if !procEqual(gots[i], wants[i]) {
return false
}
}
return true
}
func procEqual(got, want *control.Process) bool {
if want.UID != math.MaxUint32 && want.UID != got.UID {
return false
}
if want.PID != -1 && want.PID != got.PID {
return false
}
if want.PPID != -1 && want.PPID != got.PPID {
return false
}
if want.PGID != -1 && want.PGID != got.PGID {
return false
}
if len(want.TTY) != 0 && want.TTY != got.TTY {
return false
}
if len(want.Cmd) != 0 && want.Cmd != got.Cmd {
return false
}
return true
}
type processBuilder struct {
process control.Process
}
func newProcessBuilder() *processBuilder {
return &processBuilder{
process: control.Process{
UID: math.MaxUint32,
PID: -1,
PPID: -1,
PGID: -1,
},
}
}
func (p *processBuilder) Cmd(cmd string) *processBuilder {
p.process.Cmd = cmd
return p
}
func (p *processBuilder) PID(pid kernel.ThreadID) *processBuilder {
p.process.PID = pid
return p
}
func (p *processBuilder) PPID(ppid kernel.ThreadID) *processBuilder {
p.process.PPID = ppid
return p
}
func (p *processBuilder) PGID(pgid kernel.ThreadID) *processBuilder {
p.process.PGID = pgid
return p
}
func (p *processBuilder) UID(uid auth.KUID) *processBuilder {
p.process.UID = uid
return p
}
func (p *processBuilder) Process() *control.Process {
return &p.process
}
func procListToString(pl []*control.Process) string {
strs := make([]string, 0, len(pl))
for _, p := range pl {
strs = append(strs, fmt.Sprintf("%+v", p))
}
return fmt.Sprintf("[%s]", strings.Join(strs, ","))
}
// createWriteableOutputFile creates an output file that can be read and
// written to in the sandbox.
func createWriteableOutputFile(path string) (*os.File, error) {
outputFile, err := os.OpenFile(path, os.O_CREATE|os.O_EXCL|os.O_RDWR, 0666)
if err != nil {
return nil, fmt.Errorf("error creating file: %q, %v", path, err)
}
// Chmod to allow writing after umask.
if err := outputFile.Chmod(0666); err != nil {
return nil, fmt.Errorf("error chmoding file: %q, %v", path, err)
}
return outputFile, nil
}
func waitForFileNotEmpty(f *os.File) error {
op := func() error {
fi, err := f.Stat()
if err != nil {
return err
}
if fi.Size() == 0 {
return fmt.Errorf("file %q is empty", f.Name())
}
return nil
}
return testutil.Poll(op, 30*time.Second)
}
func waitForFileExist(path string) error {
op := func() error {
if _, err := os.Stat(path); os.IsNotExist(err) {
return err
}
return nil
}
return testutil.Poll(op, 30*time.Second)
}
// readOutputNum reads a file at given filepath and returns the int at the
// requested position.
func readOutputNum(file string, position int) (int, error) {
f, err := os.Open(file)
if err != nil {
return 0, fmt.Errorf("error opening file: %q, %v", file, err)
}
// Ensure that there is content in output file.
if err := waitForFileNotEmpty(f); err != nil {
return 0, fmt.Errorf("error waiting for output file: %v", err)
}
b, err := io.ReadAll(f)
if err != nil {
return 0, fmt.Errorf("error reading file: %v", err)
}
if len(b) == 0 {
return 0, fmt.Errorf("error no content was read")
}
// Strip leading null bytes caused by file offset not being 0 upon restore.
b = bytes.Trim(b, "\x00")
nums := strings.Split(string(b), "\n")
if position >= len(nums) {
return 0, fmt.Errorf("position %v is not within the length of content %v", position, nums)
}
if position == -1 {
// Expectation of newline at the end of last position.
position = len(nums) - 2
}
num, err := strconv.Atoi(nums[position])
if err != nil {
return 0, fmt.Errorf("error getting number from file: %v", err)
}
return num, nil
}
// run starts the sandbox and waits for it to exit, checking that the
// application succeeded.
func run(spec *specs.Spec, conf *config.Config) error {
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
return fmt.Errorf("error setting up container: %v", err)
}
defer cleanup()
// Create, start and wait for the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
Attached: true,
}
ws, err := Run(conf, args)
if err != nil {
return fmt.Errorf("running container: %v", err)
}
if !ws.Exited() || ws.ExitStatus() != 0 {
return fmt.Errorf("container failed, waitStatus: %v", ws)
}
return nil
}
// platforms must be provided by the BUILD rule, or all platforms are included.
var platforms = flag.String("test_platforms", os.Getenv("TEST_PLATFORMS"), "Platforms to test with.")
// configs generates different configurations to run tests.
func configs(t *testing.T, noOverlay bool) map[string]*config.Config {
var ps []string
if *platforms == "" {
ps = platform.List()
} else {
ps = strings.Split(*platforms, ",")
}
// ptrace is replaced by systrap and being deprecated. No need to run it.
ps = slices.DeleteFunc(ps, func(s string) bool { return s == "ptrace" })
// Non-overlay versions.
cs := make(map[string]*config.Config)
for _, p := range ps {
c := testutil.TestConfig(t)
c.Overlay2.Set("none")
c.Platform = p
cs[p] = c
}
// Overlay versions.
if !noOverlay {
for _, p := range ps {
c := testutil.TestConfig(t)
c.Platform = p
c.Overlay2.Set("all:memory")
cs[p+"-overlay"] = c
}
}
return cs
}
// sleepSpec generates a spec with sleep 1000 and a conf.
func sleepSpecConf(t *testing.T) (*specs.Spec, *config.Config) {
return testutil.NewSpecWithArgs("sleep", "1000"), testutil.TestConfig(t)
}
func TestPostStartHookFailure(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
spec, _ := sleepSpecConf(t)
spec.Hooks = &specs.Hooks{
Poststart: []specs.Hook{{
Path: "/bin/sh",
Args: []string{"/bin/sh", "-c", "exit 1"},
}},
}
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer func() {
if c != nil {
_ = c.Destroy()
}
}()
if err := c.Start(conf); err == nil {
t.Fatal("container start succeeded with a failing poststart hook")
}
})
}
}
func TestGetNetworkConfig(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
spec, _ := sleepSpecConf(t)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
networkArgs, err := c.GetNetworkConfig()
if err != nil {
t.Fatalf("error calling GetNetworkConfig: %v", err)
}
if len(networkArgs.LoopbackLinks) == 0 {
t.Error("network config loopback links is empty, want not empty")
}
})
}
}
// TestLifecycle tests the basic Create/Start/Signal/Destroy container lifecycle.
// It verifies after each step that the container can be loaded from disk, and
// has the correct status.
func TestLifecycle(t *testing.T) {
// Start the child reaper.
childReaper := &testutil.Reaper{}
childReaper.Start()
defer childReaper.Stop()
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
// The container will just sleep for a long time. We will kill it before
// it finishes sleeping.
spec, _ := sleepSpecConf(t)
rootDir, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// expectedPL lists the expected process state of the container.
expectedPL := []*control.Process{
newProcessBuilder().Cmd("sleep").Process(),
}
// Create the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
// Load the container from disk and check the status.
c, err = Load(rootDir, FullID{ContainerID: args.ID}, LoadOpts{})
if err != nil {
t.Fatalf("error loading container: %v", err)
}
if got, want := c.Status, Created; got != want {
t.Errorf("container status got %v, want %v", got, want)
}
// List should return the container id.
ids, err := List(rootDir)
if err != nil {
t.Fatalf("error listing containers: %v", err)
}
fullID := FullID{
SandboxID: args.ID,
ContainerID: args.ID,
}
if got, want := ids, []FullID{fullID}; !slices.Equal(got, want) {
t.Errorf("container list got %v, want %v", got, want)
}
// Start the container.
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Load the container from disk and check the status.
c, err = Load(rootDir, fullID, LoadOpts{Exact: true})
if err != nil {
t.Fatalf("error loading container: %v", err)
}
if got, want := c.Status, Running; got != want {
t.Errorf("container status got %v, want %v", got, want)
}
// Verify that "sleep 100" is running.
if err := waitForProcessList(c, expectedPL); err != nil {
t.Error(err)
}
// Wait on the container.
ch := make(chan error)
go func() {
ws, err := c.Wait()
if err != nil {
ch <- err
return
}
if got, want := ws.Signal(), unix.SIGTERM; got != want {
ch <- fmt.Errorf("got signal %v, want %v", got, want)
return
}
ch <- nil
}()
// Wait a bit to ensure that we've started waiting on
// the container before we signal.
time.Sleep(time.Second)
// Send the container a SIGTERM which will cause it to stop.
if err := c.SignalContainer(unix.SIGTERM, false); err != nil {
t.Fatalf("error sending signal %v to container: %v", unix.SIGTERM, err)
}
// Wait for it to die.
if err := <-ch; err != nil {
t.Fatalf("error waiting for container: %v", err)
}
// Load the container from disk and check the status.
if err := testutil.Poll(func() error {
var err error
c, err = Load(rootDir, fullID, LoadOpts{Exact: true})
if err != nil {
return err
}
if got, want := c.Status, Stopped; got != want {
return fmt.Errorf("container status got %v, want %v", got, want)
}
return nil
}, pollTimeout); err != nil {
t.Fatalf("container status check failed: %v", err)
}
// Destroy the container.
if err := c.Destroy(); err != nil {
t.Fatalf("error destroying container: %v", err)
}
// List should not return the container id.
ids, err = List(rootDir)
if err != nil {
t.Fatalf("error listing containers: %v", err)
}
if len(ids) != 0 {
t.Errorf("expected container list to be empty, but got %v", ids)
}
// Loading the container by id should fail.
if _, err = Load(rootDir, fullID, LoadOpts{Exact: true}); err == nil {
t.Errorf("expected loading destroyed container to fail, but it did not")
}
})
}
}
// Test the we can execute the application with different path formats.
func TestExePath(t *testing.T) {
// Create two directories that will be prepended to PATH.
firstPath, err := os.MkdirTemp(testutil.TmpDir(), "first")
if err != nil {
t.Fatalf("error creating temporary directory: %v", err)
}
defer os.RemoveAll(firstPath)
secondPath, err := os.MkdirTemp(testutil.TmpDir(), "second")
if err != nil {
t.Fatalf("error creating temporary directory: %v", err)
}
defer os.RemoveAll(secondPath)
// Create two minimal executables in the second path, two of which
// will be masked by files in first path.
for _, p := range []string{"unmasked", "masked1", "masked2"} {
path := filepath.Join(secondPath, p)
f, err := os.OpenFile(path, os.O_CREATE|os.O_EXCL|os.O_RDWR, 0777)
if err != nil {
t.Fatalf("error opening path: %v", err)
}
defer f.Close()
if _, err := io.WriteString(f, "#!/bin/true\n"); err != nil {
t.Fatalf("error writing contents: %v", err)
}
}
// Create a non-executable file in the first path which masks a healthy
// executable in the second.
nonExecutable := filepath.Join(firstPath, "masked1")
f2, err := os.OpenFile(nonExecutable, os.O_CREATE|os.O_EXCL, 0666)
if err != nil {
t.Fatalf("error opening file: %v", err)
}
f2.Close()
// Create a non-regular file in the first path which masks a healthy
// executable in the second.
nonRegular := filepath.Join(firstPath, "masked2")
if err := os.Mkdir(nonRegular, 0777); err != nil {
t.Fatalf("error making directory: %v", err)
}
defaultConf := testutil.TestConfig(t)
defaultConf.Overlay2.Set("none")
overlayConf := testutil.TestConfig(t)
overlayConf.Overlay2.Set("all:memory")
configs := map[string]*config.Config{
"default": defaultConf,
"overlay": overlayConf,
}
for name, conf := range configs {
t.Run(name, func(t *testing.T) {
for _, test := range []struct {
path string
success bool
}{
{path: "true", success: true},
{path: "bin/true", success: true},
{path: "/bin/true", success: true},
{path: "thisfiledoesntexit", success: false},
{path: "bin/thisfiledoesntexit", success: false},
{path: "/bin/thisfiledoesntexit", success: false},
{path: "unmasked", success: true},
{path: filepath.Join(firstPath, "unmasked"), success: false},
{path: filepath.Join(secondPath, "unmasked"), success: true},
{path: "masked1", success: true},
{path: filepath.Join(firstPath, "masked1"), success: false},
{path: filepath.Join(secondPath, "masked1"), success: true},
{path: "masked2", success: true},
{path: filepath.Join(firstPath, "masked2"), success: false},
{path: filepath.Join(secondPath, "masked2"), success: true},
} {
name := fmt.Sprintf("path=%s,success=%t", test.path, test.success)
t.Run(name, func(t *testing.T) {
spec := testutil.NewSpecWithArgs(test.path)
spec.Process.Env = []string{
fmt.Sprintf("PATH=%s:%s:%s", firstPath, secondPath, os.Getenv("PATH")),
}
err := run(spec, conf)
if test.success {
if err != nil {
t.Errorf("exec: error running container: %v", err)
}
} else if err == nil {
t.Errorf("exec: got: no error, want: error")
}
})
}
})
}
}
// Test the we can retrieve the application exit status from the container.
func TestAppExitStatus(t *testing.T) {
// First container will succeed.
succSpec := testutil.NewSpecWithArgs("true")
conf := testutil.TestConfig(t)
_, bundleDir, cleanup, err := testutil.SetupContainer(succSpec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: succSpec,
BundleDir: bundleDir,
Attached: true,
}
ws, err := Run(conf, args)
if err != nil {
t.Fatalf("error running container: %v", err)
}
if ws.ExitStatus() != 0 {
t.Errorf("got exit status %v want %v", ws.ExitStatus(), 0)
}
// Second container exits with non-zero status.
wantStatus := 123
errSpec := testutil.NewSpecWithArgs("bash", "-c", fmt.Sprintf("exit %d", wantStatus))
_, bundleDir2, cleanup2, err := testutil.SetupContainer(errSpec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup2()
args2 := Args{
ID: testutil.RandomContainerID(),
Spec: errSpec,
BundleDir: bundleDir2,
Attached: true,
}
ws, err = Run(conf, args2)
if err != nil {
t.Fatalf("error running container: %v", err)
}
if ws.ExitStatus() != wantStatus {
t.Errorf("got exit status %v want %v", ws.ExitStatus(), wantStatus)
}
}
// TestExec verifies that a container can exec a new program.
func TestExec(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
dir, err := os.MkdirTemp(testutil.TmpDir(), "exec-test")
if err != nil {
t.Fatalf("error creating temporary directory: %v", err)
}
// Note that some shells may exec the final command in a sequence as
// an optimization. We avoid this here by adding the exit 0.
cmd := fmt.Sprintf("ln -s /bin/true %q/symlink && sleep 100 && exit 0", dir)
spec := testutil.NewSpecWithArgs("sh", "-c", cmd)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Wait until sleep is running to ensure the symlink was created.
expectedPL := []*control.Process{
newProcessBuilder().Cmd("sh").Process(),
newProcessBuilder().Cmd("sleep").Process(),
}
if err := waitForProcessList(cont, expectedPL); err != nil {
t.Fatalf("waitForProcessList: %v", err)
}
for _, tc := range []struct {
name string
args control.ExecArgs
}{
{
name: "complete",
args: control.ExecArgs{
Filename: "/bin/true",
Argv: []string{"/bin/true"},
},
},
{
name: "filename",
args: control.ExecArgs{
Filename: "/bin/true",
},
},
{
name: "argv",
args: control.ExecArgs{
Argv: []string{"/bin/true"},
},
},
{
name: "filename resolution",
args: control.ExecArgs{
Filename: "true",
Envv: []string{"PATH=/bin"},
},
},
{
name: "argv resolution",
args: control.ExecArgs{
Argv: []string{"true"},
Envv: []string{"PATH=/bin"},
},
},
{
name: "argv symlink",
args: control.ExecArgs{
Argv: []string{filepath.Join(dir, "symlink")},
},
},
{
name: "working dir",
args: control.ExecArgs{
Argv: []string{"/bin/sh", "-c", `if [[ "${PWD}" != "/tmp" ]]; then exit 1; fi`},
WorkingDirectory: "/tmp",
},
},
{
name: "user",
args: control.ExecArgs{
Argv: []string{"/bin/sh", "-c", `if [[ "$(id -u)" != "343" ]]; then exit 1; fi`},
KUID: 343,
},
},
{
name: "group",
args: control.ExecArgs{
Argv: []string{"/bin/sh", "-c", `if [[ "$(id -g)" != "343" ]]; then exit 1; fi`},
KGID: 343,
},
},
{
name: "env",
args: control.ExecArgs{
Argv: []string{"/bin/sh", "-c", `if [[ "${FOO}" != "123" ]]; then exit 1; fi`},
Envv: []string{"FOO=123"},
},
},
} {
t.Run(tc.name, func(t *testing.T) {
// t.Parallel()
if ws, err := cont.executeSync(conf, &tc.args); err != nil {
t.Fatalf("executeAsync(%+v): %v", tc.args, err)
} else if ws != 0 {
t.Fatalf("executeAsync(%+v) failed with exit: %v", tc.args, ws)
}
})
}
// Test for exec failure with an non-existent file.
t.Run("nonexist", func(t *testing.T) {
// b/179114837 found by Syzkaller that causes nil pointer panic when
// trying to dec-ref an unix socket FD.
fds, err := unix.Socketpair(unix.AF_UNIX, unix.SOCK_STREAM, 0)
if err != nil {
t.Fatal(err)
}
defer unix.Close(fds[0])
_, err = cont.executeSync(conf, &control.ExecArgs{
Argv: []string{"/nonexist"},
FilePayload: control.NewFilePayload(map[int]*os.File{
0: os.NewFile(uintptr(fds[1]), "sock"),
}, nil),
})
want := "failed to load /nonexist"
if err == nil || !strings.Contains(err.Error(), want) {
t.Errorf("executeSync: want err containing %q; got err = %q", want, err)
}
})
})
}
}
// TestExecProcList verifies that a container can exec a new program and it
// shows correctly in the process list.
func TestExecProcList(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
const uid = 343
spec, _ := sleepSpecConf(t)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
execArgs := &control.ExecArgs{
Filename: "/bin/sleep",
Argv: []string{"/bin/sleep", "5"},
WorkingDirectory: "/",
KUID: uid,
}
// Verify that "sleep 1000" and "sleep 5" are running after exec. First,
// start running exec asynchronously.
pid2, err := cont.Execute(conf, execArgs)
if err != nil {
t.Fatalf("error executing 'sleep 5' command: %v", err)
}
// expectedPL lists the expected process state of the container.
expectedPL := []*control.Process{
newProcessBuilder().PID(1).PPID(0).Cmd("sleep").UID(0).Process(),
newProcessBuilder().PID(kernel.ThreadID(pid2)).PPID(0).Cmd("sleep").UID(uid).Process(),
}
if err := waitForProcessList(cont, expectedPL); err != nil {
t.Fatalf("error waiting for processes: %v", err)
}
})
}
}
// TestKillPid verifies that we can signal individual exec'd processes.
func TestKillPid(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
app, err := testutil.FindFile("test/cmd/test_app/test_app")
if err != nil {
t.Fatal("error finding test_app:", err)
}
const nProcs = 4
spec := testutil.NewSpecWithArgs(app, "task-tree", "--depth", strconv.Itoa(nProcs-1), "--width=1", "--pause=true")
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Verify that all processes are running. The PID list must be
// stable across poll samples so that transient tasks are not
// miscounted as members of the task tree.
procs, err := waitForStableProcessList(cont, nProcs)
if err != nil {
t.Fatalf("timed out waiting for processes to start: %v", err)
}
t.Logf("current process list:\n%v", control.ProcessListToTable(procs))
// Kill the child process with the largest PID. Processes are
// created in a chain, so this is the deepest child.
var pid int32
for _, p := range procs {
if pid < int32(p.PID) {
pid = int32(p.PID)
}
}
if err := cont.SignalProcess(unix.SIGKILL, pid); err != nil {
t.Fatalf("failed to signal process %d: %v", pid, err)
}
// Verify that the killed process is gone. It stays visible as a
// zombie until its parent reaps it, so poll.
if err := testutil.Poll(func() error {
procs, err := cont.Processes()
if err != nil {
err = fmt.Errorf("error getting process data from container: %w", err)
return &backoff.PermanentError{Err: err}
}
if got, want := len(procs), nProcs-1; got != want {
return fmt.Errorf("wrong process count, got: %d, want: %d", got, want)
}
for _, p := range procs {
if pid == int32(p.PID) {
return fmt.Errorf("pid %d is still alive, but should have been killed", pid)
}
}
return nil
}, pollTimeout); err != nil {
procs, procsErr := cont.Processes()
t.Fatalf("error waiting for process %d to be killed: %v; current processes (err: %v):\n%v", pid, err, procsErr, control.ProcessListToTable(procs))
}
})
}
}
// TestSignalProcessGroup verifies that SignalProcessGroup kills all
// processes in the targeted process group while leaving other groups
// running.
func TestSignalProcessGroup(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
app, err := testutil.FindFile("test/cmd/test_app/test_app")
if err != nil {
t.Fatal("error finding test_app:", err)
}
spec := testutil.NewSpecWithArgs(app, "task-tree-pgid")
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Wait for all 3 processes: init, child, grandchild. The PID
// list must be stable across poll samples so that transient
// tasks are not miscounted as members of the task tree: a
// transient task forked by the child even shares its PGID, which
// would make the group signal below miss the grandchild.
procs, err := waitForStableProcessList(cont, 3)
if err != nil {
t.Fatalf("timed out waiting for processes: %v", err)
}
t.Logf("before signal: %s", procListToString(procs))
// Init (PID 1) is in PGID 1.
// Child + grandchild should share a PGID != 1.
pgidA := int32(1)
pgidBCount := make(map[int32]int)
for _, p := range procs {
if int32(p.PGID) != pgidA {
pgidBCount[int32(p.PGID)]++
}
}
// Find the PGID shared by child+grandchild.
var pgidB int32
for pgid, n := range pgidBCount {
if n == 2 {
pgidB = pgid
}
}
if pgidB == 0 {
t.Fatalf("expected child and grandchild to share a PGID distinct from init (%d); got: %v", pgidA, pgidBCount)
}
t.Logf("PGID_init=%d, PGID_target=%d (%d processes)", pgidA, pgidB, pgidBCount[pgidB])
// Signal the target PGID (both child and grandchild should die, init survives).
if err := cont.SignalProcessGroup(unix.SIGKILL, pgidB); err != nil {
t.Fatalf("SignalProcessGroup(%d): %v", pgidB, err)
}
if err := waitForProcessCount(cont, 1); err != nil {
procs, procsErr := cont.Processes()
t.Fatalf("expected only init to survive: %v; processes: %s / %v", err, procListToString(procs), procsErr)
}
procs, err = cont.Processes()
if err != nil {
t.Fatalf("failed to get process list: %v", err)
}
if len(procs) != 1 || procs[0].PID != 1 {
t.Fatalf("expected only PID 1 to survive, got: %s", procListToString(procs))
}
})
}
}
// testCheckpointRestore creates a container that continuously writes successive
// integers to a file. To test checkpoint and restore functionality, the
// container is checkpointed and the last number printed to the file is
// recorded. Then, it is restored in two new containers and the first number
// printed from these containers is checked. Both should be the next consecutive
// number after the last number from the checkpointed container.
func testCheckpointRestore(t *testing.T, conf *config.Config, compression statefile.CompressionLevel, newSpecWithScript func(string) *specs.Spec) {
dir, err := os.MkdirTemp(testutil.TmpDir(), "checkpoint-test")
if err != nil {
t.Fatalf("os.MkdirTemp failed: %v", err)
}
defer os.RemoveAll(dir)
if err := os.Chmod(dir, 0777); err != nil {
t.Fatalf("error chmoding file: %q, %v", dir, err)
}
outputPath := filepath.Join(dir, "output")
outputFile, err := createWriteableOutputFile(outputPath)
if err != nil {
t.Fatalf("error creating output file: %v", err)
}
defer outputFile.Close()
script := fmt.Sprintf("i=0; while true; do echo $i >> %q; sleep 1; i=$((i+1)); done", outputPath)
spec := newSpecWithScript(script)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Wait until application has ran.
if err := waitForFileNotEmpty(outputFile); err != nil {
t.Fatalf("Failed to wait for output file: %v", err)
}
// Checkpoint running container; save state into new file.
if err := cont.Checkpoint(conf, dir, sandbox.CheckpointOpts{Compression: compression}); err != nil {
t.Fatalf("error checkpointing container to empty file: %v", err)
}
lastNum, err := readOutputNum(outputPath, -1)
if err != nil {
t.Fatalf("error with outputFile: %v", err)
}
// Delete and recreate file before restoring.
if err := os.Remove(outputPath); err != nil {
t.Fatalf("error removing file")
}
outputFile2, err := createWriteableOutputFile(outputPath)
if err != nil {
t.Fatalf("error creating output file: %v", err)
}
defer outputFile2.Close()
// Restore into a new container with different ID (e.g. clone). Keep the
// initial container running to ensure no conflict with it.
args2 := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont2, err := New(conf, args2)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont2.Destroy()
if err := cont2.Restore(conf, dir, false /* direct */, false /* background */, nil /* networkArgs */); err != nil {
t.Fatalf("error restoring container: %v", err)
}
if !cont2.Sandbox.Restored {
t.Fatalf("sandbox returned wrong value for Sandbox.Restored, got: false, want: true")
}
if cont2.Sandbox.Checkpointed {
t.Fatalf("sandbox returned wrong value for Sandbox.Checkpointed, got: true, want: false")
}
// Wait until application has ran.
if err := waitForFileNotEmpty(outputFile2); err != nil {
t.Fatalf("Failed to wait for output file: %v", err)
}
firstNum, err := readOutputNum(outputPath, 0)
if err != nil {
t.Fatalf("error with outputFile: %v", err)
}
// Check that lastNum is one less than firstNum and that the container
// picks up from where it left off.
if lastNum+1 != firstNum {
t.Errorf("error numbers not in order, previous: %d, next: %d", lastNum, firstNum)
}
cont2.Destroy()
cont2 = nil
// Restore into a container using the same ID (e.g. save/resume). It requires
// the original container to cease to exist because they share the same identity.
cont.Destroy()
cont = nil
// Delete and recreate file before restoring.
if err := os.Remove(outputPath); err != nil {
t.Fatalf("error removing file")
}
outputFile3, err := createWriteableOutputFile(outputPath)
if err != nil {
t.Fatalf("error creating output file: %v", err)
}
defer outputFile3.Close()
cont3, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont3.Destroy()
if err := cont3.Restore(conf, dir, false /* direct */, false /* background */, nil /* networkArgs */); err != nil {
t.Fatalf("error restoring container: %v", err)
}
// Wait until application has ran.
if err := waitForFileNotEmpty(outputFile3); err != nil {
t.Fatalf("Failed to wait for output file: %v", err)
}
firstNum2, err := readOutputNum(outputPath, 0)
if err != nil {
t.Fatalf("error with outputFile: %v", err)
}
// Check that lastNum is one less than firstNum and that the container
// picks up from where it left off.
if lastNum+1 != firstNum2 {
t.Errorf("error numbers not in order, previous: %d, next: %d", lastNum, firstNum2)
}
cont3.Destroy()
}
// TestCheckpointRestore does the checkpoint/restore test on each platform.
func TestCheckpointRestore(t *testing.T) {
// Skip overlay because test requires writing to host file.
for name, conf := range configs(t, true /* noOverlay */) {
t.Run(name, func(t *testing.T) {
compressionLevels := []statefile.CompressionLevel{
statefile.CompressionLevelNone,
statefile.CompressionLevelFlateBestSpeed,
}
for _, compression := range compressionLevels {
t.Run(string(compression), func(t *testing.T) {
testCheckpointRestore(t, conf, compression, func(script string) *specs.Spec {
return testutil.NewSpecWithArgs("bash", "-c", script)
})
})
}
})
}
}
// TestCheckpointRestoreHostname verifies that hostname is updated on restore
// if it was not changed inside the container, and is NOT updated if it was changed.
func TestCheckpointRestoreHostname(t *testing.T) {
for _, changed := range []bool{false, true} {
t.Run(fmt.Sprintf("changed_%t", changed), func(t *testing.T) {
spec, conf := sleepSpecConf(t)
spec.Hostname = "old-host"
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Verify initial hostname.
out, err := executeCombinedOutput(conf, cont, nil, "/bin/sh", "-c", "read -r name < /proc/sys/kernel/hostname && echo $name")
if err != nil {
t.Fatalf("exec failed: %v", err)
}
if got, want := strings.TrimSpace(string(out)), "old-host"; got != want {
t.Fatalf("hostname got %q, want %q", got, want)
}
if changed {
// Change hostname inside container.
_, err = executeCombinedOutput(conf, cont, nil, "/bin/sh", "-c", "echo user-host > /proc/sys/kernel/hostname")
if err != nil {
t.Logf("Failed to write to /proc/sys/kernel/hostname: %v, trying hostname command", err)
_, err = executeCombinedOutput(conf, cont, nil, "/bin/sh", "-c", "hostname user-host")
if err != nil {
t.Fatalf("Failed to change hostname: %v", err)
}
}
// Verify it changed.
out, err = executeCombinedOutput(conf, cont, nil, "/bin/sh", "-c", "read -r name < /proc/sys/kernel/hostname && echo $name")
if err != nil {
t.Fatalf("exec failed: %v", err)
}
if got, want := strings.TrimSpace(string(out)), "user-host"; got != want {
t.Fatalf("hostname got %q, want %q", got, want)
}
}
// Checkpoint.
dir, err := os.MkdirTemp(testutil.TmpDir(), "checkpoint-test")
if err != nil {
t.Fatalf("os.MkdirTemp failed: %v", err)
}
defer os.RemoveAll(dir)
if err := cont.Checkpoint(conf, dir, sandbox.CheckpointOpts{}); err != nil {
t.Fatalf("error checkpointing: %v", err)
}
cont.Destroy()
// Restore with new spec.
spec2, _ := sleepSpecConf(t)
spec2.Hostname = "new-host"
_, bundleDir2, cleanup2, err := testutil.SetupContainer(spec2, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup2()
args2 := Args{
ID: args.ID,
Spec: spec2,
BundleDir: bundleDir2,
}
cont2, err := New(conf, args2)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont2.Destroy()
if err := cont2.Restore(conf, dir, false, false, nil); err != nil {
t.Fatalf("error restoring: %v", err)
}
// Verify hostname.
out, err = executeCombinedOutput(conf, cont2, nil, "/bin/sh", "-c", "read -r name < /proc/sys/kernel/hostname && echo $name")
if err != nil {
t.Fatalf("exec failed: %v", err)
}
want := "new-host"
if changed {
want = "user-host"
}
if got, want := strings.TrimSpace(string(out)), want; got != want {
t.Fatalf("hostname got %q, want %q", got, want)
}
})
}
}
// TestCheckpointRestoreHostinet does the checkpoint/restore test with host
// networking.
func TestCheckpointRestoreHostinet(t *testing.T) {
app, err := testutil.FindFile("test/cmd/test_app/test_app")
if err != nil {
t.Fatal("error finding test_app:", err)
}
// Skip overlay because the test app writes its log to a bind-mounted
// host file.
for name, conf := range configs(t, true /* noOverlay */) {
conf.Network = config.NetworkHost
t.Run(name, func(t *testing.T) {
testCheckpointRestoreHostinet(t, conf, app)
})
}
}
// TestCheckpointResumeHostinet does the checkpoint --leave-running test with
// host networking.
func TestCheckpointResumeHostinet(t *testing.T) {
app, err := testutil.FindFile("test/cmd/test_app/test_app")
if err != nil {
t.Fatal("error finding test_app:", err)
}
// Skip overlay because the test app writes its log to a bind-mounted
// host file.
for name, conf := range configs(t, true /* noOverlay */) {
conf.Network = config.NetworkHost
t.Run(name, func(t *testing.T) {
testCheckpointResumeHostinet(t, conf, app)
})
}
}
// testCheckpointRestoreHostinet checkpoints a hostinet container and checks
// that connected sockets return ECONNABORTED after restore while the restored
// listener keeps accepting.
func testCheckpointRestoreHostinet(t *testing.T, conf *config.Config, app string) {
dir, err := os.MkdirTemp(testutil.TmpDir(), "checkpoint-test")
if err != nil {
t.Fatalf("os.MkdirTemp failed: %v", err)
}
defer os.RemoveAll(dir)
if err := os.Chmod(dir, 0777); err != nil {
t.Fatalf("error chmoding file: %q, %v", dir, err)
}
target, connClosed, stopServer := startHostinetSRServer(t)
defer stopServer()
logPath := filepath.Join(dir, "hostinet-sr.log")
spec := testutil.NewSpecWithArgs(app, "hostinet-sr", "--file", logPath, "--target", target)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
if err := waitForHostinetSRLog(logPath, "SETUP_DONE", "TCP_WRITE OK", "UDP_WRITE OK", "EPOLL_WAIT TIMEOUT"); err != nil {
t.Fatalf("wait for setup: %v", err)
}
lastCount, err := lastHostinetSRCount(logPath)
if err != nil {
t.Fatalf("lastHostinetSRCount pre-restore: %v", err)
}
select {
case <-connClosed:
t.Fatalf("server connection closed before checkpoint")
default:
}
if err := cont.Checkpoint(conf, dir, sandbox.CheckpointOpts{Compression: statefile.CompressionLevelFlateBestSpeed}); err != nil {
t.Fatalf("error checkpointing container: %v", err)
}
// The remote peer must observe the connection closing when the
// checkpointed sandbox exits.
select {
case <-connClosed:
case <-time.After(30 * time.Second):
t.Fatalf("remote peer did not observe connection close after checkpoint")
}
args2 := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont2, err := New(conf, args2)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont2.Destroy()
if err := cont2.Restore(conf, dir, false /* direct */, false /* background */, nil /* networkArgs */); err != nil {
t.Fatalf("error restoring container: %v", err)
}
if !cont2.Sandbox.Restored {
t.Fatalf("sandbox returned wrong value for Sandbox.Restored, got: false, want: true")
}
if err := waitForHostinetSRLog(logPath,
"TCP_WRITE ERRNO=32",
"TCP_READ ERRNO=104",
"UDP_WRITE ERRNO=104",
"UDP_READ ERRNO=104",
"EPOLL_EVENT_ERR",
"EPOLL_EVENT_HUP",
"SO_ERROR=104",
"NEW_TCP_WRITE OK"); err != nil {
t.Fatalf("wait for post-restore socket state: %v", err)
}
if err := waitForHostinetSRCountAfter(logPath, lastCount); err != nil {
t.Fatalf("wait for post-restore progress: %v", err)
}
// Dialing the re-created listener must wake the blocked accept.
listenerAddr, err := hostinetSRListenerAddr(logPath)
if err != nil {
t.Fatalf("hostinetSRListenerAddr: %v", err)
}
acceptConn, err := net.Dial("tcp", listenerAddr)
if err != nil {
t.Fatalf("dialing restored listener %q: %v", listenerAddr, err)
}
defer acceptConn.Close()
if err := waitForHostinetSRLog(logPath, "BLOCKING_ACCEPT OK"); err != nil {
t.Fatalf("wait for restored listener accept: %v", err)
}
}
// testCheckpointResumeHostinet checks that checkpoint with Resume leaves the
// container's sockets working.
func testCheckpointResumeHostinet(t *testing.T, conf *config.Config, app string) {
dir, err := os.MkdirTemp(testutil.TmpDir(), "checkpoint-test")
if err != nil {
t.Fatalf("os.MkdirTemp failed: %v", err)
}
defer os.RemoveAll(dir)
if err := os.Chmod(dir, 0777); err != nil {
t.Fatalf("error chmoding file: %q, %v", dir, err)
}
target, connClosed, stopServer := startHostinetSRServer(t)
defer stopServer()
logPath := filepath.Join(dir, "hostinet-sr.log")
spec := testutil.NewSpecWithArgs(app, "hostinet-sr", "--file", logPath, "--target", target)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
if err := waitForHostinetSRLog(logPath, "SETUP_DONE", "TCP_WRITE OK", "UDP_WRITE OK", "EPOLL_WAIT TIMEOUT"); err != nil {
t.Fatalf("wait for setup: %v", err)
}
lastCount, err := lastHostinetSRCount(logPath)
if err != nil {
t.Fatalf("lastHostinetSRCount pre-checkpoint: %v", err)
}
if err := cont.Checkpoint(conf, dir, sandbox.CheckpointOpts{
Compression: statefile.CompressionLevelFlateBestSpeed,
Resume: true,
}); err != nil {
t.Fatalf("error checkpointing container: %v", err)
}
// Wait for a few more iterations and check that no socket died. Idle
// nonblocking reads log EAGAIN, so check specifically for EBADF and
// ECONNABORTED.
if err := waitForHostinetSRCountAfter(logPath, lastCount+2); err != nil {
t.Fatalf("wait for resumed progress: %v", err)
}
b, err := os.ReadFile(logPath)
if err != nil {
t.Fatalf("error reading log file: %v", err)
}
if strings.Contains(string(b), "ERRNO=9\n") {
t.Errorf("socket returned EBADF after checkpoint --leave-running:\n%s", b)
}
if strings.Contains(string(b), "ERRNO=103\n") {
t.Errorf("socket returned ECONNABORTED after checkpoint --leave-running:\n%s", b)
}
select {
case <-connClosed:
t.Errorf("server connection closed after checkpoint --leave-running")
default:
}
}
// TestCheckpointHostinetRestoreNetworkMismatch checks that a checkpoint taken
// with host networking cannot be restored with sandbox networking.
func TestCheckpointHostinetRestoreNetworkMismatch(t *testing.T) {
dir, err := os.MkdirTemp(testutil.TmpDir(), "checkpoint-test")
if err != nil {
t.Fatalf("os.MkdirTemp failed: %v", err)
}
defer os.RemoveAll(dir)
if err := os.Chmod(dir, 0777); err != nil {
t.Fatalf("error chmoding file: %q, %v", dir, err)
}
conf := testutil.TestConfig(t)
conf.Network = config.NetworkHost
spec := testutil.NewSpecWithArgs("sleep", "1000")
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
if err := cont.Checkpoint(conf, dir, sandbox.CheckpointOpts{Compression: statefile.CompressionLevelFlateBestSpeed}); err != nil {
t.Fatalf("error checkpointing container: %v", err)
}
restoreConf := *conf
restoreConf.Network = config.NetworkSandbox
args2 := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont2, err := New(&restoreConf, args2)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont2.Destroy()
err = cont2.Restore(&restoreConf, dir, false /* direct */, false /* background */, nil /* networkArgs */)
if err == nil {
t.Fatalf("restore with mismatched network type succeeded, want error")
}
if !strings.Contains(err.Error(), "cannot be restored with") {
t.Errorf("restore failed with %v, want network mismatch error", err)
}
}
// startHostinetSRServer starts a TCP server and returns its address, a
// channel signaled when it observes a connection closing, and a stop func.
func startHostinetSRServer(t *testing.T) (string, chan struct{}, func()) {
ln, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
t.Fatalf("error listening: %v", err)
}
done := make(chan struct{})
connClosed := make(chan struct{}, 1)
go func() {
defer close(done)
for {
c, err := ln.Accept()
if err != nil {
return
}
go func() {
defer c.Close()
io.Copy(io.Discard, c)
// Only the first observed close matters.
select {
case connClosed <- struct{}{}:
default:
}
}()
}
}()
return ln.Addr().String(), connClosed, func() {
ln.Close()
<-done
}
}
// waitForHostinetSRLog waits for all wanted strings to show up in the
// hostinet-sr test app's log.
func waitForHostinetSRLog(path string, wants ...string) error {
return testutil.Poll(func() error {
b, err := os.ReadFile(path)
if err != nil {
return err
}
got := string(b)
for _, want := range wants {
if !strings.Contains(got, want) {
return fmt.Errorf("log missing %q in:\n%s", want, got)
}
}
return nil
}, 30*time.Second)
}
// waitForHostinetSRCountAfter waits for the hostinet-sr test app's iteration
// counter to advance past prev.
func waitForHostinetSRCountAfter(path string, prev int) error {
return testutil.Poll(func() error {
count, err := lastHostinetSRCount(path)
if err != nil {
return err
}
if count <= prev {
return fmt.Errorf("last COUNT=%d, want > %d", count, prev)
}
return nil
}, 30*time.Second)
}
// hostinetSRListenerAddr returns the hostinet-sr test app's logged listener
// address.
func hostinetSRListenerAddr(path string) (string, error) {
b, err := os.ReadFile(path)
if err != nil {
return "", err
}
for _, line := range strings.Split(string(b), "\n") {
if addr, ok := strings.CutPrefix(line, "LISTENER_ADDR="); ok {
return addr, nil
}
}
return "", fmt.Errorf("no LISTENER_ADDR line in:\n%s", b)
}
// lastHostinetSRCount returns the hostinet-sr test app's last logged
// iteration count.
func lastHostinetSRCount(path string) (int, error) {
b, err := os.ReadFile(path)
if err != nil {
return 0, err
}
last := -1
for _, line := range strings.Split(string(b), "\n") {
if !strings.HasPrefix(line, "COUNT=") {
continue
}
n, err := strconv.Atoi(strings.TrimPrefix(line, "COUNT="))
if err != nil {
return 0, err
}
last = n
}
if last < 0 {
return 0, fmt.Errorf("no COUNT line in:\n%s", b)
}
return last, nil
}
// TestCheckpointRestoreExecKilled checks that exec'd processes are killed
// after the container is restored.
func TestCheckpointRestoreExecKilled(t *testing.T) {
spec, conf := sleepSpecConf(t)
_, bundleDir, cu, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cu()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
execArgs := &control.ExecArgs{
Filename: "/bin/sleep",
Argv: []string{"/bin/sleep", "10000"},
}
pid1, err := cont.Execute(conf, execArgs)
if err != nil {
t.Fatalf("error executing in container: %v", err)
}
// Test exec process with stdio FDs. FDs will not be present after restore and
// should be ignored.
r, w, err := os.Pipe()
if err != nil {
t.Fatal(err)
}
stdioCleanup := cleanup.Make(func() {
r.Close()
w.Close()
})
defer stdioCleanup.Clean()
fdMap := map[int]*os.File{0: r, 1: w, 2: w}
execArgs.FilePayload = control.NewFilePayload(fdMap, nil)
pid2, err := cont.Execute(conf, execArgs)
if err != nil {
t.Fatalf("error executing in container: %v", err)
}
// Since both share the same process name, ensure that the exec'd process
// has a different PID than the init process.
if pid1 == 1 || pid2 == 1 {
t.Fatalf("exec'd PID cannot be 1")
}
// Wait until the init process and exec'd processes are present.
expectedPL := []*control.Process{
newProcessBuilder().Cmd("sleep").PID(1).Process(),
newProcessBuilder().Cmd("sleep").PID(kernel.ThreadID(pid1)).Process(),
newProcessBuilder().Cmd("sleep").PID(kernel.ThreadID(pid2)).Process(),
}
if err := waitForProcessList(cont, expectedPL); err != nil {
t.Fatalf("Failed to kill exec'ed process, err: %v", err)
}
// Set the image path, which is where the checkpoint image will be saved.
dir, err := os.MkdirTemp(testutil.TmpDir(), "checkpoint-test")
if err != nil {
t.Fatalf("os.MkdirTemp failed: %v", err)
}
defer os.RemoveAll(dir)
if err := os.Chmod(dir, 0777); err != nil {
t.Fatalf("error chmoding file: %q, %v", dir, err)
}
// Checkpoint running container.
if err := cont.Checkpoint(conf, dir, sandbox.CheckpointOpts{Compression: statefile.CompressionLevelFlateBestSpeed}); err != nil {
t.Fatalf("error checkpointing container: %v", err)
}
cont.Destroy()
cont = nil
stdioCleanup.Clean()
cont2, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont2.Destroy()
if err := cont2.Restore(conf, dir, false /* direct */, false /* background */, nil /* networkArgs */); err != nil {
t.Fatalf("error restoring container: %v", err)
}
// Check that only the init process is present and the exec'ed
// processes were killed.
expectedPL = []*control.Process{
newProcessBuilder().Cmd("sleep").PID(1).Process(),
}
if err := waitForProcessList(cont2, expectedPL); err != nil {
t.Fatalf("Failed to kill exec'ed process, err: %v", err)
}
}
// TestCheckpointRestoreCreateMountPoint tests that mountpoints created during
// container creation are re-created after checkpoint/restore.
func TestCheckpointRestoreCreateMountPoint(t *testing.T) {
dir, err := os.MkdirTemp(testutil.TmpDir(), "checkpoint-test")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
defer os.RemoveAll(dir)
if err := os.Chmod(dir, 0777); err != nil {
t.Fatalf("error chmoding file: %q, %v", dir, err)
}
spec, conf := sleepSpecConf(t)
mountDest := filepath.Join(dir, "/foo-dir")
spec.Mounts = append(spec.Mounts, specs.Mount{
Destination: mountDest,
Type: "tmpfs",
})
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
if err := waitForProcessCount(cont, 1); err != nil {
t.Fatal(err)
}
// Check that mount point was created.
if ws, err := execute(conf, cont, "/usr/bin/test", "-d", mountDest); err != nil {
t.Fatal(err)
} else if ws != 0 {
t.Fatalf("directory was not re-created upon restore, ws: %v", ws)
}
// Checkpoint running container; save state into new file.
if err := cont.Checkpoint(conf, dir, sandbox.CheckpointOpts{Compression: statefile.CompressionLevelDefault}); err != nil {
t.Fatalf("error checkpointing container to file: %v", err)
}
// Remove directory created by the container.
if err := os.RemoveAll(mountDest); err != nil {
t.Fatalf("error removing mount point directory: %v", err)
}
// Destroy the original container to restore it in place.
cont.Destroy()
cont = nil
cont2, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont2.Destroy()
if err := cont2.Restore(conf, dir, false /* direct */, false /* background */, nil /* networkArgs */); err != nil {
t.Fatalf("error restoring container: %v", err)
}
// Check that mount point was re-created after restore.
if ws, err := execute(conf, cont2, "/usr/bin/test", "-d", mountDest); err != nil {
t.Fatal(err)
} else if ws != 0 {
t.Fatalf("directory was not re-created upon restore, ws: %v", ws)
}
}
// TestUnixDomainSockets checks that Checkpoint/Restore works in cases
// with filesystem Unix Domain Socket use.
func TestUnixDomainSockets(t *testing.T) {
// Skip overlay because test requires writing to host file.
for name, conf := range configs(t, true /* noOverlay */) {
t.Run(name, func(t *testing.T) {
// UDS path is limited to 108 chars for compatibility with older systems.
// Use '/tmp' (instead of testutil.TmpDir) to ensure the size limit is
// not exceeded. Assumes '/tmp' exists in the system.
dir, err := os.MkdirTemp("/tmp", "uds-test")
if err != nil {
t.Fatalf("os.MkdirTemp failed: %v", err)
}
defer os.RemoveAll(dir)
outputPath := filepath.Join(dir, "uds_output")
outputFile, err := os.OpenFile(outputPath, os.O_CREATE|os.O_EXCL|os.O_RDWR, 0666)
if err != nil {
t.Fatalf("error creating output file: %v", err)
}
defer outputFile.Close()
app, err := testutil.FindFile("test/cmd/test_app/test_app")
if err != nil {
t.Fatal("error finding test_app:", err)
}
socketPath := filepath.Join(dir, "uds_socket")
defer os.Remove(socketPath)
spec := testutil.NewSpecWithArgs(app, "uds", "--file", outputPath, "--socket", socketPath)
spec.Process.User = specs.User{
UID: uint32(os.Getuid()),
GID: uint32(os.Getgid()),
}
spec.Mounts = []specs.Mount{{
Type: "bind",
Destination: dir,
Source: dir,
}}
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Wait until application has ran.
if err := waitForFileNotEmpty(outputFile); err != nil {
t.Fatalf("Failed to wait for output file: %v", err)
}
// Checkpoint running container; save state into new file.
if err := cont.Checkpoint(conf, dir, sandbox.CheckpointOpts{Compression: statefile.CompressionLevelDefault}); err != nil {
t.Fatalf("error checkpointing container to empty file: %v", err)
}
// Read last number outputted before checkpoint.
lastNum, err := readOutputNum(outputPath, -1)
if err != nil {
t.Fatalf("error with outputFile: %v", err)
}
// Delete and recreate file before restoring.
if err := os.Remove(outputPath); err != nil {
t.Fatalf("error removing file")
}
outputFile2, err := os.OpenFile(outputPath, os.O_CREATE|os.O_EXCL|os.O_RDWR, 0666)
if err != nil {
t.Fatalf("error creating output file: %v", err)
}
defer outputFile2.Close()
// Restore into a new container.
argsRestore := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
contRestore, err := New(conf, argsRestore)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer contRestore.Destroy()
if err := contRestore.Restore(conf, dir, false /* direct */, false /* background */, nil /* networkArgs */); err != nil {
t.Fatalf("error restoring container: %v", err)
}
// Wait until application has ran.
if err := waitForFileNotEmpty(outputFile2); err != nil {
t.Fatalf("Failed to wait for output file: %v", err)
}
// Read first number outputted after restore.
firstNum, err := readOutputNum(outputPath, 0)
if err != nil {
t.Fatalf("error with outputFile: %v", err)
}
// Check that lastNum is one less than firstNum.
if lastNum+1 != firstNum {
t.Errorf("error numbers not consecutive, previous: %d, next: %d", lastNum, firstNum)
}
contRestore.Destroy()
})
}
}
// TestPauseResume tests that we can successfully pause and resume a container.
// The container will keep touching a file to indicate it's running. The test
// pauses the container, removes the file, and checks that it doesn't get
// recreated. Then it resumes the container, verify that the file gets created
// again.
func TestPauseResume(t *testing.T) {
for name, conf := range configs(t, true /* noOverlay */) {
t.Run(name, func(t *testing.T) {
tmpDir, err := os.MkdirTemp(testutil.TmpDir(), "lock")
if err != nil {
t.Fatalf("error creating temp dir: %v", err)
}
defer os.RemoveAll(tmpDir)
running := path.Join(tmpDir, "running")
script := fmt.Sprintf("while [[ true ]]; do touch %q; sleep 0.1; done", running)
spec := testutil.NewSpecWithArgs("/bin/bash", "-c", script)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Wait until container starts running, observed by the existence of running
// file.
if err := waitForFileExist(running); err != nil {
t.Errorf("error waiting for container to start: %v", err)
}
// Pause the running container.
if err := cont.Pause(); err != nil {
t.Errorf("error pausing container: %v", err)
}
if got, want := cont.Status, Paused; got != want {
t.Errorf("container status got %v, want %v", got, want)
}
if err := os.Remove(running); err != nil {
t.Fatalf("os.Remove(%q) failed: %v", running, err)
}
// Script touches the file every 100ms. Give a bit a time for it to run to
// catch the case that pause didn't work.
time.Sleep(200 * time.Millisecond)
if _, err := os.Stat(running); !os.IsNotExist(err) {
t.Fatalf("container did not pause: file exist check: %v", err)
}
// Resume the running container.
if err := cont.Resume(); err != nil {
t.Errorf("error pausing container: %v", err)
}
if got, want := cont.Status, Running; got != want {
t.Errorf("container status got %v, want %v", got, want)
}
// Verify that the file is once again created by container.
if err := waitForFileExist(running); err != nil {
t.Fatalf("error resuming container: file exist check: %v", err)
}
})
}
}
// TestPauseResumeStatus makes sure that the statuses are set correctly
// with calls to pause and resume and that pausing and resuming only
// occurs given the correct state.
func TestPauseResumeStatus(t *testing.T) {
spec, conf := sleepSpecConf(t)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Pause the running container.
if err := cont.Pause(); err != nil {
t.Errorf("error pausing container: %v", err)
}
if got, want := cont.Status, Paused; got != want {
t.Errorf("container status got %v, want %v", got, want)
}
// Try to Pause again. Should cause error.
if err := cont.Pause(); err == nil {
t.Errorf("error pausing container that was already paused: %v", err)
}
if got, want := cont.Status, Paused; got != want {
t.Errorf("container status got %v, want %v", got, want)
}
// Resume the running container.
if err := cont.Resume(); err != nil {
t.Errorf("error resuming container: %v", err)
}
if got, want := cont.Status, Running; got != want {
t.Errorf("container status got %v, want %v", got, want)
}
// Try to resume again. Should cause error.
if err := cont.Resume(); err == nil {
t.Errorf("error resuming container already running: %v", err)
}
if got, want := cont.Status, Running; got != want {
t.Errorf("container status got %v, want %v", got, want)
}
}
// TestCapabilities verifies that:
// - Running exec as non-root UID and GID will result in an error (because the
// executable file can't be read).
// - Running exec as non-root with CAP_DAC_OVERRIDE succeeds because it skips
// this check.
func TestCapabilities(t *testing.T) {
// Pick uid/gid different than ours.
uid := auth.KUID(os.Getuid() + 1)
gid := auth.KGID(os.Getgid() + 1)
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
spec, _ := sleepSpecConf(t)
rootDir, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// expectedPL lists the expected process state of the container.
expectedPL := []*control.Process{
newProcessBuilder().Cmd("sleep").Process(),
}
if err := waitForProcessList(cont, expectedPL); err != nil {
t.Fatalf("Failed to wait for sleep to start, err: %v", err)
}
// Create an executable that can't be run with the specified UID:GID.
// This shouldn't be callable within the container until we add the
// CAP_DAC_OVERRIDE capability to skip the access check.
exePath := filepath.Join(rootDir, "exe")
if err := os.WriteFile(exePath, []byte("#!/bin/sh\necho hello"), 0770); err != nil {
t.Fatalf("couldn't create executable: %v", err)
}
defer os.Remove(exePath)
// Need to traverse the intermediate directory.
if err := os.Chmod(rootDir, 0755); err != nil {
t.Fatal(err)
}
execArgs := &control.ExecArgs{
Filename: exePath,
Argv: []string{exePath},
WorkingDirectory: "/",
KUID: uid,
KGID: gid,
Capabilities: &auth.TaskCapabilities{},
}
// "exe" should fail because we don't have the necessary permissions.
if _, err := cont.executeSync(conf, execArgs); err == nil {
t.Fatalf("container executed without error, but an error was expected")
}
// Now we run with the capability enabled and should succeed.
execArgs.Capabilities = &auth.TaskCapabilities{
EffectiveCaps: auth.CapabilitySetOf(linux.CAP_DAC_OVERRIDE),
}
// "exe" should not fail this time.
if _, err := cont.executeSync(conf, execArgs); err != nil {
t.Fatalf("container failed to exec %v: %v", args, err)
}
})
}
}
// TestRunNonRoot checks that sandbox can be configured when running as
// non-privileged user.
func TestRunNonRoot(t *testing.T) {
for name, conf := range configs(t, true /* noOverlay */) {
t.Run(name, func(t *testing.T) {
spec := testutil.NewSpecWithArgs("/bin/true")
// Set a random user/group with no access to "blocked" dir.
spec.Process.User.UID = 343
spec.Process.User.GID = 2401
spec.Process.Capabilities = nil
// User running inside container can't list '$TMP/blocked' and would fail to
// mount it.
dir, err := os.MkdirTemp(testutil.TmpDir(), "blocked")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
if err := os.Chmod(dir, 0700); err != nil {
t.Fatalf("os.MkDir(%q) failed: %v", dir, err)
}
dir = path.Join(dir, "test")
if err := os.Mkdir(dir, 0755); err != nil {
t.Fatalf("os.MkDir(%q) failed: %v", dir, err)
}
src, err := os.MkdirTemp(testutil.TmpDir(), "src")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
spec.Mounts = append(spec.Mounts, specs.Mount{
Destination: dir,
Source: src,
Type: "bind",
})
if err := run(spec, conf); err != nil {
t.Fatalf("error running sandbox: %v", err)
}
})
}
}
// TestMountNewDir checks that runsc will create destination directory if it
// doesn't exit.
func TestMountNewDir(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
root, err := os.MkdirTemp(testutil.TmpDir(), "root")
if err != nil {
t.Fatal("os.MkdirTemp() failed:", err)
}
srcDir := path.Join(root, "src", "dir", "anotherdir")
if err := os.MkdirAll(srcDir, 0755); err != nil {
t.Fatalf("os.MkDir(%q) failed: %v", srcDir, err)
}
mountDir := path.Join(root, "dir", "anotherdir")
spec := testutil.NewSpecWithArgs("/bin/ls", mountDir)
spec.Mounts = append(spec.Mounts, specs.Mount{
Destination: mountDir,
Source: srcDir,
Type: "bind",
})
// Extra points for creating the mount with a readonly root.
spec.Root.Readonly = true
if err := run(spec, conf); err != nil {
t.Fatalf("error running sandbox: %v", err)
}
})
}
}
const (
unimplementedCharDevSrc = "/dev/port"
unimplementedCharDevRdev = "1:4"
)
func TestBindMountCharDevice(t *testing.T) {
// Skip if the unimplemented device is not present in the test
// environment (e.g. a sandboxed /dev), since it cannot be bind-mounted then.
if _, err := os.Stat(unimplementedCharDevSrc); err != nil {
t.Skipf("%s not available to bind mount: %v", unimplementedCharDevSrc, err)
}
app, err := testutil.FindFile("test/cmd/test_app/test_app")
if err != nil {
t.Fatal("error finding test_app:", err)
}
// Overlay configs are excluded: with --overlay2=all, file mounts are
// wrapped in an overlay, which does not support device files as the
// lower layer's root (a pre-existing, separate limitation). Both gofer
// modes are covered: they cache the device numbers and open device files
// through independent code paths.
for name, conf := range configs(t, true /* noOverlay */) {
for _, directfs := range []bool{true, false} {
modeName := "lisafs"
if directfs {
modeName = "directfs"
}
for _, policy := range []config.CharacterDevicePolicy{
config.CharDevEmulatedOnly,
config.CharDevPreferEmulated,
config.CharDevPassthrough,
} {
t.Run(name+"/"+modeName+"/"+policy.String(), func(t *testing.T) {
conf.DirectFS = directfs
conf.CharacterDevicePolicy = policy
checkBindMountCharDevices(t, conf, app)
})
}
}
}
}
// checkBindMountCharDevices runs the container once per device, checking with
// chardev-check that the bind-mounted node has the expected device numbers
// and open behavior under conf's --character-device-policy.
func checkBindMountCharDevices(t *testing.T, conf *config.Config, app string) {
// The mount destinations must be under a writable directory so that the
// gofer can create the mount point files (with docker, dockerd
// pre-creates the mount points in the container rootfs).
dir, err := os.MkdirTemp(testutil.TmpDir(), "chardev-test")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
var wantUnimplementedOpen string
switch conf.CharacterDevicePolicy {
case config.CharDevEmulatedOnly:
wantUnimplementedOpen = "enxio"
case config.CharDevPreferEmulated:
wantUnimplementedOpen = "not-enxio"
case config.CharDevPassthrough:
wantUnimplementedOpen = "not-enxio"
default:
t.Fatalf("unexpected character device policy: %v", conf.CharacterDevicePolicy)
}
for _, check := range []struct {
src string
args []string
}{
{
src: "/dev/null",
args: []string{"--want-rdev=1:3", "--want-open=ok", "--check-null-rw"},
},
{
src: unimplementedCharDevSrc,
args: []string{"--want-rdev=" + unimplementedCharDevRdev, "--want-open=" + wantUnimplementedOpen},
},
} {
dst := path.Join(dir, path.Base(check.src))
args := append([]string{app, "chardev-check", "--path=" + dst}, check.args...)
spec := testutil.NewSpecWithArgs(args...)
spec.Mounts = append(spec.Mounts,
specs.Mount{Destination: dst, Source: check.src, Type: "bind"})
if err := run(spec, conf); err != nil {
t.Fatalf("chardev-check of %s failed: %v", check.src, err)
}
}
}
func TestReadonlyRoot(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
spec, _ := sleepSpecConf(t)
spec.Root.Readonly = true
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Read mounts to check that root is readonly.
out, err := executeCombinedOutput(conf, c, nil, "/bin/sh", "-c", "mount | grep ' / ' | grep -o -e '(.*)'")
if err != nil {
t.Fatalf("exec failed: %v", err)
}
t.Logf("root mount options: %q", out)
if !strings.Contains(string(out), "ro") {
t.Errorf("root not mounted readonly: %q", out)
}
// Check that file cannot be created.
ws, err := execute(conf, c, "/bin/touch", "/foo")
if err != nil {
t.Fatalf("touch file in ro mount: %v", err)
}
if !ws.Exited() || unix.Errno(ws.ExitStatus()) != unix.EPERM {
t.Fatalf("wrong waitStatus: %v", ws)
}
})
}
}
func TestReadonlyMount(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
dir, err := os.MkdirTemp(testutil.TmpDir(), "ro-mount")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
spec, _ := sleepSpecConf(t)
spec.Mounts = append(spec.Mounts, specs.Mount{
Destination: dir,
Source: dir,
Type: "bind",
Options: []string{"ro"},
})
spec.Root.Readonly = false
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Read mounts to check that volume is readonly.
cmd := fmt.Sprintf("mount | grep ' %s ' | grep -o -e '(.*)'", dir)
out, err := executeCombinedOutput(conf, c, nil, "/bin/sh", "-c", cmd)
if err != nil {
t.Fatalf("exec failed, err: %v", err)
}
t.Logf("mount options: %q", out)
if !strings.Contains(string(out), "ro") {
t.Errorf("volume not mounted readonly: %q", out)
}
// Check that file cannot be created.
ws, err := execute(conf, c, "/bin/touch", path.Join(dir, "file"))
if err != nil {
t.Fatalf("touch file in ro mount: %v", err)
}
if !ws.Exited() || unix.Errno(ws.ExitStatus()) != unix.EPERM {
t.Fatalf("wrong WaitStatus: %v", ws)
}
})
}
}
func TestIDMappedMount(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
kernelVersion, err := hostos.KernelVersion()
if err != nil {
t.Fatalf("Failed to check kernel version: %v", err)
}
if !kernelVersion.AtLeast(6, 3) {
t.Skipf("Skipping as kernel >=6.3 is required for id mapped mount tests")
}
dir, err := os.MkdirTemp(testutil.TmpDir(), "id-mapped-mount")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
if err := unix.Mount("tmpfs", dir, "tmpfs", 0, ""); err != nil {
t.Fatalf("mount tmpfs failed: %v", err)
}
defer unix.Unmount(dir, unix.MNT_DETACH)
// Create a file owned by 0:0
testFilePath := filepath.Join(dir, "test-file")
f, err := os.OpenFile(testFilePath, os.O_RDONLY|os.O_CREATE, 0644)
if err != nil {
t.Fatalf("os.OpenFile() failed: %+v", err)
}
err = f.Chown(0, 0)
if err != nil {
t.Fatalf("chown failed: %v", err)
}
f.Close()
spec, _ := sleepSpecConf(t)
spec.Mounts = append(spec.Mounts, specs.Mount{
Destination: dir,
Source: dir,
Type: "bind",
Options: []string{"rbind", "idmap", "rw"},
// Note that in a mount id-mapping context, the meaning of ContainerID
// and HostID is flipped from what the names would suggest.
UIDMappings: []specs.LinuxIDMapping{{
ContainerID: 100000,
HostID: 0,
Size: 1,
}},
GIDMappings: []specs.LinuxIDMapping{{
ContainerID: 100000,
HostID: 0,
Size: 1,
}},
})
spec.Root.Readonly = false
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Verify that [dir]/test-file appears to be owned by nobody:nogroup
// in the container, since 0:0 on the host is not mapped in the mount's
// id mapping.
// Unfortunately, we cannot test with a valid mapping, since the lack of
// CAP_SETUID and CAP_SETGID in the test environment means we only have
// one uid-gid pair available to us.
expectedOwner := "65534:65534"
cmd := fmt.Sprintf("stat -c '%%u:%%g' '%s'", testFilePath)
out, err := executeCombinedOutput(conf, c, nil, "/bin/sh", "-c", cmd)
if err != nil {
t.Fatalf("exec failed, out: %v, err: %v", string(out), err)
}
outStr := strings.TrimSpace(string(out))
if outStr != expectedOwner {
t.Fatalf("file should have been owned by %s, instead owned by %v", expectedOwner, outStr)
}
})
}
}
func TestIDMappedSubMount(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
kernelVersion, err := hostos.KernelVersion()
if err != nil {
t.Fatalf("Failed to check kernel version: %v", err)
}
if !kernelVersion.AtLeast(6, 3) {
t.Skipf("Skipping as kernel >=6.3 is required for id mapped mount tests")
}
dir, err := os.MkdirTemp(testutil.TmpDir(), "id-mapped-mount")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
err = unix.Mount("tmpfs", dir, "tmpfs", 0, "")
if err != nil {
t.Fatalf("mount tmpfs failed: %v", err)
}
defer unix.Unmount(dir, unix.MNT_DETACH)
// Make a submount
subDir := filepath.Join(dir, "sub-mount")
err = os.Mkdir(subDir, 0777)
if err != nil {
t.Fatalf("os.Mkdir() failed: %v", err)
}
err = unix.Mount("tmpfs", subDir, "tmpfs", 0, "")
if err != nil {
t.Fatalf("mount tmpfs failed: %v", err)
}
defer unix.Unmount(subDir, unix.MNT_DETACH)
// Create a file owned by 0:0
testFilePath := filepath.Join(subDir, "test-file")
f, err := os.OpenFile(testFilePath, os.O_RDONLY|os.O_CREATE, 0644)
if err != nil {
t.Fatalf("os.OpenFile() failed: %+v", err)
}
err = f.Chown(0, 0)
if err != nil {
t.Fatalf("chown failed: %v", err)
}
f.Close()
spec, _ := sleepSpecConf(t)
ridmapPath := filepath.Join(dir, "ridmap")
spec.Mounts = append(spec.Mounts, specs.Mount{
Destination: ridmapPath,
Source: dir,
Type: "bind",
// ridmap: recursively apply id mapping
Options: []string{"rbind", "ridmap", "rw"},
UIDMappings: []specs.LinuxIDMapping{{
ContainerID: 100000,
HostID: 0,
Size: 1,
}},
GIDMappings: []specs.LinuxIDMapping{{
ContainerID: 100000,
HostID: 0,
Size: 1,
}},
})
idmapPath := filepath.Join(dir, "idmap")
spec.Mounts = append(spec.Mounts, specs.Mount{
Destination: idmapPath,
Source: dir,
Type: "bind",
// idmap: only apply id mapping at the top level
Options: []string{"rbind", "idmap", "rw"},
UIDMappings: []specs.LinuxIDMapping{{
ContainerID: 100000,
HostID: 0,
Size: 1,
}},
GIDMappings: []specs.LinuxIDMapping{{
ContainerID: 100000,
HostID: 0,
Size: 1,
}},
})
spec.Root.Readonly = false
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Verify that [dir]/ridmap/sub-mount/test-file appears to be owned by
// nobody:nogroup in the container.
expectedOwner := "65534:65534"
cmd := fmt.Sprintf("stat -c '%%u:%%g' '%s'", filepath.Join(ridmapPath, "sub-mount", "test-file"))
out, err := executeCombinedOutput(conf, c, nil, "/bin/sh", "-c", cmd)
if err != nil {
t.Fatalf("exec failed, out: %v, err: %v", string(out), err)
}
outStr := strings.TrimSpace(string(out))
if outStr != expectedOwner {
t.Fatalf("file should have been owned by %s, instead owned by %v", expectedOwner, outStr)
}
// Verify that [dir]/idmap/sub-mount/test-file appears to be owned by
// 0:0 in the container (since id mapping shouldn't apply to the submount).
expectedOwner = "0:0"
cmd = fmt.Sprintf("stat -c '%%u:%%g' '%s'", filepath.Join(idmapPath, "sub-mount", "test-file"))
out, err = executeCombinedOutput(conf, c, nil, "/bin/sh", "-c", cmd)
if err != nil {
t.Fatalf("exec failed, out: %v, err: %v", string(out), err)
}
outStr = strings.TrimSpace(string(out))
if outStr != expectedOwner {
t.Fatalf("file should have been owned by %s, instead owned by %v", expectedOwner, outStr)
}
})
}
}
func TestIDMappedMountFlags(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
kernelVersion, err := hostos.KernelVersion()
if err != nil {
t.Fatalf("Failed to check kernel version: %v", err)
}
if !kernelVersion.AtLeast(6, 3) {
t.Skipf("Skipping as kernel >=6.3 is required for id mapped mount tests")
}
dir, err := os.MkdirTemp(testutil.TmpDir(), "id-mapped-mount-flags")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
if err := unix.Mount("tmpfs", dir, "tmpfs", 0, ""); err != nil {
t.Fatalf("mount tmpfs failed: %v", err)
}
defer unix.Unmount(dir, unix.MNT_DETACH)
dir1 := filepath.Join(dir, "mnt1")
dir2 := filepath.Join(dir, "mnt2")
if err := os.MkdirAll(dir1, 0777); err != nil {
t.Fatalf("os.MkdirAll() failed: %v", err)
}
if err := os.MkdirAll(dir2, 0777); err != nil {
t.Fatalf("os.MkdirAll() failed: %v", err)
}
// Create a file in dir1 owned by 0:0 and a script/binary
testFilePath1 := filepath.Join(dir1, "test-file")
f, err := os.OpenFile(testFilePath1, os.O_RDONLY|os.O_CREATE, 0644)
if err != nil {
t.Fatalf("os.OpenFile() failed: %+v", err)
}
err = f.Chown(0, 0)
if err != nil {
t.Fatalf("chown failed: %v", err)
}
f.Close()
execFilePath1 := filepath.Join(dir1, "test-exec")
f, err = os.OpenFile(execFilePath1, os.O_WRONLY|os.O_CREATE, 0755)
if err != nil {
t.Fatalf("os.OpenFile() failed: %+v", err)
}
if _, err := f.WriteString("#!/bin/sh\necho hello\n"); err != nil {
t.Fatalf("write failed: %v", err)
}
err = f.Chown(0, 0)
if err != nil {
t.Fatalf("chown failed: %v", err)
}
f.Close()
spec, _ := sleepSpecConf(t)
// Test with two mounts, since nodiratime and relatime are mutually exclusive.
spec.Mounts = append(spec.Mounts, specs.Mount{
Destination: dir1,
Source: dir1,
Type: "bind",
Options: []string{"rbind", "idmap", "ro", "noexec", "noatime", "nodiratime"},
UIDMappings: []specs.LinuxIDMapping{{
ContainerID: 100000,
HostID: 0,
Size: 1,
}},
GIDMappings: []specs.LinuxIDMapping{{
ContainerID: 100000,
HostID: 0,
Size: 1,
}},
})
spec.Mounts = append(spec.Mounts, specs.Mount{
Destination: dir2,
Source: dir2,
Type: "bind",
Options: []string{"rbind", "idmap", "rw", "relatime"},
UIDMappings: []specs.LinuxIDMapping{{
ContainerID: 100000,
HostID: 0,
Size: 1,
}},
GIDMappings: []specs.LinuxIDMapping{{
ContainerID: 100000,
HostID: 0,
Size: 1,
}},
})
spec.Root.Readonly = false
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Verify ro inside container on dir1
_, status, err := executeCombinedOutputWithStatus(conf, c, nil, "/bin/touch", filepath.Join(dir1, "test-ro"))
if err != nil {
t.Fatalf("execSync touch failed: %v", err)
}
if status == 0 {
t.Fatalf("touch on ro mount got exit status 0, want != 0")
}
// Verify noexec inside container on dir1
_, _, err = executeCombinedOutputWithStatus(conf, c, nil, execFilePath1)
if err == nil || !strings.Contains(err.Error(), "permission denied") {
t.Fatalf("execution on noexec mount got err: %v, want 'permission denied'", err)
}
// Verify mount options in gofer mountinfo
mountinfo, err := os.ReadFile(fmt.Sprintf("/proc/%d/mountinfo", c.GoferPid.Load()))
if err != nil {
t.Fatalf("failed to read gofer mountinfo: %v", err)
}
verifyMountinfo := func(dest string, wantOpts []string) {
var foundLine string
for _, line := range strings.Split(string(mountinfo), "\n") {
fields := strings.Fields(line)
if len(fields) >= 6 && fields[4] == dest {
foundLine = line
break
}
}
if foundLine == "" {
t.Fatalf("mount point ending with %s not found in gofer mountinfo:\n%s", dest, string(mountinfo))
}
fields := strings.Fields(foundLine)
optsMap := make(map[string]bool)
for _, opt := range strings.Split(fields[5], ",") {
optsMap[opt] = true
}
for _, want := range wantOpts {
if !optsMap[want] {
t.Fatalf("mount point ending with %s (line: %q) missing expected option %q", dest, foundLine, want)
}
}
}
verifyMountinfo(dir1, []string{"ro", "noexec", "noatime", "nodiratime"})
mnt2Want := []string{"rw", "relatime"}
if strings.Contains(name, "-overlay") {
mnt2Want = []string{"ro", "relatime"}
}
verifyMountinfo(dir2, mnt2Want)
})
}
}
func TestIDMappedMountPropagation(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
kernelVersion, err := hostos.KernelVersion()
if err != nil {
t.Fatalf("Failed to check kernel version: %v", err)
}
if !kernelVersion.AtLeast(6, 3) {
t.Skipf("Skipping as kernel >=6.3 is required for id mapped mount tests")
}
dir, err := os.MkdirTemp(testutil.TmpDir(), "id-mapped-mount-prop")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
if err := unix.Mount("tmpfs", dir, "tmpfs", 0, ""); err != nil {
t.Fatalf("mount tmpfs failed: %v", err)
}
defer unix.Unmount(dir, unix.MNT_DETACH)
if err := unix.Mount("", dir, "", unix.MS_SHARED, ""); err != nil {
t.Fatalf("make-shared failed: %v", err)
}
subDir := filepath.Join(dir, "sub")
if err := os.MkdirAll(filepath.Join(subDir, "new-tmpfs"), 0777); err != nil {
t.Fatalf("mkdir failed: %v", err)
}
if err := os.MkdirAll(filepath.Join(subDir, "private-tmpfs"), 0777); err != nil {
t.Fatalf("mkdir failed: %v", err)
}
slavePath := filepath.Join(dir, "slave")
privatePath := filepath.Join(dir, "private")
spec, _ := sleepSpecConf(t)
spec.Mounts = append(spec.Mounts, specs.Mount{
Destination: slavePath,
Source: dir,
Type: "bind",
Options: []string{"rbind", "ridmap", "rslave", "rw"},
UIDMappings: []specs.LinuxIDMapping{{
ContainerID: 100000,
HostID: 0,
Size: 1,
}},
GIDMappings: []specs.LinuxIDMapping{{
ContainerID: 100000,
HostID: 0,
Size: 1,
}},
})
spec.Mounts = append(spec.Mounts, specs.Mount{
Destination: privatePath,
Source: dir,
Type: "bind",
Options: []string{"rbind", "ridmap", "rprivate", "rw"},
UIDMappings: []specs.LinuxIDMapping{{
ContainerID: 100000,
HostID: 0,
Size: 1,
}},
GIDMappings: []specs.LinuxIDMapping{{
ContainerID: 100000,
HostID: 0,
Size: 1,
}},
})
spec.Root.Readonly = false
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Mount tmpfs on host
newTmpfsPath := filepath.Join(subDir, "new-tmpfs")
if err := unix.Mount("tmpfs", newTmpfsPath, "tmpfs", 0, ""); err != nil {
t.Fatalf("mount tmpfs failed: %v", err)
}
defer unix.Unmount(newTmpfsPath, unix.MNT_DETACH)
privateTmpfsPath := filepath.Join(subDir, "private-tmpfs")
if err := unix.Mount("tmpfs", privateTmpfsPath, "tmpfs", 0, ""); err != nil {
t.Fatalf("mount tmpfs failed: %v", err)
}
defer unix.Unmount(privateTmpfsPath, unix.MNT_DETACH)
// Create a file in each tmpfs to verify propagation
if err := os.WriteFile(filepath.Join(newTmpfsPath, "prop-file"), []byte("data"), 0644); err != nil {
t.Fatalf("write file failed: %v", err)
}
if err := os.WriteFile(filepath.Join(privateTmpfsPath, "prop-file"), []byte("data"), 0644); err != nil {
t.Fatalf("write file failed: %v", err)
}
// Verify slavePath sees prop-file
cmd := fmt.Sprintf("test -f '%s'", filepath.Join(slavePath, "sub", "new-tmpfs", "prop-file"))
_, status, err := executeCombinedOutputWithStatus(conf, c, nil, "/bin/sh", "-c", cmd)
if err != nil || status != 0 {
t.Fatalf("execSync stat failed (expected prop-file to exist in rslave mount), ws: %v, err: %v", status, err)
}
// Verify privatePath does NOT see prop-file
cmd = fmt.Sprintf("test -f '%s'", filepath.Join(privatePath, "sub", "private-tmpfs", "prop-file"))
_, status, err = executeCombinedOutputWithStatus(conf, c, nil, "/bin/sh", "-c", cmd)
if err != nil {
t.Fatalf("execSync stat failed unexpectedly: %v", err)
}
if status == 0 {
t.Fatalf("stat on rprivate mount got exit status %d, want != 0", status)
}
})
}
}
func TestIDMappedMountFile(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
kernelVersion, err := hostos.KernelVersion()
if err != nil {
t.Fatalf("Failed to check kernel version: %v", err)
}
if !kernelVersion.AtLeast(6, 3) {
t.Skipf("Skipping as kernel >=6.3 is required for id mapped mount tests")
}
dir, err := os.MkdirTemp(testutil.TmpDir(), "id-mapped-mount-file")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
if err := unix.Mount("tmpfs", dir, "tmpfs", 0, ""); err != nil {
t.Fatalf("mount tmpfs failed: %v", err)
}
defer unix.Unmount(dir, unix.MNT_DETACH)
// Create a file owned by 0:0
hostFilePath := filepath.Join(dir, "host-file")
f, err := os.OpenFile(hostFilePath, os.O_RDONLY|os.O_CREATE, 0644)
if err != nil {
t.Fatalf("os.OpenFile() failed: %+v", err)
}
err = f.Chown(0, 0)
if err != nil {
t.Fatalf("chown failed: %v", err)
}
f.Close()
targetFilePath := filepath.Join(dir, "target-file")
spec, _ := sleepSpecConf(t)
spec.Mounts = append(spec.Mounts, specs.Mount{
Destination: targetFilePath,
Source: hostFilePath,
Type: "bind",
Options: []string{"rbind", "idmap", "rw"},
UIDMappings: []specs.LinuxIDMapping{{
ContainerID: 100000,
HostID: 0,
Size: 1,
}},
GIDMappings: []specs.LinuxIDMapping{{
ContainerID: 100000,
HostID: 0,
Size: 1,
}},
})
spec.Root.Readonly = false
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Verify that targetFilePath appears to be owned by nobody:nogroup
expectedOwner := "65534:65534"
cmd := fmt.Sprintf("stat -c '%%u:%%g' '%s'", targetFilePath)
out, err := executeCombinedOutput(conf, c, nil, "/bin/sh", "-c", cmd)
if err != nil {
t.Fatalf("exec failed, out: %v, err: %v", string(out), err)
}
outStr := strings.TrimSpace(string(out))
if outStr != expectedOwner {
t.Fatalf("file should have been owned by %s, instead owned by %v", expectedOwner, outStr)
}
})
}
}
func TestUIDMap(t *testing.T) {
for name, conf := range configs(t, true /* noOverlay */) {
t.Run(name, func(t *testing.T) {
testDir, err := os.MkdirTemp(testutil.TmpDir(), "test-mount")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
defer os.RemoveAll(testDir)
testFile := path.Join(testDir, "testfile")
spec := testutil.NewSpecWithArgs("touch", "/tmp/testfile")
uid := os.Getuid()
gid := os.Getgid()
spec.Linux = &specs.Linux{
Namespaces: []specs.LinuxNamespace{
{Type: specs.UserNamespace},
{Type: specs.PIDNamespace},
{Type: specs.MountNamespace},
},
UIDMappings: []specs.LinuxIDMapping{
{
ContainerID: 0,
HostID: uint32(uid),
Size: 1,
},
},
GIDMappings: []specs.LinuxIDMapping{
{
ContainerID: 0,
HostID: uint32(gid),
Size: 1,
},
},
}
spec.Mounts = append(spec.Mounts, specs.Mount{
Destination: "/tmp",
Source: testDir,
Type: "bind",
})
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create, start and wait for the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
ws, err := c.Wait()
if err != nil {
t.Fatalf("error waiting on container: %v", err)
}
if !ws.Exited() || ws.ExitStatus() != 0 {
t.Fatalf("container failed, waitStatus: %v", ws)
}
st := unix.Stat_t{}
if err := unix.Stat(testFile, &st); err != nil {
t.Fatalf("error stat /testfile: %v", err)
}
if st.Uid != uint32(uid) || st.Gid != uint32(gid) {
t.Fatalf("UID: %d (%d) GID: %d (%d)", st.Uid, uid, st.Gid, gid)
}
})
}
}
// TestAbbreviatedIDs checks that runsc supports using abbreviated container
// IDs in place of full IDs.
func TestAbbreviatedIDs(t *testing.T) {
rootDir, cleanup, err := testutil.SetupRootDir()
if err != nil {
t.Fatalf("error creating root dir: %v", err)
}
defer cleanup()
conf := testutil.TestConfig(t)
conf.RootDir = rootDir
cids := []string{
"foo-" + testutil.RandomContainerID(),
"bar-" + testutil.RandomContainerID(),
"baz-" + testutil.RandomContainerID(),
}
for _, cid := range cids {
spec, _ := sleepSpecConf(t)
bundleDir, cleanup, err := testutil.SetupBundleDir(spec)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: cid,
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
}
// These should all be unambiguous.
unambiguous := map[string]string{
"f": cids[0],
cids[0]: cids[0],
"bar": cids[1],
cids[1]: cids[1],
"baz": cids[2],
cids[2]: cids[2],
}
for shortid, longid := range unambiguous {
if _, err := Load(rootDir, FullID{ContainerID: shortid}, LoadOpts{}); err != nil {
t.Errorf("%q should resolve to %q: %v", shortid, longid, err)
}
}
// These should be ambiguous.
ambiguous := []string{
"b",
"ba",
}
for _, shortid := range ambiguous {
if s, err := Load(rootDir, FullID{ContainerID: shortid}, LoadOpts{}); err == nil {
t.Errorf("%q should be ambiguous, but resolved to %q", shortid, s.ID)
}
}
}
func TestGoferExits(t *testing.T) {
spec, conf := sleepSpecConf(t)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Kill sandbox and expect gofer to exit on its own.
sandboxProc, err := os.FindProcess(c.Sandbox.Getpid())
if err != nil {
t.Fatalf("error finding sandbox process: %v", err)
}
if err := sandboxProc.Kill(); err != nil {
t.Fatalf("error killing sandbox process: %v", err)
}
err = blockUntilWaitable(c.GoferPid.Load())
if err != nil && err != unix.ECHILD {
t.Errorf("error waiting for gofer to exit: %v", err)
}
}
func TestRootNotMount(t *testing.T) {
appSym, err := testutil.FindFile("test/cmd/test_app/test_app")
if err != nil {
t.Fatal("error finding test_app:", err)
}
app, err := filepath.EvalSymlinks(appSym)
if err != nil {
t.Fatalf("error resolving %q symlink: %v", appSym, err)
}
log.Infof("App path %q is a symlink to %q", appSym, app)
static, err := testutil.IsStatic(app)
if err != nil {
t.Fatalf("error reading application binary: %v", err)
}
if !static {
// This happens during race builds; we cannot map in shared
// libraries also, so we need to skip the test.
t.Skip()
}
root := filepath.Dir(app)
exe := "/" + filepath.Base(app)
log.Infof("Executing %q in %q", exe, root)
spec := testutil.NewSpecWithArgs(exe, "help")
spec.Root.Path = root
spec.Root.Readonly = true
spec.Mounts = nil
conf := testutil.TestConfig(t)
if err := run(spec, conf); err != nil {
t.Fatalf("error running sandbox: %v", err)
}
}
func TestUserLog(t *testing.T) {
app, err := testutil.FindFile("test/cmd/test_app/test_app")
if err != nil {
t.Fatal("error finding test_app:", err)
}
// sched_rr_get_interval - not implemented in gvisor.
num := strconv.Itoa(unix.SYS_SCHED_RR_GET_INTERVAL)
spec := testutil.NewSpecWithArgs(app, "syscall", "--syscall="+num)
conf := testutil.TestConfig(t)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
dir, err := os.MkdirTemp(testutil.TmpDir(), "user_log_test")
if err != nil {
t.Fatalf("error creating tmp dir: %v", err)
}
userLog := filepath.Join(dir, "user.log")
// Create, start and wait for the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
UserLog: userLog,
Attached: true,
}
ws, err := Run(conf, args)
if err != nil {
t.Fatalf("error running container: %v", err)
}
if !ws.Exited() || ws.ExitStatus() != 0 {
t.Fatalf("container failed, waitStatus: %v", ws)
}
out, err := os.ReadFile(userLog)
if err != nil {
t.Fatalf("error opening user log file %q: %v", userLog, err)
}
if want := "Unsupported syscall sched_rr_get_interval("; !strings.Contains(string(out), want) {
t.Errorf("user log file doesn't contain %q, out: %s", want, string(out))
}
}
func TestWaitOnExitedSandbox(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
// Run a shell that sleeps for 1 second and then exits with a
// non-zero code.
const wantExit = 17
cmd := fmt.Sprintf("sleep 1; exit %d", wantExit)
spec := testutil.NewSpecWithArgs("/bin/sh", "-c", cmd)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and Start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Wait on the sandbox. This will make an RPC to the sandbox
// and get the actual exit status of the application.
ws, err := c.Wait()
if err != nil {
t.Fatalf("error waiting on container: %v", err)
}
if got := ws.ExitStatus(); got != wantExit {
t.Errorf("got exit status %d, want %d", got, wantExit)
}
// Now the sandbox has exited, but the zombie sandbox process
// still exists. Calling Wait() now will return the sandbox
// exit status.
ws, err = c.Wait()
if err != nil {
t.Fatalf("error waiting on container: %v", err)
}
if got := ws.ExitStatus(); got != wantExit {
t.Errorf("got exit status %d, want %d", got, wantExit)
}
})
}
}
func TestDestroyNotStarted(t *testing.T) {
spec, conf := sleepSpecConf(t)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create the container and check that it can be destroyed.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
if err := c.Destroy(); err != nil {
t.Fatalf("deleting non-started container failed: %v", err)
}
}
// TestSignalCreated verifies that a container that was created but never started
// can be killed. Per the OCI runtime spec, kill must work on created containers;
// otherwise a never-started sandbox becomes unkillable under containerd, whose
// stop path (kill, wait, delete) never reaches delete if kill is rejected.
func TestSignalCreated(t *testing.T) {
spec, conf := sleepSpecConf(t)
rootDir, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create the container, but never call Start.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if got, want := c.Status, Created; got != want {
t.Fatalf("container status got %v, want %v", got, want)
}
// SIGKILL of a created container must succeed and leave it Stopped so that
// the containerd stop/wait/delete sequence can complete.
if err := c.SignalContainer(unix.SIGKILL, true /* all */); err != nil {
t.Fatalf("SignalContainer(SIGKILL) on created container failed: %v", err)
}
c, err = Load(rootDir, FullID{ContainerID: args.ID}, LoadOpts{})
if err != nil {
t.Fatalf("error loading container after kill: %v", err)
}
if got, want := c.Status, Stopped; got != want {
t.Errorf("container status after SIGKILL got %v, want %v", got, want)
}
}
// TestDestroyStarting attempts to force a race between start and destroy.
func TestDestroyStarting(t *testing.T) {
for i := 0; i < 10; i++ {
spec, conf := sleepSpecConf(t)
rootDir, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create the container and check that it can be destroyed.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
// Container is not thread safe, so load another instance to run in
// concurrently.
startCont, err := Load(rootDir, FullID{ContainerID: args.ID}, LoadOpts{})
if err != nil {
t.Fatalf("error loading container: %v", err)
}
wg := sync.WaitGroup{}
wg.Add(1)
go func() {
defer wg.Done()
// Ignore failures, start can fail if destroy runs first.
_ = startCont.Start(conf)
}()
wg.Add(1)
go func() {
defer wg.Done()
if err := c.Destroy(); err != nil {
t.Errorf("deleting non-started container failed: %v", err)
}
}()
wg.Wait()
}
}
func TestCreateWorkingDir(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
tmpDir, err := os.MkdirTemp(testutil.TmpDir(), "cwd-create")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
dir := path.Join(tmpDir, "new/working/dir")
// touch will fail if the directory doesn't exist.
spec := testutil.NewSpecWithArgs("/bin/touch", path.Join(dir, "file"))
spec.Process.Cwd = dir
spec.Root.Readonly = true
if err := run(spec, conf); err != nil {
t.Fatalf("Error running container: %v", err)
}
})
}
}
// TestMountPropagation verifies that mount propagates to slave but not to
// private mounts.
func TestMountPropagation(t *testing.T) {
// Setup dir structure:
// - src: is mounted as shared and is used as source for both private and
// slave mounts
// - dir: will be bind mounted inside src and should propagate to slave
tmpDir, err := os.MkdirTemp(testutil.TmpDir(), "mount")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
src := filepath.Join(tmpDir, "src")
srcMnt := filepath.Join(src, "mnt")
dir := filepath.Join(tmpDir, "dir")
for _, path := range []string{src, srcMnt, dir} {
if err := os.MkdirAll(path, 0777); err != nil {
t.Fatalf("MkdirAll(%q): %v", path, err)
}
}
dirFile := filepath.Join(dir, "file")
f, err := os.Create(dirFile)
if err != nil {
t.Fatalf("os.Create(%q): %v", dirFile, err)
}
f.Close()
// Setup src as a shared mount.
if err := unix.Mount(src, src, "bind", unix.MS_BIND, ""); err != nil {
t.Fatalf("mount(%q, %q, MS_BIND): %v", dir, srcMnt, err)
}
if err := unix.Mount("", src, "", unix.MS_SHARED, ""); err != nil {
t.Fatalf("mount(%q, MS_SHARED): %v", srcMnt, err)
}
spec, conf := sleepSpecConf(t)
priv := filepath.Join(tmpDir, "priv")
slave := filepath.Join(tmpDir, "slave")
spec.Mounts = []specs.Mount{
{
Source: src,
Destination: priv,
Type: "bind",
Options: []string{"private"},
},
{
Source: src,
Destination: slave,
Type: "bind",
Options: []string{"slave"},
},
}
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("starting container: %v", err)
}
// After the container is started, mount dir inside source and check what
// happens to both destinations.
if err := unix.Mount(dir, srcMnt, "bind", unix.MS_BIND, ""); err != nil {
t.Fatalf("mount(%q, %q, MS_BIND): %v", dir, srcMnt, err)
}
// Check that mount didn't propagate to private mount.
privFile := filepath.Join(priv, "mnt", "file")
if ws, err := execute(conf, cont, "/usr/bin/test", "!", "-f", privFile); err != nil || ws != 0 {
t.Fatalf("exec: test ! -f %q, ws: %v, err: %v", privFile, ws, err)
}
// Check that mount propagated to slave mount.
slaveFile := filepath.Join(slave, "mnt", "file")
if ws, err := execute(conf, cont, "/usr/bin/test", "-f", slaveFile); err != nil || ws != 0 {
t.Fatalf("exec: test -f %q, ws: %v, err: %v", privFile, ws, err)
}
}
func TestMountSymlink(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
dir, err := os.MkdirTemp(testutil.TmpDir(), "mount-symlink")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
defer os.RemoveAll(dir)
source := path.Join(dir, "source")
target := path.Join(dir, "target")
for _, path := range []string{source, target} {
if err := os.MkdirAll(path, 0777); err != nil {
t.Fatalf("os.MkdirAll(): %v", err)
}
}
f, err := os.Create(path.Join(source, "file"))
if err != nil {
t.Fatalf("os.Create(): %v", err)
}
f.Close()
link := path.Join(dir, "link")
if err := os.Symlink(target, link); err != nil {
t.Fatalf("os.Symlink(%q, %q): %v", target, link, err)
}
spec, _ := sleepSpecConf(t)
// Mount to a symlink to ensure the mount code will follow it and mount
// at the symlink target.
spec.Mounts = append(spec.Mounts, specs.Mount{
Type: "bind",
Destination: link,
Source: source,
})
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("starting container: %v", err)
}
// Check that symlink was resolved and mount was created where the symlink
// is pointing to.
file := path.Join(target, "file")
if ws, err := execute(conf, cont, "/usr/bin/test", "-f", file); err != nil || ws != 0 {
t.Fatalf("exec: test -f %q, ws: %v, err: %v", file, ws, err)
}
})
}
}
// Check that --net-raw disables the CAP_NET_RAW capability.
func TestNetRaw(t *testing.T) {
capNetRaw := strconv.FormatUint(uint64(auth.CapabilitySetOf(linux.CAP_NET_RAW)), 10)
app, err := testutil.FindFile("test/cmd/test_app/test_app")
if err != nil {
t.Fatal("error finding test_app:", err)
}
for _, enableRaw := range []bool{true, false} {
conf := testutil.TestConfig(t)
conf.EnableRaw = enableRaw
test := "--enabled"
if !enableRaw {
test = "--disabled"
}
spec := testutil.NewSpecWithArgs(app, "capability", test, capNetRaw)
if err := run(spec, conf); err != nil {
t.Fatalf("Error running container: %v", err)
}
}
}
// TestTTYField checks TTY field returned by container.Processes().
func TestTTYField(t *testing.T) {
stop := testutil.StartReaper()
defer stop()
testApp, err := testutil.FindFile("test/cmd/test_app/test_app")
if err != nil {
t.Fatal("error finding test_app:", err)
}
testCases := []struct {
name string
useTTY bool
wantTTYField string
}{
{
name: "no tty",
useTTY: false,
wantTTYField: "?",
},
{
name: "tty used",
useTTY: true,
wantTTYField: "pts/0",
},
}
for _, test := range testCases {
t.Run(test.name, func(t *testing.T) {
conf := testutil.TestConfig(t)
// We will run /bin/sleep, possibly with an open TTY.
cmd := []string{"/bin/sleep", "10000"}
if test.useTTY {
// Run inside the "pty-runner".
cmd = append([]string{testApp, "pty-runner"}, cmd...)
}
spec := testutil.NewSpecWithArgs(cmd...)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Wait for sleep to be running, and check the TTY
// field.
var gotTTYField string
cb := func() error {
ps, err := c.Processes()
if err != nil {
err = fmt.Errorf("error getting process data from container: %v", err)
return &backoff.PermanentError{Err: err}
}
for _, p := range ps {
if strings.Contains(p.Cmd, "sleep") {
gotTTYField = p.TTY
return nil
}
}
return fmt.Errorf("sleep not running")
}
if err := testutil.Poll(cb, 30*time.Second); err != nil {
t.Fatalf("error waiting for sleep process: %v", err)
}
if gotTTYField != test.wantTTYField {
t.Errorf("tty field got %q, want %q", gotTTYField, test.wantTTYField)
}
})
}
}
// TestPGIDField checks PGID returned by container.Processes().
func TestPGIDField(t *testing.T) {
stop := testutil.StartReaper()
defer stop()
conf := testutil.TestConfig(t)
spec := testutil.NewSpecWithArgs("/bin/sleep", "10000")
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
expectedPL := []*control.Process{
newProcessBuilder().PID(1).PPID(0).PGID(1).Cmd("sleep").Process(),
}
if err := waitForProcessList(c, expectedPL); err != nil {
t.Fatalf("error waiting for process list with pgid: %v", err)
}
}
// Test that container can run even when there are corrupt state files in the
// root directiry.
func TestCreateWithCorruptedStateFile(t *testing.T) {
conf := testutil.TestConfig(t)
spec := testutil.NewSpecWithArgs("/bin/true")
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create corrupted state file.
corruptID := testutil.RandomContainerID()
corruptState := buildPath(conf.RootDir, FullID{SandboxID: corruptID, ContainerID: corruptID}, stateFileExtension)
if err := os.WriteFile(corruptState, []byte("this{file(is;not[valid.json"), 0777); err != nil {
t.Fatalf("createCorruptStateFile(): %v", err)
}
defer os.Remove(corruptState)
if _, err := Load(conf.RootDir, FullID{ContainerID: corruptID}, LoadOpts{SkipCheck: true}); err == nil {
t.Fatalf("loading corrupted state file should have failed")
}
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
Attached: true,
}
if ws, err := Run(conf, args); err != nil {
t.Errorf("running container: %v", err)
} else if !ws.Exited() || ws.ExitStatus() != 0 {
t.Errorf("container failed, waitStatus: %v", ws)
}
}
func TestBindMountByOption(t *testing.T) {
for name, conf := range configs(t, false /* noOverlay */) {
t.Run(name, func(t *testing.T) {
dir, err := os.MkdirTemp(testutil.TmpDir(), "bind-mount")
spec := testutil.NewSpecWithArgs("/bin/touch", path.Join(dir, "file"))
if err != nil {
t.Fatalf("os.MkdirTemp(): %v", err)
}
spec.Mounts = append(spec.Mounts, specs.Mount{
Destination: dir,
Source: dir,
Type: "none",
Options: []string{"rw", "bind"},
})
if err := run(spec, conf); err != nil {
t.Fatalf("error running sandbox: %v", err)
}
})
}
}
// TestRlimits sets limit to number of open files and checks that the limit
// is propagated to the container.
func TestRlimits(t *testing.T) {
file, err := os.CreateTemp(testutil.TmpDir(), "ulimit")
if err != nil {
t.Fatal(err)
}
cmd := fmt.Sprintf("ulimit -n > %q", file.Name())
spec := testutil.NewSpecWithArgs("sh", "-c", cmd)
spec.Process.Rlimits = []specs.POSIXRlimit{
{Type: "RLIMIT_NOFILE", Hard: 1000, Soft: 100},
}
conf := testutil.TestConfig(t)
if err := run(spec, conf); err != nil {
t.Fatalf("Error running container: %v", err)
}
got, err := os.ReadFile(file.Name())
if err != nil {
t.Fatal(err)
}
if want := "100\n"; string(got) != want {
t.Errorf("ulimit result, got: %q, want: %q", got, want)
}
}
// TestRlimitsExec sets limit to number of open files and checks that the limit
// is propagated to exec'd processes.
func TestRlimitsExec(t *testing.T) {
spec, conf := sleepSpecConf(t)
spec.Process.Rlimits = []specs.POSIXRlimit{
{Type: "RLIMIT_NOFILE", Hard: 1000, Soft: 100},
}
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
got, err := executeCombinedOutput(conf, cont, nil, "/bin/sh", "-c", "ulimit -n")
if err != nil {
t.Fatal(err)
}
if want := "100\n"; string(got) != want {
t.Errorf("ulimit result, got: %q, want: %q", got, want)
}
}
// TestUsage checks that usage generates the expected memory usage.
func TestUsage(t *testing.T) {
spec, conf := sleepSpecConf(t)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("Creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("starting container: %v", err)
}
for _, full := range []bool{false, true} {
// Retry a few times to ensure the container has had a chance to start up and
// generate some memory usage.
if err := backoff.Retry(func() error {
m, err := cont.Sandbox.Usage(full)
if err != nil {
return &backoff.PermanentError{Err: fmt.Errorf("error usage from container: %v", err)}
}
if m.Mapped == 0 {
return fmt.Errorf("Usage mapped got zero")
}
if m.Total == 0 {
return fmt.Errorf("Usage total got zero")
}
if full {
if m.System == 0 {
return fmt.Errorf("Usage system got zero")
}
if m.Anonymous == 0 {
return fmt.Errorf("Usage anonymous got zero")
}
}
return nil
}, backoff.WithMaxRetries(backoff.NewConstantBackOff(100*time.Millisecond), 10)); err != nil {
t.Errorf("failed to get Usage after retries: %v", err)
}
}
}
// TestUsageFD checks that usagefd generates the expected memory usage.
func TestUsageFD(t *testing.T) {
spec, conf := sleepSpecConf(t)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("Creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("starting container: %v", err)
}
m, err := cont.Sandbox.UsageFD()
if err != nil {
t.Fatalf("error usageFD from container: %v", err)
}
// Retry a few times to ensure the container has had a chance to start up and
// generate some memory usage.
if err := backoff.Retry(func() error {
mapped, unknown, total, err := m.Fetch()
if err != nil {
return fmt.Errorf("error Fetch memory usage: %v", err)
}
if mapped == 0 {
return fmt.Errorf("UsageFD Mapped got zero")
}
if unknown == 0 {
return fmt.Errorf("UsageFD unknown got zero")
}
if total == 0 {
return fmt.Errorf("UsageFD total got zero")
}
return nil
}, backoff.WithMaxRetries(backoff.NewConstantBackOff(100*time.Millisecond), 10)); err != nil {
t.Errorf("failed to get UsageFD after retries: %v", err)
}
// Set the image path, which is where the checkpoint image will be saved.
dir, err := os.MkdirTemp(testutil.TmpDir(), "checkpoint")
if err != nil {
t.Fatalf("os.MkdirTemp failed: %v", err)
}
defer os.RemoveAll(dir)
if err := os.Chmod(dir, 0777); err != nil {
t.Fatalf("error chmoding file: %q, %v", dir, err)
}
// Checkpoint running container.
if err := cont.Checkpoint(conf, dir, sandbox.CheckpointOpts{Compression: statefile.CompressionLevelDefault}); err != nil {
t.Fatalf("error checkpointing container: %v", err)
}
cont.Destroy()
cont = nil
cont2, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont2.Destroy()
if err := cont2.Restore(conf, dir, false /* direct */, false /* background */, nil /* networkArgs */); err != nil {
t.Fatalf("error restoring container: %v", err)
}
// Ensure UsageFD() is still working after restore.
_, err = cont2.Sandbox.UsageFD()
if err != nil {
t.Fatalf("error usageFD from restored container: %v", err)
}
}
// TestProfile checks that profiling options generate profiles.
func TestProfile(t *testing.T) {
// Perform a non-trivial amount of work so we actually capture
// something in the profiles.
spec := testutil.NewSpecWithArgs("/bin/bash", "-c", "true")
conf := testutil.TestConfig(t)
conf.ProfileEnable = true
conf.ProfileBlock = filepath.Join(t.TempDir(), "block.pprof")
conf.ProfileCPU = filepath.Join(t.TempDir(), "cpu.pprof")
conf.ProfileHeap = filepath.Join(t.TempDir(), "heap.pprof")
conf.ProfileMutex = filepath.Join(t.TempDir(), "mutex.pprof")
conf.TraceFile = filepath.Join(t.TempDir(), "trace.out")
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
Attached: true,
}
_, err = Run(conf, args)
if err != nil {
t.Fatalf("Creating container: %v", err)
}
// Basic test; simply assert that the profiles are not empty.
for _, name := range []string{conf.ProfileBlock, conf.ProfileCPU, conf.ProfileHeap, conf.ProfileMutex, conf.TraceFile} {
fi, err := os.Stat(name)
if err != nil {
t.Fatalf("Unable to stat profile file %s: %v", name, err)
}
if fi.Size() == 0 {
t.Errorf("Profile file %s is empty: %+v", name, fi)
}
}
}
// TestProfileLive checks that live CPU and Heap profiling on a running sandbox.
func TestProfileLive(t *testing.T) {
spec, conf := sleepSpecConf(t)
conf.ProfileEnable = true
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Test live CPU profiling (runsc profile cpu).
cpuFile, err := os.Create(filepath.Join(t.TempDir(), "live_cpu.pprof"))
if err != nil {
t.Fatalf("creating cpu file: %v", err)
}
defer cpuFile.Close()
if err := cont.Sandbox.CPUProfile(cpuFile, 500*time.Millisecond); err != nil {
t.Fatalf("CPUProfile: %v", err)
}
fi, err := cpuFile.Stat()
if err != nil {
t.Fatalf("stat cpu file: %v", err)
}
if fi.Size() == 0 {
t.Errorf("live CPU profile file is empty")
}
// Test live Heap profiling (runsc profile heap).
heapFile, err := os.Create(filepath.Join(t.TempDir(), "live_heap.pprof"))
if err != nil {
t.Fatalf("creating heap file: %v", err)
}
defer heapFile.Close()
if err := cont.Sandbox.HeapProfile(heapFile, 0); err != nil {
t.Fatalf("HeapProfile: %v", err)
}
fi, err = heapFile.Stat()
if err != nil {
t.Fatalf("stat heap file: %v", err)
}
if fi.Size() == 0 {
t.Errorf("live Heap profile file is empty")
}
// Test live Goroutine profiling (runsc profile goroutine).
goroutineFile, err := os.Create(filepath.Join(t.TempDir(), "live_goroutine.txt"))
if err != nil {
t.Fatalf("creating goroutine file: %v", err)
}
defer goroutineFile.Close()
if err := cont.Sandbox.GoroutineProfile(goroutineFile); err != nil {
t.Fatalf("GoroutineProfile: %v", err)
}
fi, err = goroutineFile.Stat()
if err != nil {
t.Fatalf("stat goroutine file: %v", err)
}
if fi.Size() == 0 {
t.Errorf("live Goroutine profile file is empty")
}
// Test live Block profiling (runsc profile block).
blockFile, err := os.Create(filepath.Join(t.TempDir(), "live_block.pprof"))
if err != nil {
t.Fatalf("creating block file: %v", err)
}
defer blockFile.Close()
if err := cont.Sandbox.BlockProfile(blockFile, 500*time.Millisecond); err != nil {
t.Fatalf("BlockProfile: %v", err)
}
fi, err = blockFile.Stat()
if err != nil {
t.Fatalf("stat block file: %v", err)
}
if fi.Size() == 0 {
t.Errorf("live Block profile file is empty")
}
// Test live Mutex profiling (runsc profile mutex).
mutexFile, err := os.Create(filepath.Join(t.TempDir(), "live_mutex.pprof"))
if err != nil {
t.Fatalf("creating mutex file: %v", err)
}
defer mutexFile.Close()
if err := cont.Sandbox.MutexProfile(mutexFile, 500*time.Millisecond); err != nil {
t.Fatalf("MutexProfile: %v", err)
}
fi, err = mutexFile.Stat()
if err != nil {
t.Fatalf("stat mutex file: %v", err)
}
if fi.Size() == 0 {
t.Errorf("live Mutex profile file is empty")
}
// Test live Trace profiling (runsc profile trace).
traceFile, err := os.Create(filepath.Join(t.TempDir(), "live_trace.out"))
if err != nil {
t.Fatalf("creating trace file: %v", err)
}
defer traceFile.Close()
if err := cont.Sandbox.Trace(traceFile, 500*time.Millisecond); err != nil {
t.Fatalf("Trace: %v", err)
}
fi, err = traceFile.Stat()
if err != nil {
t.Fatalf("stat trace file: %v", err)
}
if fi.Size() == 0 {
t.Errorf("live Trace profile file is empty")
}
}
// TestSaveSystemdCgroup emulates a sandbox saving while configured with the
// systemd cgroup driver.
func TestSaveSystemdCgroup(t *testing.T) {
spec, conf := sleepSpecConf(t)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
cont.CompatCgroup = cgroup.CgroupJSON{Cgroup: cgroup.CreateMockSystemdCgroup()}
if err := cont.Saver.lock(BlockAcquire); err != nil {
t.Fatalf("cannot lock container metadata file: %v", err)
}
if err := cont.saveLocked(); err != nil {
t.Fatalf("error saving cgroup: %v", err)
}
cont.Saver.unlock()
loadCont := Container{}
cont.Saver.load(&loadCont, LoadOpts{})
if !reflect.DeepEqual(cont.CompatCgroup, loadCont.CompatCgroup) {
t.Errorf("CompatCgroup not properly saved: want %v, got %v", cont.CompatCgroup, loadCont.CompatCgroup)
}
}
// TestSandboxCommunicationUnshare checks that communication with sandboxes do
// not require being in the same network namespace. This is required to allow
// Kubernetes daemonsets/containers to communicate with sandboxes without the
// need to join the host network namespaces.
func TestSandboxCommunicationUnshare(t *testing.T) {
spec, conf := sleepSpecConf(t)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("Creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("starting container: %v", err)
}
runtime.LockOSThread()
defer runtime.UnlockOSThread()
if err := unix.Unshare(unix.CLONE_NEWNET); err != nil {
t.Fatalf("unix.Unshare(): %v", err)
}
// Send a simple command to test that the sandbox can be reached.
if err := cont.SignalContainer(0, true); err != nil {
t.Errorf("SignalContainer(): %v", err)
}
}
// writeAndReadFromPipe writes the bytes to the write end of the pipe, then
// reads from the read end and returns the result.
func writeAndReadFromPipe(write, read *os.File, msg string) (string, error) {
// Write the message to be read by the guest.
if _, err := io.StringWriter(write).WriteString(msg); err != nil {
return "", fmt.Errorf("failed to write message to pipe: %w", err)
}
write.Close()
// Read and return the message.
response, err := io.ReadAll(read)
if err != nil {
return "", fmt.Errorf("failed to read from pipe: %w", err)
}
read.Close()
return string(response), nil
}
func createPipes() (*os.File, *os.File, *os.File, *os.File, func(), error) {
// This is the first pipe which the host writes to and the guest reads
// from.
guestRead, hostWrite, err := os.Pipe()
if err != nil {
return nil, nil, nil, nil, nil, err
}
// This is the second pipe which the guest writes to and the host reads
// from.
hostRead, guestWrite, err := os.Pipe()
if err != nil {
guestRead.Close()
hostWrite.Close()
return nil, nil, nil, nil, nil, err
}
cleanup := func() {
guestRead.Close()
hostWrite.Close()
hostRead.Close()
guestWrite.Close()
}
return guestRead, hostWrite, hostRead, guestWrite, cleanup, nil
}
// TestFDPassingRun checks that file descriptors passed into a new container
// work as expected.
func TestFDPassingRun(t *testing.T) {
guestRead, hostWrite, hostRead, guestWrite, cleanup, err := createPipes()
if err != nil {
t.Fatalf("error creating pipes: %v", err)
}
defer cleanup()
// In the guest, read from the host and write the result back to the host.
conf := testutil.TestConfig(t)
cmd := fmt.Sprintf("cat /proc/self/fd/%d > /proc/self/fd/%d", int(guestRead.Fd()), int(guestWrite.Fd()))
spec := testutil.NewSpecWithArgs("bash", "-c", cmd)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
PassFiles: map[int]*os.File{
int(guestRead.Fd()): guestRead,
int(guestWrite.Fd()): guestWrite,
},
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("Creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("starting container: %v", err)
}
// We close guestWrite here because it has been passed into the container.
// If we do not close it, we will never see an EOF.
guestWrite.Close()
msg := "hello"
got, err := writeAndReadFromPipe(hostWrite, hostRead, msg)
if err != nil {
t.Fatal(err)
}
if got != msg {
t.Errorf("got message %q, want %q", got, msg)
}
}
// TestFDPassingExec checks that file descriptors passed into an already
// running container work as expected.
func TestFDPassingExec(t *testing.T) {
guestRead, hostWrite, hostRead, guestWrite, cleanup, err := createPipes()
if err != nil {
t.Fatalf("error creating pipes: %v", err)
}
defer cleanup()
// We just sleep here because we want to test file descriptor passing
// inside a process executed inside an already running container.
spec, conf := sleepSpecConf(t)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("Creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("starting container: %v", err)
}
// Prepare executing a command in the running container.
cmd := fmt.Sprintf("cat /proc/self/fd/%d > /proc/self/fd/%d", int(guestRead.Fd()), int(guestWrite.Fd()))
execArgs := &control.ExecArgs{
Argv: []string{"/bin/bash", "-c", cmd},
FilePayload: control.NewFilePayload(map[int]*os.File{
int(guestRead.Fd()): guestRead,
int(guestWrite.Fd()): guestWrite,
}, nil),
}
if _, err = cont.Execute(conf, execArgs); err != nil {
t.Fatalf("Failed to execute command: %v", err)
}
// We close guestWrite here because it has been passed into the container.
// If we do not close it, we will never see an EOF.
guestWrite.Close()
msg := "hello"
got, err := writeAndReadFromPipe(hostWrite, hostRead, msg)
if err != nil {
t.Fatal(err)
}
if got != msg {
t.Errorf("got message %q, want %q", got, msg)
}
}
// findInPath finds a filename in the PATH environment variable.
func findInPath(filename string) string {
for _, dir := range strings.Split(os.Getenv("PATH"), ":") {
fullPath := filepath.Join(dir, filename)
if _, err := os.Stat(fullPath); err == nil {
return fullPath
}
}
return ""
}
// TestExecFDRun checks that an executable from the host can be started inside
// a container.
func TestExecFDRun(t *testing.T) {
// In the guest, read from the host and write the result back to the host.
conf := testutil.TestConfig(t)
// Note that we do not supply the name or path of the echo binary here.
// Thus, the guest does not know the binary path or name either.
// argv[0] inside echo is "can be anything".
spec := testutil.NewSpecWithArgs("can be anything", "hello world")
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Find the echo binary on the host.
echoPath := findInPath("echo")
if echoPath == "" {
t.Fatalf("failed to find echo executable in PATH")
}
// Open the echo binary as a file.
echoFile, err := os.Open(echoPath)
if err != nil {
t.Fatalf("opening echo binary: %v", err)
}
defer echoFile.Close()
r, w, err := os.Pipe()
if err != nil {
t.Fatalf("creating pipe: %v", err)
}
defer r.Close()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
PassFiles: map[int]*os.File{
0: os.Stdin, 1: w, 2: w,
},
ExecFile: echoFile,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("Creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("starting container: %v", err)
}
w.Close()
got, err := io.ReadAll(r)
if err != nil {
t.Errorf("reading container output: %v", err)
}
if want := "hello world\n"; string(got) != want {
t.Errorf("got message %q, want %q", got, want)
}
}
// TestExecFDExec checks that an executable from the host can be started from a
// file descriptor inside an already running container.
func TestExecFDExec(t *testing.T) {
// We just sleep here because we want to test execution in an already
// running container.
spec, conf := sleepSpecConf(t)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("Creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("starting container: %v", err)
}
// Find the echo binary on the host.
echoPath := findInPath("echo")
if echoPath == "" {
t.Fatalf("failed to find echo executable in PATH")
}
// Open the echo binary as a file.
echoFile, err := os.Open(echoPath)
if err != nil {
t.Fatalf("opening echo binary: %v", err)
}
defer echoFile.Close()
// Note that we do not supply the name or path of the echo binary here.
// Thus, the guest does not know the binary path or name either.
// argv[0] inside echo is "can be anything".
got, err := executeCombinedOutput(conf, cont, echoFile, "can be anything", "hello world")
if err != nil {
t.Fatal(err)
}
if want := "hello world\n"; string(got) != want {
t.Errorf("echo result, got: %q, want: %q", got, want)
}
}
// skipIfNotAvailable skips the test if the requested executable files are not available.
func skipIfNotAvailable(t *testing.T, files ...string) {
for _, f := range files {
if _, err := exec.LookPath(f); err != nil {
t.Skipf("%v is not available: %v", f, err)
}
}
}
// createImageEROFS creates the EROFS image from the source directory using the requested options.
func createImageEROFS(image, source string, options ...string) error {
mkfs, err := exec.LookPath("mkfs.erofs")
if err != nil {
return fmt.Errorf("mkfs.erofs is not available: %v", err)
}
cmd := fmt.Sprintf("%s %s %s %s", mkfs, strings.Join(options, " "), image, source)
if out, err := exec.Command("/bin/sh", "-c", cmd).CombinedOutput(); err != nil {
return fmt.Errorf("exec: sh -c %q, err: %v, out: %s", cmd, err, out)
}
return nil
}
// erofsImageInfo contains information about a created EROFS image.
type erofsImageInfo struct {
name string
options string
path string
}
// erofsTestEnv holds the environment details for EROFS tests.
type erofsTestEnv struct {
scriptFile string
checksums string
images []erofsImageInfo
}
// setupEROFS creates a temporary directory with some random files and EROFS images.
// It returns a test environment struct containing the directory paths and images,
// a cleanup function that must be called to remove the temporary files, and an error.
func setupEROFS() (*erofsTestEnv, func(), error) {
// Create a temporary directory to save the test files.
testDir, err := os.MkdirTemp(testutil.TmpDir(), "erofs_mount_test_")
if err != nil {
return nil, nil, fmt.Errorf("os.MkdirTemp() failed: %v", err)
}
cu := cleanup.Make(func() {
os.RemoveAll(testDir)
})
defer cu.Clean()
// Create a temporary directory with some random files in it, which will
// be used as the source directory to create the EROFS images.
sourceDir := filepath.Join(testDir, "source")
if err := os.Mkdir(sourceDir, 0755); err != nil {
return nil, nil, fmt.Errorf("os.Mkdir() failed: %v", err)
}
// Create some files with leading non-alphanumeric characters in name. It's helpful
// to verify the on-disk directory entries order.
for _, c := range []byte("!#$%&()*+,-:;<=>?@[]^_`{|}~") {
name := fmt.Sprintf("%s/%c_file", sourceDir, c)
// Create the file with random data.
if err := os.WriteFile(name, []byte(fmt.Sprintf("%v", rand.Uint64())), 0644); err != nil {
return nil, nil, fmt.Errorf("error creating %q: %v", name, err)
}
}
testApp, err := testutil.FindFile("test/cmd/test_app/test_app")
if err != nil {
return nil, nil, fmt.Errorf("error finding test_app: %v", err)
}
// Source directory is a small directory. Let's create a big directory in it.
// So we can cover both cases.
cmd := fmt.Sprintf("%s fsTreeCreate --target-dir=%s --create-symlink --depth=1 --file-per-level=500 --file-size=5000", testApp, filepath.Join(sourceDir, "big-directory"))
if out, err := exec.Command("/bin/sh", "-c", cmd).CombinedOutput(); err != nil {
return nil, nil, fmt.Errorf("exec: sh -c %q, err: %v, out: %s", cmd, err, out)
}
// Create a test script which can be used to get the checksums
// from a specified directory.
scriptFile := filepath.Join(testDir, "test-script")
if err := os.WriteFile(scriptFile, []byte(`#!/bin/bash
set -u -e -o pipefail
dir=$1
find $dir -printf "%P\n" | sort | md5sum
find $dir -type l | sort | xargs -L 1 readlink | md5sum
find $dir -type l -o -type f | sort | xargs cat | md5sum`), 0755); err != nil {
return nil, nil, fmt.Errorf("os.WriteFile() failed: %v", err)
}
// Get the checksums from the source directory on the host.
var checksums string
if out, err := exec.Command(scriptFile, sourceDir).CombinedOutput(); err != nil {
return nil, nil, fmt.Errorf("exec: %s %s, err: %v, out: %s", scriptFile, sourceDir, err, out)
} else {
checksums = string(out)
}
images := []struct {
name string
options string
}{
{
// Generate extended inodes. Inline regular files if possible.
name: "image1",
options: "-E force-inode-extended",
},
{
// Generate extended inodes. Do not inline regular files.
name: "image2",
options: "-E force-inode-extended -E noinline_data",
},
{
// Generate compact inodes. Inline regular files if possible.
name: "image3",
options: "-E force-inode-compact",
},
{
// Generate compact inodes. Do not inline regular files.
name: "image4",
options: "-E force-inode-compact -E noinline_data",
},
}
var resultImages []erofsImageInfo
// Create the EROFS images.
for _, i := range images {
imagePath := filepath.Join(testDir, i.name)
if err := createImageEROFS(imagePath, sourceDir, i.options); err != nil {
return nil, nil, fmt.Errorf("error creating EROFS image: %v", err)
}
resultImages = append(resultImages, erofsImageInfo{
name: i.name,
options: i.options,
path: imagePath,
})
}
return &erofsTestEnv{
scriptFile: scriptFile,
checksums: checksums,
images: resultImages,
}, cu.Release(), nil
}
// TestMountEROFS checks that the checksums from the target directory in the container
// are identical with the ones from the source directory on the host.
func TestMountEROFS(t *testing.T) {
// Skip this test if mkfs.erofs is not available.
skipIfNotAvailable(t, "mkfs.erofs")
env, cleanup, err := setupEROFS()
if err != nil {
t.Fatalf("setupEROFS failed: %v", err)
}
defer cleanup()
spec, conf := sleepSpecConf(t)
_, bundleDir, cleanupContainer, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanupContainer()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// When running this test inside a user namespace without host root mapped, like bazel is wont to
// do, /bin/umount appears as a setuid binary owned by (host) overflow-uid inside the container,
// and thus would rob the execing process of its exalted (sandbox) root EUID. So we make a copy.
copiedUmount := filepath.Join(testutil.TmpDir(), "umount")
if out, err := executeCombinedOutput(conf, c, nil,
"/bin/cp", "/bin/umount", copiedUmount); err != nil {
t.Fatalf("Failed to copy /bin/umount; err: %v, out: %s", err, out)
}
targetDir := "/mnt"
for _, i := range env.images {
// Mount the EROFS image in the container.
if err := c.Sandbox.Mount(c.ID, erofs.Name, i.path, targetDir); err != nil {
t.Fatalf("error mounting EROFS image %q at %q, err: %v", i.path, targetDir, err)
}
// Get the checksums from the target directory in the container, and check if they are
// identical with the ones got from the source directory on the host.
if out, err := executeCombinedOutput(conf, c, nil, env.scriptFile, targetDir); err != nil {
t.Fatalf("exec: %s %s, err: %v, out: %s", env.scriptFile, targetDir, err, out)
} else if env.checksums != string(out) {
t.Errorf("checksums do not match, got: %s from %s, expected: %s", out, i.path, env.checksums)
}
// Unmount the EROFS image in the container.
if out, err := executeCombinedOutput(conf, c, nil, copiedUmount, targetDir); err != nil {
t.Fatalf("exec: umount %q, err: %v, out: %s", targetDir, err, out)
}
}
}
// TestMountEROFSConfig checks that the checksums from the target directory in the container
// are identical with the ones from the source directory on the host.
// This test verifies EROFS mounts specified in config.json.
func TestMountEROFSConfig(t *testing.T) {
// Skip this test if mkfs.erofs is not available.
skipIfNotAvailable(t, "mkfs.erofs")
env, cleanup, err := setupEROFS()
if err != nil {
t.Fatalf("setupEROFS failed: %v", err)
}
defer cleanup()
targetDir := "/mnt"
for _, i := range env.images {
t.Run(i.name, func(t *testing.T) {
spec, conf := sleepSpecConf(t)
// Add EROFS mount to spec.
spec.Mounts = append(spec.Mounts, specs.Mount{
Source: i.path,
Destination: targetDir,
Type: erofs.Name,
Options: []string{"ro"},
})
_, bundleDir, cleanupContainer, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanupContainer()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Get the checksums from the target directory in the container, and check if they are
// identical with the ones got from the source directory on the host.
if out, err := executeCombinedOutput(conf, c, nil, env.scriptFile, targetDir); err != nil {
t.Fatalf("exec: %s %s, err: %v, out: %s", env.scriptFile, targetDir, err, out)
} else if env.checksums != string(out) {
t.Errorf("checksums do not match, got: %s from %s, expected: %s", out, i.path, env.checksums)
}
})
}
}
// createRootfsEROFS creates a rootfs directory and an EROFS rootfs image in
// the directory dir.
func createRootfsEROFS(dir string) (string, string, error) {
// Create a rootfs directory with busybox in root.
rootfsDir := filepath.Join(dir, "rootfs")
if err := os.Mkdir(rootfsDir, 0755); err != nil {
return "", "", fmt.Errorf("os.Mkdir() failed: %v", err)
}
busybox, err := exec.LookPath("busybox")
if err != nil {
return "", "", fmt.Errorf("busybox is not available: %v", err)
}
if err := testutil.Copy(busybox, filepath.Join(rootfsDir, "busybox")); err != nil {
return "", "", fmt.Errorf("failed to copy busybox: %v", err)
}
// Handcraft the following mount points that the sentry mounts need, because EROFS
// does not support creating synthetic directories yet and we may not want to use
// overlay in some tests.
for _, dir := range []string{"data", "dev", "proc", "sys", "tmp"} {
if err := os.Mkdir(filepath.Join(rootfsDir, dir), 0755); err != nil {
return "", "", fmt.Errorf("os.Mkdir() failed: %v", err)
}
}
// Build the EROFS rootfs image.
rootfsImage := filepath.Join(dir, "rootfs.img")
if err := createImageEROFS(rootfsImage, rootfsDir, "-E noinline_data"); err != nil {
return "", "", fmt.Errorf("error creating EROFS image: %v", err)
}
return rootfsDir, rootfsImage, nil
}
// TestRootfsEROFS starts a container using an EROFS image as the rootfs and checks that
// the rootfs in the container is an EROFS.
func TestRootfsEROFS(t *testing.T) {
// Skip this test if mkfs.erofs or busybox are not available.
skipIfNotAvailable(t, "mkfs.erofs", "busybox")
testDir, err := os.MkdirTemp(testutil.TmpDir(), "erofs_rootfs_test_")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
defer os.RemoveAll(testDir)
rootfsDir, rootfsImage, err := createRootfsEROFS(testDir)
if err != nil {
t.Fatalf("failed to create EROFS rootfs image: %v", err)
}
// Create the spec and set the EROFS rootfs annotations.
spec := testutil.NewSpecWithArgs("/busybox", "grep", "/ / ro - erofs", "/proc/self/mountinfo")
spec.Root.Path = rootfsDir
if spec.Annotations == nil {
spec.Annotations = make(map[string]string)
}
spec.Annotations[boot.RootfsPrefix+"type"] = erofs.Name
spec.Annotations[boot.RootfsPrefix+"source"] = rootfsImage
// Disable the overlay, as we want to be sure that rootfs will always be
// shown as EROFS in mountinfo.
spec.Annotations[boot.RootfsPrefix+"overlay"] = config.NoOverlay.String()
conf := testutil.TestConfig(t)
mountDir, err := os.MkdirTemp(testutil.TmpDir(), "mount_dir")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
defer os.RemoveAll(mountDir)
for _, mounts := range [][]specs.Mount{
// Case 1: EROFS rootfs without any other gofer mount.
nil,
// Case 2: EROFS rootfs with a LISAFS backed gofer mount.
{
{
Type: "bind",
Destination: "/tmp",
Source: mountDir,
},
},
// Case 3: EROFS rootfs with an EROFS backed config mount. This stays
// in goferless mode and requires donating both EROFS image FDs.
{
{
Type: erofs.Name,
Destination: "/data",
Source: rootfsImage,
Options: []string{"ro"},
},
},
} {
spec.Mounts = mounts
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
Attached: true,
}
ws, err := Run(conf, args)
if err != nil {
t.Fatalf("error running container: %v", err)
}
if ws.ExitStatus() != 0 {
t.Errorf("got exit status %v want %v", ws.ExitStatus(), 0)
}
}
}
// TestCheckpointRestoreEROFS does the checkpoint/restore test on each platform using
// an EROFS image as the rootfs.
func TestCheckpointRestoreEROFS(t *testing.T) {
// Skip this test if mkfs.erofs or busybox are not available.
skipIfNotAvailable(t, "mkfs.erofs", "busybox")
testDir, err := os.MkdirTemp(testutil.TmpDir(), "erofs_checkpoint_restore_test_")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
defer os.RemoveAll(testDir)
rootfsDir, rootfsImage, err := createRootfsEROFS(testDir)
if err != nil {
t.Fatalf("failed to create EROFS rootfs image: %v", err)
}
// Skip overlay because test requires writing to host file.
for name, conf := range configs(t, true /* noOverlay */) {
t.Run(name, func(t *testing.T) {
testCheckpointRestore(t, conf, statefile.CompressionLevelDefault, func(script string) *specs.Spec {
spec := testutil.NewSpecWithArgs("/busybox", "sh", "-c", script)
spec.Root = &specs.Root{
Path: rootfsDir,
Readonly: false,
}
if spec.Annotations == nil {
spec.Annotations = make(map[string]string)
}
spec.Annotations[boot.RootfsPrefix+"type"] = erofs.Name
spec.Annotations[boot.RootfsPrefix+"source"] = rootfsImage
// EROFS does not support creating synthetic directories yet, so let's add
// a writeable and savable overlay for rootfs, which allows the sentry to
// create the mount point for the bind mount of the temporary directory shared
// between host and test container.
spec.Annotations[boot.RootfsPrefix+"overlay"] = config.MemoryOverlay.String()
return spec
})
})
}
}
// TestLookupEROFS reads the files in EROFS images, which contain some random files,
// and checks if the data is as expected.
func TestLookupEROFS(t *testing.T) {
// Skip this test if mkfs.erofs is not available.
skipIfNotAvailable(t, "mkfs.erofs")
// Create a temporary directory to save the test files.
testDir, err := os.MkdirTemp(testutil.TmpDir(), "erofs_lookup_test_")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
defer os.RemoveAll(testDir)
spec, conf := sleepSpecConf(t)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
c, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer c.Destroy()
if err := c.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
tcs := []struct {
name string
size int
}{
{
name: "tiny",
size: 1,
},
{
name: "small",
size: 10,
},
{
name: "medium",
size: 100,
},
{
name: "large",
size: 1000,
},
}
targetDir := "/mnt"
for _, tc := range tcs {
// Add some randomness to the number of files.
size := tc.size + rand.Intn(tc.size)
// Create a temporary directory with some random files in it, which will
// be used as the source directory to create the EROFS image.
sourceDir := filepath.Join(testDir, tc.name)
if err := os.Mkdir(sourceDir, 0755); err != nil {
t.Fatalf("os.Mkdir() failed: %v", err)
}
randomFiles := make([]string, 0, size)
for i := 0; i < size; i++ {
file, err := os.CreateTemp(sourceDir, "")
if err != nil {
t.Fatalf("os.CreateTemp() failed: %v", err)
}
name := filepath.Base(file.Name())
if _, err := file.Write([]byte(name)); err != nil {
t.Fatalf("file.Write() failed: %v", err)
}
file.Close()
randomFiles = append(randomFiles, name)
}
// Create the EROFS image.
imageFile := filepath.Join(testDir, fmt.Sprintf("%s.img", tc.name))
if err := createImageEROFS(imageFile, sourceDir); err != nil {
t.Fatalf("error creating EROFS image: %v", err)
}
// Mount the EROFS image in the container.
if err := c.Sandbox.Mount(c.ID, erofs.Name, imageFile, targetDir); err != nil {
t.Fatalf("error mounting EROFS image %q at %q, err: %v", imageFile, targetDir, err)
}
// Read the files in the EROFS image and check if the data is as expected.
for i, inc := 0, max(size/100, 1); i < size; i += inc {
targetFile := randomFiles[i]
cmd := fmt.Sprintf("cat %s", filepath.Join(targetDir, targetFile))
if out, err := executeCombinedOutput(conf, c, nil, "/bin/sh", "-c", cmd); err != nil {
t.Fatalf("exec: sh -c %q, err: %v, out: %s", cmd, err, out)
} else if targetFile != string(out) {
t.Errorf("file does not match, got: %s, expected: %s", out, targetFile)
}
}
// Test for the read failure with a non-existent file.
cmd := fmt.Sprintf("cat %s", filepath.Join(targetDir, "nonexist"))
if out, err := executeCombinedOutput(conf, c, nil, "/bin/sh", "-c", cmd); err == nil {
t.Errorf("exec: sh -c %q, succeeded to read the non-existent file: %s", cmd, out)
}
// Unmount the EROFS image in the container.
if out, err := executeCombinedOutput(conf, c, nil, "/bin/umount", targetDir); err != nil {
t.Fatalf("exec: umount %q, err: %v, out: %s", targetDir, err, out)
}
}
}
func int64Ptr(v int64) *int64 {
return &v
}
func TestSpecValidation(t *testing.T) {
tests := []struct {
name string
mutate func(spec, restoreSpec *specs.Spec, mountPath, restoreMntPath string)
wantErr string
}{
{
name: "Terminal",
mutate: func(_, restoreSpec *specs.Spec, _, _ string) {
restoreSpec.Process.Terminal = true
},
wantErr: "\"Terminal\" does not match across checkpoint restore",
},
{
name: "Args",
mutate: func(_, restoreSpec *specs.Spec, _, _ string) {
restoreSpec.Process.Args = append(restoreSpec.Process.Args, "new arg")
},
wantErr: "\"Args\" does not match across checkpoint restore",
},
{
name: "Device",
mutate: func(spec, restoreSpec *specs.Spec, _, _ string) {
spec.Linux = &specs.Linux{}
restoreSpec.Linux = &specs.Linux{}
mode := os.FileMode(0666)
dev := specs.LinuxDevice{
Path: "/dev/something",
Type: "c",
Major: 100,
Minor: 100,
FileMode: &mode,
}
restoreSpec.Linux.Devices = append(restoreSpec.Linux.Devices, dev)
},
wantErr: "\"Devices\" does not match across checkpoint restore",
},
{
name: "NamespaceFail",
mutate: func(spec, restoreSpec *specs.Spec, _, _ string) {
spec.Linux = &specs.Linux{}
restoreSpec.Linux = &specs.Linux{}
restoreSpec.Linux.Namespaces = append(restoreSpec.Linux.Namespaces, specs.LinuxNamespace{
Type: "network",
Path: fmt.Sprintf("/proc/%d/ns/net", os.Getpid()),
})
},
wantErr: "\"Namespace\" does not match across checkpoint restore",
},
{
name: "NamespaceSuccess",
mutate: func(spec, restoreSpec *specs.Spec, _, _ string) {
spec.Linux = &specs.Linux{}
spec.Linux.Namespaces = append(spec.Linux.Namespaces, specs.LinuxNamespace{
Type: "network",
Path: fmt.Sprintf("/proc/%d/ns/net1", os.Getpid()),
})
restoreSpec.Linux = &specs.Linux{}
restoreSpec.Linux.Namespaces = append(restoreSpec.Linux.Namespaces, specs.LinuxNamespace{
Type: "network",
Path: fmt.Sprintf("/proc/%d/ns/net2", os.Getpid()),
})
},
wantErr: "",
},
{
name: "Seccomp",
mutate: func(spec, restoreSpec *specs.Spec, _, _ string) {
spec.Linux = &specs.Linux{}
restoreSpec.Linux = &specs.Linux{}
restoreSpec.Linux.Seccomp = &specs.LinuxSeccomp{
DefaultAction: specs.ActAllow,
}
},
wantErr: "\"Seccomp\" does not match across checkpoint restore",
},
{
name: "RestoreDupMountsSuccess",
mutate: func(spec, restoreSpec *specs.Spec, mountPath, restoreMntPath string) {
mnt := specs.Mount{
Source: mountPath,
Destination: mountPath,
Type: "tmpfs",
}
spec.Mounts = append(spec.Mounts, mnt)
restoreMnt := specs.Mount{
Source: restoreMntPath,
Destination: mountPath,
Type: "tmpfs",
}
restoreSpec.Mounts = append(restoreSpec.Mounts, restoreMnt)
restoreSpec.Mounts = append(restoreSpec.Mounts, restoreMnt)
},
wantErr: "",
},
{
name: "RestoreDupMountsFail",
mutate: func(spec, restoreSpec *specs.Spec, mountPath, restoreMntPath string) {
mnt := specs.Mount{
Source: mountPath,
Destination: mountPath,
Type: "tmpfs",
}
spec.Mounts = append(spec.Mounts, mnt)
restoreMnt := specs.Mount{
Source: restoreMntPath,
Destination: mountPath,
Type: "tmpfs",
}
restoreSpec.Mounts = append(restoreSpec.Mounts, restoreMnt)
restoreMnt.Source = restoreMntPath + "2"
restoreSpec.Mounts = append(restoreSpec.Mounts, restoreMnt)
},
wantErr: "invalid mount",
},
{
name: "RestoreMountsFail",
mutate: func(spec, restoreSpec *specs.Spec, mountPath, restoreMntPath string) {
mnt := specs.Mount{
Source: mountPath,
Destination: mountPath,
Type: "tmpfs",
}
spec.Mounts = append(spec.Mounts, mnt)
restoreMnt := specs.Mount{
Source: restoreMntPath,
Destination: restoreMntPath,
Type: "tmpfs",
}
restoreSpec.Mounts = append(restoreSpec.Mounts, restoreMnt)
},
wantErr: "\"Mounts\" does not match across checkpoint restore",
},
{
name: "AnnotationsMountsSuccess",
mutate: func(spec, restoreSpec *specs.Spec, _, _ string) {
spec.Annotations = make(map[string]string)
spec.Annotations["dev.gvisor.spec.mount.mnt1.source"] = "path1"
restoreSpec.Annotations = make(map[string]string)
restoreSpec.Annotations["dev.gvisor.spec.mount.mnt2.source"] = "path2"
},
wantErr: "",
},
{
name: "AnnotationsContainerNameRemapIgnored",
mutate: func(spec, restoreSpec *specs.Spec, _, _ string) {
spec.Annotations = make(map[string]string)
spec.Annotations["dev.gvisor.container-name-remap.1"] = "name1"
restoreSpec.Annotations = make(map[string]string)
restoreSpec.Annotations["dev.gvisor.container-name-remap.1"] = "name2"
restoreSpec.Annotations["dev.gvisor.container-name-remap.asdf"] = "foobar"
},
wantErr: "",
},
{
name: "AnnotationsFail",
mutate: func(spec, restoreSpec *specs.Spec, _, _ string) {
spec.Annotations = make(map[string]string)
spec.Annotations["dev.gvisor.flag.net-disconnect-ok"] = strconv.FormatBool(true)
},
wantErr: "\"Annotations\" does not match across checkpoint restore",
},
{
name: "InternalAnnotationsSuccess",
mutate: func(spec, restoreSpec *specs.Spec, _, _ string) {
spec.Annotations = make(map[string]string)
spec.Annotations["dev.gvisor.internal.foo"] = "foo"
restoreSpec.Annotations = make(map[string]string)
restoreSpec.Annotations["dev.gvisor.internal.foo"] = "bar"
},
wantErr: "",
},
{
name: "DebugLogAnnotationsSuccess",
mutate: func(spec, restoreSpec *specs.Spec, _, _ string) {
restoreSpec.Annotations = make(map[string]string)
restoreSpec.Annotations["dev.gvisor.flag.debug-log"] = "/tmp/sandbox-%ID%/"
restoreSpec.Annotations["dev.gvisor.flag.debug"] = "true"
restoreSpec.Annotations["dev.gvisor.flag.debug-command"] = "boot,gofer,start,create"
restoreSpec.Annotations["dev.gvisor.flag.strace"] = "true"
},
wantErr: "",
},
{
name: "Capabilities",
mutate: func(spec, restoreSpec *specs.Spec, _, _ string) {
restoreSpec.Process.Capabilities.Bounding = append(restoreSpec.Process.Capabilities.Bounding, "CAP_NET_RAW")
},
wantErr: "\"Capabilities.Bounding\" does not match across checkpoint restore",
},
{
name: "Resources",
mutate: func(spec, restoreSpec *specs.Spec, _, _ string) {
spec.Linux = &specs.Linux{
Resources: &specs.LinuxResources{
Memory: &specs.LinuxMemory{
Limit: int64Ptr(1),
Swap: int64Ptr(2),
Reservation: int64Ptr(3),
},
},
}
restoreSpec.Linux = &specs.Linux{
Resources: &specs.LinuxResources{
Memory: &specs.LinuxMemory{
Limit: int64Ptr(1),
Swap: int64Ptr(2),
Reservation: int64Ptr(5),
},
},
}
},
wantErr: "",
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
spec, _ := sleepSpecConf(t)
mountDir, err := os.MkdirTemp(testutil.TmpDir(), "mount-test")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
if err := os.Chmod(mountDir, 0777); err != nil {
t.Fatalf("error chmoding file: %q, %v", mountDir, err)
}
defer os.RemoveAll(mountDir)
mountPath := filepath.Join(mountDir, "/foo-dir")
restoreSpec, _ := sleepSpecConf(t)
restoreDir, err := os.MkdirTemp(testutil.TmpDir(), "restore-test")
if err != nil {
t.Fatalf("os.MkdirTemp() failed: %v", err)
}
if err := os.Chmod(restoreDir, 0777); err != nil {
t.Fatalf("error chmoding file: %q, %v", restoreDir, err)
}
defer os.RemoveAll(restoreDir)
restoreMntPath := filepath.Join(restoreDir, "/restore-dir")
test.mutate(spec, restoreSpec, mountPath, restoreMntPath)
conf := testutil.TestConfig(t)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Set the image path, which is where the checkpoint image will be saved.
dir, err := os.MkdirTemp(testutil.TmpDir(), "checkpoint")
if err != nil {
t.Fatalf("os.MkdirTemp failed: %v", err)
}
defer os.RemoveAll(dir)
if err := os.Chmod(dir, 0777); err != nil {
t.Fatalf("error chmoding file: %q, %v", dir, err)
}
// Checkpoint running container; save state into new file.
if err := cont.Checkpoint(conf, dir, sandbox.CheckpointOpts{Compression: statefile.CompressionLevelFlateBestSpeed}); err != nil {
t.Fatalf("error checkpointing container to empty file: %v", err)
}
_, bundleDir2, cleanup2, err := testutil.SetupContainer(restoreSpec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup2()
// Restore into a new container with different ID (e.g. clone). Keep the
// initial container running to ensure no conflict with it.
args2 := Args{
ID: testutil.RandomContainerID(),
Spec: restoreSpec,
BundleDir: bundleDir2,
}
cont2, err := New(conf, args2)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont2.Destroy()
err = cont2.Restore(conf, dir, false /* direct */, false /* background */, nil /* networkArgs */)
if err == nil {
if test.wantErr == "" {
return
}
t.Fatalf("spec validation failed for test %v, got: nil, want: %v", test, test.wantErr)
}
got := err.Error()
if !strings.Contains(got, test.wantErr) {
t.Fatalf("wrong error message, got: %v, want: %v", got, test.wantErr)
}
})
}
}
func snapshotRootfsUpperLayer(conf *config.Config, spec *specs.Spec) (string, error) {
app, err := testutil.FindFile("test/cmd/test_app/test_app")
if err != nil {
return "", fmt.Errorf("error finding test_app: %v", err)
}
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
return "", fmt.Errorf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
return "", fmt.Errorf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
return "", fmt.Errorf("error starting container: %v", err)
}
// Exec the command in the container.
execArgs := &control.ExecArgs{
Filename: app,
Argv: []string{app, "fsTreeCreate", "--depth=3", "--file-per-level=2", "--file-size=1470", "--create-symlink", "--add-empty-files"},
}
if ws, err := cont.executeSync(conf, execArgs); err != nil {
return "", fmt.Errorf("error exec'ing: %v", err)
} else if ws.ExitStatus() != 0 {
return "", fmt.Errorf("exec failed with exit status %d", ws.ExitStatus())
}
// Create a temporary file to write the tar bytes to.
tarFile, err := os.CreateTemp(testutil.TmpDir(), "tarfile-*.tar")
if err != nil {
return "", fmt.Errorf("error creating temp file: %v", err)
}
defer tarFile.Close()
if err := cont.TarRootfsUpperLayer(tarFile); err != nil {
return "", fmt.Errorf("error serializing rootfs upper layer to tar: %v", err)
}
return tarFile.Name(), nil
}
func TestTarRootfsUpperLayer(t *testing.T) {
conf := testutil.TestConfig(t)
conf.Overlay2.Set("root:memory")
spec, _ := sleepSpecConf(t)
spec.Root.Readonly = false
tarFile1, err := snapshotRootfsUpperLayer(conf, spec)
if err != nil {
t.Fatalf("error snapshotting rootfs upper layer: %v", err)
}
defer os.Remove(tarFile1)
// List the contents of the tar file using the tar command.
snap1, err := exec.Command("tar", "-tvf", tarFile1).CombinedOutput()
if err != nil {
t.Fatalf("error listing contents of tar file: %v, output: %s", err, snap1)
} else {
t.Logf("contents of tar file: %s", snap1)
}
lineCounts := make(map[string]int)
if err := processSnapBytes(snap1, lineCounts, 1); err != nil {
t.Fatalf("error processing tar file: %v", err)
}
if len(lineCounts) <= 1 {
t.Fatalf("unexpected number of lines in tar file: %d", len(lineCounts))
}
// Add the tar file to the spec annotations and create a new container.
spec.Annotations[specutils.AnnotationRootfsUpperTar] = tarFile1
conf.AllowRootfsTarAnnotation = true
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
newCont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer newCont.Destroy()
if err := newCont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Create a new temporary file to write the tar bytes to.
tarFile2, err := os.CreateTemp(testutil.TmpDir(), "tarfile-*.tar")
if err != nil {
t.Fatalf("error creating temp file: %v", err)
}
defer os.Remove(tarFile2.Name())
defer tarFile2.Close()
if err := newCont.TarRootfsUpperLayer(tarFile2); err != nil {
t.Fatalf("error serializing rootfs upper layer to tar: %v", err)
}
// List the contents of the tar file using the tar command.
snap2, err := exec.Command("tar", "-tvf", tarFile2.Name()).CombinedOutput()
if err != nil {
t.Fatalf("error listing contents of tar file: %v, output: %s", err, snap2)
}
// Check that the tar file contains the same contents as the original tar file.
if err := processSnapBytes(snap2, lineCounts, -1); err != nil {
t.Fatalf("error processing tar file: %v", err)
}
for line, count := range lineCounts {
if count != 0 {
t.Errorf("unexpected diff in tar file: line %q has %d occurrences", line, count)
}
}
}
func processSnapBytes(data []byte, lineCounts map[string]int, increment int) error {
scanner := bufio.NewScanner(bytes.NewReader(data))
for scanner.Scan() {
line := scanner.Text()
lineCounts[line] += increment
}
if err := scanner.Err(); err != nil {
return err
}
return nil
}
// TestTarRootfsUpperLayerOpaqueDir verifies that opaque directory xattrs
// (trusted.overlay.opaque) are preserved across tar serialization and
// restoration. When a directory from the lower layer is deleted and recreated,
// the overlay marks it as opaque so lower layer contents don't show through.
// Without preserving this xattr in the tar, stale files from the lower layer
// would be resurrected after restore.
func TestTarRootfsUpperLayerOpaqueDir(t *testing.T) {
conf := testutil.TestConfig(t)
conf.Overlay2.Set("root:memory")
spec, _ := sleepSpecConf(t)
spec.Root.Readonly = false
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// List the contents of /usr/share before deleting it to confirm it has
// files from the lower layer.
beforeOut, err := executeCombinedOutput(conf, cont, nil, "/bin/ls", "/usr/share")
if err != nil {
t.Fatalf("error listing /usr/share: %v", err)
}
beforeFiles := strings.Fields(strings.TrimSpace(string(beforeOut)))
if len(beforeFiles) == 0 {
t.Fatalf("/usr/share has no files in lower layer, cannot test opaque behavior")
}
t.Logf("/usr/share before delete has %d entries: %v", len(beforeFiles), beforeFiles)
// Delete /usr/share (which exists in the lower layer), recreate it, and
// add a single marker file. The overlay should mark the recreated
// directory as opaque (trusted.overlay.opaque=y).
if _, err := executeCombinedOutput(conf, cont, nil, "/bin/sh", "-c",
"rm -rf /usr/share && mkdir /usr/share && echo opaque_test > /usr/share/marker"); err != nil {
t.Fatalf("error recreating /usr/share: %v", err)
}
// Verify that after the delete+recreate, only the marker file is visible.
afterOut, err := executeCombinedOutput(conf, cont, nil, "/bin/ls", "/usr/share")
if err != nil {
t.Fatalf("error listing /usr/share after recreate: %v", err)
}
afterFiles := strings.Fields(strings.TrimSpace(string(afterOut)))
if len(afterFiles) != 1 || afterFiles[0] != "marker" {
t.Fatalf("expected only 'marker' in /usr/share after recreate, got: %v", afterFiles)
}
// Tar the upper layer.
tarFile, err := os.CreateTemp(testutil.TmpDir(), "tarfile-opaque-*.tar")
if err != nil {
t.Fatalf("error creating temp file: %v", err)
}
defer os.Remove(tarFile.Name())
defer tarFile.Close()
if err := cont.TarRootfsUpperLayer(tarFile); err != nil {
t.Fatalf("error serializing rootfs upper layer to tar: %v", err)
}
// Restore the tar into a new container.
spec.Annotations[specutils.AnnotationRootfsUpperTar] = tarFile.Name()
conf.AllowRootfsTarAnnotation = true
_, bundleDir2, cleanup2, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up restored container: %v", err)
}
defer cleanup2()
args2 := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir2,
}
newCont, err := New(conf, args2)
if err != nil {
t.Fatalf("error creating restored container: %v", err)
}
defer newCont.Destroy()
if err := newCont.Start(conf); err != nil {
t.Fatalf("error starting restored container: %v", err)
}
// Verify that in the restored container, /usr/share only contains
// "marker" and no stale files from the lower layer.
restoredOut, err := executeCombinedOutput(conf, newCont, nil, "/bin/ls", "/usr/share")
if err != nil {
t.Fatalf("error listing /usr/share in restored container: %v", err)
}
restoredFiles := strings.Fields(strings.TrimSpace(string(restoredOut)))
if len(restoredFiles) != 1 || restoredFiles[0] != "marker" {
t.Fatalf("opaque xattr not preserved: expected only 'marker' in /usr/share, got: %v (stale lower layer files leaked through)", restoredFiles)
}
t.Logf("/usr/share in restored container correctly contains only: %v", restoredFiles)
}
// buildACLXattr serializes entries into the system.posix_acl_access /
// system.posix_acl_default xattr wire format (a little-endian version header
// followed by 8-byte entries).
func buildACLXattr(entries []linux.PosixACLXattrEntry) []byte {
x := linux.PosixACLXattr{Version: linux.POSIX_ACL_XATTR_VERSION, Entries: entries}
buf := make([]byte, x.SizeBytes())
x.MarshalBytes(buf)
return buf
}
// TestTarRootfsUpperLayerACL verifies that POSIX ACLs set on files in the overlay's
// tmpfs layer are preserved across tar serialization and restoration.
func TestTarRootfsUpperLayerACL(t *testing.T) {
conf := testutil.TestConfig(t)
conf.Overlay2.Set("root:memory")
spec, _ := sleepSpecConf(t)
spec.Root.Readonly = false
app, err := testutil.FindFile("test/cmd/test_app/test_app")
if err != nil {
t.Fatalf("error finding test_app: %v", err)
}
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Paths in the writable (upper) layer that will receive ACLs.
const (
aclFile = "/acltest-file"
aclDir = "/acltest-dir"
)
// Use ACLs with named users to ensure that the ACL is actually stored as an ACL
// rather than folded into the mode
accessACL := base64.StdEncoding.EncodeToString(buildACLXattr([]linux.PosixACLXattrEntry{
{Tag: linux.ACL_USER_OBJ, Perm: linux.ACL_READ | linux.ACL_WRITE, ID: linux.ACL_UNDEFINED_ID},
{Tag: linux.ACL_USER, Perm: linux.ACL_READ, ID: 1000},
{Tag: linux.ACL_GROUP_OBJ, Perm: linux.ACL_READ, ID: linux.ACL_UNDEFINED_ID},
{Tag: linux.ACL_MASK, Perm: linux.ACL_READ | linux.ACL_WRITE, ID: linux.ACL_UNDEFINED_ID},
{Tag: linux.ACL_OTHER, Perm: linux.ACL_READ, ID: linux.ACL_UNDEFINED_ID},
}))
defaultACL := base64.StdEncoding.EncodeToString(buildACLXattr([]linux.PosixACLXattrEntry{
{Tag: linux.ACL_USER_OBJ, Perm: linux.ACL_READ | linux.ACL_WRITE | linux.ACL_EXECUTE, ID: linux.ACL_UNDEFINED_ID},
{Tag: linux.ACL_USER, Perm: linux.ACL_READ | linux.ACL_EXECUTE, ID: 1001},
{Tag: linux.ACL_GROUP_OBJ, Perm: linux.ACL_READ | linux.ACL_EXECUTE, ID: linux.ACL_UNDEFINED_ID},
{Tag: linux.ACL_MASK, Perm: linux.ACL_READ | linux.ACL_WRITE | linux.ACL_EXECUTE, ID: linux.ACL_UNDEFINED_ID},
{Tag: linux.ACL_OTHER, Perm: 0, ID: linux.ACL_UNDEFINED_ID},
}))
// Create the file and directory in the writable (upper) layer.
if out, err := executeCombinedOutput(conf, cont, nil, "/bin/touch", aclFile); err != nil {
t.Fatalf("error creating ACL test file: %v, output: %s", err, out)
}
if out, err := executeCombinedOutput(conf, cont, nil, "/bin/mkdir", aclDir); err != nil {
t.Fatalf("error creating ACL test directory: %v, output: %s", err, out)
}
// setACL sets an ACL xattr on path via test_app.
setACL := func(path, name, b64 string) {
t.Helper()
if out, err := executeCombinedOutput(conf, cont, nil, app, "setxattr",
"--path="+path, "--name="+name, "--value="+b64); err != nil {
t.Fatalf("error setting %s on %s: %v, output: %s", name, path, err, out)
}
}
// getACL returns the base64-encoded ACL xattr on path in container c.
getACL := func(c *Container, path, name string) string {
t.Helper()
out, err := executeCombinedOutput(conf, c, nil, app, "getxattr",
"--path="+path, "--name="+name)
if err != nil {
t.Fatalf("error getting %s on %s: %v, output: %s", name, path, err, out)
}
return strings.TrimSpace(string(out))
}
setACL(aclFile, linux.XATTR_NAME_POSIX_ACL_ACCESS, accessACL)
wantFileAccess := getACL(cont, aclFile, linux.XATTR_NAME_POSIX_ACL_ACCESS)
setACL(aclDir, linux.XATTR_NAME_POSIX_ACL_ACCESS, accessACL)
wantDirAccess := getACL(cont, aclDir, linux.XATTR_NAME_POSIX_ACL_ACCESS)
setACL(aclDir, linux.XATTR_NAME_POSIX_ACL_DEFAULT, defaultACL)
wantDirDefault := getACL(cont, aclDir, linux.XATTR_NAME_POSIX_ACL_DEFAULT)
for name, v := range map[string]string{"file access": wantFileAccess, "dir access": wantDirAccess, "dir default": wantDirDefault} {
if v == "" {
t.Fatalf("%s ACL was unexpectedly empty", name)
}
}
// Tar the upper layer.
tarFile, err := os.CreateTemp(testutil.TmpDir(), "tarfile-acl-*.tar")
if err != nil {
t.Fatalf("error creating temp file: %v", err)
}
defer os.Remove(tarFile.Name())
defer tarFile.Close()
if err := cont.TarRootfsUpperLayer(tarFile); err != nil {
t.Fatalf("error serializing rootfs upper layer to tar: %v", err)
}
// Restore the tar into a new container.
spec.Annotations[specutils.AnnotationRootfsUpperTar] = tarFile.Name()
conf.AllowRootfsTarAnnotation = true
_, bundleDir2, cleanup2, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up restored container: %v", err)
}
defer cleanup2()
args2 := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir2,
}
newCont, err := New(conf, args2)
if err != nil {
t.Fatalf("error creating restored container: %v", err)
}
defer newCont.Destroy()
if err := newCont.Start(conf); err != nil {
t.Fatalf("error starting restored container: %v", err)
}
// Verify the ACLs survived the round-trip.
if got := getACL(newCont, aclFile, linux.XATTR_NAME_POSIX_ACL_ACCESS); got != wantFileAccess {
t.Errorf("file access ACL mismatch after restore:\n got %q\nwant %q", got, wantFileAccess)
}
if got := getACL(newCont, aclDir, linux.XATTR_NAME_POSIX_ACL_ACCESS); got != wantDirAccess {
t.Errorf("dir access ACL mismatch after restore:\n got %q\nwant %q", got, wantDirAccess)
}
if got := getACL(newCont, aclDir, linux.XATTR_NAME_POSIX_ACL_DEFAULT); got != wantDirDefault {
t.Errorf("dir default ACL mismatch after restore:\n got %q\nwant %q", got, wantDirDefault)
}
}
func TestSpecValidationIgnore(t *testing.T) {
conf := testutil.TestConfig(t)
if err := conf.RestoreSpecValidation.Set("ignore"); err != nil {
t.Fatalf("error in setting restore-spec-validation flag: %v", err)
}
oldSpecs := make(map[string]*specs.Spec)
spec, _ := sleepSpecConf(t)
oldSpecs["container1"] = spec
newSpecs := make(map[string]*specs.Spec)
restoreSpec, _ := sleepSpecConf(t)
restoreSpec.Process.Terminal = true
newSpecs["container1"] = restoreSpec
if err := specutils.RestoreValidateSpec(oldSpecs, newSpecs, conf); err != nil {
t.Fatalf("spec validation was not ignored, got: %v, want: nil", err)
}
}
func TestSpecValidationForArgs(t *testing.T) {
tests := []struct {
name string
args []string
restoreArgs []string
wantErr bool
}{
{
name: "base path same",
args: []string{"/bin/sleep", "1000"},
restoreArgs: []string{"sleep", "1000"},
wantErr: false,
},
{
name: "executable path",
args: []string{"/bin/sleep", "1000"},
restoreArgs: []string{"./sleep", "1000"},
wantErr: false,
},
{
name: "different args",
args: []string{"/bin/sleep", "1000", "1"},
restoreArgs: []string{"./sleep", "1000", "infinity"},
wantErr: true,
},
{
name: "no base path",
args: []string{"/bin/sleep/", "1000", "1"},
restoreArgs: []string{"sleep", "1000", "infinity"},
wantErr: true,
},
{
name: "same length with different path",
args: []string{"/bin/sleep", "1000", "1"},
restoreArgs: []string{"/bin/sheep", "1000", "1"},
wantErr: true,
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
conf := testutil.TestConfig(t)
oldSpecs := make(map[string]*specs.Spec)
spec, _ := sleepSpecConf(t)
spec.Process.Cwd = "/bin"
spec.Process.Args = test.args
oldSpecs["container1"] = spec
newSpecs := make(map[string]*specs.Spec)
restoreSpec, _ := sleepSpecConf(t)
restoreSpec.Process.Cwd = "/bin"
restoreSpec.Process.Args = test.restoreArgs
newSpecs["container1"] = restoreSpec
err := specutils.RestoreValidateSpec(oldSpecs, newSpecs, conf)
if !test.wantErr && err != nil {
t.Errorf("spec validation failed, got: %v, want: nil", err)
}
if test.wantErr && err == nil {
t.Errorf("spec validation passed when we expected it to fail")
}
})
}
}
func TestSpecValidationForCapabilities(t *testing.T) {
conf := testutil.TestConfig(t)
oldSpecs := make(map[string]*specs.Spec)
spec, _ := sleepSpecConf(t)
spec.Process.Capabilities.Bounding = nil
oldSpecs["container1"] = spec
newSpecs := make(map[string]*specs.Spec)
restoreSpec, _ := sleepSpecConf(t)
restoreSpec.Process.Capabilities.Bounding = []string{}
newSpecs["container1"] = restoreSpec
if err := specutils.RestoreValidateSpec(oldSpecs, newSpecs, conf); err != nil {
t.Errorf("spec validation failed, got: %v, want: nil", err)
}
}
func TestCheckpointResume(t *testing.T) {
for name, conf := range configs(t, true /* noOverlay */) {
t.Run(name, func(t *testing.T) {
dir, err := os.MkdirTemp(testutil.TmpDir(), "checkpoint-test")
if err != nil {
t.Fatalf("os.MkdirTemp failed: %v", err)
}
defer os.RemoveAll(dir)
if err := os.Chmod(dir, 0777); err != nil {
t.Fatalf("error chmoding file: %q, %v", dir, err)
}
outputPath := filepath.Join(dir, "output")
outputFile, err := createWriteableOutputFile(outputPath)
if err != nil {
t.Fatalf("error creating output file: %v", err)
}
defer outputFile.Close()
script := fmt.Sprintf("i=0; while true; do echo $i >> %q; sleep 1; i=$((i+1)); done", outputPath)
spec := testutil.NewSpecWithArgs("bash", "-c", script)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
// Wait until application has ran.
if err := waitForFileNotEmpty(outputFile); err != nil {
t.Fatalf("Failed to wait for output file: %v", err)
}
// Checkpoint running container; save state into new file.
if err := cont.Checkpoint(conf, dir, sandbox.CheckpointOpts{Resume: true}); err != nil {
t.Fatalf("error checkpointing container to empty file: %v", err)
}
if !cont.Sandbox.Checkpointed {
t.Fatalf("sandbox returned wrong value for Sandbox.Checkpointed, got: false, want: true")
}
if cont.Sandbox.Restored {
t.Fatalf("sandbox returned wrong value for Sandbox.Restored, got: true, want: false")
}
cont.Destroy()
})
}
}
func TestMarkerFile(t *testing.T) {
app, err := testutil.FindFile("test/cmd/test_app/test_app")
if err != nil {
t.Fatal("error finding test_app:", err)
}
conf := testutil.TestConfig(t)
conf.GVisorMarkerFile = false
spec := testutil.NewSpecWithArgs(app, "gvisor-detect", "--exit-code-on-gvisor=1", "--exit-code-on-not-gvisor=0")
if err := run(spec, conf); err != nil {
t.Fatalf("unexpectedly detected gVisor when we expected to not be able to do so: %v", err)
}
conf.GVisorMarkerFile = true
spec = testutil.NewSpecWithArgs(app, "gvisor-detect", "--exit-code-on-gvisor=0", "--exit-code-on-not-gvisor=1")
if err := run(spec, conf); err != nil {
t.Fatalf("failed to detect gVisor when we expected to be able to do so: %v", err)
}
}
func TestIPv6DisableAllSysctl(t *testing.T) {
tests := []struct {
name string
ipv6Disabled bool
}{
{"IPv6Disabled", true},
{"IPv6Enabled", false},
}
for name, conf := range configs(t, true /* noOverlay */) {
for _, test := range tests {
t.Run(test.name+name, func(t *testing.T) {
spec := testutil.NewSpecWithArgs("sleep", "infinity")
conf.Network = config.NetworkSandbox
if test.ipv6Disabled {
spec.Linux = &specs.Linux{}
spec.Linux.Sysctl = make(map[string]string)
spec.Linux.Sysctl["net.ipv6.conf.all.disable_ipv6"] = "1"
}
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("error setting up container: %v", err)
}
defer cleanup()
// Create and start the container.
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("error creating container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("error starting container: %v", err)
}
out, err := executeCombinedOutput(conf, cont, nil, "/bin/sh", "-c", "ip addr")
if err != nil {
t.Fatalf("error executing 'ip addr' command: %v", err)
}
if len(out) == 0 {
// This can happen when the network does not have any network
// interfaces configured. We cannot test whether the sysctl works
// properly in this case. Log a warning and return.
t.Logf("No output from 'ip addr' command, no network interfaces are configured")
return
}
res := strings.Contains(string(out), "inet6")
if test.ipv6Disabled && res {
t.Errorf("IPv6 address present when IPv6 is disabled on all interfaces, output: %v", string(out))
}
if !test.ipv6Disabled && !res {
t.Errorf("IPv6 address not present when IPv6 is enabled on all interfaces, output: %v", string(out))
}
})
}
}
}
func TestReadFile(t *testing.T) {
conf := testutil.TestConfig(t)
spec, _ := sleepSpecConf(t)
_, bundleDir, cleanup, err := testutil.SetupContainer(spec, conf)
if err != nil {
t.Fatalf("Failed to setup container: %v", err)
}
defer cleanup()
args := Args{
ID: testutil.RandomContainerID(),
Spec: spec,
BundleDir: bundleDir,
}
cont, err := New(conf, args)
if err != nil {
t.Fatalf("Failed to create container: %v", err)
}
defer cont.Destroy()
if err := cont.Start(conf); err != nil {
t.Fatalf("Failed to start container: %v", err)
}
// Test reading /proc/version without size limit.
tmpFile1, err := os.CreateTemp(testutil.TmpDir(), "readfile-1-*.txt")
if err != nil {
t.Fatalf("Failed to create temp file: %v", err)
}
defer os.Remove(tmpFile1.Name())
defer tmpFile1.Close()
if err := cont.Sandbox.ReadFile(cont.ID, "/proc/version", 0, 0, tmpFile1); err != nil {
t.Fatalf("Failed to read /proc/version: %v", err)
}
content1, err := os.ReadFile(tmpFile1.Name())
if err != nil {
t.Fatalf("Failed to read temp file: %v", err)
}
if !strings.Contains(string(content1), "Linux") {
t.Errorf("Got %q, want string containing 'Linux'", string(content1))
}
// Test reading /proc/version with a size limit of 5 bytes.
tmpFile2, err := os.CreateTemp(testutil.TmpDir(), "readfile-2-*.txt")
if err != nil {
t.Fatalf("Failed to create temp file: %v", err)
}
defer os.Remove(tmpFile2.Name())
defer tmpFile2.Close()
if err := cont.Sandbox.ReadFile(cont.ID, "/proc/version", 0, 5, tmpFile2); err != nil {
t.Fatalf("ReadFile failed: %v", err)
}
content2, err := os.ReadFile(tmpFile2.Name())
if err != nil {
t.Fatalf("Failed to read temp file: %v", err)
}
if string(content2) != "Linux" {
t.Errorf("Got %q (%d bytes), want 'Linux' (5 bytes)", string(content2), len(content2))
}
// Test reading /proc/version with an offset of 1 and size of 4 bytes.
tmpFile3, err := os.CreateTemp(testutil.TmpDir(), "readfile-3-*.txt")
if err != nil {
t.Fatalf("Failed to create temp file: %v", err)
}
defer os.Remove(tmpFile3.Name())
defer tmpFile3.Close()
if err := cont.Sandbox.ReadFile(cont.ID, "/proc/version", 1, 4, tmpFile3); err != nil {
t.Fatalf("ReadFile failed: %v", err)
}
content3, err := os.ReadFile(tmpFile3.Name())
if err != nil {
t.Fatalf("Failed to read temp file: %v", err)
}
if string(content3) != "inux" {
t.Errorf("Got %q (%d bytes), want 'inux' (4 bytes)", string(content3), len(content3))
}
}