testsuite

Documentation

Overview

Package testsuite contains the standard test suite

Index

• func BigIntComparer() cmp.Option
• type TestSuite
  • func NewTestSuite(tb testing.TB) *TestSuite
  • func (s *TestSuite) DeferAfterSuite(newFunc func())
  • func (s *TestSuite) DeferAfterTest(newFunc func())
  • func (s *TestSuite) Eventually(willBeTrue func() bool)
  • func (s *TestSuite) GetSuiteContext() context.Context
  • func (s *TestSuite) GetTestContext() context.Context
  • func (s *TestSuite) GetTestID() int
  • func (s *TestSuite) SetupSuite()
  • func (s *TestSuite) SetupTest()
  • func (s *TestSuite) TearDownSuite()
  • func (s *TestSuite) TearDownTest()

Functions

func BigIntComparer

func BigIntComparer() cmp.Option

BigIntComparer gets the big int comparer for testing.

Types

type TestSuite

type TestSuite struct {
	suite.Suite
	// contains filtered or unexported fields
}

TestSuite defines the basic test suite. TODO: we should make sure global vars don't get mutated. Namely eth params.

func NewTestSuite

func NewTestSuite(tb testing.TB) *TestSuite

NewTestSuite creates a new test suite and performs some basic checks afterward. Every test suite in the synapse library should inherit from this suite and override where necessary.

func (*TestSuite) DeferAfterSuite

func (s *TestSuite) DeferAfterSuite(newFunc func())

DeferAfterSuite runs a function after the suite. This will run before context cancellation if you'd like to do otherwise you can from a new goroutine that watches SuiteContext() TODO: in cases of crashes this will not be done so fix this.

func (*TestSuite) DeferAfterTest

func (s *TestSuite) DeferAfterTest(newFunc func())

DeferAfterTest runs a function after the test. This will run before context cancellation if you'd like to do otherwise you can from a new goroutine that watches TestContext() TODO: in cases of crashes this will not be done so fix this.

func (*TestSuite) Eventually

func (s *TestSuite) Eventually(willBeTrue func() bool)

Eventually asserts something is eventually true.

func (*TestSuite) GetSuiteContext

func (s *TestSuite) GetSuiteContext() context.Context

GetSuiteContext returns the context for the test suite.

func (*TestSuite) GetTestContext

func (s *TestSuite) GetTestContext() context.Context

GetTestContext gets the context object for the suite. This is an alias for GetTestContext() TODO: right now this is run as a test because of naming. this is mostly harmless.

func (*TestSuite) GetTestID

func (s *TestSuite) GetTestID() int

GetTestID gets the unique test id for the current test. uniqueness is per-suite.

func (*TestSuite) SetupSuite

func (s *TestSuite) SetupSuite()

SetupSuite sets up the test suite.

func (*TestSuite) SetupTest

func (s *TestSuite) SetupTest()

SetupTest runs checks at the end of the test suite.

func (*TestSuite) TearDownSuite

func (s *TestSuite) TearDownSuite()

TearDownSuite tears down the test suite.

func (*TestSuite) TearDownTest

func (s *TestSuite) TearDownTest()

TearDownTest runs checks at the end of the test suite.