test: setup jest testing and gh workflows (#21)

# 🤖 Linear

Closes ZKS-85 ZKS-86

## Description

Properly configure Jest, install mocking helper and configure GH
Workflows for test and e2e test

.github/workflows/build.yml

@@ -26,7 +26,7 @@ jobs:
                   cache: "pnpm"
 
             - name: Install dependencies
-              run: pnpm install
+              run: pnpm install --frozen-lockfile
 
             - name: Run Build
               run: pnpm build

.github/workflows/lint.yml

@@ -32,7 +32,7 @@ jobs:
                   cache: "pnpm"
 
             - name: Install dependencies
-              run: pnpm install
+              run: pnpm install --frozen-lockfile
 
             - name: Run Prettier
               run: pnpm format

.github/workflows/main-workflow.yml

@@ -22,3 +22,7 @@ jobs:
     test:
         uses: ./.github/workflows/test.yml
         needs: lint
+
+    test-e2e:
+        uses: ./.github/workflows/test-e2e.yml
+        needs: lint

.github/workflows/test-e2e.yml

@@ -0,0 +1,31 @@
+name: Tests
+
+on:
+    workflow_call:
+
+jobs:
+    unit:
+        name: Run unit tests
+        runs-on: ubuntu-latest
+        steps:
+            - name: Check out github repository
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 1
+
+            - name: Use PNPM
+              uses: pnpm/action-setup@v4
+              with:
+                  run_install: false
+
+            - name: Use Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 20
+                  cache: "pnpm"
+
+            - name: Install dependencies
+              run: pnpm install --frozen-lockfile
+
+            - name: Run tests
+              run: pnpm test:e2e

.github/workflows/test.yml

@@ -8,21 +8,24 @@ jobs:
         name: Run unit tests
         runs-on: ubuntu-latest
         steps:
-            - name: Log Not Implemented Message
-              run: echo "Not implemented yet"
-            # - name: Check out github repository
-            #   uses: actions/checkout@v3
-            #   with:
-            #     fetch-depth: 1
+            - name: Check out github repository
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 1
 
-            # - name: Use Node.js
-            #   uses: actions/setup-node@v3
-            #   with:
-            #     node-version: 18.x
-            #     cache: "yarn"
+            - name: Use PNPM
+              uses: pnpm/action-setup@v4
+              with:
+                  run_install: false
 
-            # - name: Install dependencies
-            #   run: yarn --immutable
+            - name: Use Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 20
+                  cache: "pnpm"
 
-            # - name: Run tests
-            #   run: yarn test
+            - name: Install dependencies
+              run: pnpm install --frozen-lockfile
+
+            - name: Run tests
+              run: pnpm test

.gitignore

@@ -36,4 +36,4 @@ yarn-error.log*
 .DS_Store
 *.pem
 
-packages/*/coverage
+coverage

apps/api/src/api.controller.spec.ts

@@ -1,23 +1,32 @@
+import { createMock } from "@golevelup/ts-jest";
 import { Test, TestingModule } from "@nestjs/testing";
 import { EvmProviderService } from "@packages/providers";
 
 import { ApiController } from "./api.controller";
 
 describe("ApiController", () => {
     let apiController: ApiController;
+    let evmProvider: EvmProviderService;
 
     beforeEach(async () => {
         const app: TestingModule = await Test.createTestingModule({
             controllers: [ApiController],
-            providers: [EvmProviderService],
+            providers: [
+                {
+                    provide: EvmProviderService,
+                    useValue: createMock<EvmProviderService>(),
+                },
+            ],
         }).compile();
 
         apiController = app.get<ApiController>(ApiController);
+        evmProvider = app.get<EvmProviderService>(EvmProviderService);
     });
 
     describe("root", () => {
-        it("should return 1", async () => {
-            expect(await apiController.getTvl()).toBe(1);
+        it("should return 50", async () => {
+            jest.spyOn(evmProvider, "getTvl").mockResolvedValue(50);
+            expect(await apiController.getTvl()).toBe(50);
         });
     });
 });

apps/api/test/jest-e2e.json

@@ -1,9 +1,13 @@
 {
-  "moduleFileExtensions": ["js", "json", "ts"],
-  "rootDir": ".",
-  "testEnvironment": "node",
-  "testRegex": ".e2e-spec.ts$",
-  "transform": {
-    "^.+\\.(t|j)s$": "ts-jest"
-  }
+    "moduleFileExtensions": ["js", "json", "ts"],
+    "rootDir": "../../..",
+    "testEnvironment": "node",
+    "testRegex": ".e2e-spec.ts$",
+    "roots": ["<rootDir>/apps/"],
+    "transform": {
+        "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "moduleNameMapper": {
+        "^@packages/providers(|/.*)$": "<rootDir>/libs/providers/src/$1"
+    }
 }

package.json

@@ -30,6 +30,7 @@
     },
     "devDependencies": {
         "@commitlint/config-conventional": "19.2.2",
+        "@golevelup/ts-jest": "0.5.0",
         "@ianvs/prettier-plugin-sort-imports": "4.3.0",
         "@nestjs/cli": "10.0.0",
         "@nestjs/schematics": "10.0.0",
@@ -72,6 +73,12 @@
             "**/*.(t|j)s"
         ],
         "coverageDirectory": "./coverage",
+        "coveragePathIgnorePatterns": [
+            "/node_modules/",
+            ".e2e-spec.ts",
+            ".module.ts",
+            "main.ts"
+        ],
         "testEnvironment": "node",
         "roots": [
             "<rootDir>/apps/",