summaryrefslogtreecommitdiff
path: root/vendor/github.com/stretchr/testify/suite/suite.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/stretchr/testify/suite/suite.go')
-rw-r--r--vendor/github.com/stretchr/testify/suite/suite.go253
1 files changed, 0 insertions, 253 deletions
diff --git a/vendor/github.com/stretchr/testify/suite/suite.go b/vendor/github.com/stretchr/testify/suite/suite.go
deleted file mode 100644
index 18443a91c..000000000
--- a/vendor/github.com/stretchr/testify/suite/suite.go
+++ /dev/null
@@ -1,253 +0,0 @@
-package suite
-
-import (
- "flag"
- "fmt"
- "os"
- "reflect"
- "regexp"
- "runtime/debug"
- "sync"
- "testing"
- "time"
-
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-var allTestsFilter = func(_, _ string) (bool, error) { return true, nil }
-var matchMethod = flag.String("testify.m", "", "regular expression to select tests of the testify suite to run")
-
-// Suite is a basic testing suite with methods for storing and
-// retrieving the current *testing.T context.
-type Suite struct {
- *assert.Assertions
-
- mu sync.RWMutex
- require *require.Assertions
- t *testing.T
-
- // Parent suite to have access to the implemented methods of parent struct
- s TestingSuite
-}
-
-// T retrieves the current *testing.T context.
-func (suite *Suite) T() *testing.T {
- suite.mu.RLock()
- defer suite.mu.RUnlock()
- return suite.t
-}
-
-// SetT sets the current *testing.T context.
-func (suite *Suite) SetT(t *testing.T) {
- suite.mu.Lock()
- defer suite.mu.Unlock()
- suite.t = t
- suite.Assertions = assert.New(t)
- suite.require = require.New(t)
-}
-
-// SetS needs to set the current test suite as parent
-// to get access to the parent methods
-func (suite *Suite) SetS(s TestingSuite) {
- suite.s = s
-}
-
-// Require returns a require context for suite.
-func (suite *Suite) Require() *require.Assertions {
- suite.mu.Lock()
- defer suite.mu.Unlock()
- if suite.require == nil {
- panic("'Require' must not be called before 'Run' or 'SetT'")
- }
- return suite.require
-}
-
-// 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 *Suite) Assert() *assert.Assertions {
- suite.mu.Lock()
- defer suite.mu.Unlock()
- if suite.Assertions == nil {
- panic("'Assert' must not be called before 'Run' or 'SetT'")
- }
- return suite.Assertions
-}
-
-func recoverAndFailOnPanic(t *testing.T) {
- t.Helper()
- r := recover()
- failOnPanic(t, r)
-}
-
-func failOnPanic(t *testing.T, r interface{}) {
- t.Helper()
- if r != nil {
- t.Errorf("test panicked: %v\n%s", r, debug.Stack())
- t.FailNow()
- }
-}
-
-// 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 *Suite) Run(name string, subtest func()) bool {
- oldT := suite.T()
-
- return oldT.Run(name, func(t *testing.T) {
- suite.SetT(t)
- defer suite.SetT(oldT)
-
- defer recoverAndFailOnPanic(t)
-
- if setupSubTest, ok := suite.s.(SetupSubTest); ok {
- setupSubTest.SetupSubTest()
- }
-
- if tearDownSubTest, ok := suite.s.(TearDownSubTest); ok {
- defer tearDownSubTest.TearDownSubTest()
- }
-
- subtest()
- })
-}
-
-// Run takes a testing suite and runs all of the tests attached
-// to it.
-func Run(t *testing.T, suite TestingSuite) {
- defer recoverAndFailOnPanic(t)
-
- suite.SetT(t)
- suite.SetS(suite)
-
- var suiteSetupDone bool
-
- var stats *SuiteInformation
- if _, ok := suite.(WithStats); ok {
- stats = newSuiteInformation()
- }
-
- tests := []testing.InternalTest{}
- methodFinder := reflect.TypeOf(suite)
- suiteName := methodFinder.Elem().Name()
-
- for i := 0; i < methodFinder.NumMethod(); i++ {
- method := methodFinder.Method(i)
-
- ok, err := methodFilter(method.Name)
- if err != nil {
- fmt.Fprintf(os.Stderr, "testify: invalid regexp for -m: %s\n", err)
- os.Exit(1)
- }
-
- if !ok {
- continue
- }
-
- if !suiteSetupDone {
- if stats != nil {
- stats.Start = time.Now()
- }
-
- if setupAllSuite, ok := suite.(SetupAllSuite); ok {
- setupAllSuite.SetupSuite()
- }
-
- suiteSetupDone = true
- }
-
- test := testing.InternalTest{
- Name: method.Name,
- F: func(t *testing.T) {
- parentT := suite.T()
- suite.SetT(t)
- defer recoverAndFailOnPanic(t)
- defer func() {
- t.Helper()
-
- r := recover()
-
- if stats != nil {
- passed := !t.Failed() && r == nil
- stats.end(method.Name, passed)
- }
-
- if afterTestSuite, ok := suite.(AfterTest); ok {
- afterTestSuite.AfterTest(suiteName, method.Name)
- }
-
- if tearDownTestSuite, ok := suite.(TearDownTestSuite); ok {
- tearDownTestSuite.TearDownTest()
- }
-
- suite.SetT(parentT)
- failOnPanic(t, r)
- }()
-
- if setupTestSuite, ok := suite.(SetupTestSuite); ok {
- setupTestSuite.SetupTest()
- }
- if beforeTestSuite, ok := suite.(BeforeTest); ok {
- beforeTestSuite.BeforeTest(methodFinder.Elem().Name(), method.Name)
- }
-
- if stats != nil {
- stats.start(method.Name)
- }
-
- method.Func.Call([]reflect.Value{reflect.ValueOf(suite)})
- },
- }
- tests = append(tests, test)
- }
- if suiteSetupDone {
- defer func() {
- if tearDownAllSuite, ok := suite.(TearDownAllSuite); ok {
- tearDownAllSuite.TearDownSuite()
- }
-
- if suiteWithStats, measureStats := suite.(WithStats); measureStats {
- stats.End = time.Now()
- suiteWithStats.HandleStats(suiteName, stats)
- }
- }()
- }
-
- runTests(t, tests)
-}
-
-// Filtering method according to set regular expression
-// specified command-line argument -m
-func methodFilter(name string) (bool, error) {
- if ok, _ := regexp.MatchString("^Test", name); !ok {
- return false, nil
- }
- return regexp.MatchString(*matchMethod, name)
-}
-
-func runTests(t testing.TB, tests []testing.InternalTest) {
- if len(tests) == 0 {
- t.Log("warning: no tests to run")
- return
- }
-
- r, ok := t.(runner)
- if !ok { // backwards compatibility with Go 1.6 and below
- if !testing.RunTests(allTestsFilter, tests) {
- t.Fail()
- }
- return
- }
-
- for _, test := range tests {
- r.Run(test.Name, test.F)
- }
-}
-
-type runner interface {
- Run(name string, f func(t *testing.T)) bool
-}