envtest

package
v29.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 16, 2025 License: Apache-2.0 Imports: 38 Imported by: 0

README

Ignite CLI Integration Tests

The Ignite CLI integration tests build a new application and run all Ignite CLI commands to check the Ignite CLI code integrity. The runners and helper methods are located in this current folder. The test commands are split into folders, for better concurrency, each folder is a parallel job into the CI workflow. To create a new one, we only need to create a new folder. This will be automatically detected and added into the PR CI checks, or we can only create new tests into an existing folder or file.

Running synchronously all integration tests can be very slow. The command below can run everything:

go test -v -timeout 120m ./integration

Or you can just run a specific test folder, like the list types test

go test -v -timeout 120m ./integration/list

Usage

  • Create a new env and scaffold an empty chain:
var (
 env  = envtest.New(t)
 path = env.Scaffold("github.com/test/blog")
)
  • Now, you can use the env to run the ignite commands and check the success status:
env.Must(env.Exec("create a list with bool",
    step.NewSteps(step.New(
        step.Exec(envtest.IgniteApp, "s", "list", "--yes", "document", "signed:bool"),
        step.Workdir(path),
    )),
))
env.EnsureSteady()
  • To check if the command returns an error, you can add the envtest.ExecShouldError() step:
env.Must(env.Exec("should prevent creating a list with duplicated fields",
    step.NewSteps(step.New(
        step.Exec(envtest.IgniteApp, "s", "list", "--yes", "company", "name", "name"),
        step.Workdir(path),
    )),
    envtest.ExecShouldError(),
))
env.EnsureSteady()

Documentation

Index

Constants

View Source 
const ServeTimeout = time.Minute * 15

Variables

View Source 
var (
	// IgniteApp hold the location of the ignite binary used in the integration
	// tests. The binary is compiled the first time the env.New() function is
	// invoked.
	IgniteApp = path.Join(os.TempDir(), "ignite-tests", "ignite")

	IsCI, _ = strconv.ParseBool(os.Getenv("CI"))
)

Functions

func HasTestVerboseFlag 

func HasTestVerboseFlag() bool

Types

type App 

type App struct {
	// contains filtered or unexported fields
}

func (App) APIQuery added in v29.1.0 

func (a App) APIQuery(ctx context.Context, chainAPI, namespace, module, method string, args ...string) []byte

func (*App) Binary 

func (a *App) Binary() string

Binary returns the binary name of the app. Can be executed directly w/o any path after app.Serve is called, since it should be in the $PATH.

func (App) CLIQuery added in v29.1.0 

func (a App) CLIQuery(chainRPC, module, method string, args ...string) []byte

func (App) CLIQueryTx added in v29.1.0 

func (a App) CLIQueryTx(chainRPC, txHash string) (txResponse TxResponse)

func (App) CLITx added in v29.1.0 

func (a App) CLITx(chainRPC, module, method string, args ...string) TxResponse

func (*App) Config 

func (a *App) Config() chainconfig.Config

func (*App) EditConfig 

func (a *App) EditConfig(apply func(*chainconfig.Config))

func (*App) EnableFaucet 

func (a *App) EnableFaucet(coins, coinsMax []string) (faucetAddr string)

EnableFaucet enables faucet by finding a random port for the app faucet and update config.yml with this port and provided coins options.

func (*App) EnsureSteady 

func (a *App) EnsureSteady()

EnsureSteady ensures that app living at the path can compile and its tests are passing.

func (*App) Generate added in v29.1.0 

func (a *App) Generate(msg string, shouldFail bool, args ...string)

Generate executes a code generation command in the app and optionally validates if it should fail. - msg: description of the generation operation. - shouldFail: whether the generation is expected to fail. - args: arguments for the generation command.

func (*App) GenerateTSClient 

func (a *App) GenerateTSClient() bool

GenerateTSClient runs the command to generate the Typescript client code.

func (*App) MustServe added in v29.1.0 

func (a *App) MustServe(ctx context.Context)

MustServe serves the application and ensures success, failing the test if serving fails. It uses the provided context to allow cancellation.

func (*App) RandomizeServerPorts 

func (a *App) RandomizeServerPorts() Hosts

RandomizeServerPorts randomizes server ports for the app at path, updates its config.yml and returns new values.

func (*App) RunChainAndSimulateTxs added in v29.1.0 

func (a *App) RunChainAndSimulateTxs(servers Hosts)

RunChainAndSimulateTxs starts the blockchain network and runs transaction simulations.

func (*App) RunSimulationTxs added in v29.1.0 

func (a *App) RunSimulationTxs(ctx context.Context, servers Hosts)

RunSimulationTxs runs different types of transactions for modules and queries the chain.

func (*App) Scaffold added in v29.1.0 

func (a *App) Scaffold(msg string, shouldFail bool, typeName string, args ...string)

Scaffold scaffolds a new module or component in the app and optionally validates if it should fail. - msg: description of the scaffolding operation. - shouldFail: whether the scaffolding is expected to fail. - typeName: the type of the scaffold (e.g., "map", "message"). - args: additional arguments for the scaffold command.

func (*App) SendListTxsAndQueryFirst added in v29.1.0 

func (a *App) SendListTxsAndQueryFirst(
	ctx context.Context,
	servers Hosts,
	module string,
	name multiformatname.Name,
	fields field.Fields,
)

SendListTxsAndQueryFirst sends a list transaction and queries the first element using both CLI and API.

func (*App) SendMapTxsAndQuery added in v29.1.0 

