Build docker image (#6)

* Build docker image

Implemented Dockerfile and docker-compose.yaml.

Inlcuded docker build step in deploy workflow.

* Fix hadolint reported issues

Add progress bar for wget and specify shell options to fix hadolint issues
DL3047 and DL4006.

* Change shell to bash

Changed shell to bash since ash shell does not exist in bitnami/node image

* Login to ECR and push image

Added steps to deploy workflow for logging in to ECR and push the docker
image that was build.

Output the ECR image url.

* Add name and fix typos for deploy workflow

Add name for linter and test jobs.

Updated name for vars, build and push as well as deploy steps on deploy job.

* Fix error from copy-paste detector linter

Created JSON file for response of API and test to avoid duplicationa

Author: abame

.cspell.json

@@ -25,7 +25,13 @@
         "DEVSKIM",
         "gitmessage",
         "uuidv",
-        "EDITMSG"
+        "EDITMSG",
+        "tsbuildinfo",
+        "bitnami",
+        "healthcheck",
+        "cpus",
+        "pipefail",
+        "giga"
     ],
     "version": "0.2"
 }

.dockerignore

@@ -0,0 +1,29 @@
+**/.DS_Store
+**/.git
+**/.github
+**/.vscode
+**/coverage
+**/dist
+**/node_modules
+**/*.spec.ts
+**/.editorconfig
+
+**/.eslintignore
+**/.eslintrc.json
+**/.cspell.json
+**/.jscpd.json
+**/.mega-linter.yml
+**/.prettierignore
+**/.prettierrc.json
+**/LICENSE
+**/.env
+**/.env.dist
+**/.gitignore
+**/.gitmessage
+**/jest.config.*
+**/*.log
+**/*.md
+**/*.tsbuildinfo
+
+.dockerignore
+**/Dockerfile

.github/workflows/deploy.yml

@@ -16,22 +16,52 @@ on:
 
 jobs:
     linter:
+        name: Linters
         uses: ./.github/workflows/mega-linter.yml
         permissions:
             # Give the default GITHUB_TOKEN write permission to commit and push, comment issues & post new PR
             contents: write
             issues: write
             pull-requests: write
     tests:
+        name: Tests
         uses: ./.github/workflows/tests.yml
     deploy:
-        name: Run Deployment
+        name: Deployment
         runs-on: ubuntu-latest
         needs:
             - linter
             - tests
         steps:
             - name: Checkout
               uses: actions/checkout@v3
-            - name: deploy
+
+            - name: Declare tag variable
+              id: vars
+              shell: bash
+              run: |
+                echo "tag=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
+
+            - name: Configure AWS credentials
+              uses: aws-actions/configure-aws-credentials@v1
+              with:
+                  aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+                  aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+                  aws-region: ${{ secrets.AWS_REGION }}
+
+            - name: Login to Amazon ECR
+              id: login-ecr
+              uses: aws-actions/amazon-ecr-login@v1
+
+            - name: Build and push the tagged Docker image
+              env:
+                  ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
+                  ECR_REPOSITORY: ${{ secrets.ECR_REPOSITORY_NAME }}
+                  IMAGE_TAG: ${{ steps.vars.outputs.tag }}
+              run: |
+                docker build . --file Dockerfile --tag $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
+                docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
+                echo "image=$ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG" >> $GITHUB_OUTPUT
+
+            - name: Deploy
               run: echo "Application is deployed"

.gitignore

@@ -2,5 +2,5 @@ node_modules
 .env
 megalinter-reports/
 dist
-access.log
+**/access.log
 coverage

Dockerfile

