feat: testcontainers integration (#386)

- closes #382

.changeset/clever-mails-agree.md

@@ -0,0 +1,6 @@
+---
+'@fuel-bridge/solidity-contracts': minor
+'@fuel-bridge/test-utils': minor
+---
+
+testcontainer integration for all intergration tests

.github/workflows/upgrade-test-suite.yml

@@ -43,4 +43,4 @@ jobs:
         working-directory: docker/envs
       - name: Run integration tests on a L1 fork after upgrading contracts
         run: |
-          pnpm run test:fork
+          pnpm run test:integration:fork

docker/docker-compose.yml

@@ -83,9 +83,6 @@ services:
       COMMITTER__APP__BUNDLE__FRAGMENT_ACCUMULATION_TIMEOUT: '10m'
       COMMITTER__APP__BUNDLE__NEW_BUNDLE_CHECK_INTERVAL: '3s'
       DEPLOYMENTS_HTTP: http://l1_chain:8081/deployments.local.json
-    ports:
-      # expose the service to the host for integration testing
-      - ${COMMITTER_HTTP_PORT:-8888}:8888
     depends_on:
       db:
         condition: service_healthy

package.json

@@ -12,13 +12,7 @@
     "changeset:version": "changeset version",
     "build": "sh ./scripts/build.sh",
     "format": "sh ./scripts/format.sh",
-    "node:build": "make -C ./docker build",
-    "node:up": "make -C ./docker up",
-    "node:stop": "make -C ./docker stop",
-    "node:clean": "make -C ./docker clean",
-    "node:logs": "make -C ./docker logs",
     "test": "sh ./scripts/test.sh",
-    "test:fork": "sh ./scripts/test-fork.sh",
     "test:integration": "DEBUG=true pnpm --filter @fuel-bridge/integration-tests test",
     "test:integration:fork": "DEBUG=true pnpm --filter @fuel-bridge/integration-tests test-fork",
     "lint:check": "eslint . --ext .ts,.js",

packages/integration-tests/.env.example

@@ -27,3 +27,6 @@ ETH_ERC721_TOKEN_ADDRESS=
 # (Optional) Fuel network specific variables
 FUEL_GAS_LIMIT=10000000
 FUEL_GAS_PRICE=1
+
+# for fork test
+TENDERLY_RPC_URL=

packages/integration-tests/docker-setup/docker.ts

@@ -0,0 +1,51 @@
+import { config as dotEnvConfig } from 'dotenv';
+import * as path from 'path';
+import type {
+  StartedTestContainer,
+  StartedDockerComposeEnvironment,
+} from 'testcontainers';
+import { DockerComposeEnvironment } from 'testcontainers';
+
+dotEnvConfig();
+
+export type Containers = {
+  postGresContainer: StartedTestContainer;
+  l1_node: StartedTestContainer;
+  fuel_node: StartedTestContainer;
+  block_committer: StartedTestContainer;
+};
+
+const PROJECT_ROOT = path.resolve(__dirname, '../../../');
+let environment: StartedDockerComposeEnvironment;
+
+// responsible for starting all containers
+export async function startContainers() {
+  // building images externally
+  console.log('Setting up environment using docker compose...');
+  environment = await new DockerComposeEnvironment(
+    path.resolve(PROJECT_ROOT, 'docker'),
+    'docker-compose.yml'
+  )
+    .withBuild()
+    .up();
+
+  console.log('Environment setup done...');
+
+  const postGresContainer = environment.getContainer('db-1');
+
+  const l1_node: StartedTestContainer = environment.getContainer('l1_chain-1');
+  const fuel_node: StartedTestContainer =
+    environment.getContainer('fuel_core-1');
+  const block_committer: StartedTestContainer = environment.getContainer(
+    'fuel_block_commiter-1'
+  );
+
+  return { postGresContainer, l1_node, fuel_node, block_committer };
+}
+
+export async function stopEnvironment(): Promise<void> {
+  console.log('Stopping environment...');
+  if (environment) {
+    await environment.down();
+  }
+}

packages/integration-tests/fork-tests/bridge_erc20.ts

@@ -33,6 +33,7 @@ import type {
   Provider,
 } from 'fuels';
 
+import { startContainers, stopEnvironment } from '../docker-setup/docker';
 import { fundWithdrawalTransactionWithBaseAssetResource } from '../utils/utils';
 
 const { expect } = chai;
@@ -203,6 +204,9 @@ describe('Bridging ERC20 tokens', async function () {
   }
 
   before(async () => {
+    // spinning up all docker containers
+    await startContainers();
+
     env = await setupEnvironment({});
     eth_erc20GatewayAddress = (
       await env.eth.fuelERC20Gateway.getAddress()
@@ -722,4 +726,9 @@ describe('Bridging ERC20 tokens', async function () {
       ).to.be.true;
     });
   });
+
+  // stopping containers post the test
+  after(async () => {
+    await stopEnvironment();
+  });
 });

packages/integration-tests/fork-tests/transfer_eth.ts

@@ -20,6 +20,8 @@ import type {
   Provider,
 } from 'fuels';
 
