test

Documentation

Index

• func ReadTestdata(t *testing.T, filename string) []byte
• func TestdataPath(t *testing.T, filename string) string
• type Agent
  • func (a *Agent) Abort()
  • func (a *Agent) RunCancel(t *testing.T)
  • func (a *Agent) RunCheckErr(t *testing.T, expectedErr string)
  • func (a *Agent) RunError(t *testing.T)
  • func (a *Agent) RunSuccess(t *testing.T)
• type AgentOption
  • func WithAgentOptions(options agent.Options) AgentOption
• type CmdTest
• type CmdTestHelper
  • func SetupCommand(t *testing.T) CmdTestHelper
  • func (th CmdTestHelper) RunCommand(t *testing.T, cmd *cobra.Command, testCase CmdTest)
• type Contains
• type DAG
  • func (d *DAG) Agent(opts ...AgentOption) *Agent
  • func (d *DAG) AssertCurrentStatus(t *testing.T, expected scheduler.Status)
  • func (d *DAG) AssertHistoryCount(t *testing.T, expected int)
  • func (d *DAG) AssertLatestStatus(t *testing.T, expected scheduler.Status)
  • func (d *DAG) AssertOutputs(t *testing.T, outputs map[string]any)
• type Helper
  • func Setup(t *testing.T, opts ...TestHelperOption) Helper
  • func (h Helper) Cleanup()
  • func (h Helper) DAG(t *testing.T, name string) DAG
  • func (h Helper) DAGExpectError(t *testing.T, name string, expectedErr string)
• type NotEmpty
• type SyncBuffer
  • func (b *SyncBuffer) String() string
  • func (b *SyncBuffer) Write(p []byte) (n int, err error)
• type TestHelperOption
  • func WithCaptureLoggingOutput() TestHelperOption
  • func WithDAGsDir(dir string) TestHelperOption
• type TestOptions

Functions

func ReadTestdata

func ReadTestdata(t *testing.T, filename string) []byte

ReadTestdata reads the content of a testdata file.

func TestdataPath

func TestdataPath(t *testing.T, filename string) string

TestdataPath returns the path to a testdata file.

Types

type Agent

type Agent struct {
	*Helper
	*digraph.DAG
	*agent.Agent
	// contains filtered or unexported fields
}

func (*Agent) Abort

func (a *Agent) Abort()

func (*Agent) RunCancel

func (a *Agent) RunCancel(t *testing.T)

func (*Agent) RunCheckErr

func (a *Agent) RunCheckErr(t *testing.T, expectedErr string)

func (*Agent) RunError

func (a *Agent) RunError(t *testing.T)

func (*Agent) RunSuccess

func (a *Agent) RunSuccess(t *testing.T)

type AgentOption

type AgentOption func(*Agent)

func WithAgentOptions

func WithAgentOptions(options agent.Options) AgentOption

type CmdTest

type CmdTest struct {
	Name        string   // Name of the test.
	Args        []string // Arguments to pass to the command.
	ExpectedOut []string // Expected output to be present in the standard output / error.
}

CmdTest is a helper struct to test commands.

type CmdTestHelper

type CmdTestHelper struct {
	Helper
}

CmdTestHelper is a helper struct to test commands.

func SetupCommand

func SetupCommand(t *testing.T) CmdTestHelper

func (CmdTestHelper) RunCommand

func (th CmdTestHelper) RunCommand(t *testing.T, cmd *cobra.Command, testCase CmdTest)

type Contains

type Contains string

type DAG

type DAG struct {
	*Helper
	*digraph.DAG
}

func (*DAG) Agent

func (d *DAG) Agent(opts ...AgentOption) *Agent

func (*DAG) AssertCurrentStatus

func (d *DAG) AssertCurrentStatus(t *testing.T, expected scheduler.Status)

func (*DAG) AssertHistoryCount

func (d *DAG) AssertHistoryCount(t *testing.T, expected int)

func (*DAG) AssertLatestStatus

func (d *DAG) AssertLatestStatus(t *testing.T, expected scheduler.Status)

func (*DAG) AssertOutputs

func (d *DAG) AssertOutputs(t *testing.T, outputs map[string]any)

AssertOutputs checks the given outputs against the actual outputs of the DAG Note that this function does not respect dependencies between nodes making the outputs with the same key indeterministic

type Helper

type Helper struct {
	Context       context.Context
	Cancel        context.CancelFunc
	Config        *config.Config
	LoggingOutput *SyncBuffer
	Client        client.Client
	HistoryStore  persistence.HistoryStore
	DAGStore      persistence.DAGStore
	// contains filtered or unexported fields
}

Helper provides test utilities and configuration

func Setup

func Setup(t *testing.T, opts ...TestHelperOption) Helper

Setup creates a new Helper instance for testing

func (Helper) Cleanup

func (h Helper) Cleanup()

Cleanup removes temporary test directories

func (Helper) DAG

func (h Helper) DAG(t *testing.T, name string) DAG

DAG loads a test DAG from the testdata directory

func (Helper) DAGExpectError

func (h Helper) DAGExpectError(t *testing.T, name string, expectedErr string)

type NotEmpty

type NotEmpty struct{}

type SyncBuffer

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

SyncBuffer provides thread-safe buffer operations

func (*SyncBuffer) String

func (b *SyncBuffer) String() string

func (*SyncBuffer) Write

func (b *SyncBuffer) Write(p []byte) (n int, err error)

type TestHelperOption

type TestHelperOption func(*TestOptions)

TestHelperOption defines functional options for Helper

func WithCaptureLoggingOutput

func WithCaptureLoggingOutput() TestHelperOption

WithCaptureLoggingOutput creates a logging capture option

func WithDAGsDir

func WithDAGsDir(dir string) TestHelperOption

type TestOptions

type TestOptions struct {
	CaptureLoggingOutput bool // CaptureLoggingOutput enables capturing of logging output
	DAGsDir              string
}