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
c8870a0464
|
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 in development and its accuracy is unknown. If you find discrepancies between the coverage report and your suite's behavior, please open an issue.solidity-coverageis Solcover
Install
$ npm install --save-dev solidity-coverage
Usage notes:
- For pragma solidity >=0.4.22 <0.6.0 / Petersburg
- Coverage runs tests a little more slowly.
- Coverage distorts gas consumption.
- Coverage launches its own in-process ganache instance. You can
set ganache options via
the
providerOptionskey in your.solcover.jsconfig file.
Truffle V5
Add "solidity-coverage" to your plugins array in truffle-config.js
module.exports = {
networks: {...},
plugins: ["solidity-coverage"]
}
Run
truffle run coverage [options]
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) |
| --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 |
|---|---|---|---|
| client | Object | require("truffle").ganache | Useful if you need a specific ganache version. (usage: client: require("ganache-core")) |
| providerOptions | Object | {} | ganache-core options (ex: network_id: 55). Complete list of options here. |
| skipFiles | Array | ['Migrations.sol'] |
Array of contracts or folders (with paths expressed relative to the contracts directory) that should be skipped when doing instrumentation. Migrations.sol is skipped by default, and does not need to be added to this configuration option if it is used. |
| istanbulReporter | Array | ['html', 'lcov', 'text'] | Coverage reporters for Istanbul. Optional reporter replaces the default reporters. |
FAQ
Common problems & questions:
- Running out of gas
- Running out of memory (locally and in CI)
- Running out of time (in mocha)
- Running in CI
- Why are asserts and requires 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 please consider writing some unit tests for them. Bugs can be reported in the issues.
Set up the development environment with:
$ git clone https://github.com/sc-forks/solidity-coverage.git
$ yarn