Locate .coverage_contracts correctly for subfolder paths (#570)

Author: cgewecke

plugins/resources/plugin.utils.js

@@ -8,7 +8,6 @@ const PluginUI = require('./truffle.ui');
 const path = require('path');
 const fs = require('fs-extra');
 const shell = require('shelljs');
-const util = require('util')
 
 // ===
 // UI
@@ -93,12 +92,13 @@ function toRelativePath(pathToFile, pathToParent){
  * @return {Object}               temp paths
  */
 function getTempLocations(config){
+  const contractsRoot = path.parse(config.contractsDir).dir
   const cwd = config.workingDir;
   const contractsDirName = '.coverage_contracts';
   const artifactsDirName = config.temp || '.coverage_artifacts';
 
   return {
-    tempContractsDir: path.join(cwd, contractsDirName),
+    tempContractsDir: path.join(contractsRoot, contractsDirName),
     tempArtifactsDir: path.join(cwd, artifactsDirName)
   }
 }

test/integration/projects/contract-subfolders/.solcover.js

@@ -0,0 +1,8 @@
+// Testing hooks
+const fn = (msg, config) => config.logger.log(msg);
+
+module.exports = {
+  skipFiles: ['Migrations.sol'],
+  silent: process.env.SILENT ? true : false,
+  istanbulReporter: ['json-summary', 'text'],
+}

test/integration/projects/contract-subfolders/contracts/A/ContractA2.sol

@@ -0,0 +1,18 @@
+pragma solidity ^0.5.0;
+
+import "./../B/ContractB2.sol";
+
+contract ContractA is ContractB {
+  uint x;
+  constructor() public {
+  }
+
+  function sendFn() public {
+    x = 5;
+  }
+
+  function callFn() public pure returns (uint){
+    uint y = 5;
+    return y;
+  }
+}

test/integration/projects/contract-subfolders/contracts/B/ContractB2.sol

@@ -0,0 +1,17 @@
+pragma solidity ^0.5.0;
+
+
+contract ContractB {
+  uint x;
+  constructor() public {
+  }
+
+  function sendFnB() public {
+    x = 5;
+  }
+
+  function callFnB() public pure returns (uint){
+    uint y = 5;
+    return y;
+  }
+}

test/integration/projects/contract-subfolders/hardhat.config.js

@@ -0,0 +1,17 @@
+require("@nomiclabs/hardhat-truffle5");
+require(__dirname + "/../plugins/nomiclabs.plugin");
+
+module.exports={
+  networks: {
+    hardhat: {
+      gasPrice: 2
+    }
+  },
+  solidity: {
+    version: "0.5.15"
+  },
+  paths: {
+    sources: './contracts/A'
+  },
+  logger: process.env.SILENT ? { log: () => {} } : console,
+};

test/integration/projects/contract-subfolders/test/contracta2.js

@@ -0,0 +1,17 @@
+const ContractA = artifacts.require("ContractA");
+
+contract("contracta", function(accounts) {
+  let instance;
+
+  before(async () => instance = await ContractA.new())
+
+  it('sends', async function(){
+    await instance.sendFn();
+    await instance.sendFnB();
+  });
+
+  it('calls', async function(){
+    await instance.callFn();
+    await instance.callFnB();
+  })
+});

test/integration/projects/contract-subfolders/truffle-config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  networks: {},
+  mocha: {},
+  compilers: {
+    solc: {}
+  }
+}

test/units/hardhat/standard.js

@@ -419,4 +419,19 @@ describe('Hardhat Plugin: standard use cases', function() {
     verify.lineCoverage(expected);
   })
 
+  it('locates .coverage_contracts correctly when dir is subfolder', async function(){
+    mock.installFullProject('contract-subfolders');
+    mock.hardhatSetupEnv(this);
+
+    await this.env.run("coverage");
+
+    const expected = [
+      {
+        file: 'contracts/A/ContractA2.sol',
+        pct: 100
+      }
+    ];
+
+    verify.lineCoverage(expected);
+  })
 })

test/units/truffle/standard.js

@@ -286,6 +286,21 @@ describe('Truffle Plugin: standard use cases', function() {
     verify.lineCoverage(expected);
   });
 
+  it('locates .coverage_contracts correctly when dir is subfolder', async function(){
+    solcoverConfig = {
+      silent: process.env.SILENT ? true : false,
+      istanbulReporter: ['json-summary', 'text']
+    };
+
+    truffleConfig.contracts_directory = path.join(
+      process.cwd(),
+      mock.pathToTemp("contracts/A")
+    );
+
+    mock.installFullProject('contract-subfolders');
+    await plugin(truffleConfig);
+  })
+
   // This test tightly coupled to the ganache version in production deps
   // "test-files" project solcoverjs includes `client: require('ganache-cli')`
   it('config: client', async function(){