blockcmd

Documentation

Index

• func MustNotDone(cmd *blockingCmd, f func())
• func WhenNotDone(cmd *blockingCmd, f func())
• type BlockingCmdResults
  • func (blockingCmd *BlockingCmdResults) ExitCode() int
  • func (blockingCmd *BlockingCmdResults) Stderr() []string
  • func (blockingCmd *BlockingCmdResults) Stdout() []string
• type Cmd
  • func New(t *testing.T, cmd []string) Cmd
• type Results
  • func WithBlockingCmdObj(blockingCmdFuncArg *blockingCmd, f func(cmd Cmd)) (result Results, ok bool)
  • func WithBlockingCmdStr(t *testing.T, cmdStr []string, f func(cmd Cmd)) (result Results, ok bool)

Functions

func MustNotDone

func MustNotDone(cmd *blockingCmd, f func())

MustNotDone executes a function after checking whether the context is canceled. If the context is canceled a test failure is registered, halting all tests.

func WhenNotDone

func WhenNotDone(cmd *blockingCmd, f func())

WhenNotDone executes a function after checking whether the context is canceled. If the context is canceled a test error is registered and returned.

Types

type BlockingCmdResults

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

func (*BlockingCmdResults) ExitCode

func (blockingCmd *BlockingCmdResults) ExitCode() int

func (*BlockingCmdResults) Stderr

func (blockingCmd *BlockingCmdResults) Stderr() []string

func (*BlockingCmdResults) Stdout

func (blockingCmd *BlockingCmdResults) Stdout() []string

type Cmd

type Cmd interface {
	CmdString() []string

	WhileBlocking(f func(cmd Cmd)) (result Results, ok bool)
	WhileStillBlocking(f func())
	MustNotDone(f func())
	Stop() error
	Done() <-chan struct{}

	Fatal(args ...any)
	Fatalf(format string, args ...any)
}

func New

func New(t *testing.T, cmd []string) Cmd

type Results

type Results interface {
	Stdout() []string
	Stderr() []string
	ExitCode() int
}

func WithBlockingCmdObj

func WithBlockingCmdObj(blockingCmdFuncArg *blockingCmd, f func(cmd Cmd)) (result Results, ok bool)

func WithBlockingCmdStr

func WithBlockingCmdStr(t *testing.T, cmdStr []string, f func(cmd Cmd)) (result Results, ok bool)