testutil

Documentation

Overview

Package testutil contains common test utilities.

Index

• func ApplyDir(dir Dir)
• func ApplyDirIn(dir Dir, root string)
• func Chdir(c Cleanuper, dir string) string
• func ChmodOrSkip(s Skipper, name string, mode fs.FileMode)
• func Dedent(text string) string
• func InTempDir(c Cleanuper) string
• func InTempHome(c Cleanuper) string
• func Recover(f func()) (r any)
• func SaveEnv(c Cleanuper, name string)
• func Scaled(d time.Duration) time.Duration
• func Set[T any](c Cleanuper, p *T, v T)
• func Setenv(c Cleanuper, name, value string) string
• func TempDir(c Cleanuper) string
• func TempHome(c Cleanuper) string
• func TestTimeScale() float64
• func Umask(c Cleanuper, m int)
• func Unsetenv(c Cleanuper, name string)
• type Cleanuper
• type Dir
  • func (dir Dir) Open(name string) (fs.File, error)
• type FS
• type File
• type Skipper

Functions

func ApplyDir

func ApplyDir(dir Dir)

ApplyDir creates the given filesystem layout in the current directory.

func ApplyDirIn

func ApplyDirIn(dir Dir, root string)

ApplyDirIn creates the given filesystem layout in a given directory.

func Chdir

func Chdir(c Cleanuper, dir string) string

Chdir changes into a directory, and restores the original working directory when a test finishes. It returns the directory for easier chaining.

func ChmodOrSkip

func ChmodOrSkip(s Skipper, name string, mode fs.FileMode)

ChmodOrSkip runs os.Chmod, but skips the test if file's mode is not exactly mode or if there is any error.

func Dedent

func Dedent(text string) string

Dedent removes an optional leading newline, and removes the indentation present in the first line from all subsequent non-empty lines.

Dedent panics if any non-empty line does not start with the same indentation as the first line.

func InTempDir

func InTempDir(c Cleanuper) string

InTempDir is equivalent to Chdir(c, TempDir(c)).

func InTempHome

func InTempHome(c Cleanuper) string

InTempHome is equivalent to Setenv(c, env.HOME, InTempDir(c))

func Recover

func Recover(f func()) (r any)

func SaveEnv

func SaveEnv(c Cleanuper, name string)

SaveEnv saves the current value of an environment variable so that it will be restored after a test has finished.

func Scaled

func Scaled(d time.Duration) time.Duration

Scaled returns d scaled by $E:ELVISH_TEST_TIME_SCALE. If the environment variable does not exist or contains an invalid value, the scale defaults to 1.

func Set

func Set[T any](c Cleanuper, p *T, v T)

func Setenv

func Setenv(c Cleanuper, name, value string) string

Setenv sets the value of an environment variable for the duration of a test. It returns value.

func TempDir

func TempDir(c Cleanuper) string

TempDir creates a temporary directory for testing that will be removed after the test finishes. It is different from testing.TB.TempDir in that it resolves symlinks in the path of the directory.

It panics if the test directory cannot be created or symlinks cannot be resolved. It is only suitable for use in tests.

func TempHome

func TempHome(c Cleanuper) string

TempHome is equivalent to Setenv(c, env.HOME, TempDir(c))

func TestTimeScale

func TestTimeScale() float64

TestTimeScale parses $E:ELVISH_TEST_TIME_SCALE, defaulting to 1 it it's not set or can't be parsed as a float64.

func Umask

func Umask(c Cleanuper, m int)

Umask sets the umask for the duration of the test, and restores it afterwards.

func Unsetenv

func Unsetenv(c Cleanuper, name string)

Setenv unsets an environment variable for the duration of a test.

Types

type Cleanuper

type Cleanuper interface {
	Cleanup(func())
}

Cleanuper wraps the Cleanup method. It is a subset of testing.TB, thus satisfied by *testing.T and *testing.B.

type Dir

type Dir map[string]any

Dir describes the layout of a directory. The keys of the map represent filenames. Each value is either a string (for the content of a regular file with permission 0644), a File, or a Dir.

func (Dir) Open

func (dir Dir) Open(name string) (fs.File, error)

type FS

type FS map[string]File

type File

type File struct {
	Perm    os.FileMode
	Content string
}

File describes a file to create.

type Skipper

type Skipper interface {
	Skipf(format string, args ...any)
}

Skipper wraps the Skipf method. It is a subset of testing.TB, thus satisfied by *testing.T and *testing.B.