feat(router): add router step tests

Author: mjlescano

packages/builder/src/steps/router.test.ts

@@ -1,5 +1,5 @@
 import action from './router';
-import { fixtureContractData, fixtureCtx, fixtureRuntime } from '../../test/fixtures';
+import { fixtureContractData, fixtureCtx, fixtureRuntime, fixtureSigner, mockDeployTransaction } from '../../test/fixtures';
 
 describe('steps/router.ts', () => {
   describe('configInject()', () => {
@@ -47,4 +47,55 @@ describe('steps/router.ts', () => {
       expect(result.contractAddresses.GreeterTwo).toStrictEqual(contracts.GreeterTwo.address);
     });
   });
+
+  describe('exec()', () => {
+    it('throws an error on missing contract file', async () => {
+      const contracts = { Greeter: fixtureContractData('Greeter') };
+      const step = {
+        name: 'router-test',
+        version: '0.0.0',
+        currentLabel: 'router.Router',
+      };
+
+      const runtime = fixtureRuntime();
+      const ctx = fixtureCtx({}); // generate a ctx without the contracts
+      const config = { contracts: Object.keys(contracts) };
+
+      await expect(action.exec(runtime, ctx, config, step)).rejects.toThrow('contract not found: Greeter');
+    });
+
+    it('generates and deploys Router with a single contract', async () => {
+      const signer = fixtureSigner();
+      const contracts = { Greeter: fixtureContractData('Greeter') };
+
+      const step = {
+        name: 'router-test',
+        version: '0.0.0',
+        currentLabel: 'router.Router',
+      };
+
+      const runtime = fixtureRuntime();
+      const ctx = fixtureCtx({ contracts });
+      const config = { from: await signer.getAddress(), contracts: Object.keys(contracts) };
+
+      jest.spyOn(runtime, 'getSigner').mockResolvedValue(signer);
+
+      const { tx, rx } = await mockDeployTransaction(signer);
+      const res = await action.exec(runtime, ctx, config, step);
+
+      expect(signer.sendTransaction).toHaveBeenCalledTimes(1);
+      expect(tx.wait).toHaveBeenCalledTimes(1);
+
+      expect(res.contracts).toMatchObject({
+        Router: {
+          address: rx.contractAddress,
+          abi: contracts.Greeter.abi,
+          deployedOn: step.currentLabel,
+          deployTxnHash: tx.hash,
+          contractName: 'Router',
+          sourceName: 'Router.sol',
+        },
+      });
+    });
+  });
 });

packages/builder/test/fixtures.ts

@@ -2,6 +2,7 @@ import fs from 'node:fs';
 import _ from 'lodash';
 import { ethers } from 'ethers';
 import { JsonFragment } from '@ethersproject/abi';
+import { TransactionResponse } from '@ethersproject/abstract-provider';
 import { ChainBuilderContextWithHelpers, ChainBuilderRuntimeInfo } from '../src/types';
 import { ChainBuilderRuntime } from '../src/runtime';
 import { CannonWrapperGenericProvider, InMemoryRegistry } from '../src';
@@ -70,3 +71,25 @@ export const fixtureRuntime = (
   loaders?: ConstructorParameters<typeof ChainBuilderRuntime>[2],
   defaultLoaderScheme?: ConstructorParameters<typeof ChainBuilderRuntime>[3]
 ) => new ChainBuilderRuntime(info, registry, loaders, defaultLoaderScheme);
+
+export const fixtureSigner = () => ethers.Wallet.createRandom();
+
+export async function mockDeployTransaction(signer: ethers.Signer) {
+  const hash = fixtureTxHash();
+
+  const rx = {
+    contractAddress: fixtureAddress(),
+    transactionHash: hash,
+    logs: [],
+  };
+
+  const tx = {
+    hash,
+    from: await signer.getAddress(),
+    wait: jest.fn().mockResolvedValue(rx),
+  };
+
+  jest.spyOn(signer, 'sendTransaction').mockResolvedValue(tx as unknown as TransactionResponse);
+
+  return { tx, rx };
+}