suite

package

v0.0.1 Latest Latest Go to latest Published: Feb 19, 2022 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/zpatrick/testx

Links

Open Source Insights

Documentation ¶

Index ¶

func Get[S Suite](tb testing.TB) (s S)
func Register(s Suite)
func Run(m *testing.M) int
func Teardown() error
type Base
- func (Base) Setup(tb testing.TB) error
- func (Base) Teardown() error
type Suite

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Get ¶

func Get[S Suite](tb testing.TB) (s S)

Get returns the instance of S which must have been previously registered using Register. If this is the first time Get is called for type S, the suite's Setup method will be ran. If the suite's Setup method failed, t.Fatal will be called.

func Register ¶

func Register(s Suite)

Register allows a suite of type s to be later retrieved using Get. Only one instance of type s should be registered - multiple calls to Register using the same type will cause a panic.

func Run ¶

func Run(m *testing.M) int

Run is a helper method which calls m.Run and the Teardown function, returning the exit code from m.Run, or 1 if an error occured during Teardown.

func Teardown ¶

func Teardown() error

Teardown runs the Teardown method on registered suites who ran their Setup methods. If a suite was registered but never retrieved (by using the Get function), it's teardown method will not be run.

Types ¶

type Base ¶

type Base struct{}

Base is a placeholder type which can be embedded into other suites if they don't need to implement setup or teardown methods.

func (Base) Setup ¶

func (Base) Setup(tb testing.TB) error

Setup is a no-op.

func (Base) Teardown ¶

func (Base) Teardown() error

Teardown is a no-op.

type Suite ¶

type Suite interface {
	Setup(t testing.TB) error
	Teardown() error
}

A Suite holds some shared state for multiple tests. The state should be instantiated during the Setup method and (if neccessary) cleaned up during the Teardown method.

Source Files ¶

View all Source files

suite.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL