testutil

Documentation

Index

• func CaptureOutStreams(fn func() error) (string, string, error)
• func TestCommand(t *testing.T, cmd TestableCommand, cases map[string]TestCase)
• type DataType
• type Fixture
  • func NewFixture(t *testing.T) *Fixture
  • func NewFixtureWithConfigFile(t *testing.T, f any) *Fixture
  • func (f *Fixture) ExpectEnsureToken()
  • func (f *Fixture) Finish()
  • func (f *Fixture) Run(cmd *cobra.Command, args []string) (string, string, error)
  • func (f *Fixture) State() state.State
• type TestCase
• type TestableCommand

Functions

func CaptureOutStreams

func CaptureOutStreams(fn func() error) (string, string, error)

CaptureOutStreams redirects stdout & stderr while running fn and returns the outputs as a string. If there's an error during capture, it returns the error, otherwise it returns the error returned by fn.

func TestCommand

func TestCommand(t *testing.T, cmd TestableCommand, cases map[string]TestCase)

Types

type DataType

type DataType string

const (
	DataTypeText DataType = "text"
	DataTypeJSON DataType = "json"
	DataTypeYAML DataType = "yaml"
)

type Fixture

type Fixture struct {
	MockController *gomock.Controller
	Client         *hcapi2_mock.Client
	ActionWaiter   *state.MockActionWaiter
	TokenEnsurer   *state.MockTokenEnsurer
	Config         *config.MockConfig
	Terminal       *terminal.MockTerminal
}

Fixture provides affordances for testing CLI commands.

func NewFixture

func NewFixture(t *testing.T) *Fixture

NewFixture creates a new Fixture with default config file.

func NewFixtureWithConfigFile

func NewFixtureWithConfigFile(t *testing.T, f any) *Fixture

NewFixtureWithConfigFile creates a new Fixture with the given config file. See config.Config.Read for the supported types of f.

func (*Fixture) ExpectEnsureToken

func (f *Fixture) ExpectEnsureToken()

ExpectEnsureToken makes the mock TokenEnsurer expect a EnsureToken call.

func (*Fixture) Finish

func (f *Fixture) Finish()

Finish must be called after the test is finished, preferably via `defer` directly after creating the Fixture.

func (*Fixture) Run

func (f *Fixture) Run(cmd *cobra.Command, args []string) (string, string, error)

Run runs the given cobra command with the given arguments and returns stdout output and a potential error.

func (*Fixture) State

func (f *Fixture) State() state.State

State returns a state.State implementation for testing purposes.

type TestCase

type TestCase struct {
	Args          []string
	PreRun        func(t *testing.T, fx *Fixture)
	ExpOut        string
	ExpOutType    DataType
	ExpErrOut     string
	ExpErrOutType DataType
	ExpErr        string
}

type TestableCommand

type TestableCommand interface {
	CobraCommand(state.State) *cobra.Command
}