SolCover

Code coverage for Solidity testing

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 if your tests run using the the development network and the tool cleans up after itself if (when) it crashes.

If your truffle.js doesn't include a development network, you should add one with bare-bones options.

// Example truffle.js
module.exports = {
  networks: {
    development: {
      host: "localhost",
      network_id: "*" // Match any network id  
    },
    'dev.auction': {
      host: "localhost",
      port: 8545,
      network_id: "*" // Match any network id
    },
    test: {
      provider: TestRPC.provider(), // in-memory TestRPC provider
      network_id: "*" // Match any network id
    }
  }

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