tmtest

Documentation

Overview

Package tmtest provides helpers for testing using tendermint server.

Index

• func RunApp(ctx context.Context, t TestReporter, appName, home string) (cleanup func())
• func RunTendermint(ctx context.Context, t TestReporter, home string) (cleanup func())
• func SetupConfig(t assert.Tester, sourceDir string) (string, func())
• type TestReporter

Functions

func RunApp

func RunApp(ctx context.Context, t TestReporter, appName, home string) (cleanup func())

RunApp is like RunTendermint, just executes the application executable, assuming a prepared home directory

func RunTendermint

func RunTendermint(ctx context.Context, t TestReporter, home string) (cleanup func())

RunTendermint starts a tendermit process. Returned cleanup function will ensure the process has stopped and will block until.

Set FORCE_TM_TEST=1 environment variable to fail the test if the binary is not available. This might be desired when running tests by CI.

Set TM_DEBUG=1 environmental variable to output all tm logs

func SetupConfig

func SetupConfig(t assert.Tester, sourceDir string) (string, func())

SetupConfig creates a homedir to run inside, and copies demo tendermint files there.

these files reside in sourceDir and can be created via `tendermint init` (sourceDir can usually be "testdata")

second argument is cleanup call

Types

type TestReporter

type TestReporter interface {
	assert.Tester
	Skip(...interface{})
	Skipf(string, ...interface{})
	Logf(string, ...interface{})
}

TestReporter is the minimal subset of testing.TB needed to run these test helpers