func CreateTemplateVersionSource ¶ added in v0.4.0

func CreateTemplateVersionSource(t *testing.T, responses *echo.Responses) string

CreateTemplateVersionSource writes the echo provisioner responses into a new temporary testing directory.

func HandlersOK ¶ added in v0.25.0

func HandlersOK(t *testing.T, cmd *clibase.Cmd)

HandlersOK asserts that all commands have a handler. Without a handler, the command has no default behavior. Even for non-root commands (like 'groups' or 'users'), a handler is required. These handlers are likely just the 'help' handler, but this must be explicitly set.

func New ¶

func New(t *testing.T, args ...string) (*clibase.Invocation, config.Root)

New creates a CLI instance with a configuration pointed to a temporary testing directory.

func NewWithCommand ¶ added in v0.21.0

func NewWithCommand(
	t *testing.T, cmd *clibase.Cmd, args ...string,
) (*clibase.Invocation, config.Root)

func NormalizeGoldenFile ¶ added in v0.24.1

func NormalizeGoldenFile(t *testing.T, byt []byte) []byte

NormalizeGoldenFile replaces any strings that are system or timing dependent with a placeholder so that the golden files can be compared with a simple equality check.

func Run ¶ added in v0.21.0

func Run(t *testing.T, inv *clibase.Invocation)

Run runs the command and asserts that there is no error.

func SetupConfig ¶

func SetupConfig(t *testing.T, client *codersdk.Client, root config.Root)

SetupConfig applies the URL and SessionToken of the client to the config.

func Start ¶ added in v0.19.0

func Start(t *testing.T, inv *clibase.Invocation)

Start runs the command in a goroutine and cleans it up when the test completed.

func TestCommandHelp ¶ added in v0.24.1

func TestCommandHelp(t *testing.T, getRoot func(t *testing.T) *clibase.Cmd, cases []CommandHelpCase)

TestCommandHelp will test the help output of the given commands using golden files.