protocol/contracts/integrations/test/framework-unit-tests/function_assertion_test.ts

import {
    blockchainTests,
    constants,
    expect,
    filterLogsToArguments,
    getRandomInteger,
    hexRandom,
} from '@0x/contracts-test-utils';
import { BigNumber, StringRevertError } from '@0x/utils';
import { TransactionReceiptWithDecodedLogs } from 'ethereum-types';

import { artifacts, TestFrameworkContract, TestFrameworkEventEventArgs, TestFrameworkEvents } from '../../src';
import { FunctionAssertion, Result } from '../utils/function_assertions';

const ZERO = constants.ZERO_AMOUNT;
const MAX_UINT256 = constants.MAX_UINT256;

blockchainTests.resets('FunctionAssertion Unit Tests', env => {
    let exampleContract: TestFrameworkContract;

    before(async () => {
        exampleContract = await TestFrameworkContract.deployFrom0xArtifactAsync(
            artifacts.TestFramework,
            env.provider,
            env.txDefaults,
            artifacts,
        );
    });

    describe('runAsync', () => {
        it('should call the before function with the provided arguments', async () => {
            let sideEffectTarget = ZERO;
            const assertion = new FunctionAssertion(exampleContract.returnInteger, {
                before: async (input: BigNumber) => {
                    sideEffectTarget = randomInput;
                },
                after: async (beforeInfo: any, result: Result, input: BigNumber) => {},
            });
            const randomInput = getRandomInteger(ZERO, MAX_UINT256);
            await assertion.runAsync(randomInput);
            expect(sideEffectTarget).bignumber.to.be.eq(randomInput);
        });

        it('should call the after function with the provided arguments', async () => {
            let sideEffectTarget = ZERO;
            const assertion = new FunctionAssertion(exampleContract.returnInteger, {
                before: async (input: BigNumber) => {},
                after: async (beforeInfo: any, result: Result, input: BigNumber) => {
                    sideEffectTarget = input;
                },
            });
            const randomInput = getRandomInteger(ZERO, MAX_UINT256);
            await assertion.runAsync(randomInput);
            expect(sideEffectTarget).bignumber.to.be.eq(randomInput);
        });

        it('should not fail immediately if the wrapped function fails', async () => {
            const assertion = new FunctionAssertion(exampleContract.emptyRevert, {
                before: async () => {},
                after: async (beforeInfo: any, result: Result) => {},
            });
            await assertion.runAsync();
        });

        it('should pass the return value of "before" to "after"', async () => {
            const randomInput = getRandomInteger(ZERO, MAX_UINT256);
            let sideEffectTarget = constants.ZERO_AMOUNT;
            const assertion = new FunctionAssertion(exampleContract.returnInteger, {
                before: async (input: BigNumber) => {
                    return randomInput;
                },
                after: async (beforeInfo: any, result: Result, input: BigNumber) => {
                    sideEffectTarget = beforeInfo;
                },
            });
            await assertion.runAsync(randomInput);
            expect(sideEffectTarget).bignumber.to.be.eq(randomInput);
        });

        it('should pass the result from the function call to "after"', async () => {
            let sideEffectTarget = constants.ZERO_AMOUNT;
            const assertion = new FunctionAssertion(exampleContract.returnInteger, {
                before: async (input: BigNumber) => {},
                after: async (beforeInfo: any, result: Result, input: BigNumber) => {
                    sideEffectTarget = result.data;
                },
            });
            const randomInput = getRandomInteger(ZERO, MAX_UINT256);
            await assertion.runAsync(randomInput);
            expect(sideEffectTarget).bignumber.to.be.eq(randomInput);
        });

        it('should pass the receipt from the function call to "after"', async () => {
            let sideEffectTarget = {} as TransactionReceiptWithDecodedLogs;
            const assertion = new FunctionAssertion(exampleContract.emitEvent, {
                before: async (input: string) => {},
                after: async (beforeInfo: any, result: Result, input: string) => {
                    if (result.receipt) {
                        sideEffectTarget = result.receipt;
                    }
                },
            });

            const input = 'emitted data';
            await assertion.runAsync(input);

            // Ensure that the correct events were emitted.
            const [event] = filterLogsToArguments<TestFrameworkEventEventArgs>(
                sideEffectTarget.logs,
                TestFrameworkEvents.Event,
            );
            expect(event).to.be.deep.eq({ input });
        });

        it('should pass the error to "after" if the function call fails', async () => {
            let sideEffectTarget: Error;
            const assertion = new FunctionAssertion(exampleContract.stringRevert, {
                before: async string => {},
                after: async (any, result: Result, string) => {
                    sideEffectTarget = result.data;
                },
            });
            const message = 'error message';
            await assertion.runAsync(message);

            const expectedError = new StringRevertError(message);
            return expect(
                new Promise((resolve, reject) => {
                    reject(sideEffectTarget);
                }),
            ).to.revertWith(expectedError);
        });
    });
});