chore: add tests

common/protocol/src/methods/checks/isEndkeyReached.ts

@@ -1,4 +1,4 @@
-import { Validator, standardizeError } from "../..";
+import { standardizeError, Validator } from "../..";
 
 /**
  isEndkeyReached checks if the end key is reached.
@@ -8,6 +8,11 @@ export async function isEndkeyReached(
   toKey: string
 ): Promise<boolean> {
   try {
+    // No further checks are needed if the current_key is empty
+    if (!this.pool.data!.current_key) {
+      return false;
+    }
+
     //  Check if the current_key or to_key equals the end_key
     if (
       this.pool.data!.current_key === this.pool.data!.end_key ||

common/protocol/test/checks/is_endkey_reached.test.ts

@@ -0,0 +1,93 @@
+import { register } from "prom-client";
+import { Logger } from "tslog";
+
+import { Validator } from "../../src";
+import { isEndkeyReached, setupMetrics } from "../../src/methods";
+import { genesis_pool } from "../mocks/constants";
+import { TestRuntime } from "../mocks/runtime.mock";
+
+/*
+
+TEST CASES - isEndkeyReached
+
+* assert isEndkeyReached with empty current_key
+* assert isEndkeyReached with end_key == current_key
+* assert isEndkeyReached with toKey == end_key
+* assert isEndkeyReached is not reached
+*/
+
+describe("isEndkeyReached", () => {
+  let v: Validator;
+
+  beforeEach(() => {
+    v = new Validator(new TestRuntime());
+
+    // mock logger
+    v.logger = new Logger();
+
+    v.logger.info = jest.fn();
+    v.logger.debug = jest.fn();
+    v.logger.warn = jest.fn();
+    v.logger.error = jest.fn();
+    v.logger.fatal = jest.fn();
+
+    v.pool = {
+      ...genesis_pool,
+    } as any;
+
+    setupMetrics.call(v);
+  });
+
+  afterEach(() => {
+    // reset prometheus
+    register.clear();
+  });
+
+  test("assert isEndkeyReached with empty current_key", async () => {
+    // ARRANGE
+    v.pool.data!.current_key = "";
+    v.pool.data!.end_key = "0";
+
+    // ACT
+    const result = await isEndkeyReached.call(v, "");
+
+    // ASSERT
+    expect(result).toBeFalsy();
+  });
+
+  test("assert isEndkeyReached with end_key == current_key", async () => {
+    // ARRANGE
+    v.pool.data!.current_key = "0";
+    v.pool.data!.end_key = "0";
+
+    // ACT
+    const result = await isEndkeyReached.call(v, "");
+
+    // ASSERT
+    expect(result).toBeTruthy();
+  });
+
+  test("assert isEndkeyReached with toKey == end_key", async () => {
+    // ARRANGE
+    v.pool.data!.current_key = "0";
+    v.pool.data!.end_key = "1";
+
+    // ACT
+    const result = await isEndkeyReached.call(v, "1");
+
+    // ASSERT
+    expect(result).toBeTruthy();
+  });
+
+  test("assert isEndkeyReached is not reached", async () => {
+    // ARRANGE
+    v.pool.data!.current_key = "0";
+    v.pool.data!.end_key = "1";
+
+    // ACT
+    const result = await isEndkeyReached.call(v, "0");
+
+    // ASSERT
+    expect(result).toBeFalsy();
+  });
+});

common/protocol/test/checks/is_pool_active.test.ts

@@ -1,6 +1,6 @@
 import { Logger } from "tslog";
 import { Validator } from "../../src/index";
-import { setupMetrics, isPoolActive } from "../../src/methods";
+import { isPoolActive, setupMetrics } from "../../src/methods";
 import { register } from "prom-client";
 import { TestRuntime } from "../mocks/runtime.mock";
 import { genesis_pool } from "../mocks/constants";
@@ -13,6 +13,7 @@ TEST CASES - isPoolActive
 * assert if pool status is POOL_STATUS_ACTIVE
 * assert if pool status is POOL_STATUS_NO_FUNDS
 * assert if pool status is POOL_STATUS_DISABLED
+* assert if pool status is POOL_STATUS_END_KEY_REACHED
 * assert if pool status is POOL_STATUS_NOT_ENOUGH_DELEGATION
 * assert if pool status is POOL_STATUS_UPGRADING
 * assert if pool status is POOL_STATUS_UNSPECIFIED
@@ -80,6 +81,17 @@ describe("isPoolActive", () => {
     expect(result).toBeFalsy();
   });
 
+  test("assert if pool status is POOL_STATUS_END_KEY_REACHED", async () => {
+    // ARRANGE
+    v.pool.status = PoolStatus.POOL_STATUS_END_KEY_REACHED;
+
+    // ACT
+    const result = isPoolActive.call(v);
+
+    // ASSERT
+    expect(result).toBeFalsy();
+  });
+
   test("assert if pool status is POOL_STATUS_NOT_ENOUGH_DELEGATION", async () => {
     // ARRANGE
     v.pool.status = PoolStatus.POOL_STATUS_NOT_ENOUGH_DELEGATION;

common/protocol/test/mocks/constants.ts

@@ -7,6 +7,7 @@ export const genesis_pool = {
     logo: "ar://9FJDam56yBbmvn8rlamEucATH5UcYqSBw468rlCXn8E",
     config: "ar://bYvlKiVLb1YY0Gx4mjUhpWBkztqmA4uEN97kTaZtBfY",
     start_key: "0",
+    end_key: "",
     current_key: "",
     current_summary: "",
     current_index: "0",

yarn.lock

@@ -5218,7 +5218,7 @@ esutils@^2.0.2:
   resolved "https://registry.yarnpkg.com/esutils/-/esutils-2.0.3.tgz#74d2eb4de0b8da1293711910d50775b9b710ef64"
   integrity sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==
 
-ethers@^5.5.1:
+ethers@^5.5.1, ethers@^5.6.5:
   version "5.7.2"
   resolved "https://registry.yarnpkg.com/ethers/-/ethers-5.7.2.tgz#3a7deeabbb8c030d4126b24f84e525466145872e"
   integrity sha512-wswUsmWo1aOK8rR7DIKiWSw9DbLWe6x98Jrn8wcTflTVvaXhAMaB5zGAXy0GYQEQp9iO1iSHWVyARQm11zUtyg==