Update

1. Added some more tests etc
2. Added github workflows
3. Added Dockerfile and support

Signed-off-by: James Turnbull <[email protected]>

Author: jamtur01

.dockerignore

@@ -0,0 +1 @@
+node_modules

.github/workflows/docker.yml

@@ -0,0 +1,43 @@
+name: Publish Docker image
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      -
+        name: Login to DockerHub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      -
+        name: Login to GitHub Container Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GHRC_TOKEN }}
+      -
+        name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: |
+            jamtur01/animal-farm-nodejs:latest
+            ghcr.io/jamtur01/animal-farm-nodejs:latest

.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Animal Farm Node.js CI
+
+on:
+  push:
+   branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+    - name: Use Node.js
+      uses: actions/setup-node@v1
+      with:
+        node-version: '14.x'
+    - name: Run Yarn
+      run: yarn
+    - name: Run tests
+      run: yarn test

.gitignore

@@ -1 +1,3 @@
 node_modules
+coverage
+.nyc_output

Dockerfile

@@ -0,0 +1,15 @@
+FROM node:14
+
+# Create app directory
+WORKDIR /usr/src/app
+
+# Install app dependencies
+COPY package.json yarn.lock ./
+RUN yarn install
+
+# Bundle app source
+COPY . .
+
+EXPOSE 8080
+
+CMD [ "node", "app.js" ]

README.md

@@ -1,10 +1,38 @@
 # Animal Farm
 
-A sample application in Javascript on NodeJS for Github README.
+A sample Express application written in Node.js for a Github README post.
+
+##  Prerequisites
+
+* Node.js
+* yarn
+
+### Install modules
+
+Run `yarn` to install the required node modules.
+
+```shell
+yarn install
+```
 
 ## Running
 
-You can run the sample app in a couple of different ways. The first is to simply launch the executable:
+You can run the sample app in a couple of different ways. The first is to launch the application via `yarn`:
+
+```shell
+yarn start
 ```
+
+Or you can directly run it via `node`:
+
+```shell
 node app.js
 ```
+
+## Tests
+
+You can also run the tests via `yarn`:
+
+```shell
+yarn test
+```

app.js

@@ -1,18 +1,41 @@
-var express = require('express');
-var app = express();
-var _ = require('underscore');
-var sample = require('lodash.sample');
-var animals = [ "aardvark", "bear", "cat", "eel", "frog" ]
-var sounds  = [ "bark", "meow", "squeak", "roar", "hiss" ]
+const express = require('express');
+const _ = require('underscore');
+
+var port = process.env.PORT || 8080;
+var animals = {
+    "cat": "meow",
+    "dog": "bark",
+    "eel": "hiss",
+    "bear": "roar",
+    "frog": "croak"
+}
+
+function getAnimal() {
+  return animal = _.sample(Object.entries(animals));
+}
+
+const app = express();
 
 app.get('/', function(req, res){
-    res.writeHead(200, { 'Content-Type': 'text/html' });
-    res.write(`The ${ _.sample(animals) } went ${ _.sample(sounds) }.`);
-    res.end();
+  const [animal_name, sound] = getAnimal();
+  res.writeHead(200, { 'Content-Type': 'text/html' });
+  res.write(`George Orwell had a farm.<br />
+E-I-E-I-O<br />
+And on his farm he had a ${ animal_name }.<br />
+E-I-E-I-O<br />
+With a ${ sound }-${ sound } here.<br />
+And a ${ sound }-${ sound } there.<br />
+Here a ${ sound }, there a ${ sound }.<br />
+Everywhere a ${ sound }-${ sound }.<br />`);
+      res.end();
 });
 
-var port = process.env.PORT || 8080;
-console.log(`Launching server on http://localhost:${ port }`)
-app.listen(port);
+app.get('/api', function(req, res){
+  res.writeHead(200, { 'Content-Type': 'application/json' });
+  res.write(JSON.stringify(animals));
+  res.end();
+})
 
-module.exports = app;
+module.exports =  app.listen(port, () => {
+  console.log(`Launching server on http://localhost:${ port }`)
+});

package.json

@@ -2,18 +2,20 @@
   "name": "animal-farm-nodejs",
   "license": "MIT",
   "version": "0.0.1",
-  "engines": {
-    "node": "12.x"
-  },
   "dependencies": {
     "express": "4.x",
-    "lodash.sample": "^4.2.1",
-    "mocha": "8.2.1",
-    "supertest": "6.1.3",
     "underscore": "^1.12.0"
   },
   "scripts": {
-    "test": "./node_modules/mocha/bin/mocha --exit",
+    "test": "nyc --reporter=html mocha --exit",
     "start": "node app.js"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.11",
+    "@types/supertest": "^2.0.10",
+    "@types/underscore": "^1.10.24",
+    "mocha": "^8.2.1",
+    "nyc": "^15.1.0",
+    "supertest": "^6.1.3"
   }
 }

test/test.js

@@ -1,12 +1,34 @@
-const request = require('supertest')
 const app = require('../app.js');
+const request = require('supertest')(app);
 
 describe('GET', function(){
   it('respond with text/html', function(done){
-   request(app)
-   .get('/')
-   .set('Accept', 'text/html')
-   .expect('Content-Type', /html/)
-   .expect(200, done);
- })
-})
+    request
+    .get('/')
+    .set('Accept', 'text/html')
+    .expect('Content-Type', /html/)
+    .expect(200, done);
+  })
+
+  it('respond with George Orwell', function(done){
+    request
+    .get('/')
+    .set('Accept', 'text/html')
+    .expect(200, /George Orwell had a farm/ig, done);
+  })
+
+  it('/api responds with json', function(done){
+    request
+    .get('/api')
+    .set('Accept', 'application/json')
+    .expect('Content-Type', /json/)
+    .expect(200, done);
+  })
+
+  it('/api responds with animals object', function(done){
+    request
+    .get('/api')
+    .set('Accept', 'application/json')
+    .expect(200, {"cat":"meow","dog":"bark","eel":"hiss","bear":"roar","frog":"croak"}, done);
+  })
+})