testcmd

package module

v0.0.0-...-e72ed8e Latest Latest Go to latest Published: Jun 24, 2024 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gammazero/testcmd

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type CmdArgs
- func Args(name string, args ...string) CmdArgs
- func (a CmdArgs) String() string
type Runner
- func NewRunner(t *testing.T, dir string) *Runner
type StdoutWatcher
- func NewStdoutWatcher(match string) StdoutWatcher
- func (w StdoutWatcher) Wait(ctx context.Context) error

Constants ¶

View Source

const (
	// When this environ var is set to a value and running tests with -v flag,
	// then Runner output is logged.
	EnvTestRunnerOutput = "TEST_RUNNER_OUTPUT"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type CmdArgs ¶

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

CmdArgs contains a command name and any arguments.

func Args ¶

func Args(name string, args ...string) CmdArgs

Args creates a CmdArgs instance with the given command name and args. This is used to supply the command names and args to Start.

func (CmdArgs) String ¶

func (a CmdArgs) String() string

type Runner ¶

type Runner struct {
	Dir string
	Env []string
	// contains filtered or unexported fields
}

Runner is a helper for running the indexer and other commands. Runner is not specifically tied to the indexer, but is designed to be used to manage multiple processes in a test; and is therefore useful for testing the indexer, the dhstore, and providers, all in a temporary directory and with a test environment.

func NewRunner ¶

func NewRunner(t *testing.T, dir string) *Runner

NewRunner creates a new Runner for the given test, context, and temporary directory. It also takes a list of StdoutWatchers, which will be used to watch for specific output from the commands.

func (*Runner) Run ¶

func (rnr *Runner) Run(ctx context.Context, name string, args ...string) []byte

Run runs a command and returns its output. This is useful for executing synchronous commands within the temporary environment.

func (*Runner) Start ¶

func (rnr *Runner) Start(ctx context.Context, args CmdArgs, watchers ...StdoutWatcher) *exec.Cmd

Start starts and returns the command. This is useful for executing asynchronous commands within the temporary environment. If any watchers are supplied, the command's stdout is scanned to look for any matches and signal the corresponding watchers.

func (*Runner) Stop ¶

func (rnr *Runner) Stop(cmd *exec.Cmd, timeout time.Duration)

Stop stops a command. It sends SIGINT, and if that does not work, SIGKILL.

type StdoutWatcher ¶

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

StdoutWatcher is a helper for watching the stdout of a command for a specific string. It is used by Runner to watch for specific output from the commands. The Signal channel is signaled when the match string is found.

func NewStdoutWatcher ¶

func NewStdoutWatcher(match string) StdoutWatcher

func (StdoutWatcher) Wait ¶

func (w StdoutWatcher) Wait(ctx context.Context) error

Wait waits for the watcher to be signaled for the the context to be canceled. If the context is canceled then the context error is returned.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL