Merge pull request #375 from kleros/chore/initialize-relayer-testing

test(relayer): adds initial testing base

Author: mani99brar

.eslintrc.json

@@ -7,7 +7,8 @@
     "es6": true,
     "node": true,
     "mocha": true,
-    "es2020": true
+    "es2020": true,
+    "jest": true
   },
   "extends": [
     "eslint:recommended",

relayer-cli/.gitconfig

@@ -0,0 +1 @@
+coverage

relayer-cli/jest.config.ts

@@ -0,0 +1,10 @@
+import type { Config } from "jest";
+
+const config: Config = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  collectCoverage: true,
+  collectCoverageFrom: ["**/*.ts"],
+};
+
+export default config;

relayer-cli/package.json

@@ -10,6 +10,7 @@
     "yarn": "4.2.2"
   },
   "scripts": {
+    "test": "jest --coverage",
     "start-devnet-relayer": "npx ts-node ./src/devnetRelayExample.ts",
     "start-testnet-relayer": "npx ts-node ./src/testnetRelayer.ts"
   },
@@ -23,6 +24,9 @@
     "web3-batched-send": "^1.0.3"
   },
   "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2"
   }
 }

relayer-cli/src/utils/relayerHelpers.ts

@@ -1,20 +1,5 @@
 import * as fs from "fs";
-
-class ShutdownManager {
-  private isShuttingDown: boolean;
-
-  constructor(initialState: boolean = false) {
-    this.isShuttingDown = initialState;
-  }
-
-  public getIsShuttingDown(): boolean {
-    return this.isShuttingDown;
-  }
-
-  public triggerShutdown() {
-    this.isShuttingDown = true;
-  }
-}
+import ShutdownManager from "./shutdownManager";
 
 async function initialize(chainId: number, network: string): Promise<number> {
   const lockFileName = "./state/" + network + "_" + chainId + ".pid";

relayer-cli/src/utils/shutdownManager.test.ts

@@ -0,0 +1,36 @@
+import ShutdownManager from "./shutdownManager";
+
+describe("ShutdownManager", () => {
+  describe("constructor", () => {
+    it("should create a new instance", () => {
+      const instance = new ShutdownManager();
+      expect(instance).toBeInstanceOf(ShutdownManager);
+    });
+
+    it("should set isShuttingDown to the provided value", () => {
+      const instance = new ShutdownManager(true);
+      expect(instance["isShuttingDown"]).toBe(true);
+    });
+
+    it("should set isShuttingDown to false if no value is provided", () => {
+      const instance = new ShutdownManager();
+      expect(instance["isShuttingDown"]).toBe(false);
+    });
+  });
+
+  describe("getIsShuttingDown", () => {
+    it("should return true when isShuttingDown is true", () => {
+      const instance = new ShutdownManager(true);
+      expect(instance.getIsShuttingDown()).toBe(true);
+    });
+
+    it("should return false when isShuttingDown is false", () => {
+      const instance = new ShutdownManager(false);
+      expect(instance.getIsShuttingDown()).toBe(false);
+    });
+  });
+
+  describe("triggerShutdown", () => {
+    it.todo("should set isShuttingDown to true");
+  });
+});

relayer-cli/src/utils/shutdownManager.ts

@@ -0,0 +1,15 @@
+export default class ShutdownManager {
+  private isShuttingDown: boolean;
+
+  constructor(initialState: boolean = false) {
+    this.isShuttingDown = initialState;
+  }
+
+  public getIsShuttingDown(): boolean {
+    return this.isShuttingDown;
+  }
+
+  public triggerShutdown() {
+    this.isShuttingDown = true;
+  }
+}