test(api): Add E2E tests to API

.github/workflows/api.yaml

@@ -45,7 +45,13 @@ jobs:
         run: |
           pnpm run lint:api
 
-      - name: Test
+      - name: Unit tests
         run: |
           pnpm run db:generate-types
           pnpm run test:api
+
+      - name: E2E tests
+        run: |
+          docker compose up -d
+          pnpm run e2e:api
+          docker compose down

.husky/pre-commit

@@ -2,3 +2,6 @@
 . "$(dirname -- "$0")/_/husky.sh"
 
 pnpm run lint:fix && pnpm run prettier:fix && pnpm run test:api
+docker compose up -d
+pnpm run e2e:api
+docker compose down

Makefile

@@ -2,10 +2,12 @@ VERSION ?= $(shell echo $$1)
 RELEASE_TYPE ?= $(shell echo $$2)
 CURRENT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
 
-all: check_args update_version generate_changelog commit_changes tag_release push_changes switch_branch rebase_and_push
+all: check_args update_version generate_changelog commit_changes tag_release push_changes switch_branch rebase_and_push api_e2e
 
 release: check_args update_version generate_changelog commit_changes tag_release push_changes switch_branch rebase_and_push
 
+api_e2e: run_api run_e2e docker_down
+
 check_args:
 	@if [ -z "$(VERSION)" ]; then echo "Usage: make <version> <release_type>"; exit 1; fi
 	@if [ -z "$(RELEASE_TYPE)" ]; then echo "Usage: make <version> <release_type>"; exit 1; fi
@@ -41,4 +43,25 @@ rebase_and_push:
 	@echo "Rebasing main branch"
 	@git rebase main
 	@echo "Pushing the changes to $(RELEASE_TYPE)"
-	@git push origin $(RELEASE_TYPE) --tags
+	@git push origin $(RELEASE_TYPE) --tags
+
+
+# -----------------------_E2E TESTS----------------------- #
+
+docker_up:
+	@echo "Starting docker containers"
+	@docker compose up -d
+
+run_api: docker_up
+	@echo "Running API"
+	@DATABASE_URL="postgresql://prisma:prisma@localhost:5433/tests" pnpm run dev:api&
+
+run_e2e:
+	@sleep 10
+	@echo "Running tests"
+	@nx run api-e2e:e2e
+
+docker_down: run_e2e
+	@echo "Stopping docker containers"
+	@docker compose down
+	@kill -9 $(shell lsof -t -i:4200)

apps/api/jest.config.ts

@@ -3,6 +3,8 @@ export default {
   displayName: 'api',
   preset: '../../jest.preset.js',
   testEnvironment: 'node',
+  testMatch: ['**/*.spec.ts'],
+  testPathIgnorePatterns: ['.*.e2e.spec.ts'],
   transform: {
     '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }]
   },

apps/api/jest.e2e-config.ts

@@ -0,0 +1,12 @@
+/* eslint-disable */
+export default {
+  displayName: 'api',
+  preset: '../../jest.preset.js',
+  testEnvironment: 'node',
+  testMatch: ['**/*.e2e.spec.ts'],
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }]
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/apps/api'
+}

apps/api/project.json

@@ -60,6 +60,19 @@
         "jestConfig": "apps/api/jest.config.ts"
       }
     },
+    "test:e2e": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage-e2e/{projectRoot}"],
+      "options": {
+        "devServerTarget": "api:serve",
+        "jestConfig": "apps/api/jest.e2e-config.ts"
+      },
+      "configurations": {
+        "development": {
+          "devServerTarget": "api:serve:development"
+        }
+      }
+    },
     "prisma:generate": {
       "command": "prisma generate",
       "options": {

apps/api/src/app/app.e2e.spec.ts

@@ -0,0 +1,35 @@
+import {
+  FastifyAdapter,
+  NestFastifyApplication
+} from '@nestjs/platform-fastify'
+import { Test } from '@nestjs/testing'
+import { AppModule } from './app.module'
+
+describe('Health Check', () => {
+  let app: NestFastifyApplication
+
+  beforeAll(async () => {
+    const moduleRef = await Test.createTestingModule({
+      imports: [AppModule]
+    }).compile()
+    app = moduleRef.createNestApplication<NestFastifyApplication>(
+      new FastifyAdapter()
+    )
+
+    await app.init()
+    await app.getHttpAdapter().getInstance().ready()
+  })
+
+  it(`should pass health check`, async () => {
+    const result = await app.inject({
+      method: 'GET',
+      url: '/health'
+    })
+    expect(result.statusCode).toEqual(200)
+    expect(result.body).toEqual('UP')
+  })
+
+  afterAll(async () => {
+    await app.close()
+  })
+})

apps/api/src/app/e2e.setup.ts

@@ -0,0 +1,58 @@
+import { Injectable, Logger, OnModuleInit } from '@nestjs/common'
+import { PrismaClient } from '@prisma/client'
+
+@Injectable()
+export class E2ESetup implements OnModuleInit {
+  private readonly prisma: PrismaClient
+  private readonly logger: Logger = new Logger(E2ESetup.name)
+
+  constructor(prisma: PrismaClient) {
+    this.prisma = prisma
+  }
+
+  async onModuleInit() {
+    if (process.env.NODE_ENV === 'e2e') {
+      // Clean the DB
+      await this.prisma.user.deleteMany()
+
+      // Create admin user
+      const adminUser = await this.prisma.user.create({
+        data: {
+          email: '[email protected]',
+          isActive: true,
+          isAdmin: true,
+          isOnboardingFinished: true,
+          name: 'Admin'
+        }
+      })
+      this.logger.log(`Created admin user: ${adminUser.email}`)
+
+      // Create regular user
+      const regularUser = await this.prisma.user.create({
+        data: {
+          email: '[email protected]',
+          isActive: true,
+          isAdmin: false,
+          isOnboardingFinished: true,
+          name: 'John Doe'
+        }
+      })
+      this.logger.log(`Created regular user: ${regularUser.email}`)
+
+      // Create regular user's workspace
+      await this.prisma.workspace.create({
+        data: {
+          name: `My Workspace`,
+          description: 'My default workspace',
+          isDefault: true,
+          ownerId: regularUser.id,
+          lastUpdatedBy: {
+            connect: {
+              id: regularUser.id
+            }
+          }
+        }
+      })
+    }
+  }
+}