Run the Sway unit tests for the current project.
NOTE: Previously this command was used to support Rust integration testing, however the provided
behaviour served no benefit over running
cargo test directly. The proposal to change the behaviour
to support unit testing can be found at the following link:
Sway unit tests are functions decorated with the
#[test] attribute. Each test is compiled as a
unique entry point for a single program and has access to the namespace of the module in which it is
Unit tests decorated with the
#[test(script)] attribute that are declared within
projects may also call directly into their associated contract's ABI.
Upon successful compilation, test scripts are executed to their completion. A test is considered a
failure in the case that a revert (
rvrt) instruction is encountered during execution. Otherwise,
it is considered a success.
forc test [OPTIONS] [FILTER]
<FILTER> When specified, only tests containing the given string will be executed
Name of the build profile to use. If it is not specified, forc will use debug build profile
If set, outputs source file mapping in JSON format
Print help information
Set the log level
Requires that the Forc.lock file is up-to-date. If the lock file is missing, or it needs to be updated, Forc will exit with an error
By default the JSON for ABIs is formatted for human readability. By using this option JSON output will be "minified", i.e. all on one line without whitespace
By default the JSON for initial storage slots is formatted for human readability. By using this option JSON output will be "minified", i.e. all on one line without whitespace
If set, outputs a binary file representing the script bytes
Offline mode, prevents Forc from using the network when managing dependencies. Meaning it will only try to use previously downloaded dependencies
The directory in which the sway compiler output artifacts are placed.
By default, this is
Path to the project, if not specified, current working directory will be used
Print the generated Sway AST (Abstract Syntax Tree)
Print the finalized ASM.
This is the state of the ASM with registers allocated and optimisations applied.
Print the generated ASM.
This is the state of the ASM prior to performing register allocation and other ASM optimisations.
Print the generated Sway IR (Intermediate Representation)
Use release build plan. If a custom release plan is not specified, it is implicitly added to the manifest file.
If --build-profile is also provided, forc omits this flag and uses provided build-profile.
Silence all output
Terse mode. Limited warning and error output
Output the time elapsed over each part of the compilation process
Use verbose output