Documentation
¶
Overview ¶
Package testutil contains utility functions for runsc tests.
Index ¶
- Constants
- func BoolFromEnv(name string, def bool) bool
- func ConfigureExePath() error
- func Copy(src, dst string) error
- func DurationFromEnv(name string, def time.Duration) time.Duration
- func FindFile(path string) (string, error)
- func ImageByName(name string) string
- func IntFromEnv(name string, def int) int
- func IsCheckpointSupported() bool
- func IsRunningWithHostNet() bool
- func IsRunningWithOverlay() bool
- func IsStatic(filename string) (bool, error)
- func KillCommand(cmd *exec.Cmd) error
- func NewSpecWithArgs(args ...string) *specs.Spec
- func Poll(cb func() error, timeout time.Duration) error
- func PollContext(ctx context.Context, cb func() error) error
- func RandomContainerID() string
- func RandomID(prefix string) string
- func SetupBundleDir(spec *specs.Spec) (string, func(), error)
- func SetupContainer(spec *specs.Spec, conf *config.Config) (rootDir, bundleDir string, cleanup func(), err error)
- func SetupRootDir() (string, func(), error)
- func StartReaper() func()
- func StringFromEnv(name, def string) string
- func TestConfig(t *testing.T) *config.Config
- func TestIndicesForShard(numTests int) ([]int, error)
- func TmpDir() string
- func TouchShardStatusFile() error
- func WaitForHTTP(ip string, port int, timeout time.Duration) error
- func WaitUntilRead(r io.Reader, want string, timeout time.Duration) error
- func WriteTmpFile(pattern, text string) (string, func(), error)
- type Cmd
- type DefaultLogger
- type Logger
- type Reaper
- type Shell
- func (s *Shell) Expect(ctx context.Context, want []byte) error
- func (s *Shell) ExpectEmptyLine(ctx context.Context) error
- func (s *Shell) ExpectLine(ctx context.Context, want string) error
- func (s *Shell) ExpectPrompt(ctx context.Context) error
- func (s *Shell) ExpectString(ctx context.Context, want string) error
- func (s *Shell) GetCommandOutput(ctx context.Context) ([]byte, error)
- func (s *Shell) ReadUntil(ctx context.Context, finalLine string) ([]byte, error)
- func (s *Shell) RefreshSTTY(ctx context.Context, expectPrompt string) error
- func (s *Shell) RunCommand(ctx context.Context, cmd ...string) ([]byte, error)
- func (s *Shell) SendEOF(ctx context.Context, expectLinebreak bool) error
- func (s *Shell) SendInterrupt(ctx context.Context, expectLinebreak bool) error
- func (s *Shell) StartCommand(ctx context.Context, cmd ...string) error
- func (s *Shell) Write(b []byte) error
- func (s *Shell) WriteLine(ctx context.Context, line string) error
Constants ¶
const Prompt = "PROMPT> "
Prompt is used as shell prompt. It is meant to be unique enough to not be seen in command outputs.
Variables ¶
This section is empty.
Functions ¶
func BoolFromEnv ¶
BoolFromEnv returns the boolean value of the named environment variable, or `def` if unset/empty. It is useful for defining flags where the default value can be specified through the environment.
func ConfigureExePath ¶
func ConfigureExePath() error
ConfigureExePath configures the executable for runsc in the test environment.
func DurationFromEnv ¶
DurationFromEnv returns the duration of the named environment variable, or `def` if unset/empty. It is useful for defining flags where the default value can be specified through the environment.
func FindFile ¶
FindFile searchs for a file inside the test run environment. It returns the full path to the file. It fails if none or more than one file is found.
func ImageByName ¶
ImageByName mangles the image name used locally. This depends on the image build infrastructure in images/ and tools/vm.
func IntFromEnv ¶
IntFromEnv returns the integer value of the named environment variable, or `def` if unset/empty. It is useful for defining flags where the default value can be specified through the environment.
func IsCheckpointSupported ¶
func IsCheckpointSupported() bool
IsCheckpointSupported returns the relevant command line flag.
func IsRunningWithHostNet ¶
func IsRunningWithHostNet() bool
IsRunningWithHostNet returns the relevant command line flag.
func IsRunningWithOverlay ¶
func IsRunningWithOverlay() bool
IsRunningWithOverlay returns the relevant command line flag.
func KillCommand ¶
KillCommand kills the process running cmd unless it hasn't been started. It returns an error if it cannot kill the process unless the reason is that the process has already exited.
KillCommand will also reap the process.
func NewSpecWithArgs ¶
NewSpecWithArgs creates a simple spec with the given args suitable for use in tests.
func PollContext ¶
PollContext is like Poll, but takes a context instead of a timeout.
func RandomContainerID ¶
func RandomContainerID() string
RandomContainerID generates a random container id for each test.
The container id is used to create an abstract unix domain socket, which must be unique. While the container forbids creating two containers with the same name, sometimes between test runs the socket does not get cleaned up quickly enough, causing container creation to fail.
func SetupBundleDir ¶
SetupBundleDir creates a bundle dir and writes the spec to config.json.
func SetupContainer ¶
func SetupContainer(spec *specs.Spec, conf *config.Config) (rootDir, bundleDir string, cleanup func(), err error)
SetupContainer creates a bundle and root dir for the container, generates a test config, and writes the spec to config.json in the bundle dir.
func SetupRootDir ¶
SetupRootDir creates a root directory for containers.
func StartReaper ¶
func StartReaper() func()
StartReaper is a helper that starts a new Reaper and returns a function to stop it.
func StringFromEnv ¶
StringFromEnv returns the value of the named environment variable, or `def` if unset/empty. It is useful for defining flags where the default value can be specified through the environment.
func TestConfig ¶
TestConfig returns the default configuration to use in tests. Note that 'RootDir' must be set by caller if required.
func TestIndicesForShard ¶
TestIndicesForShard returns indices for this test shard based on the TEST_SHARD_INDEX and TEST_TOTAL_SHARDS environment vars, as well as the passed partition flags.
If either of the env vars are not present, then the function will return all tests. If there are more shards than there are tests, then the returned list may be empty.
func TmpDir ¶
func TmpDir() string
TmpDir returns the absolute path to a writable directory that can be used as scratch by the test.
func TouchShardStatusFile ¶
func TouchShardStatusFile() error
TouchShardStatusFile indicates to Bazel that the test runner supports sharding by creating or updating the last modified date of the file specified by TEST_SHARD_STATUS_FILE.
See https://docs.bazel.build/versions/master/test-encyclopedia.html#role-of-the-test-runner.
func WaitForHTTP ¶
WaitForHTTP tries GET requests on a port until the call succeeds or timeout.
func WaitUntilRead ¶
WaitUntilRead reads from the given reader until the wanted string is found or until timeout.
func WriteTmpFile ¶
WriteTmpFile writes text to a temporary file, closes the file, and returns the name of the file. A cleanup function is also returned.
Types ¶
type Cmd ¶
Cmd is a simple wrapper.
func (*Cmd) CombinedOutput ¶
CombinedOutput returns the output and logs.
type DefaultLogger ¶
type DefaultLogger string
DefaultLogger logs using the log package.
func (DefaultLogger) Logf ¶
func (d DefaultLogger) Logf(fmt string, args ...any)
Logf implements Logger.Logf.
type Logger ¶
Logger is a simple logging wrapper.
This is designed to be implemented by *testing.T.
func NewMultiLogger ¶
NewMultiLogger returns a new Logger that logs on multiple Loggers.
type Reaper ¶
type Reaper struct {
// contains filtered or unexported fields
}
Reaper reaps child processes.
type Shell ¶
type Shell struct {
// contains filtered or unexported fields
}
Shell manages a /bin/sh invocation with convenience functions to handle I/O. The shell is run in its own interactive TTY and should present its prompt.
func NewShell ¶
NewShell returns a new managed sh process along with a cleanup function. The caller is expected to call this function once it no longer needs the shell. The optional passed-in logger will be used for logging.
func (*Shell) ExpectEmptyLine ¶
ExpectEmptyLine verifies that the next few bytes we read are an empty line, as defined by any number of carriage or line break characters.
func (*Shell) ExpectLine ¶
ExpectLine verifies that the next `len(want)` bytes we read match `want`, followed by carriage returns or newline characters.
func (*Shell) ExpectPrompt ¶
ExpectPrompt verifies that the next few bytes we read are the shell prompt.
func (*Shell) ExpectString ¶
ExpectString verifies that the next `len(want)` bytes we read match `want`.
func (*Shell) GetCommandOutput ¶
GetCommandOutput gets all following bytes until the prompt is encountered. This is useful for matching the output of a command. All \r are removed for ease of matching.
func (*Shell) ReadUntil ¶
ReadUntil gets all following bytes until a certain line is encountered. This final line is not returned as part of the output, but everything before it (including the \n) is included. This is useful for matching the output of a command. All \r are removed for ease of matching.
func (*Shell) RefreshSTTY ¶
RefreshSTTY interprets output from `stty -a` to check whether we are in echo mode and other settings. It will assume that any line matching `expectPrompt` means the end of the `stty -a` output. Why do this rather than using `tcgets`? Because this function can be used in conjunction with sub-shell processes that can allocate their own TTYs.
func (*Shell) RunCommand ¶
RunCommand is a convenience wrapper for StartCommand + GetCommandOutput.
func (*Shell) SendInterrupt ¶
SendInterrupt sends the \x03 (Ctrl+C) control character to the shell.
func (*Shell) StartCommand ¶
StartCommand is a convenience wrapper for WriteLine that mimics entering a command line and pressing Enter. It does some basic shell argument escaping.
Source Files