The highest tagged major version is
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.EnsureAppIsSteady(path)
- 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.EnsureAppIsSteady(path)
Documentation
¶
Index ¶
- Constants
- Variables
- func HasTestVerboseFlag() bool
- type App
- func (a App) Binary() string
- func (a App) Config() chainconfig.Config
- func (a App) EditConfig(apply func(*chainconfig.Config))
- func (a App) EnableFaucet(coins, coinsMax []string) (faucetAddr string)
- func (a App) EnsureSteady()
- func (a App) GenerateTSClient() bool
- func (a App) RandomizeServerPorts() Hosts
- func (a App) RunClientTests(options ...ClientOption) bool
- func (a App) Serve(msg string, options ...ExecOption) (ok bool)
- func (a *App) SetConfigPath(path string)
- func (a *App) SetHomePath(homePath string)
- func (a App) Simulate(numBlocks, blockSize int)
- func (a App) SourcePath() string
- func (a App) UseRandomHomeDir() (homeDirPath string)
- type AppOption
- type ClientOption
- type Env
- func (e Env) App(path string, options ...AppOption) App
- func (e Env) AppHome(name string) string
- func (e Env) Ctx() context.Context
- func (e Env) Exec(msg string, steps step.Steps, options ...ExecOption) (ok bool)
- func (e Env) HasFailed() bool
- func (e Env) Home() string
- func (e Env) IsAppServed(ctx context.Context, apiAddr string) error
- func (e Env) IsFaucetServed(ctx context.Context, faucetClient cosmosfaucet.HTTPClient) error
- func (e Env) Must(ok bool)
- func (e Env) RequireExpectations()
- func (e Env) Scaffold(name string, flags ...string) App
- func (e Env) SetCleanup(f func())
- func (e Env) T() *testing.T
- func (e Env) TmpDir() (path string)
- type ExecOption
- type Hosts
Constants ¶
const ServeTimeout = time.Minute * 15
Variables ¶
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") )
Functions ¶
func HasTestVerboseFlag ¶
func HasTestVerboseFlag() bool
Types ¶
type App ¶
type App struct {
// contains filtered or unexported fields
}
func (App) Binary ¶
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) Config ¶
func (a App) Config() chainconfig.Config
func (App) EditConfig ¶
func (a App) EditConfig(apply func(*chainconfig.Config))
func (App) EnableFaucet ¶
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) GenerateTSClient ¶
GenerateTSClient runs the command to generate the Typescript client code.
func (App) RandomizeServerPorts ¶
RandomizeServerPorts randomizes server ports for the app at path, updates its config.yml and returns new values.
func (App) RunClientTests ¶
func (a App) RunClientTests(options ...ClientOption) bool
RunClientTests runs the Typescript client tests.
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 (*App) SetHomePath ¶
func (App) SourcePath ¶
func (App) UseRandomHomeDir ¶
UseRandomHomeDir sets in the blockchain config files generated temporary directories for home directories. Returns the random home directory.
type AppOption ¶
type AppOption func(*App)
func AppConfigPath ¶
func AppHomePath ¶
func AppTestTimeout ¶
type ClientOption ¶
type ClientOption func(*clientOptions)
ClientOption defines options for the TS client test runner.
func ClientEnv ¶
func ClientEnv(env map[string]string) ClientOption
ClientEnv option defines environment values for the tests.
func ClientTestFile ¶
func ClientTestFile(filePath string) ClientOption
ClientTestFile option defines the name of the file where to look for tests.
func ClientTestName ¶
func ClientTestName(pattern string) ClientOption
ClientTestName option defines a pattern to match the test names that should be run.
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 (Env) Exec ¶
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) IsAppServed ¶
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 ¶
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) SetCleanup ¶
func (e Env) SetCleanup(f func())
SetCleanup registers a function to be called when the test (or subtest) and all its subtests complete.
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.
Source Files