Merge pull request #29 from libero/add-mock-service

feat: add mock server to development stack and configure for testing

.mockServer/initializerJson.json

@@ -0,0 +1,32 @@
+[
+  {
+    "httpRequest": {
+      "method": "POST",
+      "path": "/pdf-generation/start",
+      "body": {}
+    },
+    "httpResponse": {
+      "body": "{\"status\": {\"code\": 200,\"message\": \"job created successfully\"},\"message\": {\"jobid\": \"4b111882-d0e8-4d3d-8ef2-043ac3751ea2\"}}",
+      "statusCode": 200
+    }
+  },
+  {
+    "httpRequest": {
+      "method": "POST",
+      "path": "/pdf-generation/status"
+    },
+    "httpResponse": {
+      "body": "{\"status\": { \"code\": 200, \"message\": { \"id\": \"385ae272-e98e-47d9-83f5-c3ded54ab467\", \"lastUpdatedTime\": 1620885422660, \"status\": \"completed\" }}}",
+      "statusCode": 200
+    }
+  },
+  {
+    "httpRequest": {
+      "method": "HEAD",
+      "path": "/articles/.*"
+    },
+    "httpResponse": {
+      "statusCode": 200
+    }
+  }
+]

Dockerfile

@@ -14,6 +14,8 @@ RUN npm install
 
 COPY src/ src/
 
+CMD ["npm", "run", "dev"]
+
 #
 # Stage: Production build
 #

Makefile

@@ -3,11 +3,12 @@
 IMAGE_TAG ?= local
 
 build:
-	docker build --no-cache -t editor-pdf-service:${IMAGE_TAG} .
+	IMAGE_TAG=${IMAGE_TAG} docker-compose build editor-pdf-service
 
 start:
-	npm run build
-	npm start
+	RUN_ENV=prod ${MAKE} build
+	IMAGE_TAG=${IMAGE_TAG} docker-compose up -d
 
 start_dev:
-	npm run dev
+	RUN_ENV=dev ${MAKE} build
+	IMAGE_TAG=${IMAGE_TAG} docker-compose up -d

README.md

@@ -20,6 +20,8 @@ make start_dev
 
 By default the service should now be available at `http://localhost:4001` and any changes made to files within the `/dev` directory will be picked up and cause the service to restart.
 
+When in dev mode the application relies on [`mockserver`](https://www.mock-server.com/) to provide mocked responses to external requests. These responses can be configured [here](.mockServer/initializerJson.json) to change expected behaviour.
+
 ## Configuration
 
 The service can be configured through the use of environment variables. 

docker-compose.yaml

@@ -0,0 +1,24 @@
+version: "3.9"
+services:
+  mockServer:
+    image: mockserver/mockserver:mockserver-5.11.1
+    container_name: ${PREFIX-editor}-mock-service
+    ports:
+      - 1080:1080
+    environment:
+      MOCKSERVER_INITIALIZATION_JSON_PATH: /config/initializerJson.json
+    volumes:
+          - './.mockserver:/config:ro'
+  editor-pdf-service:
+    build:
+      context: './'
+      target: ${RUN_ENV:-prod}
+    image: ${PREFIX-editor}-pdf-service:${IMAGE_TAG:-local}
+    environment: 
+      - ARTICLE_STORE_PATH=http://${PREFIX-editor}-mock-service:1080/articles/
+      - GENERATION_STATUS_URL=http://${PREFIX-editor}-mock-service:1080/pdf-generation/status
+      - GENERATION_START_URL=http://${PREFIX-editor}-service:1080/pdf-generation/start
+    ports:
+      - 4001:4001
+    volumes:
+      - ./src/:/app/src

src/index.ts

@@ -21,7 +21,6 @@ const app: express.Application = express();
 
 // Log all requests on this route.
 app.use(logRequest);
-
 app.get('/health', (_, res) => res.sendStatus(200));
 app.post('/generate/:articleId', async (req, res) => {
     try {