Merge pull request #44 from sc-forks/copy-all-folders

Copy all directories when setting up coverageEnv

Author: cgewecke

README.md

@@ -7,7 +7,7 @@
 ### Code coverage for Solidity testing
 ![coverage example](https://cdn-images-1.medium.com/max/800/1*uum8t-31bUaa6dTRVVhj6w.png)
 
-For more details about what this is, how it works and potential limitations, see 
+For more details about what this is, how it works and potential limitations, see
 [the accompanying article](https://blog.colony.io/code-coverage-for-solidity-eecfa88668c2).
 
 **solidity-coverage** is a stand-alone fork of [Solcover](https://github.com/JoinColony/solcover)
@@ -17,25 +17,25 @@ For more details about what this is, how it works and potential limitations, see
 $ npm install --save-dev solidity-coverage
 ```
 
-### Run 
+### Run
 ```
 $ ./node_modules/.bin/solidity-coverage
 ```
 
-Tests run signficantly slower while coverage is being generated. A 1 to 2 minute delay 
+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 possible if your
 test suite is large. Large solidity files can also take a while to instrument.
 
 ### Configuration
 
-By default, solidity-coverage generates a stub `truffle.js` that accomodates its special gas needs and 
+By default, solidity-coverage generates a stub `truffle.js` that accomodates its special gas needs and
 connects to a modified version of testrpc on port 8555. If your tests will run on the development network
-using a standard `truffle.js` and a testrpc instance with no special options, you shouldn't have to 
-do any configuration. If your tests depend on logic added to `truffle.js` - for example: 
-[zeppelin-solidity](https://github.com/OpenZeppelin/zeppelin-solidity/blob/master/truffle.js) 
-uses the file to expose a babel polyfill that its suite requires - you can override the 
+using a standard `truffle.js` and a testrpc instance with no special options, you shouldn't have to
+do any configuration. If your tests depend on logic added to `truffle.js` - for example:
+[zeppelin-solidity](https://github.com/OpenZeppelin/zeppelin-solidity/blob/master/truffle.js)
+uses the file to expose a babel polyfill that its suite requires - you can override the
 default behavior by declaring a coverage network in `truffle.js`. solidity-coverage will use your 'truffle.js'
-instead of a dynamically generated one. 
+instead of a dynamically generated one.
 
 **Example coverage network config**
 ```javascript
@@ -48,7 +48,7 @@ module.exports = {
     },
     coverage: {
       host: "localhost",
-      network_id: "*", 
+      network_id: "*",
       port: 8555,         // <-- Use port 8555  
       gas: 0xfffffffffff, // <-- Use this high gas value
       gasPrice: 0x01      // <-- Use this low gas price
@@ -57,24 +57,25 @@ module.exports = {
 };
 ```
 
-You can also create a `.solcover.js` config file in the root directory of your project and specify 
+You can also create a `.solcover.js` config file in the root directory of your project and specify
 some additional options:
 
 
 + **port**: *{ Number }* Port to run testrpc on / have truffle connect to. (Default: 8555)
 + **accounts**: *{ Number }* Number of accounts to launch testrpc with. (Default: 35)
-+ **testrpcOptions**: *{ String }* options to append to a command line invocation of testrpc. 
-  + ex: `--secure --unlock "0x1234..." --unlock "0xabcd..."`. 
++ **testrpcOptions**: *{ String }* options to append to a command line invocation of testrpc.
+  + ex: `--secure --unlock "0x1234..." --unlock "0xabcd..."`.
   + 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 
-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). 
-  + make sure you don't have another instance of testrpc running on that port (web3 will error if you do). 
++ **testCommand**: *{ String }* By default solidity-coverage runs `truffle test`. This option lets
+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).
+  + 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
 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
-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/`
++ **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**
 ```javascript
@@ -89,28 +90,28 @@ module.exports = {
 
 ### Known Issues
 
-**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 
-the extra events. If this is the case, then the coverage may be incomplete. To avoid this, using 
+**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
+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.
 
 **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
 ([see Truffle issue #383](https://github.com/trufflesuite/truffle/issues/383)). 
-Because solidity-coverage copies an instrumented version of your project into a temporary folder, `require` 
+Because solidity-coverage copies an instrumented version of your project into a temporary folder, `require`
 statements handled by Truffle internally won't resolve correctly.  
 
 **Using HDWalletProvider in `truffle.js`**: [See Truffle issue #348](https://github.com/trufflesuite/truffle/issues/348).
-HDWalletProvider crashes solidity-coverage, so its constructor shouldn't be invoked while running this tool. 
-A workaround can be found at the zeppelin-solidity project 
-[here](https://github.com/OpenZeppelin/zeppelin-solidity/blob/master/truffle.js#L8-L10), where a 
-shell script is used to set an environment variable which `truffle.js` checks before instantiating the wallet. 
+HDWalletProvider crashes solidity-coverage, so its constructor shouldn't be invoked while running this tool.
+A workaround can be found at the zeppelin-solidity project
+[here](https://github.com/OpenZeppelin/zeppelin-solidity/blob/master/truffle.js#L8-L10), where a
+shell script is used to set an environment variable which `truffle.js` checks before instantiating the wallet.
 
 ### Examples
 
-**WARNING**: This utility is in development and its accuracy is unknown. If you 
-find discrepancies between the coverage report and your suite's behavior, please open an 
-[issue](https://github.com/sc-forks/solidity-coverage/issues). 
+**WARNING**: This utility is in development and its accuracy is unknown. If you
+find discrepancies between the coverage report and your suite's behavior, please open an
+[issue](https://github.com/sc-forks/solidity-coverage/issues).
 
 + **metacoin**: The default truffle project
   + [HTML reports](https://sc-forks.github.io/metacoin/)
@@ -125,8 +126,8 @@ find discrepancies between the coverage report and your suite's behavior, please
 ### Contribution Guidelines
 
 Contributions are welcome! If you're opening a PR that adds features please consider writing some
-[unit tests](https://github.com/sc-forks/solidity-coverage/tree/master/test) for them. You could 
-also lint your submission with `npm run lint`. Bugs can be reported in the 
+[unit tests](https://github.com/sc-forks/solidity-coverage/tree/master/test) for them. You could
+also lint your submission with `npm run lint`. Bugs can be reported in the
 [issues](https://github.com/sc-forks/solidity-coverage/issues).  
 
 ### Contributors

bin/exec.js

@@ -61,6 +61,7 @@ const config = reqCwd.silent('./.solcover.js') || {};
 const workingDir = config.dir || '.';       // Relative path to contracts folder
 let port = config.port || 8555;             // Port testrpc listens on
 const accounts = config.accounts || 35;     // Number of accounts to testrpc launches with
+const copyNodeModules = config.copyNodeModules || false; // Whether we copy node_modules when making coverage environment
 
 // Silence shell and script logging (for solcover's unit tests / CI)
 if (config.silent) {
@@ -78,10 +79,16 @@ try {
   // migrations/
   // truffle.js
 
+  let files = shell.ls(`${workingDir}`);
+  const nmIndex = files.indexOf('node_modules');
+
+  if (!config.copyNodeModules && nmIndex > -1) {
+    files.splice(nmIndex, 1); // Removes node_modules from array.
+  }
+
+  files = files.map(file => `${workingDir}/` + file);
   shell.mkdir(`${coverageDir}`);
-  shell.cp('-R', `${workingDir}/contracts`, `${coverageDir}`);
-  shell.cp('-R', `${workingDir}/test`, `${coverageDir}`);
-  shell.cp('-R', `${workingDir}/migrations`, `${coverageDir}`);
+  shell.cp('-R', files, `${coverageDir}`);
 
   const truffleConfig = reqCwd.silent(`${workingDir}/truffle.js`);
 
@@ -97,7 +104,7 @@ try {
       module.exports = {
         networks: {
           development: {
-            host: "localhost", 
+            host: "localhost",
             network_id: "*",
             port: ${port},
             gas: ${gasLimitHex},
@@ -148,7 +155,7 @@ if (!config.norpc) {
   const defaultRpcOptions = `--gasLimit ${gasLimitString} --accounts ${accounts} --port ${port}`;
   const testrpcOptions = config.testrpcOptions || defaultRpcOptions;
   const command = './node_modules/.bin/testrpc-sc ';
-  
+
   testrpcProcess = childprocess.exec(command + testrpcOptions, null, err => {
     if (err) cleanUp('testRpc errored after launching as a childprocess.');
   });
@@ -178,9 +185,9 @@ try {
   const msg =
   `
     There was an error generating coverage. Possible reasons include:
-    1. Another application is using port ${port} 
+    1. Another application is using port ${port}
     2. Truffle crashed because your tests errored
-    
+
   `;
   cleanUp(msg + err);
 }

test/cli.js

@@ -118,12 +118,12 @@ describe('cli', () => {
       `module.exports = {
         networks: {
           development: {
-            host: "localhost", 
+            host: "localhost",
             port: 8545,
             network_id: "*"
           },
           coverage: {
-            host: "localhost", 
+            host: "localhost",
             port: 8999,
             network_id: "*"
           }