internal

Documentation

Index

• func Argument(index int) (string, error)
• func DirectoryContents(root string) ([]string, error)
• func FileExists(file string) (bool, error)
• func HaveContent(expected string) types.GomegaMatcher
• func ProtectEnv(t *testing.T, keys ...string) func()
• func ReplaceArgs(t *testing.T, args ...string) func()
• func ReplaceEnv(t *testing.T, key string, value string) func()
• func ReplaceWorkingDirectory(t *testing.T, dir string) func()
• func ScratchDir(t *testing.T, prefix string) string
• func TouchTestFile(t *testing.T, elem ...string)
• func WriteFile(filename string, perm os.FileMode, format string, args ...interface{}) error
• func WriteTestFile(t *testing.T, filename string, format string, args ...interface{})
• func WriteTomlFile(filename string, perm os.FileMode, value interface{}) error
• type Console
  • func ReplaceConsole(t *testing.T) (Console, func())
  • func (c Console) Err(t *testing.T) string
  • func (c Console) In(t *testing.T, string string)
  • func (c Console) Out(t *testing.T) string

Functions

func Argument

func Argument(index int) (string, error)

Argument returns the specified argument from os.Args. It returns an error if there are not enough arguments to satisfy the request.

func DirectoryContents

func DirectoryContents(root string) ([]string, error)

DirectoryContents walks the tree of files below a given root and returns their relative paths.

func FileExists

func FileExists(file string) (bool, error)

FileExists returns whether a file exists taking into account various error cases.

func HaveContent

func HaveContent(expected string) types.GomegaMatcher

func ProtectEnv

func ProtectEnv(t *testing.T, keys ...string) func()

ProtectEnv protects a collection of environment variables. Returns a function for use with defer in order to reset the previous values.

defer ProtectEnv(t, "alpha")()

func ReplaceArgs

func ReplaceArgs(t *testing.T, args ...string) func()

ReplaceArgs replaces the current command line arguments (os.Args) with a new collection of values. Returns a function suitable for use with defer in order to reset the previous values

defer ReplaceArgs(t, "alpha")()

func ReplaceEnv

func ReplaceEnv(t *testing.T, key string, value string) func()

ReplaceEnv replaces an environment variable. Returns a function for use with defer in order to reset the previous value.

defer ReplaceEnv(t, "alpha", "bravo")()

func ReplaceWorkingDirectory

func ReplaceWorkingDirectory(t *testing.T, dir string) func()

ReplaceWorkingDirectory replaces the current working directory (os.Getwd()) with a new value. Returns a function for use with defer in order to reset the previous value

defer ReplaceWorkingDirectory(t, "alpha")()

func ScratchDir

func ScratchDir(t *testing.T, prefix string) string

ScratchDir returns a safe scratch directory for tests to modify.

func TouchTestFile

func TouchTestFile(t *testing.T, elem ...string)

TouchTestFile writes a zero-length file during testing.

func WriteFile

func WriteFile(filename string, perm os.FileMode, format string, args ...interface{}) error

WriteFile writes a file with the given content. Before writing, it creates all required parent directories for the file.

func WriteTestFile

func WriteTestFile(t *testing.T, filename string, format string, args ...interface{})

WriteTestFile writes a file during testing.

func WriteTomlFile

func WriteTomlFile(filename string, perm os.FileMode, value interface{}) error

WriteTomlFile writes a file with a TOML representation of the given value. Before writing it creates all required parent directories for the file.

Types

type Console

type Console struct {
	// contains filtered or unexported fields
}

Console represents the standard console objects, stdin, stdout, and stderr.

func ReplaceConsole

func ReplaceConsole(t *testing.T) (Console, func())

ReplaceConsole replaces the console files (os.Stderr, os.Stdin, os.Stdout). Returns a function for use with defer in order to reset the previous values

c, d := ReplaceConsole(t) defer d()

func (Console) Err

func (c Console) Err(t *testing.T) string

Err returns a string representation of captured stderr.

func (Console) In

func (c Console) In(t *testing.T, string string)

In writes a string and closes the connection once complete.

func (Console) Out

func (c Console) Out(t *testing.T) string

Out returns a string representation of captured stdout.