Add a template for JSON-RPC mock tests. (#3577)

* add requestEmailVerificationCode case

* Added JSON-RPC mock test scripts and related Docker configurations

* update README

* revert docke compose

* update lock file

* update pnpm-lock.yaml

* add todo comment

* fmt

* update environment

* chmod file

* update volumes

* rename project

* update  docker compose

* revert docker-compose.test.yml

* enable mock-server

* using OMNI_WORKER_ENDPOINT as rpc endpoint

* update ci workflow, always rebuild omni executor while need to run omni executor test

* add mock api

* rm unused code

---------

Co-authored-by: wli-pro <wli-pro>
Co-authored-by: BillyWooo <yang@trustcomputing.de>

Author: 0xverin

.github/workflows/ci.yml

@@ -173,6 +173,7 @@ jobs:
           fi
           if [ "${{ steps.filter.outputs.omni_executor_test }}" = "true" ] || [ "$rebuild_parachain" = "true" ] || [ "$rebuild_omni_executor" = "true" ]; then
             run_omni_executor_test=true
+            rebuild_omni_executor=true
           fi
 
           echo "rebuild_parachain=$rebuild_parachain" | tee -a $GITHUB_OUTPUT
@@ -618,6 +619,8 @@ jobs:
           file: tee-worker/omni-executor/Dockerfile
           tags: litentry/omni-executor:latest
           target: executor-worker
+          build-args: |
+            CARGO_FEATURES=mock-server
 
       - name: Pull omni-executor image optionally
         if: needs.set-condition.outputs.rebuild_omni_executor == 'false'
@@ -1048,6 +1051,7 @@ jobs:
       matrix:
         include:
           - test_name: omni-account-test
+          - test_name: jsonrpc-mock-tests
           # disable it during RPC method refactoring
           # - test_name: omni-client-sdk-test
     name: ${{ matrix.test_name }}
@@ -1075,7 +1079,7 @@ jobs:
         run: |
           # Create .env file that needs by the docker-compose.yml
           touch ../.env
-          docker compose -f docker-compose.yml -f ${{ matrix.test_name }}.yml up --no-build --exit-code-from ${{ matrix.test_name }} ${{ matrix.test_name }}
+          docker compose -f docker-compose.yml -f docker-compose.test.yml -f ${{ matrix.test_name }}.yml up --no-build --exit-code-from ${{ matrix.test_name }} ${{ matrix.test_name }}
 
       - name: Collect docker logs if test fails
         continue-on-error: true

tee-worker/omni-executor/cli/ts_jsonrpc_mock_test.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+# Copyright 2020-2024 Trust Computing GmbH.
+
+# Enable strict error handling: exit on error (-e), error on undefined vars (-u), exit on pipe failures (-o pipefail)
+set -euo pipefail
+
+# Parse command line options:
+# -u: Node URL to connect to
+while getopts ":u" opt; do
+    case $opt in
+        u)
+            NODE_URL=$OPTARG
+            ;;
+        ?)
+            echo "Invalid option: -${OPTARG}."
+            exit 1
+            ;;
+    esac
+done
+
+NODE_URL=${NODE_URL:-"http://heima-node:9944"}
+echo "Using node url $NODE_URL"
+
+echo "Running JSON-RPC tests"
+
+echo "Installing dependencies and building ts-tests"
+cd /ts-tests
+pnpm install --force
+
+echo "Running JSON-RPC tests"
+OMNI_WORKER_ENDPOINT=http://omni-executor:2100 pnpm --filter jsonrpc-mock-tests test jsonrpc.test.ts
+
+echo "JSON-RPC tests completed successfully" 

tee-worker/omni-executor/docker/jsonrpc-mock-tests.yml

@@ -0,0 +1,23 @@
+services:
+  jsonrpc-mock-tests:
+    image: litentry/omni-executor:latest
+    container_name: litentry-jsonrpc-mock-tests
+    volumes:
+      - ../ts-tests:/ts-tests
+      - ../../client-api:/client-api
+      - ../cli:/usr/local/executor-worker-cli
+    build:
+      context: ${PWD}/../../
+      dockerfile: tee-worker/omni-executor/Dockerfile
+      target: executor-worker
+    depends_on:
+      omni-executor:
+        condition: service_healthy
+        restart: true
+    networks:
+      - litentry-test-network
+    entrypoint: "sh -c '/usr/local/executor-worker-cli/ts_jsonrpc_mock_test.sh 3>&1' "
+    restart: "no"
+networks:
+  litentry-test-network:
+    driver: bridge 