@@ -0,0 +1,38 @@
+FROM bitnami/node:20.3.1-debian-11-r3@sha256:348cf7ec9f6901daf791ace21846fabe1c372f907919e99b07a2dbbd1b0b0052 as builder
+
+WORKDIR /code
+
+COPY . .
+
+# Set SHELL flags for RUN commands to allow -e and pipefail
+# Rationale: https://github.com/hadolint/hadolint/wiki/DL4006
+SHELL ["/bin/bash", "-eo", "pipefail", "-c"]
+
+RUN yarn install \
+    && yarn build \
+    && rm -rf node_modules \
+    && yarn install --production 
+
+# Set progress bar for wget to avoid excessively bloated build logs
+# Rationale: https://github.com/hadolint/hadolint/wiki/DL3047
+RUN wget --progress=dot:giga https://gobinaries.com/tj/node-prune --output-document - | /bin/sh \
+    && node-prune
+
+FROM node:20.3.1-bullseye-slim@sha256:18cfcccefacb1bb2ca8df40f881cca0f1eedeae020154e6b07eddad0073bdc8e
+
+WORKDIR /app
+
+COPY --from=builder /code/node_modules /app/node_modules
+COPY --from=builder /code/dist /app
+COPY --from=builder /code/views /app/views
+
+RUN mkdir -p /app/node_modules/.cache \
+    && chown -R 1001:1001 /app/node_modules/.cache \
+    && touch /app/access.log \
+    && chown 1001:1001 /app/access.log
+
+USER 1001:1001
+
+HEALTHCHECK CMD curl --fail http://localhost:3000/hello-world || exit 1
+
+CMD ["node", "./index.js"]

docker-compose.yaml

@@ -0,0 +1,36 @@
+---
+version: '3.7'
+
+services:
+    demo-app:
+        platform: linux/amd64
+        build:
+            context: .
+            dockerfile: Dockerfile
+        env_file:
+            - .env
+        ports:
+            - '127.0.0.1:3000:3000'
+        deploy:
+            resources:
+                limits:
+                    cpus: '0.3'
+                    memory: 256M
+                reservations:
+                    cpus: '0.1'
+                    memory: 128M
+        networks:
+            - demo-app
+        restart: always
+        pid: 'demo-app:demo-app'
+        security_opt:
+            - no-new-privileges:true
+        healthcheck:
+            test: curl --fail -s http://localhost:3000/hello-world || exit 1
+            interval: 1m30s
+            timeout: 10s
+            retries: 3
+        cap_drop:
+            - all
+networks:
+    demo-app:

src/app.spec.ts

@@ -1,5 +1,6 @@
 /* globals describe, expect, it */
 import request from 'supertest'
+import response from './database/hello-world.json'
 import app from './app'
 
 process.env.AUTH_TOKEN = 'test'
@@ -10,23 +11,6 @@ describe('Hello World API Endpoint', function () {
       .get('/api/v1/hello-world')
       .set('Authorization', 'Basic test')
     expect(res.statusCode).toEqual(200)
-    expect(res.body).toEqual({
-      status: 'success',
-      message: 'Hello World API!',
-      products: [
-        {
-          id: '1',
-          name: 'MacBook Pro'
-        },
-        {
-          id: '2',
-          name: 'HP'
-        },
-        {
-          id: '3',
-          name: 'Dell'
-        }
-      ]
-    })
+    expect(res.body).toEqual(response)
   })
 })

src/app.ts

@@ -36,7 +36,7 @@ app.use(bodyParser.json())
 app.use(cors())
 
 // adding morgan to log HTTP requests
-const accessLogStream = createWriteStream(join(__dirname, '../access.log'), {
+const accessLogStream = createWriteStream(join(__dirname, 'access.log'), {
   flags: 'a'
 })
 app.use(

src/database/hello-world.json

@@ -0,0 +1,18 @@
+{
+    "status": "success",
+    "message": "Hello World API!",
+    "products": [
+        {
+            "id": "1",
+            "name": "MacBook Pro"
+        },
+        {
+            "id": "2",
+            "name": "HP"
+        },
+        {
+            "id": "3",
+            "name": "Dell"
+        }
+    ]
+}

src/routes/api/v1/hello-world.ts

@@ -1,27 +1,11 @@
 import type { Request, Response } from 'express'
 import express from 'express'
+import apiResponse from '../../../database/hello-world.json'
 import authentication from '../../../middleware/security/authentication'
 
 const router = express.Router()
 
 router.get('/', authentication, (_request: Request, response: Response) => {
-  response.json({
-    status: 'success',
-    message: 'Hello World API!',
-    products: [
-      {
-        id: '1',
-        name: 'MacBook Pro'
-      },
-      {
-        id: '2',
-        name: 'HP'
-      },
-      {
-        id: '3',
-        name: 'Dell'
-      }
-    ]
-  })
+  response.json(apiResponse)
 })
 export default router