func (a *App) SendMapTxsAndQuery(
	ctx context.Context,
	servers Hosts,
	module string,
	name multiformatname.Name,
	fields field.Fields,
	index field.Field,
)

SendMapTxsAndQuery sends a map transaction and queries the element using both CLI and API.

func (*App) SendSingleTxsAndQuery added in v29.1.0 

func (a *App) SendSingleTxsAndQuery(
	ctx context.Context,
	servers Hosts,
	module string,
	name multiformatname.Name,
	fields field.Fields,
)

SendSingleTxsAndQuery submits a single transaction and queries the result from both CLI and API.

func (*App) SendTxsAndQuery added in v29.1.0 

func (a *App) SendTxsAndQuery(
	ctx context.Context,
	servers Hosts,
	module string,
	name multiformatname.Name,
	fields field.Fields,
	index string,
)

SendTxsAndQuery sends a transaction and queries the element using both CLI and API.

func (*App) Serve 

func (a *App) Serve(msg string, options ...ExecOption) (ok bool)

Serve serves an application lives under path with options where msg describes the execution from the serving action. unless calling with Must(), Serve() will not exit test runtime on failure.

func (*App) SetConfigPath 

func (a *App) SetConfigPath(path string)

func (*App) SetHomePath 

func (a *App) SetHomePath(homePath string)

func (*App) Simulate 

func (a *App) Simulate(numBlocks, blockSize int)

Simulate runs the simulation test for the app.

func (*App) SourcePath 

func (a *App) SourcePath() string

func (*App) UseRandomHomeDir 

func (a *App) UseRandomHomeDir() (homeDirPath string)

UseRandomHomeDir sets in the blockchain config files generated temporary directories for home directories. Returns the random home directory.

func (*App) WaitChainUp added in v29.1.0 

func (a *App) WaitChainUp(ctx context.Context, chainAPI string)

WaitChainUp waits the chain is up.

type AppOption 

type AppOption func(*App)

func AppConfigPath 

func AppConfigPath(path string) AppOption

func AppHomePath 

func AppHomePath(path string) AppOption

func AppTestTimeout 

func AppTestTimeout(d time.Duration) AppOption

type Env 

type Env struct {
	// contains filtered or unexported fields
}

Env provides an isolated testing environment and what's needed to make it possible.

func New 

func New(t *testing.T) Env

New creates a new testing environment.

func (Env) App 

func (e Env) App(namespace, appPath string, options ...AppOption) App

func (Env) AppHome 

func (e Env) AppHome(name string) string

AppHome returns app's root home/data dir path.

func (Env) Ctx 

func (e Env) Ctx() context.Context

Ctx returns parent context for the test suite to use for cancelations.

func (Env) Exec 

func (e Env) Exec(msg string, steps step.Steps, options ...ExecOption) (ok bool)

Exec executes a command step with options where msg describes the expectation from the test. unless calling with Must(), Exec() will not exit test runtime on failure.

func (Env) HasFailed 

func (e Env) HasFailed() bool

func (Env) Home 

func (e Env) Home() string

Home returns user's home dir.

func (Env) IsAppServed 

func (e Env) IsAppServed(ctx context.Context, apiAddr string) error

IsAppServed checks that app is served properly and servers are started to listening before ctx canceled.

func (Env) IsFaucetServed 

func (e Env) IsFaucetServed(ctx context.Context, faucetClient cosmosfaucet.HTTPClient) error

IsFaucetServed checks that faucet of the app is served properly.

func (Env) Must 

func (e Env) Must(ok bool)

Must fails the immediately if not ok. t.Fail() needs to be called for the failing tests before running Must().

func (Env) RequireExpectations 

func (e Env) RequireExpectations()

func (Env) ScaffoldApp added in v29.1.0 

func (e Env) ScaffoldApp(namespace string, flags ...string) App

ScaffoldApp scaffolds an app to a unique appPath and returns it.

func (Env) SetCleanup 

func (e Env) SetCleanup(f func())

SetCleanup registers a function to be called when the test (or subtest) and all its subtests complete.

func (Env) T 

func (e Env) T() *testing.T

func (Env) TmpDir 

func (e Env) TmpDir() (path string)

TmpDir creates a new temporary directory.

type ExecOption 

type ExecOption func(*execOptions)

func ExecCtx 

func ExecCtx(ctx context.Context) ExecOption

ExecCtx sets cancelation context for the execution.

func ExecRetry 

func ExecRetry() ExecOption

ExecRetry retries command until it is successful before context is canceled.

func ExecShouldError 

func ExecShouldError() ExecOption

ExecShouldError sets the expectations of a command's execution to end with a failure.

func ExecStderr 

func ExecStderr(w io.Writer) ExecOption

ExecStderr captures stderr of an execution.

func ExecStdout 

func ExecStdout(w io.Writer) ExecOption

ExecStdout captures stdout of an execution.

type Hosts 

type Hosts struct {
	RPC     string
	P2P     string
	Prof    string
	GRPC    string
	GRPCWeb string
	API     string
	Faucet  string
}

Hosts contains the "hostname:port" addresses for different service hosts.

type TxResponse added in v29.1.0 

type TxResponse struct {
	Code      int    `json:"code"`
	Codespace string `json:"codespace"`
	RawLog    string `json:"raw_log"`
	TxHash    string `json:"txhash"`
	Height    string `json:"height"`
	Data      string `json:"data"`
	Info      string `json:"info"`
	GasWanted string `json:"gas_wanted"`
	GasUsed   string `json:"gas_used"`
	Timestamp string `json:"timestamp"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.