Skip to content

Commit

Permalink
Merge pull request #808 from multiversx/sc-meta-test
Browse files Browse the repository at this point in the history
added sc-meta test docs
  • Loading branch information
andrei-marinica authored Feb 6, 2024
2 parents bb88859 + 63e6e2d commit 45c945e
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/developers/meta/sc-meta-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,31 @@ Paramameter:
- The framework version on which the contracts should be created.
- _default_: The latest released version.

[comment]: # (mx-context-auto)

### Calling `test`

This command is a useful shorthand for running various types of tests.

Parameters:
- `--path`
- Target directory where to generate contract integration tests.
- _default_: current directory.
- `--go`
- Use this argument to only run the mx-scenario-go tool, directly. It is equivalent to running `mx-scenario-go run`.
- You can find out how to install `mx-scenario-go` [here](/developers/meta/sc-meta-cli#calling-install).
- _default_: `false`
- `--scen`
- This argument causes cargo test to be run with the `multiversx-sc-scenario/run-go-tests` feature, causing tests relying on the mx-scenairo-go tool to also be run.
- _default_: `false`
- If `scen` and `go` are both specified, scen overrides the go argument.
- `--nocapture`
- This argument prints the entire output of the vm.
- _default_: `false`
- `--help`
- Print help
- `--version`
- Print version

[comment]: # (mx-context-auto)

Expand Down Expand Up @@ -238,6 +263,18 @@ Paramameters:
- `--create`
- Creates test files if they don't exist.

[comment]: # (mx-exclude-context)

### Calling `install`

This command can be used to quickly install other tools needed for smart contract development, interaction and testing.

Paramameters:
- `all`
- Installs all the known tools.
- `mx-scenario-go`
- Installs the `mx-scenario-go` tool.
- Can further specify the framework version on which the contracts should be created by using `--tag`

---

Expand Down

0 comments on commit 45c945e

Please sign in to comment.