appcmdtesting

Documentation

Overview

Package appcmdtesting contains test utilities for appcmd.

Index

• func RunCommandExitCode(t *testing.T, newCommand func(use string) *appcmd.Command, ...)
• func RunCommandExitCodeStderr(t *testing.T, newCommand func(use string) *appcmd.Command, ...)
• func RunCommandExitCodeStderrContains(t *testing.T, newCommand func(use string) *appcmd.Command, ...)
• func RunCommandExitCodeStdout(t *testing.T, newCommand func(use string) *appcmd.Command, ...)
• func RunCommandExitCodeStdoutFile(t *testing.T, newCommand func(use string) *appcmd.Command, ...)
• func RunCommandExitCodeStdoutStderr(t *testing.T, newCommand func(use string) *appcmd.Command, ...)
• func RunCommandExitCodeStdoutStdinFile(t *testing.T, newCommand func(use string) *appcmd.Command, ...)
• func RunCommandExitCodes(t *testing.T, newCommand func(use string) *appcmd.Command, ...)
• func RunCommandExitCodesStderr(t *testing.T, newCommand func(use string) *appcmd.Command, ...)
• func RunCommandSuccess(t *testing.T, newCommand func(use string) *appcmd.Command, ...)
• func RunCommandSuccessStdout(t *testing.T, newCommand func(use string) *appcmd.Command, ...)

Functions

func RunCommandExitCode

func RunCommandExitCode(
	t *testing.T,
	newCommand func(use string) *appcmd.Command,
	expectedExitCode int,
	newEnv func(use string) map[string]string,
	stdin io.Reader,
	stdout io.Writer,
	stderr io.Writer,
	args ...string,
)

RunCommandExitCode runs the command and compares the exit code.

func RunCommandExitCodeStderr

func RunCommandExitCodeStderr(
	t *testing.T,
	newCommand func(use string) *appcmd.Command,
	expectedExitCode int,
	expectedStderr string,
	newEnv func(use string) map[string]string,
	stdin io.Reader,
	args ...string,
)

RunCommandExitCodeStderr runs the command and compares the exit code and stderr output.

func RunCommandExitCodeStderrContains

func RunCommandExitCodeStderrContains(
	t *testing.T,
	newCommand func(use string) *appcmd.Command,
	expectedExitCode int,
	expectedStderrPartials []string,
	newEnv func(use string) map[string]string,
	stdin io.Reader,
	args ...string,
)

RunCommandExitCodeStderrContains runs the command and compares the exit code and stderr output with the passed partial messages.

func RunCommandExitCodeStdout

func RunCommandExitCodeStdout(
	t *testing.T,
	newCommand func(use string) *appcmd.Command,
	expectedExitCode int,
	expectedStdout string,
	newEnv func(use string) map[string]string,
	stdin io.Reader,
	args ...string,
)

RunCommandExitCodeStdout runs the command and compares the exit code and stdout output.

func RunCommandExitCodeStdoutFile

func RunCommandExitCodeStdoutFile(
	t *testing.T,
	newCommand func(use string) *appcmd.Command,
	expectedExitCode int,
	expectedStdout string,
	newEnv func(use string) map[string]string,
	stdin io.Reader,
	args ...string,
)

RunCommandExitCodeStdoutFile runs the command and compares the exit code and stdout output.

func RunCommandExitCodeStdoutStderr

func RunCommandExitCodeStdoutStderr(
	t *testing.T,
	newCommand func(use string) *appcmd.Command,
	expectedExitCode int,
	expectedStdout string,
	expectedStderr string,
	newEnv func(use string) map[string]string,
	stdin io.Reader,
	args ...string,
)

RunCommandExitCodeStdoutStderr runs the command and compares the exit code, stdout, and stderr output.

func RunCommandExitCodeStdoutStdinFile

func RunCommandExitCodeStdoutStdinFile(
	t *testing.T,
	newCommand func(use string) *appcmd.Command,
	expectedExitCode int,
	expectedStdout string,
	newEnv func(use string) map[string]string,
	stdinFile string,
	args ...string,
)

RunCommandExitCodeStdoutStdinFile runs the command and allows a stdinFile to be opened and piped into the command.

func RunCommandExitCodes

func RunCommandExitCodes(
	t *testing.T,
	newCommand func(use string) *appcmd.Command,
	expectedExitCodes []int,
	newEnv func(use string) map[string]string,
	stdin io.Reader,
	stdout io.Writer,
	stderr io.Writer,
	args ...string,
)

RunCommandExitCodes runs the command and compares the exit code to the expected exit codes.

It would be nice if we could do:

type IntOrInts interface {
  int | []int
}

func RunCommandExitCode[I IntOrInts](expectedExitCode I)

However we can't: https://github.com/golang/go/issues/49206

func RunCommandExitCodesStderr

func RunCommandExitCodesStderr(
	t *testing.T,
	newCommand func(use string) *appcmd.Command,
	expectedExitCodes []int,
	expectedStderr string,
	newEnv func(use string) map[string]string,
	stdin io.Reader,
	args ...string,
)

RunCommandExitCodesStderr runs the command and compares the exit codes and stderr output.

func RunCommandSuccess

func RunCommandSuccess(
	t *testing.T,
	newCommand func(use string) *appcmd.Command,
	newEnv func(use string) map[string]string,
	stdin io.Reader,
	stdout io.Writer,
	args ...string,
)

RunCommandSuccess runs the command and makes sure it was successful.

func RunCommandSuccessStdout

func RunCommandSuccessStdout(
	t *testing.T,
	newCommand func(use string) *appcmd.Command,
	expectedStdout string,
	newEnv func(use string) map[string]string,
	stdin io.Reader,
	args ...string,
)

RunCommandSuccessStdout runs the command and makes sure it was successful, and compares the stdout output.