utils

type Commander ¶

type Commander struct {
	Command string
	Options []string
}

Commander is a wrapper around os/exec.Command(). It returns a byte array containing the output of stdout and error. An error in command execution will land there. Stderr is scanned as well, its output is printed out.

func NewCommander() *Commander

func (c *Commander) CallCMD(ctx context.Context, cmd []string, dir string) ([]byte, []byte, error)

func (c *Commander) Run(cmd string) ([]byte, []byte, error)

type CreatePathResponse ¶

type CreatePathResponse error

CreatePathResponse is used to define the default response returned by MockedFileIO.CreatePath calls.

type CreatePipeResponse ¶

type CreatePipeResponse error

CreatePipeResponse is used to define the default response returned by MockedFileIO.CreatePipe calls.

type DeleteResponse ¶

type DeleteResponse error

DeleteResponse is used to define the default response returned by MockedFileIO.Delete calls.

type Executor ¶

type Executor interface {
	// CallCMD executes the command and returns the output's STDOUT, STDERR streams as well as any errors
	CallCMD(ctx context.Context, cmd []string, dir string) ([]byte, []byte, error)
}

Executor is an interface for calling a command and process its output.

type File ¶

type File interface {
	io.ReadWriteCloser
	io.StringWriter
	SetWriteDeadline(t time.Time) error
}

File is an interface for basic file based io methods

type FileErrorPair ¶

type FileErrorPair struct {
	File  File
	Error error
}

FileErrorPair is a tuple of File and error as returned by some MockedFileIO methods.

type FileIO ¶

type FileIO interface {
	CreatePath(path string) error
	CreatePipe(path string) error
	Delete(path string) error
	OpenRead(path string) (File, error)
	OpenWriteOrCreate(name string) (File, error)
	OpenWritePipe(name string) (File, error)
	ReadLine(file File) (string, error)
}

FileIO is an interface for filesystem methods

var Fio FileIO = &OSFileIO{}

type MockedBrokenRoundTripper ¶

type MockedBrokenRoundTripper struct {
}

MockedBrokenRoundTripper mocks http.RoundTripper for testing which will always result in an error

func (m *MockedBrokenRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

type MockedFileIO ¶

type MockedFileIO struct {
	CreatePathResponse        CreatePathResponse
	CreatePathCalls           []string
	CreatePipeResponse        CreatePipeResponse
	CreatePipeCalls           []string
	DeleteResponse            DeleteResponse
	DeleteCalls               []string
	OpenReadResponse          OpenReadResponse
	OpenReadCalls             []string
	OpenWriteOrCreateResponse OpenWriteOrCreateResponse
	OpenWriteOrCreateCalls    []string
	OpenWritePipeResponse     OpenWritePipeResponse
	OpenWritePipeCalls        []string
	ReadLineResponse          ReadLineResponse
	ReadLineCalls             []File
}

MockedFileIO implements fileIO as a mock for testing

func (mfio *MockedFileIO) CreatePath(path string) error

func (mfio *MockedFileIO) CreatePipe(path string) error

func (mfio *MockedFileIO) Delete(path string) error

func (mfio *MockedFileIO) OpenRead(path string) (File, error)

func (mfio *MockedFileIO) OpenWriteOrCreate(path string) (File, error)

func (mfio *MockedFileIO) OpenWritePipe(path string) (File, error)

func (mfio *MockedFileIO) ReadLine(file File) (string, error)

type MockedRoundTripper ¶

type MockedRoundTripper struct {
	ExpectedPath         string
	ReturnJSON           []byte
	ExpectedResponseCode int
}

MockedRoundTripper mocks http.RoundTripper for testing which always returns successful

func (m *MockedRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

type OSFileIO ¶

type OSFileIO struct{}

OSFileIO implements fileIO backed by default os methods

func (OSFileIO) CreatePath(path string) error

func (OSFileIO) CreatePipe(path string) error

func (OSFileIO) Delete(path string) error

func (OSFileIO) OpenRead(path string) (File, error)

func (OSFileIO) OpenWriteOrCreate(path string) (File, error)

func (OSFileIO) OpenWritePipe(path string) (File, error)

func (OSFileIO) ReadLine(file File) (string, error)

type OpenReadResponse ¶

type OpenReadResponse FileErrorPair

OpenReadResponse is used to define the default response returned by MockedFileIO.OpenRead calls.

type OpenWriteOrCreateResponse ¶

type OpenWriteOrCreateResponse FileErrorPair

OpenWriteOrCreateResponse is used to define the default response returned by MockedFileIO.OpenWriteOrCreate calls.

type OpenWritePipeResponse ¶

type OpenWritePipeResponse FileErrorPair

OpenWritePipeResponse is used to define the default response returned by MockedFileIO.OpenWritePipe calls.

type ReadLineResponse ¶

type ReadLineResponse struct {
	Line  string
	Error error
}

ReadLineResponse is a tuple of a string and an error as returned by MockedFileIO.ReadLine.

type SimpleFileMock ¶

type SimpleFileMock struct {
	ReadWriteCountResponse int
	IOError                error
	SetDeadlineError       error
	CloseError             error
	WrittenData            []byte
	WriteDeadline          time.Time
}

SimpleFileMock mocks os.File i/o for testing.

The error given in IOError is returned on all methods. Data written is appended to IOData on with each call an the length of the passed data returned as number of bytes written.

func (sfm *SimpleFileMock) Close() error

func (sfm *SimpleFileMock) Read(t []byte) (int, error)

func (sfm *SimpleFileMock) SetWriteDeadline(t time.Time) error

func (sfm *SimpleFileMock) Write(d []byte) (int, error)

func (sfm *SimpleFileMock) WriteString(d string) (int, error)