tee-worker/omni-executor/mock-server/src/pumpx.rs

@@ -22,7 +22,15 @@ pub(crate) fn handle() -> impl Filter<Extract = (impl warp::Reply,), Error = war
 			Response::builder().status(200).body("").unwrap()
 		});
 
+	let post_heima_login = warp::post()
+		.and(warp::path(BASE_PATH))
+		.and(warp::path!("v3" / "account" / "post_heima_login"))
+		.map(|| {
+			// TODO implements your response logic
+			Response::builder().status(200).body("").unwrap()
+		});
+
 	// mock other APIs you need here
 
-	user_connect.or(verify_google_code)
+	user_connect.or(verify_google_code).or(post_heima_login)
 }

tee-worker/omni-executor/ts-tests/jsonrpc-mock-tests/README.md

@@ -0,0 +1,19 @@
+# JSON-RPC Mock Tests
+
+This project contains TypeScript-based mock tests for the Omni Executor JSON-RPC API endpoints.
+
+## Quick Start
+
+### Local Development Setup
+
+1. **Start the worker services:**
+
+    ```bash
+    make build-docker-test
+    make start-test
+    ```
+
+2. **Run the JSON-RPC tests:**
+    ```bash
+    pnpm --filter jsonrpc-mock-tests run test jsonrpc.test.ts
+    ```

tee-worker/omni-executor/ts-tests/jsonrpc-mock-tests/eslintrc.json

@@ -0,0 +1,40 @@
+{
+    "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+    "parser": "@typescript-eslint/parser",
+    "plugins": ["@typescript-eslint"],
+    "root": true,
+    "rules": {
+        /**
+    It's a temporary solution, folks. We had no choice but to shut it off,
+    because there's just a liiittle bit too much "any" lurking around in the code.
+    But fear not, my friends, for this is not the end of the story.
+    We shall return, armed with determination and resolve,
+    to tackle those "any" types head-on in the near future.
+    **/
+        "@typescript-eslint/no-explicit-any": ["off"],
+        "@typescript-eslint/no-non-null-assertion": ["off"],
+        "@typescript-eslint/no-var-requires": ["off"],
+
+        // explanation: https://typescript-eslint.io/rules/naming-convention/
+        "@typescript-eslint/naming-convention": [
+            "error",
+            {
+                "selector": "typeLike",
+                "format": ["StrictPascalCase"]
+            },
+            {
+                "selector": "variable",
+                "modifiers": ["const"],
+                "format": ["strictCamelCase", "UPPER_CASE"]
+            },
+            {
+                "selector": "function",
+                "format": ["strictCamelCase", "StrictPascalCase"]
+            },
+            {
+                "selector": "parameter",
+                "format": ["strictCamelCase"]
+            }
+        ]
+    }
+}

tee-worker/omni-executor/ts-tests/jsonrpc-mock-tests/jsonrpc.test.ts

@@ -0,0 +1,22 @@
+import { describe, it } from 'mocha';
+import { expect } from 'chai';
+import { omniApi, RequestEmailVerificationCodeResponse } from './utils';
+
+enum ClientId {
+    Wildmeta = 'wildmeta',
+    Heima = 'heima',
+    Pumpx = 'pumpx',
+}
+
+describe('Request Email Verification Code', () => {
+    it('should request email verification code successfully', async function () {
+        this.timeout(10000);
+
+        const result: RequestEmailVerificationCodeResponse = await omniApi.requestEmailVerificationCode({
+            client_id: ClientId.Wildmeta,
+            user_email: 'test@gmail.com',
+        });
+
+        expect(result).to.be.null;
+    });
+});

tee-worker/omni-executor/ts-tests/jsonrpc-mock-tests/package.json

