clitest

Documentation

Index

• Variables
• func CreateTemplateVersionSource(t *testing.T, responses *echo.Responses) string
• func New(t *testing.T, args ...string) (*clibase.Invocation, config.Root)
• func NewWithCommand(t *testing.T, cmd *clibase.Cmd, args ...string) (*clibase.Invocation, config.Root)
• func NormalizeGoldenFile(t *testing.T, byt []byte) []byte
• func Run(t *testing.T, inv *clibase.Invocation)
• func SetupConfig(t *testing.T, client *codersdk.Client, root config.Root)
• func Start(t *testing.T, inv *clibase.Invocation)
• func TestCommandHelp(t *testing.T, getRoot func(t *testing.T) *clibase.Cmd, cases []CommandHelpCase)
• type CommandHelpCase
  • func DefaultCases() []CommandHelpCase
• type ErrorWaiter
  • func StartWithWaiter(t *testing.T, inv *clibase.Invocation) *ErrorWaiter
  • func (w *ErrorWaiter) Cancel()
  • func (w *ErrorWaiter) RequireAs(want interface{})
  • func (w *ErrorWaiter) RequireContains(s string)
  • func (w *ErrorWaiter) RequireError()
  • func (w *ErrorWaiter) RequireIs(want error)
  • func (w *ErrorWaiter) RequireSuccess()
  • func (w *ErrorWaiter) Wait() error

Variables

var UpdateGoldenFiles = flag.Bool("update", false, "update .golden files")

UpdateGoldenFiles indicates golden files should be updated. To update the golden files: make update-golden-files

Functions

func CreateTemplateVersionSource

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

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

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

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

func NormalizeGoldenFile

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

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

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

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.

Types

type CommandHelpCase

type CommandHelpCase struct {
	Name string
	Cmd  []string
}

func DefaultCases

func DefaultCases() []CommandHelpCase

type ErrorWaiter

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

func StartWithWaiter

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

StartWithWaiter runs the command in a goroutine but returns the error instead of asserting it. This is useful for testing error cases.

func (*ErrorWaiter) Cancel

func (w *ErrorWaiter) Cancel()

func (*ErrorWaiter) RequireAs

func (w *ErrorWaiter) RequireAs(want interface{})

func (*ErrorWaiter) RequireContains

func (w *ErrorWaiter) RequireContains(s string)

func (*ErrorWaiter) RequireError

func (w *ErrorWaiter) RequireError()

func (*ErrorWaiter) RequireIs

func (w *ErrorWaiter) RequireIs(want error)

func (*ErrorWaiter) RequireSuccess

func (w *ErrorWaiter) RequireSuccess()

func (*ErrorWaiter) Wait

func (w *ErrorWaiter) Wait() error