v1.9.0 Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Feb 29, 2024 License: MIT Imports: 11 Imported by: 2,045



Package suite contains logic for creating testing suite structs and running the methods on those structs as tests. The most useful piece of this package is that you can create setup/teardown methods on your testing suites, which will run before/after the whole suite or individual tests (depending on which interface(s) you implement).

A testing suite is usually built by first extending the built-in suite functionality from suite.Suite in testify. Alternatively, you could reproduce that logic on your own if you wanted (you just need to implement the TestingSuite interface from suite/interfaces.go).

After that, you can implement any of the interfaces in suite/interfaces.go to add setup/teardown functionality to your suite, and add any methods that start with "Test" to add tests. Methods that do not match any suite interfaces and do not begin with "Test" will not be run by testify, and can safely be used as helper methods.

Once you've built your testing suite, you need to run the suite (using suite.Run from testify) inside any function that matches the identity that "go test" is already looking for (i.e. func(*testing.T)).

Regular expression to select test suites specified command-line argument "-run". Regular expression to select the methods of test suites specified command-line argument "-m". Suite object has assertion methods.

A crude example:

// Basic imports
import (

// Define the suite, and absorb the built-in basic suite
// functionality from testify - including a T() method which
// returns the current testing context
type ExampleTestSuite struct {
    VariableThatShouldStartAtFive int

// Make sure that VariableThatShouldStartAtFive is set to five
// before each test
func (suite *ExampleTestSuite) SetupTest() {
    suite.VariableThatShouldStartAtFive = 5

// All methods that begin with "Test" are run as tests within a
// suite.
func (suite *ExampleTestSuite) TestExample() {
    assert.Equal(suite.T(), 5, suite.VariableThatShouldStartAtFive)
    suite.Equal(5, suite.VariableThatShouldStartAtFive)

// In order for 'go test' to run this suite, we need to create
// a normal test function and pass our suite to suite.Run
func TestExampleTestSuite(t *testing.T) {
    suite.Run(t, new(ExampleTestSuite))



This section is empty.


This section is empty.


func Run

func Run(t *testing.T, suite TestingSuite)

Run takes a testing suite and runs all of the tests attached to it.


type AfterTest added in v1.2.0

type AfterTest interface {
	AfterTest(suiteName, testName string)

AfterTest has a function to be executed right after the test finishes and receives the suite and test names as input

type BeforeTest added in v1.2.0

type BeforeTest interface {
	BeforeTest(suiteName, testName string)

BeforeTest has a function to be executed right before the test starts and receives the suite and test names as input

type SetupAllSuite

type SetupAllSuite interface {

SetupAllSuite has a SetupSuite method, which will run before the tests in the suite are run.

type SetupSubTest added in v1.8.2

type SetupSubTest interface {

SetupSubTest has a SetupSubTest method, which will run before each subtest in the suite.

type SetupTestSuite

type SetupTestSuite interface {

SetupTestSuite has a SetupTest method, which will run before each test in the suite.

type Suite

type Suite struct {
	// contains filtered or unexported fields

Suite is a basic testing suite with methods for storing and retrieving the current *testing.T context.

func (*Suite) Assert

func (suite *Suite) Assert() *assert.Assertions

Assert returns an assert context for suite. Normally, you can call `suite.NoError(expected, actual)`, but for situations where the embedded methods are overridden (for example, you might want to override assert.Assertions with require.Assertions), this method is provided so you can call `suite.Assert().NoError()`.

func (*Suite) Require

func (suite *Suite) Require() *require.Assertions

Require returns a require context for suite.

func (*Suite) Run added in v1.3.0

func (suite *Suite) Run(name string, subtest func()) bool

Run provides suite functionality around golang subtests. It should be called in place of t.Run(name, func(t *testing.T)) in test suite code. The passed-in func will be executed as a subtest with a fresh instance of t. Provides compatibility with go test pkg -run TestSuite/TestName/SubTestName.

func (*Suite) SetS added in v1.8.2

func (suite *Suite) SetS(s TestingSuite)

SetS needs to set the current test suite as parent to get access to the parent methods

func (*Suite) SetT

func (suite *Suite) SetT(t *testing.T)

SetT sets the current *testing.T context.

func (*Suite) T

func (suite *Suite) T() *testing.T

T retrieves the current *testing.T context.

type SuiteInformation added in v1.6.0

type SuiteInformation struct {
	Start, End time.Time
	TestStats  map[string]*TestInformation

SuiteInformation stats stores stats for the whole suite execution.

func (SuiteInformation) Passed added in v1.6.0

func (s SuiteInformation) Passed() bool

type TearDownAllSuite

type TearDownAllSuite interface {

TearDownAllSuite has a TearDownSuite method, which will run after all the tests in the suite have been run.

type TearDownSubTest added in v1.8.2

type TearDownSubTest interface {

TearDownSubTest has a TearDownSubTest method, which will run after each subtest in the suite have been run.

type TearDownTestSuite

type TearDownTestSuite interface {

TearDownTestSuite has a TearDownTest method, which will run after each test in the suite.

type TestInformation added in v1.6.0

type TestInformation struct {
	TestName   string
	Start, End time.Time
	Passed     bool

TestInformation stores information about the execution of each test.

type TestingSuite

type TestingSuite interface {
	T() *testing.T
	SetS(suite TestingSuite)

TestingSuite can store and return the current *testing.T context generated by 'go test'.

type WithStats added in v1.6.0

type WithStats interface {
	HandleStats(suiteName string, stats *SuiteInformation)

WithStats implements HandleStats, a function that will be executed when a test suite is finished. The stats contain information about the execution of that suite and its tests.

Jump to

Keyboard shortcuts

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