Add --file command option (for js test subsets) (#387)

Author: cgewecke

dist/truffle.plugin.js

@@ -33,6 +33,7 @@ const dir = require('node-dir');
 const Web3 = require('web3');
 const util = require('util');
 const ganache = require('ganache-core-sc');
+const globby = require('globby');
 
 async function plugin(truffleConfig){
   let app;
@@ -116,16 +117,21 @@ async function plugin(truffleConfig){
   // Finish
   await app.cleanUp();
 
-  if (error !== undefined) throw new Error(error)
+  if (error !== undefined) throw error;
   if (failures > 0) throw new Error(`${failures} test(s) failed under coverage.`)
 }
 
 // -------------------------------------- Helpers --------------------------------------------------
 
 function tests(truffle){
+  let target;
+
+  (typeof truffle.file === 'string')
+    ? target = globby.sync([truffle.file])
+    : target = dir.files(truffle.test_directory, { sync: true }) || [];
+
   const regex = /.*\.(js|ts|es|es6|jsx|sol)$/;
-  const files = dir.files(truffle.test_directory, { sync: true }) || [];
-  return files.filter(f => f.match(regex) != null);
+  return target.filter(f => f.match(regex) != null);
 }
 
 

package.json

@@ -23,6 +23,7 @@
   "dependencies": {
     "death": "^1.1.0",
     "ganache-core-sc": "2.7.0-sc.0",
+    "globby": "^10.0.1",
     "istanbul": "^0.4.5",
     "node-dir": "^0.1.17",
     "req-cwd": "^1.0.1",

test/integration/projects/test-files/.solcover.js

@@ -0,0 +1,3 @@
+module.exports = {
+  silent: process.env.SILENT ? true : false,
+}

test/integration/projects/test-files/contracts/ContractA.sol

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

test/integration/projects/test-files/contracts/ContractB.sol

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

test/integration/projects/test-files/contracts/ContractC.sol

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

test/integration/projects/test-files/contracts/Migrations.sol

@@ -0,0 +1,23 @@
+pragma solidity >=0.4.21 <0.6.0;
+
+contract Migrations {
+  address public owner;
+  uint public last_completed_migration;
+
+  constructor() public {
+    owner = msg.sender;
+  }
+
+  modifier restricted() {
+    if (msg.sender == owner) _;
+  }
+
+  function setCompleted(uint completed) public restricted {
+    last_completed_migration = completed;
+  }
+
+  function upgrade(address new_address) public restricted {
+    Migrations upgraded = Migrations(new_address);
+    upgraded.setCompleted(last_completed_migration);
+  }
+}

test/integration/projects/test-files/migrations/1_initial_migration.js

@@ -0,0 +1,5 @@
+const Migrations = artifacts.require("Migrations");
+
+module.exports = function(deployer) {
+  deployer.deploy(Migrations);
+};

test/integration/projects/test-files/migrations/2_contracta.js

@@ -0,0 +1,5 @@
+const ContractA = artifacts.require("ContractA");
+
+module.exports = function(deployer) {
+  deployer.deploy(ContractA);
+};

test/integration/projects/test-files/migrations/3_contractb.js

@@ -0,0 +1,5 @@
+const ContractB = artifacts.require("ContractB");
+
+module.exports = function(deployer) {
+  deployer.deploy(ContractB);
+};

test/integration/projects/test-files/migrations/4_contractc.js

@@ -0,0 +1,5 @@
+const ContractC = artifacts.require("ContractC");
+
+module.exports = function(deployer) {
+  deployer.deploy(ContractC);
+};

test/integration/projects/test-files/test/globby_b.js

@@ -0,0 +1,15 @@
+const ContractB = artifacts.require("ContractB");
+
+contract("contractB", function(accounts) {
+  let instance;
+
+  before(async () => instance = await ContractB.deployed())
+
+  it('sends', async function(){
+    await instance.sendFn();
+  });
+
+  it('calls', async function(){
+    await instance.callFn();
+  })
+});

test/integration/projects/test-files/test/globby_c.js

@@ -0,0 +1,20 @@
+const ContractC = artifacts.require("ContractC");
+
+contract("contractc", function(accounts) {
+  let instance;
+
+  before(async () => instance = await ContractC.deployed())
+
+  it('sends', async function(){
+    await instance.sendFn();
+  });
+
+  it('calls', async function(){
+    await instance.callFn();
+  })
+
+  it('sends', async function(){
+    await instance.sendFn();
+  });
+
+});

test/integration/projects/test-files/test/specific_a.js

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

test/integration/projects/test-files/truffle-config.js

@@ -0,0 +1,99 @@
+/**
+ * Use this file to configure your truffle project. It's seeded with some
+ * common settings for different networks and features like migrations,
+ * compilation and testing. Uncomment the ones you need or modify
+ * them to suit your project as necessary.
+ *
+ * More information about configuration can be found at:
+ *
+ * truffleframework.com/docs/advanced/configuration
+ *
+ * To deploy via Infura you'll need a wallet provider (like truffle-hdwallet-provider)
+ * to sign your transactions before they're sent to a remote public node. Infura accounts
+ * are available for free at: infura.io/register.
+ *
+ * You'll also need a mnemonic - the twelve word phrase the wallet uses to generate
+ * public/private key pairs. If you're publishing your code to GitHub make sure you load this
+ * phrase from a file you've .gitignored so it doesn't accidentally become public.
+ *
+ */
+
+// const HDWalletProvider = require('truffle-hdwallet-provider');
+// const infuraKey = "fj4jll3k.....";
+//
+// const fs = require('fs');
+// const mnemonic = fs.readFileSync(".secret").toString().trim();
+
+module.exports = {
+  /**
+   * Networks define how you connect to your ethereum client and let you set the
+   * defaults web3 uses to send transactions. If you don't specify one truffle
+   * will spin up a development blockchain for you on port 9545 when you
+   * run `develop` or `test`. You can ask a truffle command to use a specific
+   * network from the command line, e.g
+   *
+   * $ truffle test --network <network-name>
+   */
+
+  networks: {
+    // Useful for testing. The `development` name is special - truffle uses it by default
+    // if it's defined here and no other network is specified at the command line.
+    // You should run a client (like ganache-cli, geth or parity) in a separate terminal
+    // tab if you use this network and you must also set the `host`, `port` and `network_id`
+    // options below to some value.
+    //
+    // development: {
+    //  host: "127.0.0.1",     // Localhost (default: none)
+    //  port: 8545,            // Standard Ethereum port (default: none)
+    //  network_id: "*",       // Any network (default: none)
+    // },
+
+    // Another network with more advanced options...
+    // advanced: {
+      // port: 8777,             // Custom port
+      // network_id: 1342,       // Custom network
+      // gas: 8500000,           // Gas sent with each transaction (default: ~6700000)
+      // gasPrice: 20000000000,  // 20 gwei (in wei) (default: 100 gwei)
+      // from: <address>,        // Account to send txs from (default: accounts[0])
+      // websockets: true        // Enable EventEmitter interface for web3 (default: false)
+    // },
+
+    // Useful for deploying to a public network.
+    // NB: It's important to wrap the provider as a function.
+    // ropsten: {
+      // provider: () => new HDWalletProvider(mnemonic, `https://ropsten.infura.io/v3/YOUR-PROJECT-ID`),
+      // network_id: 3,       // Ropsten's id
+      // gas: 5500000,        // Ropsten has a lower block limit than mainnet
+      // confirmations: 2,    // # of confs to wait between deployments. (default: 0)
+      // timeoutBlocks: 200,  // # of blocks before a deployment times out  (minimum/default: 50)
+      // skipDryRun: true     // Skip dry run before migrations? (default: false for public nets )
+    // },
+
+    // Useful for private networks
+    // private: {
+      // provider: () => new HDWalletProvider(mnemonic, `https://network.io`),
+      // network_id: 2111,   // This network is yours, in the cloud.
+      // production: true    // Treats this network as if it was a public net. (default: false)
+    // }
+  },
+
+  // Set default mocha options here, use special reporters etc.
+  mocha: {
+    // timeout: 100000
+  },
+
+  // Configure your compilers
+  compilers: {
+    solc: {
+      // version: "0.5.1",    // Fetch exact version from solc-bin (default: truffle's version)
+      // docker: true,        // Use "0.5.1" you've installed locally with docker (default: false)
+      // settings: {          // See the solidity docs for advice about optimization and evmVersion
+      //  optimizer: {
+      //    enabled: false,
+      //    runs: 200
+      //  },
+      //  evmVersion: "byzantium"
+      // }
+    }
+  }
+}

test/units/app.js

@@ -96,12 +96,38 @@ describe('app', function() {
     await plugin(truffleConfig);
   });
 
-  it('project with node_modules packages and relative path solidity imports', async function() {
+  it('project with relative path solidity imports', async function() {
     assertCleanInitialState();
     mock.installFullProject('import-paths');
     await plugin(truffleConfig);
   });
 
+  it('truffle run coverage --file test/<fileName>', async function() {
+    assertCleanInitialState();
+
+    const testPath = path.join(truffleConfig.working_directory, 'test/specific_a.js');
+    truffleConfig.file = testPath;
+    mock.installFullProject('test-files');
+    await plugin(truffleConfig);
+  });
+
+  it('truffle run coverage --file test/<glob*>', async function() {
+    assertCleanInitialState();
+
+    const testPath = path.join(truffleConfig.working_directory, 'test/globby*');
+    truffleConfig.file = testPath;
+    mock.installFullProject('test-files');
+    await plugin(truffleConfig);
+  });
+
+  it('truffle run coverage --file test/gl{o,b}*.js', async function() {
+    assertCleanInitialState();
+
+    const testPath = path.join(truffleConfig.working_directory, 'test/gl{o,b}*.js');
+    truffleConfig.file = testPath;
+    mock.installFullProject('test-files');
+    await plugin(truffleConfig);
+  });
 
   it('contract only uses ".call"', async function(){
     assertCleanInitialState();
@@ -197,7 +223,7 @@ describe('app', function() {
       await plugin(truffleConfig);
       assert.fail()
     } catch(err){
-      assert(err.message.includes('SyntaxError'));
+      assert(err.toString().includes('SyntaxError'));
     }
   });
 
@@ -211,7 +237,7 @@ describe('app', function() {
       await plugin(truffleConfig);
       assert.fail()
     } catch(err){
-      assert(err.message.includes('Compilation failed'));
+      assert(err.toString().includes('Compilation failed'));
     }
 
     assertCoverageNotGenerated(truffleConfig);