@@ -0,0 +1,32 @@
+{
+    "name": "jsonrpc-mock-tests",
+    "license": "ISC",
+    "type": "module",
+    "scripts": {
+        "check-format": "prettier --check .",
+        "format": "prettier --write .",
+        "lint": "eslint .",
+        "test": "mocha --exit --sort -r ts-node/register --loader=ts-node/esm",
+        "check-types": "tsc --noEmit"
+    },
+    "dependencies": {
+        "mocha": "^10.6.0",
+        "mocha-steps": "^1.3.0",
+        "chai": "^4.3.6"
+    },
+    "devDependencies": {
+        "@types/chai": "^4.3.3",
+        "@types/mocha": "^10.0.10",
+        "@types/node": "^20.4.4",
+        "@typescript-eslint/eslint-plugin": "^5.60.0",
+        "@typescript-eslint/parser": "^5.60.0",
+        "prettier": "^2.8.3",
+        "ts-node": "^10.9.1",
+        "typescript": "^5.1.0",
+        "eslint": "^8.46.0"
+    },
+    "packageManager": "pnpm@9.15.2",
+    "engines": {
+        "node": ">=20.0.0"
+    }
+}

tee-worker/omni-executor/ts-tests/jsonrpc-mock-tests/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "target": "ESNext",
+        "module": "ESNext",
+        "moduleResolution": "Node",
+        "declaration": true,
+        "strict": true,
+        "skipLibCheck": true,
+        "esModuleInterop": true,
+        "allowSyntheticDefaultImports": true,
+        "resolveJsonModule": true,
+        "baseUrl": "."
+    },
+    "ts-node": {
+        "esm": true,
+        "experimentalResolver": true,
+        "experimentalSpecifierResolution": "node",
+        "transpileOnly": true
+    }
+}

tee-worker/omni-executor/ts-tests/jsonrpc-mock-tests/utils/client.ts

@@ -0,0 +1,81 @@
+export interface JsonRpcRequest {
+    jsonrpc: '2.0';
+    method: string;
+    params?: any[];
+    id: string | number;
+}
+
+export interface JsonRpcResponse<T = any> {
+    jsonrpc: '2.0';
+    result?: T;
+    error?: {
+        code: number;
+        message: string;
+        data?: any;
+    };
+    id: string | number;
+}
+
+export class JsonRpcError extends Error {
+    public readonly code: number;
+    public readonly data?: any;
+
+    constructor(error: { code: number; message: string; data?: any }) {
+        super(error.message);
+        this.name = 'JsonRpcError';
+        this.code = error.code;
+        this.data = error.data;
+    }
+}
+
+export class JsonRpcClient {
+    private static instance: JsonRpcClient;
+    private readonly endpoint = process.env.OMNI_WORKER_ENDPOINT ?? 'http://localhost:2100/';
+    private requestId = 1;
+
+    private constructor() {}
+
+    static getInstance(): JsonRpcClient {
+        if (!JsonRpcClient.instance) {
+            JsonRpcClient.instance = new JsonRpcClient();
+        }
+        return JsonRpcClient.instance;
+    }
+
+    async call<T = any>(method: string, params?: any, token?: string): Promise<T> {
+        const request: JsonRpcRequest = {
+            jsonrpc: '2.0',
+            method,
+            params: params || [],
+            id: this.requestId++,
+        };
+
+        const headers: Record<string, string> = {
+            'Content-Type': 'application/json',
+        };
+
+        if (token) {
+            headers['Authorization'] = `Bearer ${token}`;
+        }
+
+        const response = await fetch(this.endpoint, {
+            method: 'POST',
+            headers,
+            body: JSON.stringify(request),
+        });
+
+        if (!response.ok) {
+            throw new Error(`HTTP ${response.status}: ${response.statusText}`);
+        }
+
+        const jsonResponse: JsonRpcResponse<T> = await response.json();
+        console.log('jsonrpc method', method);
+        console.log('jsonrpc params', params);
+        console.log('jsonrpc response', jsonResponse);
+        if (jsonResponse.error) {
+            throw new JsonRpcError(jsonResponse.error);
+        }
+
+        return jsonResponse.result!;
+    }
+}