utils

Documentation

Index

• Constants
• func UserConfigEnv(dir string) map[string]string
• type ExecOpts
  • func Binary(binPath string) *ExecOpts
  • func (opts *ExecOpts) Clear()
  • func (opts *ExecOpts) Exec(args ...string) *Matcher
  • func (opts *ExecOpts) ExpectBlocking() *ExecOpts
  • func (opts *ExecOpts) ExpectFailure() *ExecOpts
  • func (opts *ExecOpts) WithDescription(text string) *ExecOpts
  • func (opts *ExecOpts) WithEnv(env map[string]string) *ExecOpts
  • func (opts *ExecOpts) WithInput(r io.Reader) *ExecOpts
  • func (opts *ExecOpts) WithTimeOut(timeout time.Duration) *ExecOpts
  • func (opts *ExecOpts) WithWorkDir(path string) *ExecOpts
• type HostOption
• type Matcher
  • func NewMatcher(session *gexec.Session) *Matcher
  • func (m *Matcher) MatchContent(content string) *Matcher
  • func (m *Matcher) MatchErrContent(content string) *Matcher
  • func (m *Matcher) MatchErrKeyWords(keywords ...string) *Matcher
  • func (m *Matcher) MatchKeyWords(keywords ...string) *Matcher
  • func (m *Matcher) NoMatchErrKeyWords(keywords ...string) *Matcher
• type VirtualHost
  • func NewVirtualHost(binPath string, options ...HostOption) (*VirtualHost, error)
  • func (h *VirtualHost) AbsolutePath(elem ...string) string
  • func (h *VirtualHost) SetOption(options ...HostOption)
  • func (h *VirtualHost) UpdateEnv(env map[string]string)

Constants

const (
	DefaultTimeout = 10 * time.Second
)

Functions

func UserConfigEnv

func UserConfigEnv(dir string) map[string]string

UserConfigEnv creates environment variable for changing user config dir (By setting $XDG_CONFIG_HOME).

Types

type ExecOpts

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

ExecOpts is an option used to execute a command.

func Binary

func Binary(binPath string) *ExecOpts

Binary returns default execution option for customized binary.

func (*ExecOpts) Clear

func (opts *ExecOpts) Clear()

Clear clears the ExecOpts to get ready for the next execution.

func (*ExecOpts) Exec

func (opts *ExecOpts) Exec(args ...string) *Matcher

Exec run the execution based on opts.

func (*ExecOpts) ExpectBlocking

func (opts *ExecOpts) ExpectBlocking() *ExecOpts

ExpectBlocking consistently check if the execution is blocked.

func (*ExecOpts) ExpectFailure

func (opts *ExecOpts) ExpectFailure() *ExecOpts

ExpectFailure sets failure exit code checking for the execution.

func (*ExecOpts) WithDescription

func (opts *ExecOpts) WithDescription(text string) *ExecOpts

WithDescription sets description text for the execution.

func (*ExecOpts) WithEnv

func (opts *ExecOpts) WithEnv(env map[string]string) *ExecOpts

WithEnv update the environment variables.

func (*ExecOpts) WithInput

func (opts *ExecOpts) WithInput(r io.Reader) *ExecOpts

WithInput redirects stdin to r for the execution.

func (*ExecOpts) WithTimeOut

func (opts *ExecOpts) WithTimeOut(timeout time.Duration) *ExecOpts

WithTimeOut sets timeout for the execution.

func (*ExecOpts) WithWorkDir

func (opts *ExecOpts) WithWorkDir(path string) *ExecOpts

WithWorkDir sets working directory for the execution.

type HostOption

type HostOption func(vhost *VirtualHost) error

HostOption is a function to set the host configuration.

type Matcher

type Matcher struct {
	Session *gexec.Session
	// contains filtered or unexported fields
}

Matcher contains the execution result for matching.

func NewMatcher

func NewMatcher(session *gexec.Session) *Matcher

NewMatcher returns a new Matcher.

func (*Matcher) MatchContent

func (m *Matcher) MatchContent(content string) *Matcher

MatchContent matches the content with the stdout.

func (*Matcher) MatchErrContent

func (m *Matcher) MatchErrContent(content string) *Matcher

MatchErrContent matches the content with stderr.

func (*Matcher) MatchErrKeyWords

func (m *Matcher) MatchErrKeyWords(keywords ...string) *Matcher

MatchErrKeyWords matches given keywords with the stderr.

func (*Matcher) MatchKeyWords

func (m *Matcher) MatchKeyWords(keywords ...string) *Matcher

MatchKeyWords matches given keywords with the stdout.

func (*Matcher) NoMatchErrKeyWords

func (m *Matcher) NoMatchErrKeyWords(keywords ...string) *Matcher

NoMatchErrKeyWords guarantees that the given keywords do not match with the stderr.

type VirtualHost

type VirtualHost struct {
	Executor *ExecOpts
	// contains filtered or unexported fields
}

VirtualHost is a virtualized host machine isolated by environment variable.

func NewVirtualHost

func NewVirtualHost(binPath string, options ...HostOption) (*VirtualHost, error)

NewVirtualHost creates a temporary user-level directory and updates the "XDG_CONFIG_HOME" environment variable for Executor of the VirtualHost.

func (*VirtualHost) AbsolutePath

func (h *VirtualHost) AbsolutePath(elem ...string) string

AbsolutePath returns the absolute path for the given path elements that are relative to the user directory.

func (*VirtualHost) SetOption

func (h *VirtualHost) SetOption(options ...HostOption)

SetOption sets the options for the host.

func (*VirtualHost) UpdateEnv

func (h *VirtualHost) UpdateEnv(env map[string]string)

UpdateEnv updates the environment variables for the VirtualHost.