dbtest

Documentation

Index

• Variables
• func Run(t *testing.T, db TestableDB, cfg Config)
• type Config
  • func (cfg *Config) InitDefaults()
• type TestableDB

Variables

var (
	// DefaultTimeout is the default timeout for running the test harness.
	DefaultTimeout = 5 * time.Second
	// DefaultRelPath is the default relative path to the test data.
	DefaultRelPath = "../dbtest/testdata"
)

Functions

func Run

func Run(t *testing.T, db TestableDB, cfg Config)

Run should be used to test any implementation of the trust.DB interface. An implementation interface should at least have one test method that calls this test-suite.

Types

type Config

type Config struct {
	Timeout time.Duration
	RelPath string
}

Config holds the configuration for the trust database testing harness.

func (*Config) InitDefaults

func (cfg *Config) InitDefaults()

InitDefaults initializes the default values for the config.

type TestableDB

type TestableDB interface {
	trust.DB
	// Prepare should reset the internal state so that the db is empty and is ready to be tested.
	Prepare(*testing.T, context.Context)
}

TestableDB extends the trust db interface with methods that are needed for testing.