testutil

Documentation

Index

• Constants
• func ApplyMockIO(c *cobra.Command) (BufferReader, BufferWriter)
• func DefaultContext(key, tkey storetypes.StoreKey) sdk.Context
• func DefaultContextWithKeys(keys map[string]*storetypes.KVStoreKey, ...) sdk.Context
• func DiffCollectionsMigration(ctx sdk.Context, storeKey *storetypes.KVStoreKey, iterations int, ...) error
• 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(tb testing.TB) string
• func PostRequest(url, contentType string, data []byte) ([]byte, error)
• func RandSliceElem[E any](r *rand.Rand, elems []E) (E, bool)
• func RequireProtoDeepEqual(t *testing.T, p1, p2 interface{})
• func TempFile(tb testing.TB) *os.File
• func WriteToNewTempFile(tb 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(tb testing.TB, key, tkey storetypes.StoreKey) TestContext

Constants

const (
	AccountsModuleName              = "accounts"
	AuthModuleName                  = "auth"
	AuthzModuleName                 = "authz"
	BankModuleName                  = "bank"
	CircuitModuleName               = "circuit"
	DistributionModuleName          = "distribution"
	EvidenceModuleName              = "evidence"
	FeegrantModuleName              = "feegrant"
	GovModuleName                   = "gov"
	GroupModuleName                 = "group"
	MintModuleName                  = "mint"
	NFTModuleName                   = "nft"
	ParamsModuleName                = "params"
	ProtocolPoolModuleName          = "protocolpool"
	SlashingModuleName              = "slashing"
	StakingModuleName               = "staking"
	AuthTxConfigDepinjectModuleName = "tx"
	UpgradeModuleName               = "upgrade"
	EpochsModuleName                = "epochs"
	ValidateModuleName              = "validate"
)

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, tkey storetypes.StoreKey) sdk.Context

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

func DefaultContextWithKeys

func DefaultContextWithKeys(
	keys map[string]*storetypes.KVStoreKey,
	transKeys map[string]*storetypes.TransientStoreKey,
	memKeys map[string]*storetypes.MemoryStoreKey,
) sdk.Context

DefaultContextWithKeys creates a sdk.Context with a fresh MemDB, mounting the providing keys for usage in the multistore. This function is intended to be used for testing purposes only.

func DiffCollectionsMigration

func DiffCollectionsMigration(
	ctx sdk.Context,
	storeKey *storetypes.KVStoreKey,
	iterations int,
	writeElem func(int64),
	targetHash string,
) error

DiffCollectionsMigration is meant to aid in the migration from the previous store solution to collections. It takes a few steps to use it:

1. Write a test function that writes elements using the old store solution.
2. Run the test function and copy the hash that it outputs (run it a couple of times to make sure no non-deterministic data is being used).
3. Change the code to use collections and run the test function again to make sure the hash didn't change.

First we write it as such:

func TestMigrateStore(t *testing.T) {
	DiffCollectionsMigration(
		ctx,
		storeKey,
		100,
		func(i int64) {
			err := SetPreviousProposerConsAddr(ctx, addrs[i])
			require.NoError(t, err)
		},
		"abcdef0123456789",
	)
}

Then after we change the code to use collections, we modify the writeElem function:

func TestMigrateStore(t *testing.T) {
	DiffCollectionsMigration(
		ctx,
		storeKey,
		100,
		func(i int64) {
			err := keeper.PreviousProposer.Set(ctx, addrs[i])
			require.NoError(t, err)
		},
		"abcdef0123456789",
	)
}

func GenerateCoinKey

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

GenerateCoinKey generates a new key mnemonic along with its address.

func GenerateSaveCoinKey

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

GenerateSaveCoinKey generates a new key mnemonic with its address. 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(tb testing.TB) string

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

func PostRequest

func PostRequest(url, 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 RequireProtoDeepEqual

func RequireProtoDeepEqual(t *testing.T, p1, p2 interface{})

RequireProtoDeepEqual fails the test t if p1 and p2 are not equivalent protobuf messages. Where p1 and p2 are proto.Message or slices of proto.Message.

func TempFile

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

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

func WriteToNewTempFile

func WriteToNewTempFile(tb 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

ApplyMockIODiscardOutErr 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  corestore.KVStoreWithBatch
	CMS store.CommitMultiStore
}

func DefaultContextWithDB

func DefaultContextWithDB(tb testing.TB, key, tkey storetypes.StoreKey) TestContext