+ NB: if you specify the port in your rpc options string, also declare it as a `port` option.
+ NB: if you specify the port in your rpc options string, also declare it as a `port` option.
+ **testCommand**: *{ String }* By default solidity-coverage runs `truffle test`. This option lets
+ **testCommand**: *{ String }* By default solidity-coverage runs `truffle test`. This option lets
you run an arbitrary test command instead, like: `mocha --timeout 5000`.
you run an arbitrary test command instead, like: `mocha --timeout 5000`.
+ remember to set the config's port option to whatever port your tests use (probably 8545).
+ remember to set the config's port option to whatever port your tests use (probably 8545).
+ make sure you don't have another instance of testrpc running on that port (web3 will error if you do).
+ make sure you don't have another instance of testrpc running on that port (web3 will error if you do).
+ **norpc**: *{ Boolean }* When true, solidity-coverage will not launch its own testrpc instance. This
+ **norpc**: *{ Boolean }* When true, solidity-coverage will not launch its own testrpc instance. This
can be useful if you are using a different vm like the [sc-forks version of pyethereum](https://github.com/sc-forks/pyethereum).
can be useful if you are using a different vm like the [sc-forks version of pyethereum](https://github.com/sc-forks/pyethereum).
+ **dir**: *{ String }* : Solidity-coverage usually looks for `contracts` and `test` folders in your root
+ **dir**: *{ String }* : Solidity-coverage usually looks for `contracts` and `test` folders in your root
directory. `dir` allows you to define a relative path from the root directory to those assets.
directory. `dir` allows you to define a relative path from the root directory to those assets.
`dir: "./<dirname>"` would tell solidity-coverage to look for `./<dirname>/contracts/` and `./<dirname>/test/`
`dir: "./<dirname>"` would tell solidity-coverage to look for `./<dirname>/contracts/` and `./<dirname>/test/`
+ **copyNodeModules**: *{ Boolean }* : When true, will copy `node_modules` into the coverage environment. False by default, and may significantly increase the time for coverage to complete if enabled. Only enable if required.
**Example .solcover.js config file**
**Example .solcover.js config file**
```javascript
```javascript
@ -89,28 +90,28 @@ module.exports = {
### Known Issues
### Known Issues
**Hardcoded gas costs**: If you have hardcoded gas costs into your tests some of them may fail when using solidity-coverage.
**Hardcoded gas costs**: If you have hardcoded gas costs into your tests some of them may fail when using solidity-coverage.
This is because the instrumentation process increases the gas costs for using the contracts, due to
This is because the instrumentation process increases the gas costs for using the contracts, due to
the extra events. If this is the case, then the coverage may be incomplete. To avoid this, using
the extra events. If this is the case, then the coverage may be incomplete. To avoid this, using
`estimateGas` to estimate your gas costs should be more resilient in most cases.
`estimateGas` to estimate your gas costs should be more resilient in most cases.
**Using `require` in `migrations.js` files**: Truffle overloads Node's `require` function but
**Using `require` in `migrations.js` files**: Truffle overloads Node's `require` function but
implements a simplified search algorithm for node_modules packages
implements a simplified search algorithm for node_modules packages
c-g-e-w-e-k-e-
8 years ago
committed by
GitHub