mirror of
https://github.com/nspcc-dev/neo-go.git
synced 2024-10-16 15:43:25 +00:00
d0c45477f5
Test coverage is automatically enabled when go test is running with coverage enabled. It can be disabled for any Executor by using relevant methods. Coverage is gathered by capturing VM OPs during test contract execution and mapping them to the contract source code using the DebugInfo information. Signed-off-by: Slava0135 <super.novalskiy_0135@inbox.ru>
33 lines
1.8 KiB
Go
33 lines
1.8 KiB
Go
/*
|
|
Package neotest contains a framework for automated contract testing.
|
|
It can be used to implement unit-tests for contracts in Go using regular Go
|
|
conventions.
|
|
|
|
Usually it's used like this:
|
|
|
|
- an instance of the blockchain is created using chain subpackage
|
|
- the target contract is compiled using one of Compile* functions
|
|
- and Executor is created for the blockchain
|
|
- it's used to deploy a contract with DeployContract
|
|
- CommitteeInvoker and/or ValidatorInvoker are then created to perform test invocations
|
|
- if needed, NewAccount is used to create an appropriate number of accounts for the test
|
|
|
|
Higher-order methods provided in Executor and ContractInvoker hide the details
|
|
of transaction creation for the most part, but there are lower-level methods as
|
|
well that can be used for specific tasks.
|
|
|
|
It's recommended to have a separate folder/package for tests, because having
|
|
them in the same package with the smart contract iself can lead to unxpected
|
|
results if smart contract has any init() functions. If that's the case they
|
|
will be compiled into the testing binary even when using package_test and their
|
|
execution can affect tests. See https://github.com/nspcc-dev/neo-go/issues/3120 for details.
|
|
|
|
Test coverage for contracts is automatically enabled when `go test` is running with
|
|
coverage enabled. When not desired, it can be disabled for any Executor by using
|
|
EnableCoverage and DisableCoverage. Be aware that coverage data collected by `go test`
|
|
itself will not be saved because it will be replaced with contracts coverage instead.
|
|
In case `go test` coverage is wanted DISABLE_NEOTEST_COVER=1 variable can be set.
|
|
Coverage is gathered by capturing VM instructions during test contract execution and
|
|
mapping them to the contract source code using the DebugInfo information.
|
|
*/
|
|
package neotest
|