goldentest

Documentation

Overview

Package goldentest implements golden test related subcommands.

Package goldentest implements golden test related subcommands.

Package goldentest implements golden test related subcommands.

Package goldentest implements golden test related subcommands.

Package goldentest implements golden test related subcommands.

Index

• type Flags
  • func (r *Flags) Register(set *cli.FlagSet)
• type NewTestCommand
  • func (c *NewTestCommand) Desc() string
  • func (c *NewTestCommand) Flags() *cli.FlagSet
  • func (c *NewTestCommand) Help() string
  • func (c *NewTestCommand) PredictArgs() complete.Predictor
  • func (c *NewTestCommand) Run(ctx context.Context, args []string) (rErr error)
• type NewTestFlags
  • func (r *NewTestFlags) Register(set *cli.FlagSet)
• type RecordCommand
  • func (c *RecordCommand) Desc() string
  • func (c *RecordCommand) Flags() *cli.FlagSet
  • func (c *RecordCommand) Help() string
  • func (c *RecordCommand) PredictArgs() complete.Predictor
  • func (c *RecordCommand) Run(ctx context.Context, args []string) error
• type TestCase
• type VerifyCommand
  • func (c *VerifyCommand) Desc() string
  • func (c *VerifyCommand) Flags() *cli.FlagSet
  • func (c *VerifyCommand) Help() string
  • func (c *VerifyCommand) PredictArgs() complete.Predictor
  • func (c *VerifyCommand) Run(ctx context.Context, args []string) (rErr error)

Types

type Flags

type Flags struct {

	// Location is the file system location of the templates to be tested.
	//
	// Example: t/rest_server.
	Location string

	// Testnames are the name of the test cases to record or verify. If no
	// test name is specified, all gold tests will be run against.
	//
	// Optional.
	TestNames []string
}

Flags describes the template location and the test case.

func (*Flags) Register

func (r *Flags) Register(set *cli.FlagSet)

type NewTestCommand

type NewTestCommand struct {
	cli.BaseCommand
	// contains filtered or unexported fields
}

func (*NewTestCommand) Desc

func (c *NewTestCommand) Desc() string

func (*NewTestCommand) Flags

func (c *NewTestCommand) Flags() *cli.FlagSet

func (*NewTestCommand) Help

func (c *NewTestCommand) Help() string

func (*NewTestCommand) PredictArgs

func (c *NewTestCommand) PredictArgs() complete.Predictor

func (*NewTestCommand) Run

func (c *NewTestCommand) Run(ctx context.Context, args []string) (rErr error)

type NewTestFlags

type NewTestFlags struct {

	// Location is the file system location of the template to be tested.
	//
	// Example: t/rest_server.
	Location string

	// NewTestName are the name of the test case to create.
	NewTestName string

	// Flag arguments (--foo):
	// See common/flags.Inputs().
	Inputs map[string]string

	// Whether to prompt the user for new-test inputs.
	Prompt bool

	// Fake builtin_vars used in goldentest.
	BuiltinVars map[string]string

	// ForceOverwrite lets existing test config file be overwritten.
	ForceOverwrite bool

	// See common/flags.AcceptDefaults().
	AcceptDefaults bool
}

NewTestFlags describes what new golden test to render and how.

func (*NewTestFlags) Register

func (r *NewTestFlags) Register(set *cli.FlagSet)

type RecordCommand

type RecordCommand struct {
	cli.BaseCommand
	// contains filtered or unexported fields
}

func (*RecordCommand) Desc

func (c *RecordCommand) Desc() string

func (*RecordCommand) Flags

func (c *RecordCommand) Flags() *cli.FlagSet

func (*RecordCommand) Help

func (c *RecordCommand) Help() string

func (*RecordCommand) PredictArgs

func (c *RecordCommand) PredictArgs() complete.Predictor

func (*RecordCommand) Run

func (c *RecordCommand) Run(ctx context.Context, args []string) error

type TestCase

type TestCase struct {
	// Name of the test case.
	// Example: nextjs_with_auth0_idp.
	TestName string

	// Config of the test case.
	TestConfig *goldentest.Test
}

TestCase describes a template golden test case.

type VerifyCommand

type VerifyCommand struct {
	cli.BaseCommand
	// contains filtered or unexported fields
}

func (*VerifyCommand) Desc

func (c *VerifyCommand) Desc() string

func (*VerifyCommand) Flags

func (c *VerifyCommand) Flags() *cli.FlagSet

func (*VerifyCommand) Help

func (c *VerifyCommand) Help() string

func (*VerifyCommand) PredictArgs

func (c *VerifyCommand) PredictArgs() complete.Predictor

func (*VerifyCommand) Run

func (c *VerifyCommand) Run(ctx context.Context, args []string) (rErr error)