Add gas reporter and coverage plugings

Author: 0xGabi

Diff for: .gitignore

@@ -5,3 +5,5 @@ cache
 dist
 ipfs.cmd
 package-lock.json
+coverage
+coverage.json

Diff for: .solcover.js

@@ -0,0 +1,5 @@
+module.exports = {
+  norpc: true,
+  copyPackages: ['@aragon/os'],
+  skipFiles: ['test', '@aragon/os'],
+}

Diff for: buidler.config.js

@@ -3,6 +3,8 @@ const { usePlugin } = require('@nomiclabs/buidler/config')
 const hooks = require('./scripts/buidler-hooks')
 
 usePlugin('@aragon/buidler-aragon')
+usePlugin('buidler-gas-reporter')
+usePlugin('solidity-coverage')
 
 module.exports = {
   // Default Buidler configurations. Read more about it at https://buidler.dev/config/
@@ -19,6 +21,9 @@ module.exports = {
       runs: 10000,
     },
   },
+  gasReporter: {
+    enabled: !!process.env.GAS_REPORTER,
+  },
   // Aragon plugin configuration
   aragon: {
     appServePort: 8001,

Diff for: contracts/test/TestImport.sol

@@ -0,0 +1,24 @@
+pragma solidity 0.4.24;
+
+import "@aragon/os/contracts/acl/ACL.sol";
+import "@aragon/os/contracts/factory/DAOFactory.sol";
+import "@aragon/os/contracts/factory/EVMScriptRegistryFactory.sol";
+
+
+// You might think this file is a bit odd, but let me explain.
+// We only use some contracts in our tests, which means Truffle
+// will not compile it for us, because it is from an external
+// dependency.
+//
+// We are now left with three options:
+// - Copy/paste these contracts
+// - Run the tests with `truffle compile --all` on
+// - Or trick Truffle by claiming we use it in a Solidity test
+//
+// You know which one I went for.
+
+contract TestImports {
+    constructor() public {
+        // solium-disable-previous-line no-empty-blocks
+    }
+}

Diff for: package.json

@@ -6,8 +6,11 @@
     "postinstall": "yarn compile && yarn build-app",
     "build-app": "cd app && npm install && cd ..",
     "compile": "buidler compile --force",
-    "test": "buidler test --network buidlerevm",
     "start": "buidler start",
+    "test": "buidler test --network buidlerevm",
+    "test:gas": "GAS_REPORTER=true npm run ganache-cli:test",
+    "coverage": "SOLIDITY_COVERAGE=true npm run ganache-cli:test",
+    "ganache-cli:test": "./scripts/ganache-cli.sh",
     "publish:major": "buidler publish major",
     "publish:minor": "buidler publish minor",
     "publish:patch": "buidler publish patch"
@@ -23,6 +26,7 @@
     "@nomiclabs/buidler-truffle5": "^1.3.2",
     "@nomiclabs/buidler-web3": "^1.3.2",
     "babel-eslint": "^10.1.0",
+    "buidler-gas-reporter": "^0.1.3",
     "eslint": "^7.1.0",
     "eslint-config-prettier": "^6.11.0",
     "eslint-config-standard": "^14.1.1",
@@ -35,7 +39,9 @@
     "eslint-plugin-react": "^7.20.0",
     "eslint-plugin-react-hooks": "^4.0.4",
     "eslint-plugin-standard": "^4.0.1",
+    "ganache-cli": "^6.9.1",
     "prettier": "^2.0.5",
+    "solidity-coverage": "^0.7.0",
     "web3": "^1.2.7"
   }
 }

Diff for: scripts/ganache-cli.sh

@@ -0,0 +1,54 @@
+#!/usr/bin/env bash
+
+# Exit script as soon as a command fails.
+set -o errexit
+
+# Executes cleanup function at script exit.
+trap cleanup EXIT
+
+cleanup() {
+  # Kill the ganache instance that we started (if we started one and if it's still running).
+  if [ -n "$rpc_pid" ] && ps -p $rpc_pid > /dev/null; then
+    kill -9 $rpc_pid
+  fi
+}
+
+ganache_port=8545
+
+rpc_running() {
+  nc -z localhost "$ganache_port"
+}
+
+start_ganache() {
+  if [ "$SOLIDITY_COVERAGE" = true ]; then
+    export RUNNING_COVERAGE=true
+  else
+    echo "Starting our own ganache instance"
+
+    node_modules/.bin/ganache-cli -l 8000000 --port "$ganache_port" -m "explain tackle mirror kit van hammer degree position ginger unfair soup bonus" > /dev/null &
+
+    rpc_pid=$!
+
+    echo "Waiting for ganache to launch on port "$ganache_port"..."
+
+    while ! rpc_running; do
+      sleep 0.1 # wait for 1/10 of the second before check again
+    done
+
+    echo "Ganache launched!"
+  fi
+}
+
+if rpc_running; then
+  echo "Using existing ganache instance"
+else
+  start_ganache
+fi
+
+echo "Buidler version $(npx buidler --version)"
+
+if [ "$SOLIDITY_COVERAGE" = true ]; then
+  node_modules/.bin/buidler coverage --network coverage "$@"
+else
+  node_modules/.bin/buidler test "$@"
+fi