add example e2e tests in nestjs app

README.md

@@ -12,9 +12,11 @@
 - [x] manually deploy to Fly.io
 - [x] create CI deployment workflow to Fly.io
 - [x] improve CI deployment workflow to trigger only for changed apps
+- [ ] run typecheck, lint, test and build in parallel
 - [ ] create shared ui lib
 - [ ] setup Storybook in shared ui lib
 - [x] set unified path aliases for all apps and shared libs (done for `apps/`, because `libs/` probably don't need them anyway)
+- [ ] add unused imports plugin to eslint
 
 ## References
 

apps/nestjs/.eslintrc.js

@@ -11,4 +11,12 @@ module.exports = {
       },
     },
   },
+  overrides: [
+    {
+      files: ['jest.config.js', 'jest-e2e.config.js'],
+      rules: {
+        '@typescript-eslint/no-var-requires': 'off',
+      },
+    },
+  ],
 }

apps/nestjs/jest.config.js

@@ -0,0 +1,18 @@
+module.exports = {
+  preset: 'ts-jest',
+  transform: {
+    '^.+\\.(t|j)s$': 'ts-jest',
+  },
+  moduleFileExtensions: ['js', 'json', 'ts'],
+  moduleNameMapper: {
+    '^~/(.*)$': '../src/$1',
+  },
+  testEnvironment: 'node',
+  rootDir: './src',
+  testRegex: '.*\\.spec\\.ts$',
+  transform: {
+    '^.+\\.(t|j)s$': 'ts-jest',
+  },
+  collectCoverageFrom: ['**/*.(t|j)s'],
+  coverageDirectory: '../coverage',
+}

apps/nestjs/package.json

@@ -10,7 +10,7 @@
     "test:watch": "jest --watch",
     "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --config ./test/jest-e2e.json"
+    "test:e2e": "jest --config ./test/jest-e2e.config.js"
   },
   "dependencies": {
     "@nestjs/common": "^10.0.0",
@@ -33,28 +33,12 @@
     "@types/node": "^20.3.1",
     "@types/supertest": "^2.0.12",
     "jest": "^29.5.0",
+    "jest-mock": "^29.7.0",
     "source-map-support": "^0.5.21",
     "supertest": "^6.3.3",
     "ts-jest": "^29.1.0",
     "ts-loader": "^9.4.3",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.2.0"
-  },
-  "jest": {
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts"
-    ],
-    "rootDir": "src",
-    "testRegex": ".*\\.spec\\.ts$",
-    "transform": {
-      "^.+\\.(t|j)s$": "ts-jest"
-    },
-    "collectCoverageFrom": [
-      "**/*.(t|j)s"
-    ],
-    "coverageDirectory": "../coverage",
-    "testEnvironment": "node"
   }
 }

apps/nestjs/src/app.module.ts

@@ -7,11 +7,13 @@ import { appConfig } from '~/config/app.config'
 
 import { AppController } from './app.controller'
 import { AppService } from './app.service'
+import { DogsModule } from './dogs/dogs.module'
 
 @Module({
   imports: [
     CatsModule,
     ConfigModule.forRoot({ isGlobal: true, load: [appConfig] }),
+    DogsModule,
     MongooseModule.forRootAsync({
       imports: [ConfigModule],
       useFactory: (configService: ConfigService) => ({

apps/nestjs/src/dogs/dogs.controller.spec.ts

@@ -0,0 +1,19 @@
+import { Test, TestingModule } from '@nestjs/testing'
+
+import { DogsController } from './dogs.controller'
+
+describe('DogsController', () => {
+  let controller: DogsController
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [DogsController],
+    }).compile()
+
+    controller = module.get<DogsController>(DogsController)
+  })
+
+  it('should be defined', () => {
+    expect(controller).toBeDefined()
+  })
+})

apps/nestjs/src/dogs/dogs.controller.ts

@@ -0,0 +1,14 @@
+import { Dog } from '@company/types'
+import { Controller, Get } from '@nestjs/common'
+
+import { DogsService } from './dogs.service'
+
+@Controller('dogs')
+export class DogsController {
+  constructor(private readonly dogsService: DogsService) {}
+
+  @Get()
+  async findAll(): Promise<Dog[]> {
+    return this.dogsService.findAll()
+  }
+}

apps/nestjs/src/dogs/dogs.module.ts

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common'
+
+import { DogsController } from './dogs.controller'
+import { DogsService } from './dogs.service'
+
+@Module({
+  controllers: [DogsController],
+  providers: [DogsService],
+})
+export class DogsModule {}

apps/nestjs/src/dogs/dogs.service.spec.ts

@@ -0,0 +1,19 @@
+import { Test, TestingModule } from '@nestjs/testing'
+
+import { DogsService } from './dogs.service'
+
+describe('DogsService', () => {
+  let service: DogsService
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [DogsService],
+    }).compile()
+
+    service = module.get<DogsService>(DogsService)
+  })
+
+  it('should be defined', () => {
+    expect(service).toBeDefined()
+  })
+})

apps/nestjs/src/dogs/dogs.service.ts

@@ -0,0 +1,22 @@
+import { Dog } from '@company/types'
+import { Injectable } from '@nestjs/common'
+
+@Injectable()
+export class DogsService {
+  async findAll(): Promise<Dog[]> {
+    return [
+      {
+        _id: '1',
+        name: 'Barnaba',
+      },
+      {
+        _id: '2',
+        name: 'Homelander',
+      },
+      {
+        _id: '3',
+        name: 'Butcher',
+      },
+    ]
+  }
+}

apps/nestjs/test/dogs.e2e-spec.ts

@@ -0,0 +1,34 @@
+import { INestApplication } from '@nestjs/common'
+import { Test, TestingModule } from '@nestjs/testing'
+import request from 'supertest'
+
+import { DogsModule } from '~/dogs/dogs.module'
+import { DogsService } from '~/dogs/dogs.service'
+
+describe('UsersController (e2e)', () => {
+  let app: INestApplication
+
+  const dogsServiceMock = {
+    findAll: jest.fn().mockResolvedValue([]),
+  }
+
+  beforeEach(async () => {
+    const moduleRef: TestingModule = await Test.createTestingModule({
+      imports: [DogsModule],
+    })
+      .overrideProvider(DogsService)
+      .useValue(dogsServiceMock)
+      .compile()
+
+    app = moduleRef.createNestApplication()
+    await app.init()
+  })
+
+  it('[GET] /users', async () => {
+    await request(app.getHttpServer()).get('/dogs').expect(200).expect([])
+  })
+
+  afterAll(async () => {
+    await app.close()
+  })
+})

apps/nestjs/test/jest-e2e.config.js

@@ -0,0 +1,32 @@
+// const { pathsToModuleNameMapper } = require('ts-jest')
+
+// // In the following statement, replace `./tsconfig` with the path to your `tsconfig` file
+// // which contains the path mapping (ie the `compilerOptions.paths` option):
+// const { compilerOptions } = require('./tsconfig.json')
+
+module.exports = {
+  preset: 'ts-jest',
+  transform: {
+    '^.+\\.(t|j)s$': 'ts-jest',
+  },
+  moduleFileExtensions: ['js', 'json', 'ts'],
+  moduleNameMapper: {
+    '^~/(.*)$': '../src/$1',
+  },
+  testEnvironment: 'node',
+
+  rootDir: '.',
+  testRegex: '.e2e-spec.ts$',
+  collectCoverageFrom: ['**/*.(t|j)s'],
+  coverageDirectory: '../coverage',
+}
+
+// {
+//   // "moduleFileExtensions": ["js", "json", "ts"],
+//   "rootDir": ".",
+//   "testEnvironment": "node",
+
+//   "transform": {
+//     "^.+\\.(t|j)s$": "ts-jest"
+//   }
+// }

apps/nestjs/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "extends": "../../tsconfig.json",
-  "include": ["**/*.ts"],
+  "include": ["**/*.ts", "jest.config.js"],
   "compilerOptions": {
     "module": "commonjs",
     "declaration": true,
@@ -15,9 +15,11 @@
     "noImplicitAny": false,
     "strictBindCallApply": false,
     "noFallthroughCasesInSwitch": false,
+    "resolveJsonModule": true,
     "baseUrl": "./",
     "paths": {
       "~/*": ["./src/*"]
-    }
+    },
+    "types": ["@types/jest"]
   }
 }

libs/types/index.ts

@@ -4,3 +4,8 @@ export type Cat = {
   age: number
   breed: string
 }
+
+export type Dog = {
+  _id: string
+  name: string
+}