Changed before for beforeAll, refactored Bouncer tests. (#1094)

* Changed before for beforeAll, refactored Bouncer tests.

* Fixed linter errors.

* fix: updates for SignatureBouncer tests and voucher construction

contracts/access/SignatureBouncer.sol

@@ -34,8 +34,8 @@ contract SignatureBouncer is Ownable, RBAC {
 
   string public constant ROLE_BOUNCER = "bouncer";
   uint constant METHOD_ID_SIZE = 4;
-  // (signature length size) 32 bytes + (signature size 65 bytes padded) 96 bytes
-  uint constant SIGNATURE_SIZE = 128;
+  // signature size is 65 bytes (tightly packed v + r + s), but gets padded to 96 bytes
+  uint constant SIGNATURE_SIZE = 96;
 
   /**
    * @dev requires that a valid signature of a bouncer was provided

contracts/mocks/BouncerMock.sol

@@ -36,7 +36,12 @@ contract SignatureBouncerMock is SignatureBouncer {
 
   }
 
-  function checkValidSignatureAndData(address _address, bytes _bytes, uint _val, bytes _sig)
+  function checkValidSignatureAndData(
+    address _address,
+    bytes,
+    uint,
+    bytes _sig
+  )
     public
     view
     returns (bool)
@@ -44,11 +49,18 @@ contract SignatureBouncerMock is SignatureBouncer {
     return isValidSignatureAndData(_address, _sig);
   }
 
-  function onlyWithValidSignatureAndData(uint _val, bytes _sig)
+  function onlyWithValidSignatureAndData(uint, bytes _sig)
     onlyValidSignatureAndData(_sig)
     public
     view
   {
 
   }
+
+  function theWrongMethod(bytes)
+    public
+    pure
+  {
+
+  }
 }

test/helpers/sign.js

 const utils = require('ethereumjs-util');
+const { soliditySha3 } = require('web3-utils');
+
+const REAL_SIGNATURE_SIZE = 2 * 65; // 65 bytes in hexadecimal string legnth
+const PADDED_SIGNATURE_SIZE = 2 * 96; // 96 bytes in hexadecimal string length
+
+const DUMMY_SIGNATURE = `0x${web3.padLeft('', REAL_SIGNATURE_SIZE)}`;
 
 /**
  * Hash and add same prefix to the hash that ganache use.
@@ -11,18 +17,63 @@ function hashMessage (message) {
   return utils.bufferToHex(utils.sha3(Buffer.concat([prefix, messageHex])));
 }
 
-// signs message using web3 (auto-applies prefix)
-function signMessage (signer, message = '', options = {}) {
-  return web3.eth.sign(signer, web3.sha3(message, options));
-}
+// signs message in node (auto-applies prefix)
+// message must be in hex already! will not be autoconverted!
+const signMessage = (signer, message = '') => {
+  return web3.eth.sign(signer, message);
+};
 
-// signs hex string using web3 (auto-applies prefix)
-function signHex (signer, message = '') {
-  return signMessage(signer, message, { encoding: 'hex' });
-}
+// @TODO - remove this when we migrate to web3-1.0.0
+const transformToFullName = function (json) {
+  if (json.name.indexOf('(') !== -1) {
+    return json.name;
+  }
+
+  var typeName = json.inputs.map(function (i) { return i.type; }).join();
+  return json.name + '(' + typeName + ')';
+};
+
+/**
+ * Create a signer between a contract and a signer for a voucher of method, args, and redeemer
+ * Note that `method` is the web3 method, not the truffle-contract method
+ * Well truffle is terrible, but luckily (?) so is web3 < 1.0, so we get to make our own method id
+ *   fetcher because the method on the contract isn't actually the SolidityFunction object ಠ_ಠ
+ * @param contract TruffleContract
+ * @param signer address
+ * @param redeemer address
+ * @param methodName string
+ * @param methodArgs any[]
+ */
+const getBouncerSigner = (contract, signer) => (redeemer, methodName, methodArgs = []) => {
+  const parts = [
+    contract.address,
+    redeemer,
+  ];
+
+  // if we have a method, add it to the parts that we're signing
+  if (methodName) {
+    if (methodArgs.length > 0) {
+      parts.push(
+        contract.contract[methodName].getData(...methodArgs.concat([DUMMY_SIGNATURE])).slice(
+          0,
+          -1 * PADDED_SIGNATURE_SIZE
+        )
+      );
+    } else {
+      const abi = contract.abi.find(abi => abi.name === methodName);
+      const name = transformToFullName(abi);
+      const signature = web3.sha3(name).slice(0, 10);
+      parts.push(signature);
+    }
+  }
+
+  // ^ substr to remove `0x` because in solidity the address is a set of byes, not a string `0xabcd`
+  const hashOfMessage = soliditySha3(...parts);
+  return signMessage(signer, hashOfMessage);
+};
 
 module.exports = {
   hashMessage,
   signMessage,
-  signHex,
+  getBouncerSigner,
 };

test/introspection/SupportsInterfaceWithLookup.test.js

@@ -8,7 +8,7 @@ require('chai')
   .should();
 
 contract('SupportsInterfaceWithLookup', function (accounts) {
-  before(async function () {
+  beforeEach(async function () {
     this.mock = await SupportsInterfaceWithLookup.new();
   });
 

test/library/ECRecovery.test.js

@@ -11,7 +11,7 @@ contract('ECRecovery', function (accounts) {
   let ecrecovery;
   const TEST_MESSAGE = 'OpenZeppelin';
 
-  before(async function () {
+  beforeEach(async function () {
     ecrecovery = await ECRecoveryMock.new();
   });
 
@@ -37,7 +37,7 @@ contract('ECRecovery', function (accounts) {
 
   it('recover using web3.eth.sign()', async function () {
     // Create the signature using account[0]
-    const signature = signMessage(accounts[0], TEST_MESSAGE);
+    const signature = signMessage(accounts[0], web3.sha3(TEST_MESSAGE));
 
     // Recover the signer address from the generated message and signature.
     const addrRecovered = await ecrecovery.recover(
@@ -49,7 +49,7 @@ contract('ECRecovery', function (accounts) {
 
   it('recover using web3.eth.sign() should return wrong signer', async function () {
     // Create the signature using account[0]
-    const signature = signMessage(accounts[0], TEST_MESSAGE);
+    const signature = signMessage(accounts[0], web3.sha3(TEST_MESSAGE));
 
     // Recover the signer address from the generated message and wrong signature.
     const addrRecovered = await ecrecovery.recover(hashMessage('Nope'), signature);

test/library/Math.test.js

@@ -3,7 +3,7 @@ var MathMock = artifacts.require('MathMock');
 contract('Math', function (accounts) {
   let math;
 
-  before(async function () {
+  beforeEach(async function () {
     math = await MathMock.new();
   });
 

test/library/MerkleProof.test.js

@@ -6,7 +6,7 @@ var MerkleProofWrapper = artifacts.require('MerkleProofWrapper');
 contract('MerkleProof', function (accounts) {
   let merkleProof;
 
-  before(async function () {
+  beforeEach(async function () {
     merkleProof = await MerkleProofWrapper.new();
   });
 

test/lifecycle/Destructible.test.js

@@ -2,20 +2,21 @@ var Destructible = artifacts.require('Destructible');
 const { ethGetBalance } = require('../helpers/web3');
 
 contract('Destructible', function (accounts) {
+  beforeEach(async function () {
+    this.destructible = await Destructible.new({ from: accounts[0], value: web3.toWei('10', 'ether') });
+    this.owner = await this.destructible.owner();
+  });
+
   it('should send balance to owner after destruction', async function () {
-    let destructible = await Destructible.new({ from: accounts[0], value: web3.toWei('10', 'ether') });
-    let owner = await destructible.owner();
-    let initBalance = await ethGetBalance(owner);
-    await destructible.destroy({ from: owner });
-    let newBalance = await ethGetBalance(owner);
+    let initBalance = await ethGetBalance(this.owner);
+    await this.destructible.destroy({ from: this.owner });
+    let newBalance = await ethGetBalance(this.owner);
     assert.isTrue(newBalance > initBalance);
   });
 
   it('should send balance to recepient after destruction', async function () {
-    let destructible = await Destructible.new({ from: accounts[0], value: web3.toWei('10', 'ether') });
-    let owner = await destructible.owner();
     let initBalance = await ethGetBalance(accounts[1]);
-    await destructible.destroyAndSend(accounts[1], { from: owner });
+    await this.destructible.destroyAndSend(accounts[1], { from: this.owner });
     let newBalance = await ethGetBalance(accounts[1]);
     assert.isTrue(newBalance.greaterThan(initBalance));
   });

test/lifecycle/Pausable.test.js

@@ -2,61 +2,59 @@ const { assertRevert } = require('../helpers/assertRevert');
 const PausableMock = artifacts.require('PausableMock');
 
 contract('Pausable', function (accounts) {
+  beforeEach(async function () {
+    this.Pausable = await PausableMock.new();
+  });
+
   it('can perform normal process in non-pause', async function () {
-    let Pausable = await PausableMock.new();
-    let count0 = await Pausable.count();
+    let count0 = await this.Pausable.count();
     assert.equal(count0, 0);
 
-    await Pausable.normalProcess();
-    let count1 = await Pausable.count();
+    await this.Pausable.normalProcess();
+    let count1 = await this.Pausable.count();
     assert.equal(count1, 1);
   });
 
   it('can not perform normal process in pause', async function () {
-    let Pausable = await PausableMock.new();
-    await Pausable.pause();
-    let count0 = await Pausable.count();
+    await this.Pausable.pause();
+    let count0 = await this.Pausable.count();
     assert.equal(count0, 0);
 
-    await assertRevert(Pausable.normalProcess());
-    let count1 = await Pausable.count();
+    await assertRevert(this.Pausable.normalProcess());
+    let count1 = await this.Pausable.count();
     assert.equal(count1, 0);
   });
 
   it('can not take drastic measure in non-pause', async function () {
-    let Pausable = await PausableMock.new();
-    await assertRevert(Pausable.drasticMeasure());
-    const drasticMeasureTaken = await Pausable.drasticMeasureTaken();
+    await assertRevert(this.Pausable.drasticMeasure());
+    const drasticMeasureTaken = await this.Pausable.drasticMeasureTaken();
     assert.isFalse(drasticMeasureTaken);
   });
 
   it('can take a drastic measure in a pause', async function () {
-    let Pausable = await PausableMock.new();
-    await Pausable.pause();
-    await Pausable.drasticMeasure();
-    let drasticMeasureTaken = await Pausable.drasticMeasureTaken();
+    await this.Pausable.pause();
+    await this.Pausable.drasticMeasure();
+    let drasticMeasureTaken = await this.Pausable.drasticMeasureTaken();
 
     assert.isTrue(drasticMeasureTaken);
   });
 
   it('should resume allowing normal process after pause is over', async function () {
-    let Pausable = await PausableMock.new();
-    await Pausable.pause();
-    await Pausable.unpause();
-    await Pausable.normalProcess();
-    let count0 = await Pausable.count();
+    await this.Pausable.pause();
+    await this.Pausable.unpause();
+    await this.Pausable.normalProcess();
+    let count0 = await this.Pausable.count();
 
     assert.equal(count0, 1);
   });
 
   it('should prevent drastic measure after pause is over', async function () {
-    let Pausable = await PausableMock.new();
-    await Pausable.pause();
-    await Pausable.unpause();
+    await this.Pausable.pause();
+    await this.Pausable.unpause();
 
-    await assertRevert(Pausable.drasticMeasure());
+    await assertRevert(this.Pausable.drasticMeasure());
 
-    const drasticMeasureTaken = await Pausable.drasticMeasureTaken();
+    const drasticMeasureTaken = await this.Pausable.drasticMeasureTaken();
     assert.isFalse(drasticMeasureTaken);
   });
 });

test/lifecycle/TokenDestructible.test.js

@@ -5,16 +5,18 @@ var StandardTokenMock = artifacts.require('StandardTokenMock');
 
 contract('TokenDestructible', function (accounts) {
   let destructible;
+  let owner;
 
   beforeEach(async function () {
     destructible = await TokenDestructible.new({
       from: accounts[0],
       value: web3.toWei('10', 'ether'),
     });
+
+    owner = await destructible.owner();
   });
 
   it('should send balance to owner after destruction', async function () {
-    let owner = await destructible.owner();
     let initBalance = await ethGetBalance(owner);
     await destructible.destroy([], { from: owner });
     let newBalance = await ethGetBalance(owner);
@@ -22,7 +24,6 @@ contract('TokenDestructible', function (accounts) {
   });
 
   it('should send tokens to owner after destruction', async function () {
-    let owner = await destructible.owner();
     let token = await StandardTokenMock.new(destructible.address, 100);
     let initContractBalance = await token.balanceOf(destructible.address);
     let initOwnerBalance = await token.balanceOf(owner);

test/math/SafeMath.test.js

@@ -9,7 +9,7 @@ require('chai')
 contract('SafeMath', () => {
   const MAX_UINT = new BigNumber('115792089237316195423570985008687907853269984665640564039457584007913129639935');
 
-  before(async function () {
+  beforeEach(async function () {
     this.safeMath = await SafeMathMock.new();
   });
 

test/ownership/HasNoEther.test.js

@@ -7,7 +7,7 @@ const ForceEther = artifacts.require('ForceEther');
 contract('HasNoEther', function (accounts) {
   const amount = web3.toWei('1', 'ether');
 
-  it('should be constructorable', async function () {
+  it('should be constructible', async function () {
     await HasNoEtherTest.new();
   });
 

test/ownership/Whitelist.test.js

@@ -17,7 +17,7 @@ contract('Whitelist', function (accounts) {
 
   const whitelistedAddresses = [whitelistedAddress1, whitelistedAddress2];
 
-  before(async function () {
+  beforeEach(async function () {
     this.mock = await WhitelistMock.new();
     this.role = await this.mock.ROLE_WHITELISTED();
   });

test/ownership/rbac/RBAC.test.js

@@ -19,7 +19,7 @@ contract('RBAC', function (accounts) {
     ...advisors
   ] = accounts;
 
-  before(async () => {
+  beforeEach(async () => {
     mock = await RBACMock.new(advisors, { from: admin });
   });
 

test/proposals/ERC1046/TokenMetadata.test.js

@@ -7,7 +7,7 @@ require('chai')
 const metadataURI = 'https://example.com';
 
 describe('ERC20WithMetadata', function () {
-  before(async function () {
+  beforeEach(async function () {
     this.token = await ERC20WithMetadata.new(metadataURI);
   });