Package suite

// Basic imports
import (
    "testing"
    "github.com/stretchr/testify/assert"
    "github.com/stretchr/testify/suite"
)

// 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 {
    suite.Suite
    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))
}

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 ¶

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

type AfterTest interface {
    AfterTest(suiteName, testName string)
}

type BeforeTest ¶

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

type BeforeTest interface {
    BeforeTest(suiteName, testName string)
}

type SetupAllSuite ¶

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

type SetupAllSuite interface {
    SetupSuite()
}

type SetupSubTest ¶

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

type SetupSubTest interface {
    SetupSubTest()
}

type SetupTestSuite ¶

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

type SetupTestSuite interface {
    SetupTest()
}

type Suite ¶

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

type Suite struct {
    *assert.Assertions
    // contains filtered or unexported fields
}

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 ¶

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 ¶

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 ¶

SuiteInformation stats stores stats for the whole suite execution.

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

func (SuiteInformation) Passed ¶

func (s SuiteInformation) Passed() bool

type TearDownAllSuite ¶

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

type TearDownAllSuite interface {
    TearDownSuite()
}

type TearDownSubTest ¶

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

type TearDownSubTest interface {
    TearDownSubTest()
}

type TearDownTestSuite ¶

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

type TearDownTestSuite interface {
    TearDownTest()
}

type TestInformation ¶

TestInformation stores information about the execution of each test.

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

type TestingSuite ¶

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

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

type WithStats ¶

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.

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