testutil

Documentation

Index

• func ApplyMockIO(c *cobra.Command) (BufferReader, BufferWriter)
• func DefaultContext(key storetypes.StoreKey, tkey storetypes.StoreKey) sdk.Context
• func GenerateCoinKey(algo keyring.SignatureAlgo, cdc codec.Codec) (sdk.AccAddress, string, error)
• func GenerateSaveCoinKey(keybase keyring.Keyring, keyName, mnemonic string, overwrite bool, ...) (sdk.AccAddress, string, error)
• func GetRequest(url string) ([]byte, error)
• func GetRequestWithHeaders(url string, headers map[string]string) ([]byte, error)
• func GetTempDir(t testing.TB) string
• func PostRequest(url string, contentType string, data []byte) ([]byte, error)
• func RandSliceElem[E any](r *rand.Rand, elems []E) (E, bool)
• func TempFile(t testing.TB) *os.File
• func WriteToNewTempFile(t testing.TB, s string) *os.File
• type BufferReader
  • func ApplyMockIODiscardOutErr(c *cobra.Command) BufferReader
• type BufferWriter
• type TestAccount
  • func CreateKeyringAccounts(t *testing.T, kr keyring.Keyring, num int) []TestAccount
• type TestContext
  • func DefaultContextWithDB(t *testing.T, key storetypes.StoreKey, tkey storetypes.StoreKey) TestContext

Functions

func ApplyMockIO

func ApplyMockIO(c *cobra.Command) (BufferReader, BufferWriter)

ApplyMockIO replaces stdin/out/err with buffers that can be used during testing. Returns an input BufferReader and an output BufferWriter.

func DefaultContext

func DefaultContext(key storetypes.StoreKey, tkey storetypes.StoreKey) sdk.Context

DefaultContext creates a sdk.Context with a fresh MemDB that can be used in tests.

func GenerateCoinKey

func GenerateCoinKey(algo keyring.SignatureAlgo, cdc codec.Codec) (sdk.AccAddress, string, error)

GenerateCoinKey generates a new key mnemonic along with its addrress.

func GenerateSaveCoinKey

func GenerateSaveCoinKey(
	keybase keyring.Keyring,
	keyName, mnemonic string,
	overwrite bool,
	algo keyring.SignatureAlgo,
) (sdk.AccAddress, string, error)

GenerateSaveCoinKey generates a new key mnemonic with its addrress. If mnemonic is provided then it's used for key generation. The key is saved in the keyring. The function returns error if overwrite=true and the key already exists.

func GetRequest

func GetRequest(url string) ([]byte, error)

GetRequest defines a wrapper around an HTTP GET request with a provided URL. An error is returned if the request or reading the body fails.

func GetRequestWithHeaders

func GetRequestWithHeaders(url string, headers map[string]string) ([]byte, error)

GetRequestWithHeaders defines a wrapper around an HTTP GET request with a provided URL and custom headers An error is returned if the request or reading the body fails.

func GetTempDir

func GetTempDir(t testing.TB) string

GetTempDir returns a writable temporary director for the test to use.

func PostRequest

func PostRequest(url string, contentType string, data []byte) ([]byte, error)

PostRequest defines a wrapper around an HTTP POST request with a provided URL and data. An error is returned if the request or reading the body fails.

func RandSliceElem

func RandSliceElem[E any](r *rand.Rand, elems []E) (E, bool)

func TempFile

func TempFile(t testing.TB) *os.File

TempFile returns a writable temporary file for the test to use.

func WriteToNewTempFile

func WriteToNewTempFile(t testing.TB, s string) *os.File

Write the given string to a new temporary file. Returns an open file for the test to use.

Types

type BufferReader

type BufferReader interface {
	io.Reader
	Reset(string)
}

BufferReader is implemented by types that read from a string buffer.

func ApplyMockIODiscardOutErr

func ApplyMockIODiscardOutErr(c *cobra.Command) BufferReader

ApplyMockIODiscardOutputs replaces a cobra.Command output and error streams with a dummy io.Writer. Replaces and returns the io.Reader associated to the cobra.Command input stream.

type BufferWriter

type BufferWriter interface {
	io.Writer
	Reset()
	Bytes() []byte
	String() string
}

BufferWriter is implemented by types that write to a buffer.

type TestAccount

type TestAccount struct {
	Name    string
	Address types.AccAddress
}

func CreateKeyringAccounts

func CreateKeyringAccounts(t *testing.T, kr keyring.Keyring, num int) []TestAccount

type TestContext

type TestContext struct {
	Ctx sdk.Context
	DB  *dbm.MemDB
	CMS store.CommitMultiStore
}

func DefaultContextWithDB

func DefaultContextWithDB(t *testing.T, key storetypes.StoreKey, tkey storetypes.StoreKey) TestContext