cmd

Documentation

Index

• Constants
• func Execute()
• func TestCommand(setup TestSetupFunc) *cobra.Command
• type Test
  • func NewTest(ast *ast.Package) Test
  • func (t *Test) Error() error
  • func (t *Test) Name() string
  • func (t *Test) Run(executor TestExecutor)
• type TestExecutor
  • func NewTestExecutor(ctx context.Context) (TestExecutor, error)
• type TestReporter
  • func NewTestReporter(verbosity int) TestReporter
  • func (t *TestReporter) ReportTestRun(test *Test)
  • func (t *TestReporter) Summarize(tests []*Test)
• type TestRunner
  • func NewTestRunner(reporter TestReporter) TestRunner
  • func (t *TestRunner) Finish()
  • func (t *TestRunner) Gather(rootDir string, names []string) error
  • func (t *TestRunner) Run(executor TestExecutor, verbosity int)
• type TestSetupFunc

Constants

const DefaultInfluxDBHost = "http://localhost:9999"

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func TestCommand

func TestCommand(setup TestSetupFunc) *cobra.Command

Types

type Test

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

Test wraps the functionality of a single testcase statement, to handle its execution and its pass/fail state.

func NewTest

func NewTest(ast *ast.Package) Test

NewTest creates a new Test instance from an ast.Package.

func (*Test) Error

func (t *Test) Error() error

Get the error from the test, if one exists.

func (*Test) Name

func (t *Test) Name() string

Get the name of the Test.

func (*Test) Run

func (t *Test) Run(executor TestExecutor)

Run the test, saving the error to the err property of the struct.

type TestExecutor

type TestExecutor interface {
	Run(pkg *ast.Package) error
	io.Closer
}

func NewTestExecutor

func NewTestExecutor(ctx context.Context) (TestExecutor, error)

type TestReporter

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

TestReporter handles reporting of test results.

func NewTestReporter

func NewTestReporter(verbosity int) TestReporter

NewTestReporter creates a new TestReporter with a provided verbosity.

func (*TestReporter) ReportTestRun

func (t *TestReporter) ReportTestRun(test *Test)

ReportTestRun reports the result a single test run, intended to be run as each test is run.

func (*TestReporter) Summarize

func (t *TestReporter) Summarize(tests []*Test)

Summarize summarizes the test run.

type TestRunner

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

TestRunner gathers and runs all tests.

func NewTestRunner

func NewTestRunner(reporter TestReporter) TestRunner

NewTestRunner returns a new TestRunner.

func (*TestRunner) Finish

func (t *TestRunner) Finish()

Finish summarizes the test run, and returns the exit code based on success for failure.

func (*TestRunner) Gather

func (t *TestRunner) Gather(rootDir string, names []string) error

Gather gathers all tests from the filesystem and creates Test instances from that info.

func (*TestRunner) Run

func (t *TestRunner) Run(executor TestExecutor, verbosity int)

Run runs all tests, reporting their results.

type TestSetupFunc

type TestSetupFunc func(ctx context.Context) (TestExecutor, error)