Set up testing of logs

Author: felix2feng

package.json

@@ -43,7 +43,6 @@
     "@types/lodash": "^4.14.86",
     "@types/mocha": "^2.2.47",
     "@types/node": "^8.5.1",
-    "abi-decoder": "^1.1.0",
     "bignumber.js": "^4.1.0",
     "chai": "^4.1.2",
     "chai-as-promised": "^7.1.1",

test/logs/SetToken.ts

@@ -0,0 +1,71 @@
+import { BigNumber } from "bignumber.js";
+import * as _ from "lodash";
+import * as LogUtils from "./log_utils";
+
+import { Address, Bytes32, UInt } from "../../types/common";
+
+interface LogInterface {
+  address: Address;
+  args: any;
+  event: string;
+}
+
+export function LogIssuance(
+  senderAddress: Address,
+  quantity: BigNumber,
+  setTokenAddress: Address,
+): LogInterface {
+  return {
+    event: "LogIssuance",
+    address: setTokenAddress,
+    args: {
+      _sender: senderAddress,
+      _quantity: quantity,
+    },
+  };
+}
+
+export function LogTransfer(
+  from: Address,
+  to: Address,
+  value: BigNumber,
+  tokenAddress: Address,
+): LogInterface {
+  return {
+    event: "Transfer",
+    address: tokenAddress,
+    args: {
+      from,
+      to,
+      value,
+    },
+  };
+}
+
+export function getExpectedIssueLogs(
+  componentAddresses: Address[],
+  quantityTransferred: BigNumber[],
+  setTokenAddress: Address,
+  quantityIssued: BigNumber,
+  sender: Address,
+): LogInterface[] {
+  const result: LogInterface[] = [];
+  // Create transfer logs from components and units
+  _.each(componentAddresses, (componentAddress, index) => {
+    result.push(LogTransfer(
+      sender,
+      setTokenAddress,
+      quantityTransferred[index],
+      componentAddresses[index],
+    ));
+  });
+
+  // Create Issuance Log
+  result.push(LogIssuance(
+    sender,
+    quantityIssued,
+    setTokenAddress,
+  ));
+
+  return result;
+}

test/logs/log_utils.ts

@@ -0,0 +1,9 @@
+
+export function extractLogEventAndArgs(logs: any) {
+  const { event, args, address } = logs;
+  return {
+    event,
+    address,
+    args,
+  };
+}

test/setToken-base.spec.ts

@@ -1,6 +1,5 @@
 import * as chai from "chai";
 import * as _ from "lodash";
-// import * as ABIDecoder from "abi-decoder";
 
 import { BigNumber } from "bignumber.js";
 import { ether, gWei } from "./utils/units";
@@ -23,6 +22,10 @@ BigNumberSetup.configure();
 ChaiSetup.configure();
 const { expect, assert } = chai;
 
+import { extractLogEventAndArgs } from "./logs/log_utils";
+
+import { getExpectedIssueLogs } from "./logs/SetToken";
+
 import {
   assertTokenBalance,
   expectInvalidOpcodeError,
@@ -197,21 +200,23 @@ contract("{Set}", (accounts) => {
 
         // Expected Quantities of tokens moved are divided by a gWei
         // to reflect the new units in set instantiation
-        const quantityA: BigNumber = units1.mul(standardQuantityIssued).div(gWei(1));
-        const quantityB: BigNumber = units2.mul(standardQuantityIssued).div(gWei(1));
+        quantitiesToTransfer = _.map(units, (unit) => unit.mul(standardQuantityIssued).div(gWei(1)));
 
         const issuanceReceipt = await setToken.issue(standardQuantityIssued, TX_DEFAULTS);
 
-        const issuanceLog = issuanceReceipt.logs[issuanceReceipt.logs.length - 1].args;
-
-        // The logs should have the right sender
-        assert.strictEqual(issuanceLog._sender, testAccount);
-
-        // The logs should have the right quantity
-        expect(issuanceLog._quantity).to.be.bignumber.equal(standardQuantityIssued);
+        const { logs } = issuanceReceipt;
+        const formattedLogs = _.map(logs, (log) => extractLogEventAndArgs(log));
+        const expectedLogs = getExpectedIssueLogs(
+          componentAddresses,
+          quantitiesToTransfer,
+          setToken.address,
+          standardQuantityIssued,
+          testAccount,
+        );
+        expect(JSON.stringify(formattedLogs)).to.equal(JSON.stringify(expectedLogs));
 
-        assertTokenBalance(component1, initialTokens.sub(quantityA), testAccount);
-        assertTokenBalance(component2, initialTokens.sub(quantityB), testAccount);
+        assertTokenBalance(component1, initialTokens.sub(quantitiesToTransfer[0]), testAccount);
+        assertTokenBalance(component2, initialTokens.sub(quantitiesToTransfer[1]), testAccount);
         assertTokenBalance(setToken, standardQuantityIssued, testAccount);
       });
 
@@ -240,10 +245,20 @@ contract("{Set}", (accounts) => {
     // 60 is about the limit for the number of components in a Set
     // This is about ~2M Gas.
     describe("of 60 Component Set", () => {
-      it(`work`, async () => {
-        await deployStandardSetAndApprove(60);
+      it(`should work`, async () => {
+        await deployStandardSetAndApprove(5);
 
-        await setToken.issue(standardQuantityIssued, TX_DEFAULTS);
+        const issuanceReceipt = await setToken.issue(standardQuantityIssued, TX_DEFAULTS);
+        // const { logs } = issuanceReceipt;
+        // const formattedLogs = _.map(logs, (log) => extractLogEventAndArgs(log));
+        // const expectedLogs = getExpectedIssueLogs(
+        //   componentAddresses,
+        //   quantitiesToTransfer,
+        //   setToken.address,
+        //   standardQuantityIssued,
+        //   testAccount,
+        // );
+        // expect(JSON.stringify(formattedLogs)).to.equal(JSON.stringify(expectedLogs));
         assertTokenBalance(setToken, standardQuantityIssued, testAccount);
       });
     });