Add core abi diff logic & tests

Author: cgewecke

lib/api.js

@@ -6,6 +6,8 @@ const istanbul = require('sc-istanbul');
 const assert = require('assert');
 const detect = require('detect-port');
 const _ = require('lodash/lang');
+const ethersABI = require("@ethersproject/abi");
+const difflib = require('difflib');
 
 const ConfigValidator = require('./validator');
 const Instrumenter = require('./instrumenter');
@@ -342,6 +344,104 @@ class API {
     }
   }
 
+  // =========
+  // Abi Diff
+  // =========
+  diffAbis(orig={}, cur={}){
+    let origHR;
+    let curHR;
+    let plus = 0;
+    let minus = 0;
+
+    const origFunctions = new ethersABI.Interface(orig.abi).functions;
+    const curFunctions = new ethersABI.Interface(cur.abi).functions;
+
+    origHR = this.toHumanReadable(origFunctions)
+    curHR = this.toHumanReadable(curFunctions)
+
+    const fns = difflib.unifiedDiff(
+      origHR,
+      curHR,
+      {
+        fromfile: orig.contractName,
+        tofile: cur.contractName,
+        fromfiledate: `sha: ${orig.sha}`,
+        tofiledate: `sha: ${cur.sha}`,
+        lineterm: ''
+      }
+    );
+
+    const origEvents = new ethersABI.Interface(orig.abi).events;
+    const curEvents = new ethersABI.Interface(cur.abi).events;
+
+    origHR = this.toHumanReadable(origEvents)
+    curHR = this.toHumanReadable(curEvents)
+
+    let events = difflib.unifiedDiff(
+      origHR,
+      curHR,
+      {
+        fromfile: orig.contractName,
+        tofile: cur.contractName,
+        fromfiledate: `sha: ${orig.sha}`,
+        tofiledate: `sha: ${cur.sha}`,
+        lineterm: ''
+      }
+    );
+
+    if (events.length && fns.length){
+      events = events.slice(3);
+    }
+
+    const diff = fns.concat(events);
+
+    // Count changes (unified diff always has a plus & minus in header);
+    if (diff.length){
+      plus = -1;
+      minus = -1;
+    }
+
+    diff.forEach(line => {
+      if (line[0] === `+`) plus++;
+      if (line[0] === `-`) minus++;
+    })
+
+    return {
+      plus,
+      minus,
+      diff
+    }
+  }
+
+  toHumanReadable(ethersOutput){
+    const human = [];
+    const signatures = Object.keys(ethersOutput);
+
+    for (const sig of signatures){
+      const method = ethersOutput[sig];
+
+      let returns = '';
+      if (method.outputs){
+        method.outputs.forEach(output => {
+          (returns.length)
+            ? returns += `, ${output.type}`
+            : returns += output.type;
+        });
+      };
+
+      const mutability = method.stateMutability || '';
+      let readable = `${method.type} ${sig} ${mutability}`;
+
+      if (returns.length){
+        readable += ` returns (${returns})`
+      }
+
+      human.push(readable);
+    }
+
+    return human;
+  }
+
   // ========
   // File I/O
   // ========

package.json

@@ -24,11 +24,13 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "@ethersproject/abi": "^5.0.9",
     "@solidity-parser/parser": "^0.10.1",
     "@truffle/provider": "^0.2.24",
     "chalk": "^2.4.2",
     "death": "^1.1.0",
     "detect-port": "^1.3.0",
+    "difflib": "^0.2.4",
     "fs-extra": "^8.1.0",
     "ganache-cli": "^6.11.0",
     "ghost-testrpc": "^0.0.2",

test/sources/solidity/contracts/diff/addition.sol

@@ -0,0 +1,38 @@
+pragma solidity ^0.7.0;
+
+contract Old {
+  uint public y;
+
+  function a() public {
+    bool x = true;
+  }
+
+  function b() external {
+    bool x = true;
+  }
+
+  function c() external {
+    bool x = true;
+  }
+}
+
+contract New {
+  uint public y;
+
+  function a() public {
+    bool x = true;
+  }
+
+  function b() external {
+    bool x = true;
+  }
+
+  function c() external {
+    bool x = true;
+  }
+
+  function d() external {
+    bool x = true;
+  }
+}
+

