Merge pull request #67 from matter-labs/QA-487-re-structure-tests

test: re-stucturing API test suites/global hooks
matter-labs · Nov 14, 2023 · f7ddfe6 · f7ddfe6
2 parents 5e62c42 + 37765e0
commit f7ddfe6
Show file tree

Hide file tree

Showing 30 changed files with 1,617 additions and 1,796 deletions.
diff --git a/.github/workflows/app-e2e.yml b/.github/workflows/app-e2e.yml
@@ -33,7 +33,7 @@ env:
 
 jobs:
   e2e:
-    runs-on: [self-hosted, ci-runner]
+    runs-on: [matterlabs-ci-runner]
     permissions:
       contents: read
     defaults:
@@ -64,6 +64,12 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          cache: 'npm'
+
       - name: Cache node modules
         id: cache-nodemodules
         uses: actions/cache@v3

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -55,7 +55,7 @@ jobs:
 
   deployBackendToStaging:
     name: Deploy Block Explorer backend to staging
-    runs-on: [self-hosted, ci-runner]
+    runs-on: [matterlabs-ci-runner]
     permissions:
       contents: read
     needs: createReleaseVersion

diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -26,6 +26,7 @@ services:
       - DATABASE_PASSWORD=postgres
       - DATABASE_NAME=block-explorer
       - BLOCKCHAIN_RPC_URL=http://zksync:3050
+      - BATCHES_PROCESSING_POLLING_INTERVAL=1000
     ports:
       - '3001:3001'
       - '9229:9229'

