README
¶
Integration testing in Go
goint is an integration testing framework written in Go. It was written for use in applications developed in Go. While the implementation of an integration test using the framework must be written in Go, much of the functionality can be used for applications written in other languages as well. Some of the functionality could be used in contexts other than integration testing (e.g., verifying deployments or health checks).
Features
goint implements several capabilities which can be called verbs. goint supports the following verbs:
Exec- executes an arbitrary process. This can be anything that can be launched from a shell command line. One field in theExecstruct isTokenwhich can be referenced in theKillandWaitverbs.Kill- used to kill anExec'd process. The process to be killed is identified by theTokenfield value in the correspondingExecdefinition.Delay- does just that, it delays for a given amount of time and then continuesWait- waits for a processExec'd with the matchingTokenvalue to exitCurl- will run an aribtrary curl requestDelayHealthCheck- pings an arbitrary URL for a given number of times waiting a given number of sections between polls. It will complete with either an error or success.GoFunc- will run an arbitrary Go function.Comp- combines an arbitrary set of the above verbs into a composite action.Compverbs can be nested to create arbitrarily complex hierarchies of arbitrarily complex steps.
Examples
See goint_test.go.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( TailReportOnError = stream{ Report: 1, TailMode: true, } TailReportOn = stream{ TailMode: true, } ReportOn = stream{} )
var (
Execs map[string]*Exec
)
Functions ¶
func ReportNode ¶
func ReportNodeSkipped ¶
Types ¶
type Comp ¶
type Comp struct {
// Name of this step
Name string // Name of the step. Documentation only
Sequential bool // The nodes in SubN should be done serially
SubN []Worker
Err error
}
Comp is a composite node. It groups multiple nodes together
type Curl ¶
type Curl struct {
Name string // Name of the step. Documentation only
URL string
PrintBodyFlag bool
Resp *http.Response
Err error
}
Curl is used to do an http request a la curl
type Delay ¶
type Delay struct {
Name string // Name of the step. Documentation only
Duration time.Duration
Err error
}
These types are used to implement the integration test spec
type DelayHealthCheck ¶
type DelayHealthCheck struct {
Name string // Name of the step. Documentation only
URL string
Resp *http.Response
PollInterval time.Duration
NPolls int
Err error
}
These types are used to implement the integration test spec
func (*DelayHealthCheck) Go ¶
func (w *DelayHealthCheck) Go(wg *sync.WaitGroup)
---------------- DelayHealthCheck Methods
func (*DelayHealthCheck) Report ¶
func (w *DelayHealthCheck) Report(dep int) error
type Exec ¶
type Exec struct {
Name string // Name of the step. Documentation only
Token string
Directory string
Precommand string
Command func() *exec.Cmd
Args []string
Sequential bool // DEPRECATED, remove all references
SubN []Worker
Cmd *exec.Cmd
Pid int // Pid of process
Err error
KilledExplicitly bool // Whether killed explicitly by Kill worker
Stdout stream
Stderr stream
// contains filtered or unexported fields
}
These types are used to implement the integration test spec
type GoFunc ¶
type GoFunc struct {
Name string // Name of the step. Documentation only
Func GoRoutine // Function to invoke
Skip bool // Flag to skip a test case, this will be reported SKIPPED in test report
Err error
}
GoFunc is used to embed
Source Files