test/sources/solidity/contracts/diff/events.sol

@@ -0,0 +1,23 @@
+pragma solidity ^0.7.0;
+
+contract Old {
+  uint y;
+
+  event Evt(uint x, bytes8 y);
+
+  function a() public {
+    bool x = true;
+  }
+}
+
+contract New {
+  uint y;
+
+  function a() public {
+    bool x = true;
+  }
+
+  event aEvt(bytes8);
+  event _Evt(bytes8 x, bytes8 y);
+}
+

test/sources/solidity/contracts/diff/no-change.sol

@@ -0,0 +1,34 @@
+pragma solidity ^0.7.0;
+
+contract Old {
+  uint y;
+
+  function a() public {
+    bool x = true;
+  }
+
+  function b() external {
+    bool x = true;
+  }
+
+  function c() external {
+    bool x = true;
+  }
+}
+
+contract New {
+  uint y;
+
+  function a() public {
+    bool x = true;
+  }
+
+  function b() external {
+    bool x = true;
+  }
+
+  function c() external {
+    bool x = true;
+  }
+}
+

test/sources/solidity/contracts/diff/param-change.sol

@@ -0,0 +1,33 @@
+pragma solidity ^0.7.0;
+
+contract Old {
+  uint y;
+
+  function a() public {
+    bool x = true;
+  }
+
+  function b() external {
+    bool x = true;
+  }
+
+  function c() external {
+    bool x = true;
+  }
+}
+
+contract New {
+  uint y;
+
+  function a() public {
+    bool x = true;
+  }
+
+  function b(bytes8 z) external {
+    bool x = true;
+  }
+
+  function c(uint q, uint r) external {
+    bool x = true;
+  }
+}

test/sources/solidity/contracts/diff/removal.sol

@@ -0,0 +1,29 @@
+pragma solidity ^0.7.0;
+
+contract Old {
+  uint y;
+
+  function a() public {
+    bool x = true;
+  }
+
+  function b() external {
+    bool x = true;
+  }
+
+  function c() external {
+    bool x = true;
+  }
+}
+
+contract New {
+  uint y;
+
+  function a() public {
+    bool x = true;
+  }
+
+  function b() external {
+    bool x = true;
+  }
+}

test/sources/solidity/contracts/diff/reorder.sol

@@ -0,0 +1,33 @@
+pragma solidity ^0.7.0;
+
+contract Old {
+  uint y;
+
+  function a() public {
+    bool x = true;
+  }
+
+  function b() external {
+    bool x = true;
+  }
+
+  function c() external {
+    bool x = true;
+  }
+}
+
+contract New {
+  uint y;
+
+  function c() external {
+    bool x = true;
+  }
+
+  function a() public {
+    bool x = true;
+  }
+
+  function b() external {
+    bool x = true;
+  }
+}

test/sources/solidity/contracts/diff/return-sig.sol

@@ -0,0 +1,25 @@
+pragma solidity ^0.7.0;
+
+contract Old {
+  function a() public view returns (uint) {
+    return 1;
+  }
+}
+
+contract New {
+  function a() public view returns (bool) {
+    return true;
+  }
+
+  function e() public view returns (uint8[2] memory) {
+    return [5,7];
+  }
+
+  function f() public view returns (uint8[2] memory, uint) {
+    return ([5,7], 7);
+  }
+
+  function g() public view returns (uint8[3] memory) {
+    return [5,7,8];
+  }
+}

test/sources/solidity/contracts/diff/state-mod-change.sol

@@ -0,0 +1,13 @@
+pragma solidity ^0.7.0;
+
+contract Old {
+  function a() public {
+    bool x = true;
+  }
+}
+
+contract New {
+  function a() public view returns (bool) {
+    return true;
+  }
+}