+import { startContainers, stopEnvironment } from '../docker-setup/docker';
+
 const { expect } = chai;
 
 describe('Transferring ETH', async function () {
@@ -131,6 +133,9 @@ describe('Transferring ETH', async function () {
   }
 
   before(async () => {
+    // spinning up all docker containers
+    await startContainers();
+
     env = await setupEnvironment({});
     BASE_ASSET_ID = env.fuel.provider.getBaseAssetId();
   });
@@ -465,4 +470,9 @@ describe('Transferring ETH', async function () {
       expect(currentWithdrawnAmountAfterSettingLimit == 0n).to.be.true;
     });
   });
+
+  // stopping containers post the test
+  after(async () => {
+    await stopEnvironment();
+  });
 });

packages/integration-tests/package.json

@@ -28,6 +28,8 @@
     "fuels": "0.96.1",
     "mocha": "^10.0.0",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "typescript": "^5.1.6",
+    "testcontainers": "^10.16.0",
+    "@testcontainers/postgresql": "^10.16.0"
   }
 }

packages/integration-tests/tests/bridge_erc20.ts

@@ -37,6 +37,7 @@ import type {
   MessageProof,
 } from 'fuels';
 
+import { startContainers, stopEnvironment } from '../docker-setup/docker';
 import { fundWithdrawalTransactionWithBaseAssetResource } from '../utils/utils';
 
 const { expect } = chai;
@@ -234,6 +235,9 @@ describe('Bridging ERC20 tokens', async function () {
   }
 
   before(async () => {
+    // spinning up all docker containers
+    await startContainers();
+
     env = await setupEnvironment({});
     eth_erc20GatewayAddress = (
       await env.eth.fuelERC20Gateway.getAddress()
@@ -876,4 +880,9 @@ describe('Bridging ERC20 tokens', async function () {
       ).to.be.true;
     });
   });
+
+  // stopping containers post the test
+  after(async () => {
+    await stopEnvironment();
+  });
 });

packages/integration-tests/tests/bridge_erc721.ts

@@ -27,6 +27,8 @@ import type {
   MessageProof,
 } from 'fuels';
 
+import { startContainers, stopEnvironment } from '../docker-setup/docker';
+
 const { expect } = chai;
 
 // TODO: develop new version of ERC721 gateway
@@ -48,6 +50,9 @@ describe.skip('Bridging ERC721 tokens', async function () {
   this.timeout(DEFAULT_TIMEOUT_MS);
 
   before(async () => {
+    // spinning up all docker containers
+    await startContainers();
+
     env = await setupEnvironment({});
     eth_testToken = await getOrDeployERC721Contract(env);
     eth_testTokenAddress = (await eth_testToken.getAddress()).toLowerCase();
@@ -263,4 +268,9 @@ describe.skip('Bridging ERC721 tokens', async function () {
       );
     });
   });
+
+  // stopping containers post the test
+  after(async () => {
+    await stopEnvironment();
+  });
 });

packages/integration-tests/tests/bridge_mainnet_tokens.ts

@@ -43,6 +43,7 @@ import type {
   MessageProof,
 } from 'fuels';
 
+import { startContainers, stopEnvironment } from '../docker-setup/docker';
 import { fundWithdrawalTransactionWithBaseAssetResource } from '../utils/utils';
 
 const { expect } = chai;
@@ -160,6 +161,9 @@ describe('Bridge mainnet tokens', function () {
   }
 
   before(async () => {
+    // spinning up all docker containers
+    await startContainers();
+
     env = await setupEnvironment({});
     eth_erc20GatewayAddress = (
       await env.eth.fuelERC20Gateway.getAddress()
@@ -737,4 +741,9 @@ describe('Bridge mainnet tokens', function () {
       });
     });
   }
+
+  // stopping containers post the test
+  after(async () => {
+    await stopEnvironment();
+  });
 });

packages/integration-tests/tests/bridge_proxy.ts

@@ -4,6 +4,8 @@ import { setupEnvironment, getOrDeployL2Bridge } from '@fuel-bridge/test-utils';
 import chai from 'chai';
 import type { Contract, FuelError } from 'fuels';
 
+import { startContainers, stopEnvironment } from '../docker-setup/docker';
+
 const { expect } = chai;
 
 describe('Proxy', async function () {
@@ -16,6 +18,9 @@ describe('Proxy', async function () {
   let fuel_proxy: Proxy;
 
   before(async () => {
+    // spinning up all docker containers
+    await startContainers();
+
     env = await setupEnvironment({});
 
     const { proxy, implementation } = await getOrDeployL2Bridge(
@@ -177,4 +182,9 @@ describe('Proxy', async function () {
       expect(message).contains('NotOwner');
     });
   });
+
+  // stopping containers post the test
+  after(async () => {
+    await stopEnvironment();
+  });
 });

packages/integration-tests/tests/transfer_eth.ts

@@ -23,6 +23,8 @@ import type {
   MessageProof,
 } from 'fuels';
 
+import { startContainers, stopEnvironment } from '../docker-setup/docker';
+
 const { expect } = chai;
 
 describe('Transferring ETH', async function () {
@@ -93,6 +95,9 @@ describe('Transferring ETH', async function () {
   }
 
   before(async () => {
+    // spinning up all docker containers
+    await startContainers();
+
     env = await setupEnvironment({});
     BASE_ASSET_ID = env.fuel.provider.getBaseAssetId();
   });
@@ -523,4 +528,9 @@ describe('Transferring ETH', async function () {
       expect(currentWithdrawnAmountAfterSettingLimit == 0n).to.be.true;
     });
   });
+
+  // stopping containers post the test
+  after(async () => {
+    await stopEnvironment();
+  });
 });