system

Documentation

Overview

Package system contains interfaces for OS related APIs, intended to be used for dependency injection to facilitate unit testing.

The naming of the methods in this package is not very Go-idiomatic because the user of this package usually composes the interfaces in this package into one interface.

For example, the `Executable` method of `ExecutableFinder` should have been named as `Find` according to Go idiom, but it will be unreadable if the interface is embedded in another interface. For instance,

type SystemDeps interface {
	system.ExecutableFinder
	// other methods
}
var deps SystemDeps
deps.Executable() // in favor of deps.Find()

Index

• type AbsFilePath
• type EnvChecker
• type EnvGetter
• type EnvironGetter
• type ExecutableFinder
• type FilePathJoiner
• type FilePathToSlash
• type PipeGetter
• type RuntimeArchGetter
• type RuntimeCPUGetter
• type RuntimeOSGetter
• type StdLib
  • func NewStdLib() *StdLib
  • func (s *StdLib) Arch() string
  • func (s *StdLib) Env(key string) string
  • func (s *StdLib) Environ() []string
  • func (s *StdLib) EvalSymlinks(path string) (string, error)
  • func (s *StdLib) Executable() (string, error)
  • func (s *StdLib) FilePathAbs(elem string) (string, error)
  • func (s *StdLib) FilePathJoin(elem ...string) string
  • func (s *StdLib) FilePathToSlash(elem string) string
  • func (s *StdLib) GetUserHome() (string, error)
  • func (s *StdLib) GetWd() (string, error)
  • func (s *StdLib) LookupEnv(key string) (string, bool)
  • func (s *StdLib) NumCPU() int
  • func (s *StdLib) OS() string
  • func (s *StdLib) Pipe() (*os.File, *os.File, error)
  • func (s *StdLib) ReadMemStats(st *runtime.MemStats)
  • func (s *StdLib) SetStdout(w *os.File)
  • func (s *StdLib) Stderr() *os.File
  • func (s *StdLib) Stdin() *os.File
  • func (s *StdLib) Stdout() *os.File
• type StderrGetter
• type StdinGetter
• type StdoutGetter
• type StdoutSetter
• type SymlinksEvaluator
• type UserHomeDir
• type WorkingDirectory

Types

type AbsFilePath

type AbsFilePath interface {
	FilePathAbs(elem string) (string, error)
}

AbsFilePath mocks out filepath.Abs.

type EnvChecker

type EnvChecker interface {
	LookupEnv(key string) (string, bool)
}

EnvChecker mocks out os.LookupEnv.

type EnvGetter

type EnvGetter interface {
	Env(key string) string
}

EnvGetter mocks out os.Getenv.

type EnvironGetter

type EnvironGetter interface {
	Environ() []string
}

EnvironGetter mocks out os.Environ.

type ExecutableFinder

type ExecutableFinder interface {
	Executable() (string, error)
}

ExecutableFinder mocks out os.Executable.

type FilePathJoiner

type FilePathJoiner interface {
	FilePathJoin(elem ...string) string
}

FilePathJoiner mocks out filepath.Join.

type FilePathToSlash

type FilePathToSlash interface {
	FilePathToSlash(elem string) string
}

FilePathToSlash mocks out filepath.ToSlash.

type PipeGetter

type PipeGetter interface {
	Pipe() (*os.File, *os.File, error)
}

PipeGetter mocks out os.Pipe.

type RuntimeArchGetter

type RuntimeArchGetter interface {
	Arch() string
}

RuntimeArchGetter mocks out runtime.GOARCH.

type RuntimeCPUGetter

type RuntimeCPUGetter interface {
	NumCPU() int
}

RuntimeCPUGetter mocks out runtime.NumCPU.

type RuntimeOSGetter

type RuntimeOSGetter interface {
	OS() string
}

RuntimeOSGetter mocks out runtime.GOOS.

type StdLib

type StdLib struct{}

StdLib implements the interfaces defined in system.go via standard library functions.

func NewStdLib

func NewStdLib() *StdLib

func (*StdLib) Arch

func (s *StdLib) Arch() string

func (*StdLib) Env

func (s *StdLib) Env(key string) string

func (*StdLib) Environ

func (s *StdLib) Environ() []string

func (*StdLib) EvalSymlinks

func (s *StdLib) EvalSymlinks(path string) (string, error)

func (*StdLib) Executable

func (s *StdLib) Executable() (string, error)

func (*StdLib) FilePathAbs

func (s *StdLib) FilePathAbs(elem string) (string, error)

func (*StdLib) FilePathJoin

func (s *StdLib) FilePathJoin(elem ...string) string

func (*StdLib) FilePathToSlash

func (s *StdLib) FilePathToSlash(elem string) string

func (*StdLib) GetUserHome

func (s *StdLib) GetUserHome() (string, error)

func (*StdLib) GetWd

func (s *StdLib) GetWd() (string, error)

func (*StdLib) LookupEnv

func (s *StdLib) LookupEnv(key string) (string, bool)

func (*StdLib) NumCPU

func (s *StdLib) NumCPU() int

func (*StdLib) OS

func (s *StdLib) OS() string

func (*StdLib) Pipe

func (s *StdLib) Pipe() (*os.File, *os.File, error)

func (*StdLib) ReadMemStats

func (s *StdLib) ReadMemStats(st *runtime.MemStats)

func (*StdLib) SetStdout

func (s *StdLib) SetStdout(w *os.File)

func (*StdLib) Stderr

func (s *StdLib) Stderr() *os.File

func (*StdLib) Stdin

func (s *StdLib) Stdin() *os.File

func (*StdLib) Stdout

func (s *StdLib) Stdout() *os.File

type StderrGetter

type StderrGetter interface {
	Stderr() *os.File
}

StderrGetter mocks out os.Stderr.

type StdinGetter

type StdinGetter interface {
	Stdin() *os.File
}

StdinGetter mocks out os.Stdin.

type StdoutGetter

type StdoutGetter interface {
	Stdout() *os.File
}

StdoutGetter mocks out os.Stdout.

type StdoutSetter

type StdoutSetter interface {
	SetStdout(*os.File)
}

StdoutSetter mocks out redirecting os.Stdout.

type SymlinksEvaluator

type SymlinksEvaluator interface {
	EvalSymlinks(path string) (string, error)
}

SymlinksEvaluator mocks out filepath.EvalSymlinks.

type UserHomeDir

type UserHomeDir interface {
	GetUserHome() (string, error)
}

UserHomeDir mocks out os.UserHomeDir.

type WorkingDirectory

type WorkingDirectory interface {
	GetWd() (string, error)
}

WorkingDirectory mocks out os.GetWd.