Add acceptance tests (#211)

* Add acceptance tests

* Use a specific Postgres version

---------

Co-authored-by: Juga Paazmaya <[email protected]>

Author: pashidlos

.github/workflows/workflow.yml

@@ -1,12 +1,6 @@
-# This is a basic workflow to help you get started with Actions
-
 name: CI
 
-on:
-  push:
-    branches: [master]
-  pull_request:
-    branches: [master]
+on: [push]
 
 jobs:
   build:
@@ -19,40 +13,37 @@ jobs:
       - name: Setup Node.js environment
         uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: '14.16.1'
 
       - name: Install npm dependencies
         run: npm ci
 
+      - name: Prisma generate
+        run: npm run prisma:generate
+
       - name: Unit tests
         run: npm run test:cov
 
-      - name: Codacy Coverage Reporter
-        uses: codacy/codacy-coverage-reporter-action@v1
-        with:
-          project-token: ${{ secrets.CODACY_TOKEN }}
-
-      - name: Setup PostgreSQL
-        uses: Harmon758/postgresql-action@v1
-        with:
-          postgresql db: vrt_db_dev
-          postgresql user: postgres
-          postgresql password: postgres
+      - name: Build and run containers
+        run: docker-compose up --build -d
 
       # FIXME: This action is unmaintained.
-      - name: Wait untill DB started (workaround of https://github.com/Harmon758/postgresql-action/issues/7)
+      - name: Wait untill service started (replace with health status check)
         uses: jakejarvis/[email protected]
         with:
-          time: '5s'
+          time: '10s'
 
-      - name: Apply Manual DB migrations
-        run: npx ts-node ./prisma/manual_migrations.ts
-
-      - name: Apply DB migrations
-        run: npx prisma migrate up -c --experimental
-
-      - name: Seed DB data
-        run: npx ts-node ./prisma/seed.ts
+      - name: Run acceptance tests
+        run: npm run test:acceptance
 
       - name: Run e2e tests
         run: npm run test:e2e
+
+      - name: Stop containers
+        if: always()
+        run: docker-compose down
+
+      - name: Codacy Coverage Reporter
+        uses: codacy/codacy-coverage-reporter-action@v1
+        with:
+          project-token: ${{ secrets.CODACY_TOKEN }}

Dockerfile

@@ -1,5 +1,5 @@
-# Using LTS version https://github.com/nodejs/release#release-schedule
-FROM node:lts-alpine AS builder
+# https://github.com/Visual-Regression-Tracker/Visual-Regression-Tracker/issues/137
+FROM node:14-alpine3.17 AS builder
 
 # Create app directory
 WORKDIR /app
@@ -19,7 +19,8 @@ COPY src ./src
 
 RUN npm run build
 
-FROM node:lts-alpine
+# https://github.com/Visual-Regression-Tracker/Visual-Regression-Tracker/issues/137
+FROM node:14-alpine3.17
 COPY --from=builder /app/node_modules ./node_modules
 COPY --from=builder /app/package*.json ./
 COPY --from=builder /app/dist ./dist

README.md

@@ -5,6 +5,7 @@
 
 ## Local setup
 
+- Install Node `14`
 - clone repo
 - Update `.env` and `prisma/.env`
 - Make sure Postgres is up and running

docker-compose.yml

@@ -1,23 +1,34 @@
 version: "3.7"
 services:
-  # api:
-  #   build:
-  #     context: .
-  #     dockerfile: Dockerfile
-  #   environment:
-  #     DATABASE_URL: postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}
-  #     JWT_SECRET: ${JWT_SECRET}
-  #     JWT_LIFE_TIME: ${JWT_LIFE_TIME}
-  #     BODY_PARSER_JSON_LIMIT: ${BODY_PARSER_JSON_LIMIT}
-  #     APP_FRONTEND_URL: ${APP_FRONTEND_URL}
-  #   ports:
-  #     - "${APP_PORT}:3000"
-  #   expose:
-  #     - "${APP_PORT}"
-  #   depends_on:
-  #     - postgres
+  api:
+    container_name: vrt_api
+    build:
+      context: .
+      dockerfile: Dockerfile
+    environment:
+      DATABASE_URL: postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}
+      JWT_SECRET: ${JWT_SECRET}
+      JWT_LIFE_TIME: ${JWT_LIFE_TIME}
+      BODY_PARSER_JSON_LIMIT: ${BODY_PARSER_JSON_LIMIT}
+      APP_FRONTEND_URL: ${APP_FRONTEND_URL}
+    ports:
+      - "${APP_PORT}:3000"
+    expose:
+      - "${APP_PORT}"
+    depends_on:
+      - postgres
+  migration:
+    container_name: vrt_migration
+    build:
+      context: prisma
+      dockerfile: Dockerfile
+    environment:
+      DATABASE_URL: postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}
+    depends_on:
+      - postgres
   postgres:
