feat: server test with docker CI

.github/workflows/docker-compose.yml

@@ -0,0 +1,28 @@
+name: Docker Test
+
+on: [pull_request, workflow_dispatch]
+jobs:
+  test:
+    name: Run test suite
+    runs-on: ubuntu-latest
+    timeout-minutes: 3
+    env:
+      POSTGRES_USER: "postgres"
+      POSTGRES_PASSWORD: "postgres"
+      POSTGRES_DB: "notes_data"
+      COMPOSE_FILE: ./docker-compose.yml
+      DOCKER_USER: ${{ secrets.DOCKER_USER }}
+      DOCKER_PASS: ${{ secrets.DOCKER_PASS }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Login to DockerHub
+        run: docker login -u $DOCKER_USER -p $DOCKER_PASS
+
+      - name: Build docker images
+        run: docker-compose build
+
+      - name: Run tests
+        run: docker-compose up --abort-on-container-exit

docker-compose.yml

@@ -0,0 +1,31 @@
+version: "3"
+services:
+  db:
+    image: postgres:10
+    networks:
+      - webnet
+    environment:
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_USER: postgres
+      POSTGRES_DB: notes_data
+    ports:
+      - "5432:5432"
+  app:
+    image: server_app
+    build:
+      context: ./
+      dockerfile: ./server/Dockerfile
+    depends_on:
+      - db
+    ports:
+      - "5000:5000"
+    environment:
+      DATABASE_URL: "postgres://postgres:postgres@db:5432/notes_data?sslmode=disable"
+    networks:
+      - webnet
+    volumes:
+      - .:/app/
+      - /app/node_modules
+    command: npm test
+networks:
+  webnet:

server/Dockerfile

@@ -0,0 +1,7 @@
+FROM node
+WORKDIR /usr/app
+COPY types.d.ts ../
+COPY ./server .
+RUN  npm install typescript -g && npm install
+EXPOSE 3000
+CMD npm test 

server/db.ts

@@ -0,0 +1,11 @@
+import * as pg from "pg";
+import * as env from "./env";
+
+const pool = new pg.Pool({
+  connectionString: env.DATABASE_URL,
+  ssl: {
+    rejectUnauthorized: false,
+  },
+});
+
+export default pool;

server/jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+};

server/package.json

@@ -11,7 +11,7 @@
     "dev": "tsnd --respawn --transpile-only server.ts",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",
-    "test": "jest"
+    "test": "jest --detectOpenHandles -- ./test/index.test.ts"
   },
   "repository": {
     "type": "git",
@@ -34,7 +34,7 @@
   },
   "devDependencies": {
     "@types/express": "^4.17.11",
-    "@types/jest": "^26.0.22",
+    "@types/jest": "^27.0.1",
     "@types/lodash": "^4.14.168",
     "@types/node": "^14.14.41",
     "@types/pg": "^7.14.11",
@@ -43,10 +43,11 @@
     "eslint": "^7.24.0",
     "eslint-config-prettier": "^8.2.0",
     "eslint-plugin-prettier": "^3.4.0",
-    "jest": "^26.6.3",
+    "jest": "^27.0.3",
     "nodemon": "^2.0.7",
     "prettier": "^2.2.1",
     "supertest": "^6.0.1",
+    "ts-jest": "^27.0.2",
     "ts-node": "^9.1.1",
     "ts-node-dev": "^1.1.6",
     "typescript": "^4.2.4"

server/server.ts

@@ -1,15 +1,7 @@
 import app from "./index";
 import * as env from "./env";
-import * as pg from "pg";
 import { initialiseSQLTable } from "./service";
 
-export const pool = new pg.Pool({
-  connectionString: env.DATABASE_URL,
-  ssl: {
-    rejectUnauthorized: false,
-  },
-});
-
 initialiseSQLTable();
 const port = env.SERVER_PORT;
 app.listen(port, () => console.log(`Listening at port ${port} ...`));

server/service.ts

@@ -1,7 +1,6 @@
 import _ from "lodash";
 import { v4 as uuidv4 } from "uuid";
-
-import { pool } from "./server";
+import pool from "./db";
 
 const handleSQLQuery = async (sqlQuery, values?) => {
   const client = await pool.connect();

server/test/index.test.ts

@@ -1,8 +1,18 @@
 import request from "supertest";
 
 import app from "../index";
+import pool from "../db";
 
 describe("http requests testing", () => {
+  beforeAll(async () => {
+    const client = await pool.connect();
+    await client.query(
+      `CREATE TABLE IF NOT EXISTS "notes"(id UUID PRIMARY KEY, title VARCHAR(32) NOT NULL, "noteContent" TEXT NOT NULL, created TIMESTAMPTZ, "lastUpdated" TIMESTAMPTZ)`
+    );
+    client.release(true);
+  });
+
+  let secondId;
   test("Initial GET request", async () => {
     const response = await request(app).get("/notes");
     expect(response.statusCode).toBe(200);
@@ -32,6 +42,7 @@ describe("http requests testing", () => {
       title: "2nd",
       noteContent: "This is Second note",
     });
+    secondId = response.text;
     expect(response.statusCode).toBe(200);
   });
 
@@ -45,28 +56,38 @@ describe("http requests testing", () => {
   });
 
   test("GET request of second note by id", async () => {
-    const response = await request(app).get("/notes/2");
+    const response = await request(app).get(`/notes/${secondId}`);
     expect(response.statusCode).toStrictEqual(200);
     const noteJson: Note = response.body;
     expect(noteJson.title).toBe("2nd");
     expect(noteJson.noteContent).toBe("This is Second note");
   });
 
-  test("GET request by id to get 404 response", async () => {
-    const response = await request(app).get("/notes/99");
+  test("GET request by a random id to get 404 response", async () => {
+    const response = await request(app).get(
+      "/notes/c61f1fc9-e0d2-43ce-a6c1-b5436cdebe7d"
+    );
     expect(response.statusCode).toStrictEqual(404);
   });
 
   test("DELETE request of second note by id", async () => {
-    const response = await request(app).delete("/notes/2");
+    const response = await request(app).delete(`/notes/${secondId}`);
     expect(response.statusCode).toStrictEqual(200);
   });
   test("GET request of deleted second note", async () => {
-    const response = await request(app).get("/notes/2");
+    const response = await request(app).get(`/notes/${secondId}`);
     expect(response.statusCode).toStrictEqual(404);
   });
   test("DELETE request to get bad request response", async () => {
-    const response = await request(app).delete("/notes/2");
+    const response = await request(app).delete(
+      "/notes/c61f1fc9-e0d2-43ce-a6c1-b5436cdebe7d"
+    );
     expect(response.statusCode).toStrictEqual(400);
   });
+
+  afterAll(async () => {
+    const client = await pool.connect();
+    await client.query(`DROP TABLE notes`);
+    client.release(true);
+  });
 });

server/tsconfig.json

@@ -11,6 +11,6 @@
     "noImplicitAny": false,
     "typeRoots": ["./node_modules/@types", "../types.d.ts"]
   },
-  "exclude": ["build", "node_modules", "test"],
+  "exclude": ["build", "node_modules", "jest.config.js"],
   "include": ["./", "../types.d.ts"]
 }