diff --git a/packages/integration-tests/jest.config.json b/packages/integration-tests/jest.config.json
@@ -1,5 +1,6 @@
 {
   "moduleFileExtensions": ["js", "json", "ts"],
+  "globalSetup": "<rootDir>/tests/hooks/global.ts",
   "rootDir": ".",
   "testEnvironment": "node",
   "testRegex": ".test.ts$",

diff --git a/packages/integration-tests/package.json b/packages/integration-tests/package.json
@@ -9,7 +9,7 @@
   "license": "MIT",
   "scripts": {
     "postinstall": "cd src/playbook && npm install",
-    "integration-test:api": "jest --verbose --testPathPattern=tokens.test.ts && jest --verbose --testPathPattern=deposit.test.ts && jest --verbose --testPathPattern=common && jest --verbose --testPathPattern=transactions",
+    "integration-test:api": "jest --verbose",
     "integration-test:ui": "npx playwright test",
     "block-explorer:start": "docker-compose up",
     "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-pattern 'repos' --ignore-pattern 'git add .'"

diff --git a/packages/integration-tests/src/config.ts b/packages/integration-tests/src/config.ts
@@ -1,8 +1,8 @@
 import { Wallets } from "./entities";
 
 export const localConfig = {
-  gasLimit: { gasLimit: 8000000 },
-  l2GasLimit: 8000000,
+  gasLimit: { gasLimit: 10000000 },
+  l2GasLimit: 10000000,
   L1Network: "http://localhost:8545",
   L2Network: "http://localhost:3050",
   privateKey: Wallets.richWalletPrivateKey,

diff --git a/packages/integration-tests/src/entities.ts b/packages/integration-tests/src/entities.ts
@@ -19,6 +19,12 @@ export enum Buffer {
   txMultiCallCaller = "./buffer/txMultiCallCaller.txt",
   txMultiCallRoot = "./buffer/txmultiCallRoot.txt",
   txUseMultiCallContracts = "./buffer/txUseMultiCallContracts.txt",
+  txEthTransfer = "./buffer/txEthTransfer.txt",
+  txERC20Withdraw = "./buffer/txERC20Withdraw.txt",
+  txERC20WithdrawOtherAddress = "./buffer/txERC20WithdrawOtherAddress.txt",
+  txEthWithdraw = "./buffer/txEthWithdraw.txt",
+  txEthWithdrawOtherAddress = "./buffer/txEthWithdrawOtherAddress.txt",
+  txERC20Transfer = "./buffer/txERC20Transfer.txt",
   emptyWalletPrivateKey = "./buffer/emptyWalletPrivateKey.txt",
   emptyWalletAddress = "./buffer/emptyWalletAddress.txt",
   failedState = "./buffer/failedState.txt",

diff --git a/packages/integration-tests/src/playbook/scenarios/transfers/transferERC20.ts b/packages/integration-tests/src/playbook/scenarios/transfers/transferERC20.ts
@@ -1,8 +1,9 @@
 import * as ethers from "ethers";
+import { promises as fs } from "fs";
 import * as zksync from "zksync-web3";
 
 import { localConfig } from "../../../config";
-import { Logger, Wallets } from "../../../entities";
+import { Buffer, Logger, Wallets } from "../../../entities";
 import { Helper } from "../../../helper";
 
 export const transferERC20 = async function (sum: string, tokenAddress: string, tokenName?: string /*, units = 18*/) {
@@ -11,6 +12,8 @@ export const transferERC20 = async function (sum: string, tokenAddress: string,
   const ethProvider = ethers.getDefaultProvider(localConfig.L1Network);
   const syncWallet = new zksync.Wallet(localConfig.privateKey, syncProvider, ethProvider);
   const syncWallet2 = new zksync.Wallet(Wallets.secondWalletPrivateKey, syncProvider, ethProvider);
+  const playbookRoot = "src/playbook/";
+  const bufferFile = playbookRoot + Buffer.txEthTransfer;
 
   const transfer = await syncWallet.transfer({
     to: syncWallet2.address,
@@ -21,6 +24,7 @@ export const transferERC20 = async function (sum: string, tokenAddress: string,
 
   const txHash = transfer.hash;
   await helper.txHashLogger(Logger.transfer, txHash, tokenName);
+  await fs.writeFile(bufferFile, txHash);
 
   return txHash;
 };
diff --git a/packages/integration-tests/src/playbook/scenarios/transfers/transferETH.ts b/packages/integration-tests/src/playbook/scenarios/transfers/transferETH.ts
@@ -1,8 +1,9 @@
 import * as ethers from "ethers";
+import { promises as fs } from "fs";
 import * as zksync from "zksync-web3";
 
 import { localConfig } from "../../../config";
-import { Logger, Wallets } from "../../../entities";
+import { Buffer, Logger, Wallets } from "../../../entities";
 import { Helper } from "../../../helper";
 
 export const transferEth = async function (sum = "0.000009", address: string = Wallets.mainWalletPrivateKey) {
@@ -11,6 +12,8 @@ export const transferEth = async function (sum = "0.000009", address: string = W
   const ethProvider = ethers.getDefaultProvider(localConfig.L1Network);
   const syncWallet = new zksync.Wallet(localConfig.privateKey, syncProvider, ethProvider);
   const syncWallet2 = new zksync.Wallet(address, syncProvider, ethProvider);
+  const playbookRoot = "src/playbook/";
+  const bufferFile = playbookRoot + Buffer.txEthTransfer;
 
   const transfer = await syncWallet.transfer({
     to: syncWallet2.address,
@@ -20,6 +23,7 @@ export const transferEth = async function (sum = "0.000009", address: string = W
 
   const txHash = transfer.hash;
   await helper.txHashLogger(Logger.transfer, txHash, "ETH");
+  await fs.writeFile(bufferFile, txHash);
 
   return txHash;
 };
diff --git a/packages/integration-tests/src/playbook/scenarios/transfers/transferFailedState.ts b/packages/integration-tests/src/playbook/scenarios/transfers/transferFailedState.ts
@@ -1,8 +1,9 @@
 import * as ethers from "ethers";
+import { promises as fs } from "fs";
 import * as zksync from "zksync-web3";
 
 import { localConfig } from "../../../config";
-import { Logger } from "../../../entities";
+import { Buffer, Logger } from "../../../entities";
 import { Helper } from "../../../helper";
 
 export const transferFailedState = async function (tokenAddress: string, tokenName?: string) {
@@ -11,6 +12,8 @@ export const transferFailedState = async function (tokenAddress: string, tokenNa
   const ethProvider = ethers.getDefaultProvider(localConfig.L1Network);
   const syncWallet = new zksync.Wallet(localConfig.privateKey, syncProvider, ethProvider);
   const amount = ethers.utils.parseEther("1.0");
+  const playbookRoot = "src/playbook/";
+  const bufferFile = playbookRoot + Buffer.failedState;
 
   const transfer = await syncWallet.transfer({
     to: "0x0000000000000000000000000000000000000000",
@@ -21,6 +24,7 @@ export const transferFailedState = async function (tokenAddress: string, tokenNa
 
   const txHash = transfer.hash;
   await helper.txHashLogger(Logger.txFailedState, txHash, tokenName);
+  await fs.writeFile(bufferFile, txHash);
 
   return txHash;
 };
diff --git a/packages/integration-tests/src/playbook/scenarios/withdrawal/withdrawERC20.ts b/packages/integration-tests/src/playbook/scenarios/withdrawal/withdrawERC20.ts
@@ -1,8 +1,9 @@
 import * as ethers from "ethers";
+import { promises as fs } from "fs";
 import * as zksync from "zksync-web3";
 
 import { localConfig } from "../../../config";
-import { Logger, Wallets } from "../../../entities";
+import { Buffer, Logger, Wallets } from "../../../entities";
 import { Helper } from "../../../helper";
 
 export const withdrawERC20 = async function (tokenAddress: string, sum = "0.2") {
@@ -11,6 +12,8 @@ export const withdrawERC20 = async function (tokenAddress: string, sum = "0.2")
   const ethProvider = ethers.getDefaultProvider(localConfig.L1Network);
   const syncWallet = new zksync.Wallet(localConfig.privateKey, syncProvider, ethProvider);
   const bridges = await syncProvider.getDefaultBridgeAddresses();
+  const playbookRoot = "src/playbook/";
+  const bufferFile = playbookRoot + Buffer.txERC20Withdraw;
 
   const balance = await syncWallet.getBalance(tokenAddress);
 
@@ -21,7 +24,7 @@ export const withdrawERC20 = async function (tokenAddress: string, sum = "0.2")
     amount: ethers.utils.parseEther(sum),
     token: tokenAddress,
     bridgeAddress: bridges.erc20L2,
-    overrides: localConfig.gasLimit,
+    // overrides: localConfig.gasLimit,
   });
 
   const txHash = withdrawL2.hash;
@@ -34,6 +37,7 @@ export const withdrawERC20 = async function (tokenAddress: string, sum = "0.2")
   console.log(`Your balance is ${balanceAfter.toString()}`);
 
   await helper.txHashLogger(Logger.withdraw, txHash, "Custom token");
+  await fs.writeFile(bufferFile, txHash);
 
   return txHash;
 };
diff --git a/packages/integration-tests/src/playbook/scenarios/withdrawal/withdrawERC20toOtherAddress.ts b/packages/integration-tests/src/playbook/scenarios/withdrawal/withdrawERC20toOtherAddress.ts
@@ -1,8 +1,9 @@
 import * as ethers from "ethers";
+import { promises as fs } from "fs";
 import * as zksync from "zksync-web3";
 
 import { localConfig } from "../../../config";
-import { Logger, Wallets } from "../../../entities";
+import { Buffer, Logger, Wallets } from "../../../entities";
 import { Helper } from "../../../helper";
 
 export const withdrawERC20toOtherAddress = async function (tokenAddress: string, sum = "0.2") {
@@ -11,6 +12,8 @@ export const withdrawERC20toOtherAddress = async function (tokenAddress: string,
   const ethProvider = ethers.getDefaultProvider(localConfig.L1Network);
   const syncWallet = new zksync.Wallet(localConfig.privateKey, syncProvider, ethProvider);
   const bridges = await syncProvider.getDefaultBridgeAddresses();
+  const playbookRoot = "src/playbook/";
+  const bufferFile = playbookRoot + Buffer.txERC20WithdrawOtherAddress;
 
   const balance = await syncWallet.getBalance(tokenAddress);
 
@@ -34,6 +37,7 @@ export const withdrawERC20toOtherAddress = async function (tokenAddress: string,
   console.log(`Your balance is ${balanceAfter.toString()}`);
 
   await helper.txHashLogger(Logger.withdraw, txHash, "Custom token");
+  await fs.writeFile(bufferFile, txHash);
 
   return txHash;
 };
diff --git a/packages/integration-tests/src/playbook/scenarios/withdrawal/withdrawETH.ts b/packages/integration-tests/src/playbook/scenarios/withdrawal/withdrawETH.ts
@@ -1,15 +1,18 @@
 import * as ethers from "ethers";
+import { promises as fs } from "fs";
 import * as zksync from "zksync-web3";
 
 import { localConfig } from "../../../config";
-import { Logger } from "../../../entities";
+import { Buffer, Logger } from "../../../entities";
 import { Helper } from "../../../helper";
 
 export const withdrawETH = async function (sum = "0.000009") {
   const helper = new Helper();
   const syncProvider = new zksync.Provider(localConfig.L2Network);
   const ethProvider = ethers.getDefaultProvider(localConfig.L1Network);
   const syncWallet = new zksync.Wallet(localConfig.privateKey, syncProvider, ethProvider);
+  const playbookRoot = "src/playbook/";
+  const bufferFile = playbookRoot + Buffer.txEthWithdraw;
 
   const withdrawL2 = await syncWallet.withdraw({
     token: zksync.utils.ETH_ADDRESS,
@@ -20,6 +23,7 @@ export const withdrawETH = async function (sum = "0.000009") {
 
   await withdrawL2.waitFinalize();
   await helper.txHashLogger(Logger.withdraw, txHash, "ETH");
+  await fs.writeFile(bufferFile, txHash);
 
   return txHash;
 };
diff --git a/packages/integration-tests/src/playbook/scenarios/withdrawal/withdrawETHtoOtherAddress.ts b/packages/integration-tests/src/playbook/scenarios/withdrawal/withdrawETHtoOtherAddress.ts
@@ -1,15 +1,18 @@
 import * as ethers from "ethers";
+import { promises as fs } from "fs";
 import * as zksync from "zksync-web3";
 
 import { localConfig } from "../../../config";
-import { Logger, Wallets } from "../../../entities";
+import { Buffer, Logger, Wallets } from "../../../entities";
 import { Helper } from "../../../helper";
 
 export const withdrawETHtoOtherAddress = async function (sum = "0.000009") {
   const helper = new Helper();
   const syncProvider = new zksync.Provider(localConfig.L2Network);
   const ethProvider = ethers.getDefaultProvider(localConfig.L1Network);
   const syncWallet = new zksync.Wallet(localConfig.privateKey, syncProvider, ethProvider);
+  const playbookRoot = "src/playbook/";
+  const bufferFile = playbookRoot + Buffer.txEthWithdrawOtherAddress;
 
   const withdrawL2 = await syncWallet.withdraw({
     token: zksync.utils.ETH_ADDRESS,
@@ -21,6 +24,7 @@ export const withdrawETHtoOtherAddress = async function (sum = "0.000009") {
 
   await withdrawL2.waitFinalize();
   await helper.txHashLogger(Logger.withdraw, txHash, "ETH");
+  await fs.writeFile(bufferFile, txHash);
 
   return txHash;
 };