Code coverage for Solidity smart-contracts
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 7d652aa7e8 Generate a config for truffle.js networks -> development, instead of modifying pre-existing 8 years ago
test Fix testrpc fork name in pkg, remove unused testing utils 8 years ago
.eslintignore Lint III: add .eslintignore for truffle-crash test (intentional syntax error) 8 years ago
.eslintrc Lint II 8 years ago
.gitignore Merge adriamb inheritance fix, use non-forked (global) truffle 8 years ago
LICENSE Add MIT License 8 years ago
README.md Add assembly AST node names, edit README for npm install 8 years ago
circle.yml Merge adriamb inheritance fix, use non-forked (global) truffle 8 years ago
coverageMap.js eslint-ed 8 years ago
exec.js Generate a config for truffle.js networks -> development, instead of modifying pre-existing 8 years ago
injector.js eslint-ed 8 years ago
instrumentSolidity.js eslint-ed 8 years ago
instrumenter.js Add brief headers to new files 8 years ago
package.json Fix testrpc fork name in pkg, remove unused testing utils 8 years ago
parse.js Add assembly AST node names, edit README for npm install 8 years ago
preprocessor.js Run ESLint over everything 8 years ago

README.md

SolCover

CircleCI Status codecov

Code coverage for Solidity testing

coverage example

For more details about what this is, how it work and potential limitations, see the accompanying article.

This branch is an attempt to prepare solcover for npm publication and simplify its use as a command line utility. Gas cost issues etc are managed under the hood - you don't have to modify truffle.js - and the tool cleans up after itself if (when) it crashes.

Install

$ npm install --save-dev https://github.com/JoinColony/solcover.git#truffle3

Run

$ ./node_modules/solcover/exec.js

Tests run signficantly slower while coverage is being generated. A 1 to 2 minute delay between the end of Truffle compilation and the beginning of test execution is not impossible if your test suite is large.

Note that if you have hardcoded gas costs into your tests some of them may fail when using SolCover. 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 estimateGas to estimate your gas costs should be more resilient in most cases.

TODO

  • Turn into a true command line tool, rather than just a hacked-together script
  • Allow the use of a dedicated coverage network in truffle.js
  • Release on NPM
  • Support for arbitrary testing commands
  • You tell me