Added tests for logging

Author: felix2feng

contracts/SetToken.sol

@@ -37,8 +37,7 @@ contract SetToken is StandardToken, DetailedERC20("", "", 18), Set {
 
   event LogRedeemExcluded(
     address indexed _sender,
-    uint[] _quantities,
-    address[] _component
+    address[] _components
   );
 
   modifier hasSufficientBalance(uint quantity) {
@@ -244,7 +243,7 @@ contract SetToken is StandardToken, DetailedERC20("", "", 18), Set {
       assert(ERC20(currentComponent).transfer(msg.sender, currentQuantity));
     }
 
-    LogRedeemExcluded(msg.sender, quantities, excludedComponents);
+    LogRedeemExcluded(msg.sender, excludedComponents);
 
     return true;
   }

test/logs/SetToken.ts

@@ -10,6 +10,23 @@ interface LogInterface {
   event: string;
 }
 
+export function LogTransfer(
+  from: Address,
+  to: Address,
+  value: BigNumber,
+  tokenAddress: Address,
+): LogInterface {
+  return {
+    event: "Transfer",
+    address: tokenAddress,
+    args: {
+      from,
+      to,
+      value,
+    },
+  };
+}
+
 export function LogIssuance(
   senderAddress: Address,
   quantity: BigNumber,
@@ -57,19 +74,17 @@ export function LogPartialRedemption(
   };
 }
 
-export function LogTransfer(
-  from: Address,
-  to: Address,
-  value: BigNumber,
-  tokenAddress: Address,
+export function LogRedeemExcluded(
+  senderAddress: Address,
+  setTokenAddress: Address,
+  components: Address[],
 ): LogInterface {
   return {
-    event: "Transfer",
-    address: tokenAddress,
+    event: "LogRedeemExcluded",
+    address: setTokenAddress,
     args: {
-      from,
-      to,
-      value,
+      _sender: senderAddress,
+      _components: components,
     },
   };
 }
@@ -161,3 +176,30 @@ export function getExpectedPartialRedeemLogs(
 
   return result;
 }
+
+export function getExpectedRedeemExcludedLogs(
+  componentAddresses: Address[],
+  quantitiesTransferred: BigNumber[],
+  setTokenAddress: Address,
+  sender: Address,
+): LogInterface[] {
+  const result: LogInterface[] = [];
+  // Create transfer logs from transferred components and units
+  _.each(componentAddresses, (componentAddress, index) => {
+    result.push(LogTransfer(
+      setTokenAddress,
+      sender,
+      quantitiesTransferred[index],
+      componentAddresses[index],
+    ));
+  });
+
+  // Create Redeem Excluded Log
+  result.push(LogRedeemExcluded(
+    sender,
+    setTokenAddress,
+    componentAddresses,
+  ));
+
+  return result;
+}

test/setToken-base.spec.ts

@@ -28,6 +28,7 @@ import {
   getExpectedIssueLogs,
   getExpectedRedeemLogs,
   getExpectedPartialRedeemLogs,
+  getExpectedRedeemExcludedLogs,
 } from "./logs/SetToken";
 
 import {
@@ -477,7 +478,7 @@ contract("{Set}", (accounts) => {
     });
   });
 
-  describe.only("Redeem Excluded", async () => {
+  describe("Redeem Excluded", async () => {
     let componentExcluded: any;
     let componentAddressExcluded: Address;
 
@@ -491,7 +492,22 @@ contract("{Set}", (accounts) => {
       });
 
       it("should work", async () => {
-        await setToken.redeemExcluded([quantitiesToTransfer[0]], [componentAddressExcluded], TX_DEFAULTS);
+        const redeemExcludedReceipt = await setToken.redeemExcluded(
+          [quantitiesToTransfer[0]],
+          [componentAddressExcluded],
+          TX_DEFAULTS,
+        );
+
+        const { logs } = redeemExcludedReceipt;
+        const formattedLogs = _.map(logs, (log) => extractLogEventAndArgs(log));
+        const expectedLogs = getExpectedRedeemExcludedLogs(
+          [componentAddressExcluded],
+          [quantitiesToTransfer[0]],
+          setToken.address,
+          testAccount,
+        );
+
+        expect(JSON.stringify(formattedLogs)).to.equal(JSON.stringify(expectedLogs));
 
         assertTokenBalance(componentExcluded, initialTokens, testAccount);