refactor: moved websocket acceptance tests from server package to ws-server package (#2329)

quiet-node · web-flow · commit 5f26a6aadf1e · 2024-04-11T16:14:51.000-06:00
refactor: moved ws acceptance test to ws-server package

Signed-off-by: Logan Nguyen &lt;logan.nguyen@swirldslabs.com&gt;
diff --git a/package.json b/package.json
@@ -38,7 +38,7 @@
     "acceptancetest:tokenmanagement": "ts-mocha packages/server/tests/acceptance/index.spec.ts  -g '@tokenmanagement' --exit",
     "acceptancetest:htsprecompilev1": "ts-mocha packages/server/tests/acceptance/index.spec.ts  -g '@htsprecompilev1' --exit",
     "acceptancetest:release": "ts-mocha packages/server/tests/acceptance/index.spec.ts  -g '@release' --exit",
-    "acceptancetest:ws": "ts-mocha packages/server/tests/acceptance/index.spec.ts  -g '@web-socket' --exit",
+    "acceptancetest:ws": "ts-mocha packages/ws-server/tests/acceptance/index.spec.ts  -g '@web-socket' --exit",
     "acceptancetest:ws_newheads": "ts-mocha packages/server/tests/acceptance/index.spec.ts  -g '@web-socket-newheads' --exit",
     "acceptancetest:precompile-calls": "ts-mocha packages/server/tests/acceptance/index.spec.ts  -g '@precompile-calls' --exit",
     "acceptancetest:cache-service": "ts-mocha packages/server/tests/acceptance/index.spec.ts  -g '@cache-service' --exit",
diff --git a/packages/ws-server/tests/acceptance/blockNumber.spec.ts b/packages/ws-server/tests/acceptance/blockNumber.spec.ts
@@ -21,7 +21,7 @@
 // external resources
 import { expect } from 'chai';
 import { ethers, WebSocketProvider } from 'ethers';
-import RelayClient from '../../clients/relayClient';
+import RelayClient from '@hashgraph/json-rpc-server/tests/clients/relayClient';
 
 describe('@release @web-socket eth_blockNumber', async function () {
   const WS_RELAY_URL = `${process.env.WS_RELAY_URL}`;
diff --git a/packages/ws-server/tests/acceptance/call.spec.ts b/packages/ws-server/tests/acceptance/call.spec.ts
@@ -20,19 +20,18 @@
 
 // external resources
 import { expect } from 'chai';
-import { Utils } from '../../helpers/utils';
 import { ethers, WebSocketProvider } from 'ethers';
-import ERC20MockJson from '../../contracts/ERC20Mock.json';
-import { AliasAccount } from '../../clients/servicesClient';
+import { Utils } from '@hashgraph/json-rpc-server/tests/helpers/utils';
+import ERC20MockJson from '@hashgraph/json-rpc-server/tests/contracts/ERC20Mock.json';
+import { AliasAccount } from '@hashgraph/json-rpc-server/tests/clients/servicesClient';
 
 describe('@release @web-socket eth_call', async function () {
   const WS_RELAY_URL = `${process.env.WS_RELAY_URL}`;
   const METHOD_NAME = 'eth_call';
   const FAKE_TX_HASH = `0x${'00'.repeat(20)}`;
   const INVALID_PARAMS = [
-    ["{ to: '0xabcdef', data: '0x1a2b3c4d' }", 36, ''],
     ['{}', false, '0x0'],
-    [{ to: FAKE_TX_HASH, data: '' }, 'latest'],
+    ["{ to: '0xabcdef', data: '0x1a2b3c4d' }", 36, ''],
     [{ to: FAKE_TX_HASH, data: 36 }, 'latest'],
   ];
 
diff --git a/packages/ws-server/tests/acceptance/estimateGas.spec.ts b/packages/ws-server/tests/acceptance/estimateGas.spec.ts
@@ -21,15 +21,14 @@
 // external resources
 import WebSocket from 'ws';
 import { expect } from 'chai';
-import basicContractJson from '../../contracts/Basic.json';
-import { AliasAccount } from '../../clients/servicesClient';
-import { Contract, ethers, JsonRpcProvider, WebSocketProvider } from 'ethers';
+import { Contract, ethers, WebSocketProvider } from 'ethers';
+import basicContractJson from '@hashgraph/json-rpc-server/tests/contracts/Basic.json';
+import { AliasAccount } from '@hashgraph/json-rpc-server/tests/clients/servicesClient';
 
 describe('@release @web-socket eth_estimateGas', async function () {
   // @ts-ignore
   const { servicesNode, relay } = global;
 
-  const RELAY_URL = `${process.env.RELAY_ENDPOINT}`;
   const WS_RELAY_URL = `${process.env.WS_RELAY_URL}`;
   const BASIC_CONTRACT_PING_CALL_DATA = '0x5c36b186';
   const PING_CALL_ESTIMATED_GAS = '0x6122';
@@ -39,7 +38,6 @@ describe('@release @web-socket eth_estimateGas', async function () {
     currentPrice: number,
     expectedGas: number,
     gasPriceDeviation: number,
-    provider: JsonRpcProvider,
     requestId: string,
     wsProvider: WebSocketProvider,
     webSocket: WebSocket;
@@ -48,7 +46,6 @@ describe('@release @web-socket eth_estimateGas', async function () {
     accounts[0] = await servicesNode.createAliasAccount(100, relay.provider, requestId);
     basicContract = await servicesNode.deployContract(basicContractJson);
     wsProvider = await new ethers.WebSocketProvider(WS_RELAY_URL);
-    provider = new ethers.JsonRpcProvider(RELAY_URL);
 
     webSocket = new WebSocket(WS_RELAY_URL);
     currentPrice = await relay.gasPrice(requestId);
diff --git a/packages/ws-server/tests/acceptance/gasPrice.spec.ts b/packages/ws-server/tests/acceptance/gasPrice.spec.ts
@@ -21,7 +21,7 @@
 // external resources
 import { expect } from 'chai';
 import { ethers, WebSocketProvider } from 'ethers';
-import RelayClient from '../../clients/relayClient';
+import RelayClient from '@hashgraph/json-rpc-server/tests/clients/relayClient';
 
 describe('@release @web-socket eth_gasPrice', async function () {
   const WS_RELAY_URL = `${process.env.WS_RELAY_URL}`;
diff --git a/packages/ws-server/tests/acceptance/getBalance.spec.ts b/packages/ws-server/tests/acceptance/getBalance.spec.ts
@@ -21,8 +21,8 @@
 // external resources
 import { expect } from 'chai';
 import { ethers, WebSocketProvider } from 'ethers';
-import RelayClient from '../../clients/relayClient';
-import { AliasAccount } from '../../clients/servicesClient';
+import RelayClient from '@hashgraph/json-rpc-server/tests/clients/relayClient';
+import { AliasAccount } from '@hashgraph/json-rpc-server/tests/clients/servicesClient';
 
 describe('@release @web-socket eth_getBalance', async function () {
   const WS_RELAY_URL = `${process.env.WS_RELAY_URL}`;
diff --git a/packages/ws-server/tests/acceptance/getBlockByHash.spec.ts b/packages/ws-server/tests/acceptance/getBlockByHash.spec.ts
@@ -21,7 +21,7 @@
 // external resources
 import { expect } from 'chai';
 import { ethers, WebSocketProvider } from 'ethers';
-import RelayClient from '../../clients/relayClient';
+import RelayClient from '@hashgraph/json-rpc-server/tests/clients/relayClient';
 
 describe('@release @web-socket eth_getBlockByHash', async function () {
   const WS_RELAY_URL = `${process.env.WS_RELAY_URL}`;
diff --git a/packages/ws-server/tests/acceptance/getBlockByNumber.spec.ts b/packages/ws-server/tests/acceptance/getBlockByNumber.spec.ts
@@ -21,7 +21,7 @@
 // external resources
 import { expect } from 'chai';
 import { ethers, WebSocketProvider } from 'ethers';
-import RelayClient from '../../clients/relayClient';
+import RelayClient from '@hashgraph/json-rpc-server/tests/clients/relayClient';
 
 describe('@release @web-socket eth_getBlockByNumber', async function () {
   const WS_RELAY_URL = `${process.env.WS_RELAY_URL}`;
diff --git a/packages/ws-server/tests/acceptance/getCode.spec.ts b/packages/ws-server/tests/acceptance/getCode.spec.ts
@@ -19,18 +19,18 @@
  */
 
 // external resources
-import { expect } from 'chai';
-import { Contract, ethers, JsonRpcProvider, WebSocketProvider } from 'ethers';
-import { AliasAccount } from '../../clients/servicesClient';
 import WebSocket from 'ws';
-import basicContractJson from '../../contracts/Basic.json';
+import { expect } from 'chai';
+import { ethers, JsonRpcProvider, WebSocketProvider } from 'ethers';
+import basicContractJson from '@hashgraph/json-rpc-server/tests/contracts/Basic.json';
+import { AliasAccount } from '@hashgraph/json-rpc-server/tests/clients/servicesClient';
 
 describe('@release @web-socket eth_getCode', async function () {
   const RELAY_URL = `${process.env.RELAY_ENDPOINT}`;
   const WS_RELAY_URL = `${process.env.WS_RELAY_URL}`;
 
   let accounts: AliasAccount[] = [],
-    basicContract: Contract,
+    basicContract: any,
     codeFromRPC: string,
     provider: JsonRpcProvider,
     requestId: string,
diff --git a/packages/ws-server/tests/acceptance/getLogs.spec.ts b/packages/ws-server/tests/acceptance/getLogs.spec.ts
@@ -21,7 +21,7 @@
 // external resources
 import { expect } from 'chai';
 import { ethers, WebSocketProvider } from 'ethers';
-import { AliasAccount } from '../../clients/servicesClient';
+import { AliasAccount } from '@hashgraph/json-rpc-server/tests/clients/servicesClient';
 
 describe('@release @web-socket eth_getLogs', async function () {
   const WS_RELAY_URL = `${process.env.WS_RELAY_URL}`;
diff --git a/packages/ws-server/tests/acceptance/getStorageAt.spec.ts b/packages/ws-server/tests/acceptance/getStorageAt.spec.ts
@@ -21,7 +21,7 @@
 // external resources
 import { expect } from 'chai';
 import { ethers, WebSocketProvider } from 'ethers';
-import { AliasAccount } from '../../clients/servicesClient';
+import { AliasAccount } from '@hashgraph/json-rpc-server/tests/clients/servicesClient';
 
 describe('@release @web-socket eth_getStorageAt', async function () {
   const WS_RELAY_URL = `${process.env.WS_RELAY_URL}`;
diff --git a/packages/ws-server/tests/acceptance/getTransactionByHash.spec.ts b/packages/ws-server/tests/acceptance/getTransactionByHash.spec.ts
@@ -21,10 +21,10 @@
 // external resources
 import { expect } from 'chai';
 import { ethers, WebSocketProvider } from 'ethers';
-import RelayClient from '../../clients/relayClient';
-import MirrorClient from '../../clients/mirrorClient';
-import { AliasAccount } from '../../clients/servicesClient';
 import { numberTo0x } from '@hashgraph/json-rpc-relay/src/formatters';
+import RelayClient from '@hashgraph/json-rpc-server/tests/clients/relayClient';
+import MirrorClient from '@hashgraph/json-rpc-server/tests/clients/mirrorClient';
+import { AliasAccount } from '@hashgraph/json-rpc-server/tests/clients/servicesClient';
 import { ONE_TINYBAR_IN_WEI_HEX } from '@hashgraph/json-rpc-relay/tests/lib/eth/eth-config';
 
 describe('@release @web-socket eth_getTransactionByHash', async function () {
diff --git a/packages/ws-server/tests/acceptance/getTransactionCount.spec.ts b/packages/ws-server/tests/acceptance/getTransactionCount.spec.ts
@@ -21,25 +21,19 @@
 // external resources
 import WebSocket from 'ws';
 import { expect } from 'chai';
-import { Utils } from '../../helpers/utils';
-import Assertions from '../../helpers/assertions';
-import basicContractJson from '../../contracts/Basic.json';
-import { AliasAccount } from '../../clients/servicesClient';
+import { ethers, WebSocketProvider } from 'ethers';
 import { numberTo0x } from '@hashgraph/json-rpc-relay/src/formatters';
-import { Contract, ethers, JsonRpcProvider, WebSocketProvider } from 'ethers';
+import { Utils } from '@hashgraph/json-rpc-server/tests/helpers/utils';
+import Assertions from '@hashgraph/json-rpc-server/tests/helpers/assertions';
+import { AliasAccount } from '@hashgraph/json-rpc-server/tests/clients/servicesClient';
 
 describe('@release @web-socket eth_getTransactionCount', async function () {
   const CHAIN_ID = process.env.CHAIN_ID || 0;
   const ONE_TINYBAR = Utils.add0xPrefix(Utils.toHex(ethers.parseUnits('1', 10)));
-  const RELAY_URL = `${process.env.RELAY_ENDPOINT}`;
   const WS_RELAY_URL = `${process.env.WS_RELAY_URL}`;
   const defaultGasPrice = numberTo0x(Assertions.defaultGasPrice);
 
   let accounts: AliasAccount[] = [],
-    basicContract: Contract,
-    codeFromRPC: string,
-    nonce: string,
-    provider: JsonRpcProvider,
     requestId: string,
     wsProvider: WebSocketProvider,
     webSocket: WebSocket;
@@ -50,10 +44,7 @@ describe('@release @web-socket eth_getTransactionCount', async function () {
   beforeEach(async () => {
     accounts[0] = await servicesNode.createAliasAccount(100, relay.provider, requestId);
     accounts[1] = await servicesNode.createAliasAccount(100, relay.provider, requestId);
-    basicContract = await servicesNode.deployContract(basicContractJson);
-    wsProvider = await new ethers.WebSocketProvider(WS_RELAY_URL);
-    provider = new ethers.JsonRpcProvider(RELAY_URL);
-    codeFromRPC = await provider.getCode(`0x${basicContract.contractId.toSolidityAddress()}`);
+    wsProvider = new ethers.WebSocketProvider(WS_RELAY_URL);
 
     webSocket = new WebSocket(WS_RELAY_URL);
   });
diff --git a/packages/ws-server/tests/acceptance/getTransactionReceipt.spec.ts b/packages/ws-server/tests/acceptance/getTransactionReceipt.spec.ts
@@ -21,10 +21,10 @@
 // external resources
 import { expect } from 'chai';
 import { ethers, WebSocketProvider } from 'ethers';
-import RelayClient from '../../clients/relayClient';
-import MirrorClient from '../../clients/mirrorClient';
-import { AliasAccount } from '../../clients/servicesClient';
 import { numberTo0x } from '@hashgraph/json-rpc-relay/src/formatters';
+import RelayClient from '@hashgraph/json-rpc-server/tests/clients/relayClient';
+import MirrorClient from '@hashgraph/json-rpc-server/tests/clients/mirrorClient';
+import { AliasAccount } from '@hashgraph/json-rpc-server/tests/clients/servicesClient';
 import { ONE_TINYBAR_IN_WEI_HEX } from '@hashgraph/json-rpc-relay/tests/lib/eth/eth-config';
 
 describe('@release @web-socket eth_getTransactionReceipt', async function () {
diff --git a/packages/ws-server/tests/acceptance/index.spec.ts b/packages/ws-server/tests/acceptance/index.spec.ts
@@ -0,0 +1,140 @@
+/*-
+ *
+ * Hedera JSON RPC Relay
+ *
+ * Copyright (C) 2023 Hedera Hashgraph, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+import chai from 'chai';
+import path from 'path';
+import pino from 'pino';
+import dotenv from 'dotenv';
+import chaiAsPromised from 'chai-as-promised';
+
+chai.use(chaiAsPromised);
+
+import fs from 'fs';
+import { Hbar } from '@hashgraph/sdk';
+import app from '@hashgraph/json-rpc-server/dist/server';
+import constants from '@hashgraph/json-rpc-relay/dist/lib/constants';
+import RelayClient from '@hashgraph/json-rpc-server/tests/clients/relayClient';
+import MirrorClient from '@hashgraph/json-rpc-server/tests/clients/mirrorClient';
+import { app as wsApp } from '@hashgraph/json-rpc-ws-server/dist/webSocketServer';
+import ServicesClient from '@hashgraph/json-rpc-server/tests/clients/servicesClient';
+dotenv.config({ path: path.resolve(__dirname, '../../../.env') });
+
+const testLogger = pino({
+  name: 'hedera-json-rpc-relay',
+  level: process.env.LOG_LEVEL || 'trace',
+  transport: {
+    target: 'pino-pretty',
+    options: {
+      colorize: true,
+      translateTime: true,
+    },
+  },
+});
+const logger = testLogger.child({ name: 'rpc-acceptance-test' });
+
+const NETWORK = process.env.HEDERA_NETWORK || '';
+const OPERATOR_KEY = process.env.OPERATOR_KEY_MAIN || '';
+const OPERATOR_ID = process.env.OPERATOR_ID_MAIN || '';
+const MIRROR_NODE_URL = process.env.MIRROR_NODE_URL || '';
+const LOCAL_RELAY_URL = 'http://localhost:7546';
+const RELAY_URL = process.env.E2E_RELAY_HOST || LOCAL_RELAY_URL;
+let startOperatorBalance: Hbar;
+global.relayIsLocal = RELAY_URL === LOCAL_RELAY_URL;
+
+describe('RPC Server Acceptance Tests', function () {
+  this.timeout(240 * 1000); // 240 seconds
+
+  let relayServer; // Relay Server
+  let socketServer;
+  global.servicesNode = new ServicesClient(
+    NETWORK,
+    OPERATOR_ID,
+    OPERATOR_KEY,
+    logger.child({ name: `services-test-client` }),
+  );
+  global.mirrorNode = new MirrorClient(MIRROR_NODE_URL, logger.child({ name: `mirror-node-test-client` }));
+  global.relay = new RelayClient(RELAY_URL, logger.child({ name: `relay-test-client` }));
+  global.relayServer = relayServer;
+  global.socketServer = socketServer;
+  global.logger = logger;
+
+  before(async () => {
+    // configuration details
+    logger.info('Acceptance Tests Configurations successfully loaded');
+    logger.info(`LOCAL_NODE: ${process.env.LOCAL_NODE}`);
+    logger.info(`CHAIN_ID: ${process.env.CHAIN_ID}`);
+    logger.info(`HEDERA_NETWORK: ${process.env.HEDERA_NETWORK}`);
+    logger.info(`OPERATOR_ID_MAIN: ${process.env.OPERATOR_ID_MAIN}`);
+    logger.info(`MIRROR_NODE_URL: ${process.env.MIRROR_NODE_URL}`);
+    logger.info(`E2E_RELAY_HOST: ${process.env.E2E_RELAY_HOST}`);
+
+    if (global.relayIsLocal) {
+      runLocalRelay();
+    }
+
+    // cache start balance
+    startOperatorBalance = await global.servicesNode.getOperatorBalance();
+  });
+
+  after(async function () {
+    const endOperatorBalance = await global.servicesNode.getOperatorBalance();
+    const cost = startOperatorBalance.toTinybars().subtract(endOperatorBalance.toTinybars());
+    logger.info(`Acceptance Tests spent ${Hbar.fromTinybars(cost)}`);
+
+    //stop relay
+    logger.info('Stop relay');
+    if (relayServer !== undefined) {
+      relayServer.close();
+    }
+
+    if (process.env.TEST_WS_SERVER === 'true' && socketServer !== undefined) {
+      socketServer.close();
+    }
+  });
+
+  describe('Acceptance tests', async () => {
+    fs.readdirSync(path.resolve(__dirname, './')).forEach((file) => {
+      if (fs.statSync(path.resolve(__dirname, file)).isDirectory()) {
+        fs.readdirSync(path.resolve(__dirname, file)).forEach((subFile) => {
+          loadTest(`${file}/${subFile}`);
+        });
+      } else {
+        loadTest(file);
+      }
+    });
+  });
+
+  function loadTest(testFile) {
+    if (testFile !== 'index.spec.ts' && testFile.endsWith('.spec.ts')) {
+      require(`./${testFile}`);
+    }
+  }
+
+  function runLocalRelay() {
+    // start local relay, relay instance in local should not be running
+
+    logger.info(`Start relay on port ${constants.RELAY_PORT}`);
+    relayServer = app.listen({ port: constants.RELAY_PORT });
+
+    if (process.env.TEST_WS_SERVER === 'true') {
+      logger.info(`Start ws-server on port ${constants.WEB_SOCKET_PORT}`);
+      global.socketServer = wsApp.listen({ port: constants.WEB_SOCKET_PORT });
+    }
+  }
+});
diff --git a/packages/ws-server/tests/acceptance/sendRawTransaction.spec.ts b/packages/ws-server/tests/acceptance/sendRawTransaction.spec.ts
@@ -21,10 +21,10 @@
 // external resources
 import { expect } from 'chai';
 import { ethers, WebSocketProvider } from 'ethers';
-import RelayClient from '../../clients/relayClient';
-import MirrorClient from '../../clients/mirrorClient';
-import { AliasAccount } from '../../clients/servicesClient';
 import { numberTo0x } from '@hashgraph/json-rpc-relay/src/formatters';
+import RelayClient from '@hashgraph/json-rpc-server/tests/clients/relayClient';
+import MirrorClient from '@hashgraph/json-rpc-server/tests/clients/mirrorClient';
+import { AliasAccount } from '@hashgraph/json-rpc-server/tests/clients/servicesClient';
 import { ONE_TINYBAR_IN_WEI_HEX } from '@hashgraph/json-rpc-relay/tests/lib/eth/eth-config';
 
 describe('@release @web-socket eth_sendRawTransaction', async function () {
diff --git a/packages/ws-server/tests/acceptance/subscribe.spec.ts b/packages/ws-server/tests/acceptance/subscribe.spec.ts
diff --git a/packages/ws-server/tests/acceptance/subscribeNewHeads.spec.ts b/packages/ws-server/tests/acceptance/subscribeNewHeads.spec.ts
diff --git a/test-results.02088f1d2a29bfef82062b5ed525526f.xml b/test-results.02088f1d2a29bfef82062b5ed525526f.xml