-    image: postgres:12
+    container_name: postgres
+    image: postgres:12-alpine3.18
     restart: always
     environment:
       POSTGRES_USER: ${POSTGRES_USER}
@@ -29,13 +40,16 @@ services:
       - "${POSTGRES_PORT}"
     volumes:
       - postgres:/var/lib/postgresql/data
-  # migration:
-  #   build:
-  #     context: prisma
-  #     dockerfile: Dockerfile
-  #   environment:
-  #     DATABASE_URL: postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}
-  #   depends_on:
-  #     - postgres
+  pgadmin:
+    container_name: pgadmin4
+    image: dpage/pgadmin4
+    restart: always
+    environment:
+      PGADMIN_DEFAULT_EMAIL: [email protected]
+      PGADMIN_DEFAULT_PASSWORD: root
+    ports:
+      - "5050:80"
+    depends_on:
+      - postgres
 volumes:
   postgres:

jest.config.ts

@@ -1,7 +1,11 @@
 /** @returns {Promise<import('jest').Config>} */
 module.exports = async () => {
   return {
-    projects: ['./test/jest.config.ts', './src/jest.config.ts'],
+    projects: [
+      './src/jest.config.ts', 
+      './test/jest.config.ts', 
+      './test_acceptance/jest.config.ts'
+    ],
     roots: ['./'],
     testTimeout: 30000,
   };

package-lock.json

@@ -13,12 +13,14 @@
     "start:dev": "nest start --watch",
     "start:debug": "nest start --debug --watch",
     "start:prod": "node dist/main",
+    "prisma:generate": "prisma generate",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "test": "jest --projects src",
     "test:watch": "jest --projects src --watch",
     "test:cov": "jest --projects src --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --projects src --runInBand",
-    "test:e2e": "jest --projects test"
+    "test:e2e": "jest --projects test",
+    "test:acceptance": "jest --projects test_acceptance"
   },
   "dependencies": {
     "@nestjs/common": "^8.4.1",

package.json

@@ -1,5 +1,5 @@
-# Using LTS version https://github.com/nodejs/release#release-schedule
-FROM node:lts-alpine
+# https://github.com/Visual-Regression-Tracker/Visual-Regression-Tracker/issues/137
+FROM node:14-alpine3.17
 
 RUN apk add --no-cache bash
 

prisma/Dockerfile

@@ -0,0 +1,30 @@
+import { User } from '@prisma/client';
+import axios from 'axios'
+import { UserLoginRequestDto } from 'src/users/dto/user-login-request.dto';
+import { UserLoginResponseDto } from 'src/users/dto/user-login-response.dto';
+import uuidAPIKey from 'uuid-apikey';
+
+axios.defaults.baseURL = 'http://localhost:4200';
+
+let user: Partial<User> = {
+    email: `${uuidAPIKey.create().uuid}@example.com`,
+    password: '123456',
+    firstName: 'fName',
+    lastName: 'lName',
+};
+const loginData: UserLoginRequestDto = {
+    email: user.email,
+    password: user.password,
+}
+
+describe('Acceptance', () => {
+
+    test('Register and login', async () => {
+        await axios.post<User>('/users/register', user);
+
+        const response = await axios.post<UserLoginResponseDto>('/users/login', loginData)
+
+        expect(response.status).toBe(201)
+        expect(response.data.token).toBeDefined()
+    })
+})

test_acceptance/acceptance.spec.ts

@@ -0,0 +1,15 @@
+/** @returns {Promise<import('jest').Config>} */
+module.exports = async () => {
+  return {
+    name: 'Acceptance',
+    displayName: 'Acceptance',
+    roots: ['./'],
+    testTimeout: 30000,
+    testRegex: '.spec.ts$',
+    moduleFileExtensions: ['js', 'json', 'ts'],
+    transform: {
+      '^.+\\.(t|j)s$': 'ts-jest',
+    },
+    testEnvironment: 'node',
+  };
+};