You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
cgewecke
a43ee6553e
|
5 years ago | |
|---|---|---|
| .circleci | 5 years ago | |
| dist | 5 years ago | |
| docs | 5 years ago | |
| lib | 5 years ago | |
| scripts | 5 years ago | |
| test | 5 years ago | |
| .gitignore | 5 years ago | |
| .npmignore | 5 years ago | |
| CHANGELOG.md | 5 years ago | |
| LICENSE | 8 years ago | |
| README.md | 5 years ago | |
| buidler.config.js | 5 years ago | |
| index.js | 5 years ago | |
| package.json | 5 years ago | |
| truffle-plugin.json | 5 years ago | |
| yarn.lock | 5 years ago | |
README.md
solidity-coverage
Code coverage for Solidity testing
- For more details about what this is, how it works and potential limitations, see the accompanying article.
solidity-coverageis Solcover
Install
$ npm install --save-dev solidity-coverage@beta
Truffle V5
Add this package to your plugins array in truffle-config.js
module.exports = {
networks: {...},
plugins: ["solidity-coverage"]
}
Run
truffle run coverage [command-options]
Usage notes:
- Coverage runs tests a little more slowly.
- Coverage launches its own in-process ganache server.
- You can set ganache options using the
providerOptionskey in your.solcover.jsconfig. - Coverage distorts gas consumption. Tests that check exact gas consumption should be skipped.
- ⚠️ Contracts are compiled without optimization. Please report unexpected compilation faults to issue 417
Command Options
| Option |
Example |
Description |
|---|---|---|
| file | --file="test/registry/*.js" |
Filename or glob describing a subset of JS tests to run. (Globs must be enclosed by quotes.) |
| solcoverjs | --solcoverjs ./../.solcover.js |
Relative path from working directory to config. Useful for monorepo packages that share settings. (Path must be "./" prefixed) |
| network | --network development |
Use network settings defined in the Truffle config |
| temp* | --temp build |
⚠️ Caution ⚠️ Path to a disposable folder to store compilation artifacts in. Useful when your test setup scripts include hard-coded paths to a build directory. More... |
| version | Version info | |
| help | Usage notes |
Config Options
Additional options can be specified in a .solcover.js config file located in the root directory
of your project.
Example:
module.exports = {
skipFiles: ['Routers/EtherRouter.sol']
};
| Option |
Type |
Default |
Description |
|---|---|---|---|
| silent | Boolean | false | Suppress logging output |
| client | Object | require("ganache-core") |
Useful if you need a specific ganache version. |
| providerOptions | Object | { } |
ganache-core options |
| skipFiles | Array | ['Migrations.sol'] |
Array of contracts or folders (with paths expressed relative to the contracts directory) that should be skipped when doing instrumentation. |
| istanbulReporter | Array | ['html', 'lcov', 'text'] |
Istanbul coverage reporters |
| mocha | Object | { } |
Mocha options to merge into existing mocha config. grep and invert are useful for skipping certain tests under coverage using tags in the test descriptions. |
| onServerReady* | Function | Hook run after server is launched, before the tests execute. Useful if you need to use the Oraclize bridge or have setup scripts which rely on the server's availability. More... | |
| onCompileComplete* | Function | Hook run after compilation completes, before tests are run. Useful if you have secondary compilation steps or need to modify built artifacts. More... | |
| onTestsComplete* | Function | Hook run after the tests complete, before Istanbul reports are generated. | |
| onIstanbulComplete* | Function | Hook run after the Istanbul reports are generated, before the ganache server is shut down. Useful if you need to clean resources up. |
FAQ
Common problems & questions:
- Running in CI
- Running out of gas
- Running out of time
- Running out of memory
- Why are
requirestatements highlighted as branch points?
Example reports
- metacoin (Istanbul HTML)
- openzeppelin-solidity(Coveralls)
Contribution Guidelines
Contributions are welcome! If you're opening a PR that adds features or options please consider writing full unit tests for them. (We've built simple fixtures for almost everything and are happy to add some for your case if necessary).
Set up the development environment with:
$ git clone https://github.com/sc-forks/solidity-coverage.git
$ yarn