Merge pull request #16 from mathiasberggren/feature/integration-tests…

…. Solves #17

[Monorepo] Enable Integration tests

.github/workflows/ci.yml

@@ -22,6 +22,9 @@ jobs:
         with:
           fetch-depth: 2
 
+      - name: Enable Corepack
+        run: corepack enable
+
       - name: Setup Node.js environment
         uses: actions/setup-node@v4
         with:
@@ -39,3 +42,6 @@ jobs:
 
       - name: Test
         run: yarn test
+
+      - name: Integration Test
+        run: yarn test:e2e

.gitignore

@@ -38,12 +38,10 @@ testem.log
 .DS_Store
 Thumbs.db
 
-.nx/cache
-
 # Expo
 node_modules/
 .expo/
-.yarn/
+.yarn/*
 dist/
 npm-debug.*
 *.jks
@@ -125,3 +123,12 @@ yarn-error.log
 /coverage
 
 .turbo
+
+# Yarn Berry
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

.vscode/extensions.json

@@ -1,6 +1,5 @@
 {
   "recommendations": [
-    "nrwl.angular-console",
     "esbenp.prettier-vscode",
     "firsttris.vscode-jest-runner",
     "vivaxy.vscode-conventional-commits",

.yarnrc.yml

@@ -0,0 +1,9 @@
+nodeLinker: node-modules
+
+supportedArchitectures:
+  cpu:
+    - current
+    - x64
+    - arm64
+
+yarnPath: .yarn/releases/yarn-4.1.1.cjs

apps/api/.env.development

@@ -0,0 +1,7 @@
+# Environment variables declared in this file are automatically made available to Prisma.
+# See the documentation for more detail: https://pris.ly/d/prisma-schema#accessing-environment-variables-from-the-schema
+
+# Prisma supports the native connection string format for PostgreSQL, MySQL, SQLite, SQL Server, MongoDB and CockroachDB.
+# See the documentation for all the connection string options: https://pris.ly/d/connection-strings
+
+DATABASE_URL="postgresql://api:admin@localhost:5432/postgres?schema=public"

apps/api/.env.test

@@ -0,0 +1 @@
+DATABASE_URL="postgresql://test:test@localhost:5433/tests"

apps/api/package.json

@@ -6,20 +6,21 @@
   "license": "MIT",
   "author": "",
   "scripts": {
-    "build": "vite build",
+    "build": "vite build && yarn prisma generate",
     "start": "nest start",
     "dev": "vite",
     "start:debug": "nest start --debug --watch",
     "start:prod": "node dist/main",
-    "console": "npm run start -- --watch --entryFile repl",
+    "console": "yarn start -- --watch --entryFile repl",
     "db:deploy": "npx prisma migrate deploy",
     "db:migrate": "npx prisma migrate dev",
     "db:seed": "npx prisma db seed",
+    "db:studio": "npx prisma studio",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "test": "jest",
     "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": "dotenv -e .env.test -- jest --config ./test/jest-e2e.json",
     "test:watch": "jest --watch"
   },
   "lint-staged": {
@@ -63,6 +64,8 @@
     "@types/supertest": "^6.0.0",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",
+    "docker-compose": "^0.24.8",
+    "dotenv-cli": "^7.4.1",
     "eslint": "^8.42.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.0",

apps/api/src/app/app.module.ts

@@ -14,7 +14,11 @@ import { HttpExceptionFilter } from './http-exception.filter'
 
 @Module({
   imports: [
-    ConfigModule.forRoot({ isGlobal: true, validate }),
+    ConfigModule.forRoot({
+      isGlobal: true,
+      validate,
+      envFilePath: ['.env', '.env.development']
+    }),
     DatabaseModule,
     MoviesModule,
     SubscriptionsModule

apps/api/src/app/http-exception.filter.ts

@@ -1,7 +1,7 @@
 import { ExceptionFilter, Catch, ArgumentsHost, HttpException, Logger } from '@nestjs/common'
 import { Request, Response } from 'express'
 
-@Catch()
+@Catch(HttpException)
 export class HttpExceptionFilter implements ExceptionFilter {
   constructor (private readonly logger: Logger) {}
   catch (exception: HttpException, host: ArgumentsHost) {

apps/api/src/database/client.ts

@@ -0,0 +1,5 @@
+import { PrismaClient } from '@prisma/client'
+
+const prisma = new PrismaClient()
+
+export default prisma

apps/api/src/database/factories/company.ts

@@ -1,11 +1,20 @@
-import { PrismaClient, Company } from '@prisma/client'
+import { Company } from '@prisma/client'
 import { Factory } from 'fishery'
 import { faker } from '@faker-js/faker'
 
+import prisma from '../client'
+
 export const companyFactory = Factory.define<Company>(({ sequence, onCreate }) => {
   onCreate(async (company) => {
-    const prisma = new PrismaClient()
-    return await prisma.company.create({ data: company })
+    return await prisma.company.create({
+      data: {
+        // ID is auto-generated
+        name: company.name,
+        image: company.image,
+        createdAt: company.createdAt,
+        updatedAt: company.updatedAt
+      }
+    })
   })
 
   return {

apps/api/src/database/factories/subscription.ts

@@ -1,6 +1,8 @@
-import { Company, PrismaClient, Subscription, SubscriptionCredential, User } from '@prisma/client'
+import { Company, Subscription, SubscriptionCredential, User } from '@prisma/client'
 import { Factory } from 'fishery'
 
+import prisma from '../client'
+
 import { userFactory } from './user'
 import { companyFactory } from './company'
 import { subscriptionCredentialFactory } from './subscriptionCredential'
@@ -21,8 +23,6 @@ class SubscriptionFactory extends Factory<ISubscriptionFactory> {
 
 export const subscriptionFactory = SubscriptionFactory.define(({ sequence, onCreate }) => {
   onCreate(async (subscription) => {
-    const prisma = new PrismaClient()
-
     const user = await userFactory.create(subscription.user)
     const company = await companyFactory.create(subscription.company)
 

apps/api/src/database/factories/subscriptionCredential.ts

@@ -1,16 +1,16 @@
-import { PrismaClient, Subscription, SubscriptionCredential } from '@prisma/client'
+import { Subscription, SubscriptionCredential } from '@prisma/client'
 import { Factory } from 'fishery'
 import { faker } from '@faker-js/faker'
 
+import prisma from '../client'
+
 import { subscriptionFactory } from './subscription'
 
 interface ISubscriptionCredentialFactory extends SubscriptionCredential {
   subscription?: Subscription
 }
 export const subscriptionCredentialFactory = Factory.define<ISubscriptionCredentialFactory>(({ sequence, onCreate }) => {
   onCreate(async (credential) => {
-    const prisma = new PrismaClient()
-
     const subscription = await subscriptionFactory.create(credential.subscription)
 
     return await prisma.subscriptionCredential.create({

apps/api/src/database/factories/user.ts

@@ -1,14 +1,23 @@
-import { PrismaClient, Subscription, User } from '@prisma/client'
+import { Subscription, User } from '@prisma/client'
 import { Factory } from 'fishery'
 import { faker } from '@faker-js/faker'
 
+import prisma from '../client'
+
 interface IUserFactory extends User {
   subscription?: Subscription[]
 }
 export const userFactory = Factory.define<IUserFactory>(({ sequence, onCreate }) => {
   onCreate(async (user) => {
-    const prisma = new PrismaClient()
-    return await prisma.user.create({ data: user })
+    return await prisma.user.create({
+      data: {
+        // ID is auto-generated
+        name: user.name,
+        email: user.email,
+        createdAt: user.createdAt,
+        updatedAt: user.updatedAt
+      }
+    })
   })
   return {
     id: sequence,

apps/api/src/database/schema.prisma

@@ -5,7 +5,8 @@
 // Try Prisma Accelerate: https://pris.ly/cli/accelerate-init
 
 generator client {
-  provider = "prisma-client-js"
+  provider      = "prisma-client-js"
+  binaryTargets = ["native", "darwin", "darwin-arm64"]
 }
 
 datasource db {

apps/api/src/subscriptions/entities/subscription.entity.ts

@@ -9,7 +9,7 @@ const SubscriptionResponseSchema = z.object({
     id: z.number(),
     username: z.string()
     // Hides password in any response payload
-  }).nullable(),
+  }).nullable().optional(),
   createdAt: z.date(),
   updatedAt: z.date()
 })

apps/api/test/app.e2e-spec.ts

@@ -1,13 +1,15 @@
+import { Server } from 'net'
+
 import { Test, TestingModule } from '@nestjs/testing'
 import { INestApplication } from '@nestjs/common'
-import * as request from 'supertest'
+import request from 'supertest'
 
-import { AppModule } from './../src/app.module'
+import { AppModule } from './../src/app/app.module'
 
 describe('AppController (e2e)', () => {
-  let app: INestApplication
+  let app: INestApplication<Server>
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     const moduleFixture: TestingModule = await Test.createTestingModule({
       imports: [AppModule]
     }).compile()
@@ -16,10 +18,14 @@ describe('AppController (e2e)', () => {
     await app.init()
   })
 
+  afterAll(async () => {
+    await app.close()
+  })
+
   it('/ (GET)', () => {
     return request(app.getHttpServer())
       .get('/')
       .expect(200)
-      .expect('Hello World!')
+      .expect({ message: 'Hello API' })
   })
 })

apps/api/test/helpers/global-setup.ts

@@ -0,0 +1,25 @@
+import { execSync } from 'child_process'
+
+import dockerCompose from 'docker-compose'
+
+export default async () => {
+  console.time('⏱️ Global setup time')
+  try {
+    console.info('\n🟡 - Starting Docker containers...')
+    await dockerCompose.upMany(['test_database'])
+    console.info('🟢 - Containers are ready!')
+
+    console.info('🟡 - Waiting for database to be ready...')
+    await dockerCompose.exec(
+      'test_database',
+      ['sh', '-c', 'until pg_isready ; do sleep 1; done']
+    )
+    console.info('🟢 - Database is ready!')
+
+    execSync('dotenv -e .env.test -- yarn db:deploy', { stdio: 'inherit' })
+  } catch (e) {
+    console.dir(e)
+    throw e
+  }
+  console.timeEnd('⏱️ Global setup time')
+}

apps/api/test/helpers/setup.ts

@@ -0,0 +1,5 @@
+import truncateDb from './truncate-db'
+
+beforeEach(async () => {
+  await truncateDb()
+})

apps/api/test/helpers/truncate-db.ts

@@ -0,0 +1,21 @@
+import { PrismaClient } from '@prisma/client'
+
+const prisma = new PrismaClient()
+
+// From Prisma Doc: https://www.prisma.io/docs/orm/prisma-client/queries/crud#delete-all-records
+
+export default async () => {
+  const tablenames = await prisma.$queryRaw<Array<{ tablename: string }>>`SELECT tablename FROM pg_tables WHERE schemaname='public'`
+
+  const tables = tablenames
+    .map(({ tablename }: { tablename: string }) => tablename)
+    .filter((name: string) => name !== '_prisma_migrations')
+    .map((name: string) => `"public"."${name}"`)
+    .join(', ')
+
+  try {
+    await prisma.$executeRawUnsafe(`TRUNCATE TABLE ${tables} CASCADE;`)
+  } catch (error) {
+    console.log({ error })
+  }
+}

apps/api/test/jest-e2e.json

@@ -5,5 +5,7 @@
   "testRegex": ".e2e-spec.ts$",
   "transform": {
     "^.+\\.(t|j)s$": "ts-jest"
-  }
+  },
+  "setupFilesAfterEnv": ["./helpers/setup.ts"],
+  "globalSetup": "./helpers/global-setup.ts"
 }