Feature/ci enhancement (#15)

* Separate postgres and redis volume for dev and test. Run container as node user. Add cors support

Run as root when setting up image, run as node before starting app. Set image build stage to release. Add files to dockerignore

Build image

Copy files from host to image

Set image owner to node

* Run as user node. Add prettier ignore

Do not use cache when running ci test

Do not run nyc in ci test

Remove --no-cache

* Copy from base image in test image. Run test with nyc

Copy from base image in test image. Run test with nyc

Do not run nyc in test due to mkdir permission error

Author: hanchiang

.dockerignore

@@ -5,4 +5,12 @@ Dockerfile
 dist
 node_modules
 npm-debug.log
-README.md
+README.md
+loadtest
+coverage
+.nyc_output
+.github
+images
+.env
+.env.test
+debug.log

.github/workflows/build_and_push_image.yml

@@ -15,7 +15,7 @@ jobs:
       - uses: actions/checkout@v3
       - name: Build docker image
         id: build_image
-        run: docker build -t "$IMAGE_REGISTRY/$APP_NAME:$GITHUB_SHA" .
+        run: docker build -t "$IMAGE_REGISTRY/$APP_NAME:$GITHUB_SHA" --target release .
       - name: Log in to github container registry
         id: login_registry
         run: echo $REGISTRY_PASSWORD | docker login ghcr.io -u $REGISTRY_USER --password-stdin

.prettierignore

@@ -0,0 +1,5 @@
+.nyc_output
+dist
+coverage
+node_modules
+loadtest

Dockerfile

@@ -1,45 +1,45 @@
-# 1. --- Base ---
+# --- Base ---
 FROM node:16-stretch-slim AS base
 
-# install dependencies first, in a different location for easier app bind mounting for local development
-# due to default /opt permissions we have to create the dir with root and change perms
 RUN mkdir -p /opt/node_app && chown -R node:node /opt/node_app
 WORKDIR /opt/node_app
-
-# the official node image provides an unprivileged user as a security best practice
-# but we have to manually enable it. We put it here so npm installs dependencies as the same
-# user who runs the app. 
-# https://github.com/nodejs/docker-node/blob/master/docs/BestPractices.md#non-root-user
 COPY ./package*.json ./
 
-
-# 2. --- dev ---
+# --- dev ---
 FROM base AS dev
+RUN npm install
+
 ENV NODE_ENV development
 ENV PORT 3000
-
-RUN npm install
 ENV PATH /opt/node_app/node_modules/.bin:$PATH
 
 # copy in our source code last, as it changes the most
 COPY --chown=node:node . .
-RUN npm run build
+USER node
 CMD [ "npm", "run", "debug" ]
 
+# --- test ---
+FROM base as test
+RUN npm ci
 
-# 3. --- test ---
-FROM dev as test
 ENV NODE_ENV test
 ENV PORT 3000
-CMD ["npm", "test"]
-
-# 4. --- Release ---
-FROM base AS release
-ENV NODE_ENV production
-ENV PORT 3000
 ENV PATH /opt/node_app/node_modules/.bin:$PATH
 
-COPY --from=dev /opt/node_app/dist ./dist
-RUN npm ci --only=production
+COPY --chown=node:node . .
 USER node
+CMD ["npm", "run", "test:ci"]
+
+## --- Build ---
+FROM dev as build
+RUN npm run build
+
+# --- Release ---
+FROM build AS release
+COPY --from=build /opt/node_app/dist ./dist
+RUN npm ci --only=production
+
+ENV PATH /opt/node_app/node_modules/.bin:$PATH
+ENV NODE_ENV production
+ENV PORT 3000
 CMD [ "npm", "run", "start" ]

README.md

@@ -157,4 +157,5 @@ Each key contains 6 characters.
 * URL shortening: Check if URL is stored in the database. If it is, return the short url
 * Key generation: do not check against the database for existing short urls because there can still be a conflict due to concurrency. Let the database handle the conflict
 * Handle expired keys
-* load test with multiple instances of API service and database
+* Collect metric
+* Centralised log collection

docker-compose.dev.yml

@@ -30,7 +30,15 @@ services:
       - POSTGRES_DB=url_shortener
     ports:
       - "5432:5432"
+    volumes:
+      - postgres-volume-dev:/var/lib/postgresql/data
 
   redis:
     ports:
-      - "6379:6379"
+      - "6379:6379"
+    volumes:
+      - redis-volume-dev:/data
+
+volumes:
+  postgres-volume-dev:
+  redis-volume-dev:

docker-compose.test.yml

@@ -7,6 +7,7 @@ services:
       target: test
       dockerfile: Dockerfile
     image: url-shortener:test
+    command: npm run test:ci
     environment:
       - NODE_ENV=test
       - POSTGRES_HOST=postgres
@@ -29,7 +30,15 @@ services:
       - POSTGRES_DB=url_shortener_test
     ports:
       - "5432:5432"
+    volumes:
+      - postgres-volume-test:/var/lib/postgresql/data
 
   redis:
     ports:
-      - "6379:6379"
+      - "6379:6379"
+    volumes:
+      - redis-volume-test:/data
+
+volumes:
+  postgres-volume-test:
+  redis-volume-test:

docker-compose.yml

@@ -14,7 +14,6 @@ services:
   postgres:
     image: postgres:13.1
     volumes:
-      - postgres-volume:/var/lib/postgresql/data
       - ./src/db/postgres/schema.sql:/docker-entrypoint-initdb.d/schema.sql
 
   redis:

package-lock.json

@@ -30,10 +30,13 @@
     "start": "npm run serve",
     "build": "npm run build-ts",
     "serve": "node dist/bin/www.js",
+    "test:ci": "npm run test-unit-ci && npm run test-integration-ci",
+    "test-integration-ci": "ts-mocha test/dbhelper.ts test/integration/index.ts",
+    "test-unit-ci": "ts-mocha test/unit/index.ts",
     "test": "npm run test-unit && npm run test-integration",
     "test-integration": "nyc ts-mocha test/dbhelper.ts test/integration/index.ts",
     "test-unit": "nyc ts-mocha test/unit/index.ts",
-    "build-ts": "tsc",
+    "build-ts": "tsc -p .",
     "watch-ts": "tsc -w",
     "prettier:fix": "prettier --write \"**/*.+(ts|js|json)\"",
     "prettier:check": "prettier --check \"**/*.+(ts|js|json)\"",
@@ -51,6 +54,7 @@
   "dependencies": {
     "bluebird": "^3.7.2",
     "body-parser": "^1.19.0",
+    "cors": "^2.8.5",
     "dotenv": "^8.2.0",
     "express": "^4.17.1",
     "express-joi-validation": "^5.0.0",