api unit test base

Author: hersveit

apps/api/src/__mocks__/ConfigServiceMock.ts

@@ -0,0 +1,29 @@
+import { ConfigModel } from '../config/config.model';
+
+export class ConfigServiceMock implements ConfigModel {
+    DB_NAME: string;
+    DB_HOST: string;
+    DB_USERNAME: string;
+    DB_PASSWORD: string;
+    DB_PORT: number;
+    PORT: number;
+    JWT_SECRET: string;
+    JWT_EXPIRES_IN: string;
+    JWT_REFRESH_SECRET: string;
+    JWT_REFRESH_EXPIRES_IN: string;
+    DOMAIN: string;
+
+    constructor() {
+        this.DB_NAME = 'db';
+        this.DB_HOST = 'localhost';
+        this.DB_USERNAME = 'admin';
+        this.DB_PASSWORD = 'pass';
+        this.DB_PORT = 5432;
+        this.PORT = 3000;
+        this.JWT_SECRET = 'jwtSecret';
+        this.JWT_EXPIRES_IN = '10min';
+        this.JWT_REFRESH_SECRET = 'jwtRefreshSecret';
+        this.JWT_REFRESH_EXPIRES_IN = '2days';
+        this.DOMAIN = `http://localhost:${this.PORT}`;
+    }
+}

apps/api/src/__mocks__/RepositoryServiceMock.ts

@@ -0,0 +1,10 @@
+import { DeepMocked, createMock } from '@golevelup/ts-jest';
+import { RepositoryService } from '@lib/repository';
+import { UserEntity } from '@lib/repository/entities/user.entity';
+import { Repository } from 'typeorm';
+
+export const getRepositoryServiceMock = () => {
+    return {
+        user: createMock<Repository<UserEntity>>(),
+    } as unknown as DeepMocked<RepositoryService>;
+};

apps/api/src/__mocks__/stubs/user.stub.ts

@@ -0,0 +1,9 @@
+import { UserEntity } from '@lib/repository/entities/user.entity';
+
+export const getUserStub = (): UserEntity => ({
+    id: 0,
+    email: 'email@example.com',
+    createdAt: new Date(),
+    hash: '5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8', // password
+    emailConfirmed: false,
+});

apps/api/src/modules/auth/__tests__/auth.service.spec.ts

@@ -0,0 +1,52 @@
+import { createMock } from '@golevelup/ts-jest';
+import { CoreConfigService } from '@lib/core';
+import { RepositoryService } from '@lib/repository';
+import { JwtService } from '@nestjs/jwt';
+import { Test } from '@nestjs/testing';
+import { ConfigServiceMock } from '../../../__mocks__/ConfigServiceMock';
+import { getRepositoryServiceMock } from '../../../__mocks__/RepositoryServiceMock';
+import { getUserStub } from '../../../__mocks__/stubs/user.stub';
+import { ConfigModel } from '../../../config/config.model';
+import { UserService } from '../../user/user.service';
+import { AuthService } from '../auth.service';
+
+describe('AuthService', () => {
+    let rep: ReturnType<typeof getRepositoryServiceMock>;
+    let user: ReturnType<typeof getUserStub>;
+    let authService: AuthService;
+    let configService: CoreConfigService<ConfigModel>;
+    let userService: UserService;
+
+    beforeEach(async () => {
+        const module = await Test.createTestingModule({
+            providers: [
+                AuthService,
+                JwtService,
+                { provide: CoreConfigService, useClass: ConfigServiceMock },
+                {
+                    provide: RepositoryService,
+                    useValue: getRepositoryServiceMock(),
+                },
+                {
+                    provide: UserService,
+                    useValue: createMock<UserService>(),
+                },
+            ],
+        }).compile();
+
+        authService = module.get(AuthService);
+        configService = module.get(CoreConfigService);
+        rep = module.get(RepositoryService);
+        userService = module.get(UserService);
+
+        user = getUserStub();
+    });
+
+    it('should be defined service and all deps', () => {
+        expect(authService).toBeDefined();
+        expect(configService).toBeDefined();
+        expect(rep).toBeDefined();
+        expect(userService).toBeDefined();
+        expect(user).toBeDefined();
+    });
+});

apps/api/tsconfig.app.json

@@ -5,5 +5,5 @@
         "outDir": "../../dist/apps/api"
     },
     "include": ["src/**/*"],
-    "exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
+    "exclude": ["node_modules", "dist"]
 }

libs/core/tsconfig.lib.json

@@ -5,5 +5,5 @@
         "outDir": "../../dist/libs/core"
     },
     "include": ["src/**/*"],
-    "exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
+    "exclude": ["node_modules", "dist"]
 }

libs/repository/tsconfig.lib.json

@@ -5,5 +5,5 @@
         "outDir": "../../dist/libs/repository"
     },
     "include": ["src/**/*"],
-    "exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
+    "exclude": ["node_modules", "dist"]
 }

package.json

@@ -13,9 +13,11 @@
         "typeorm:run": "node ./scripts/typeorm/migrationRun.js",
         "api:build": "nest build api",
         "api:dev": "NODE_ENV=development APP=api nest start api --watch",
-        "api:prod": "NODE_ENV=production APP=api node dist/apps/api/apps/api/src/main.js"
+        "api:prod": "NODE_ENV=production APP=api node dist/apps/api/apps/api/src/main.js",
+        "test": "jest"
     },
     "dependencies": {
+        "@golevelup/ts-jest": "^0.5.0",
         "@nestjs-cls/transactional": "^2.3.1",
         "@nestjs-cls/transactional-adapter-typeorm": "^1.2.1",
         "@nestjs/common": "^10.0.0",
@@ -42,7 +44,7 @@
     "devDependencies": {
         "@nestjs/cli": "^10.0.0",
         "@nestjs/schematics": "^10.0.0",
-        "@nestjs/testing": "^10.0.0",
+        "@nestjs/testing": "^10.3.8",
         "@types/cookie-parser": "^1.4.7",
         "@types/express": "^4.17.17",
         "@types/jest": "^29.5.2",
@@ -89,8 +91,8 @@
             "<rootDir>/apps/"
         ],
         "moduleNameMapper": {
-            "^@starter-kit/repository(|/.*)$": "<rootDir>/libs/repository/src/$1",
-            "^@starter-kit/core(|/.*)$": "<rootDir>/libs/core/src/$1"
+            "^@lib/repository(|/.*)$": "<rootDir>/libs/repository/src/$1",
+            "^@lib/core(|/.*)$": "<rootDir>/libs/core/src/$1"
         }
     }
 }