Update dev deps; eslint and cs fixes; docker update; node update to v12; cs hooks; k8s resource declaration and probes

Author: tiagojsag

.editorconfig

@@ -16,7 +16,7 @@ charset = utf-8
 # 2 space indentation
 [**/*.js]
 indent_style = space
-indent_size = 2
+indent_size = 4
 
 [*.yml]
 indent_style = space

.eslintrc.yml

@@ -1,32 +1,39 @@
 ---
-extends: airbnb
+extends: [airbnb, plugin:mocha/recommended]
 env:
   node: true
   es6: true
-parser: babel-eslint
 parserOptions:
   sourceType: module
-  ecmaVersion: 6
+  ecmaVersion: 2018
+plugins: [mocha]
 globals:
   describe: true
   it: true
   before: true
   after: true
+  beforeEach: true
+  afterEach: true
 rules:
   max-len: [1, 200, 2, {"ignoreUrls":true}]
   curly: [2, "multi-line"]
   comma-dangle: [0, always-multiline]
-  no-underscore-dangle: 0
+  no-plusplus: 0
   eqeqeq: [2, "allow-null"]
   global-require: 0
   no-shadow: 1
   no-param-reassign: [2, { "props": false }]
-  indent: [2, 4]
+  indent: [2, 4, { "SwitchCase": 1 }]
   padded-blocks: [2, { "switches": "always", "classes": "always" }]
   quotes:
     - 2
     - single
     - allowTemplateLiterals: true
+  no-underscore-dangle: ["error", { "allow": ["_id"] }]
+  import/no-extraneous-dependencies: ["error", { devDependencies: ['app/test/**']}]
+  no-await-in-loop: off
+  mocha/no-mocha-arrows: [0]
+  mocha/no-hooks-for-single-case: [0]
 settings:
   import/resolver:
     node:

.travis.yml

@@ -0,0 +1,34 @@
+language: node_js
+services:
+  - mongodb
+  - redis
+node_js:
+  - "12"
+cache:
+  directories:
+  - "node_modules"
+env:
+  global:
+    - CC_TEST_REPORTER_ID=dabdd92208e41ebbec13b01f5e943a0dcf7ec40f4a98d6d0a8f811e8cca9b443
+    - NODE_ENV=test
+    - PORT=5037
+    - API_VERSION=v1
+    - CT_REGISTER_MODE=auto
+    - LOCAL_URL=http://127.0.0.1:3001
+    - CT_URL=http://127.0.0.1:9000
+    - MONGO_PORT_27017_TCP_ADDR=127.0.0.1
+    - CT_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Im1pY3Jvc2VydmljZSIsImNyZWF0ZWRBdCI6IjIwMTYtMDktMTQifQ.IRCIRm1nfIQTfda_Wb6Pg-341zhV8soAgzw7dd5HxxQ
+    - API_GATEWAY_URL=http://127.0.0.1:9000
+    - API_GATEWAY_EXTERNAL_URL=http://127.0.0.1:9000
+    - API_GATEWAY_QUEUE_URL=redis://127.0.0.1:6379
+    - API_GATEWAY_QUEUE_NAME=mail
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - yarn test
+  - yarn run coverage
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

Dockerfile

@@ -1,5 +1,5 @@
-FROM node:8.1-alpine
-MAINTAINER raul.requero@vizzuality.com
+FROM node:12-alpine
+MAINTAINER info@vizzuality.com
 
 ENV NAME fw-teams
 ENV USER fw-teams
@@ -9,19 +9,20 @@ RUN apk update && apk upgrade && \
 
 RUN addgroup $USER && adduser -s /bin/bash -D -G $USER $USER
 
-RUN npm install --unsafe-perm -g grunt-cli bunyan
+RUN yarn global add grunt-cli bunyan
 
 RUN mkdir -p /opt/$NAME
 COPY package.json /opt/$NAME/package.json
-RUN cd /opt/$NAME && npm install
+COPY yarn.lock /opt/$NAME/yarn.lock
+RUN cd /opt/$NAME && yarn
 
 COPY entrypoint.sh /opt/$NAME/entrypoint.sh
 COPY config /opt/$NAME/config
 
 WORKDIR /opt/$NAME
 
 COPY ./app /opt/$NAME/app
-RUN chown $USER:$USER /opt/$NAME
+RUN chown -R $USER:$USER /opt/$NAME
 
 # Tell Docker we are going to use this ports
 EXPOSE 3035

README.md

@@ -1,34 +1,82 @@
-# Node Skeleton Microservice
+# FW teams Microservice
 
 
 This repository is the node skeleton microservice to create node microservice for WRI API
 
-1. [Getting Started](#getting-started)
+## Dependencies
 
-## Getting Started
+You will need [Control Tower](https://github.com/control-tower/control-tower) up and running - either natively or with Docker. Refer to the project's README for information on how to set it up.
 
-### OS X
+The FW teams microservice is built using [Node.js](https://nodejs.org/en/), and can be executed either natively or using Docker, each of which has its own set of requirements.
 
-**First, make sure that you have the [API gateway running
-locally](https://github.com/control-tower/control-tower).**
+Native execution requires:
+- [Node.js](https://nodejs.org/en/)
+- [MongoDB](https://www.mongodb.com/)
 
-We're using Docker which, luckily for you, means that getting the
-application running locally should be fairly painless. First, make sure
-that you have [Docker Compose](https://docs.docker.com/compose/install/)
-installed on your machine.
+Execution using Docker requires:
+- [Docker](https://www.docker.com/)
+- [Docker Compose](https://docs.docker.com/compose/)
+
+Dependencies on other Microservices:
+- [GFW User](https://github.com/gfw-api/gfw-user-api/)
+
+## Getting started
+
+Start by cloning the repository from github to your execution environment
+
+```
+git clone https://github.com/gfw-api/fw-teams.git && cd fw-team
+```
+
+After that, follow one of the instructions below:
+
+### Using native execution
+
+1 - Set up your environment variables. See `dev.env.sample` for a list of variables you should set, which are described in detail in [this section](#environment-variables) of the documentation. Native execution will NOT load the `dev.env` file content, so you need to use another way to define those values
+
+2 - Install node dependencies using yarn:
+```
+yarn
+```
+
+3 - Start the application server:
+```
+yarn start
+```
+
+The endpoints provided by this microservice should now be available through Control Tower's URL.
+
+### Using Docker
+
+1 - Create and complete your `dev.env` file with your configuration. The meaning of the variables is available in this [section](#configuration-environment-variables). You can find an example `dev.env.sample` file in the project root.
+
+2 - Execute the following command to run Control tower:
 
 ```
-git clone https://github.com/gfw-api/fw-teams
-cd fw-teams
 ./team.sh develop
-./team.sh test
-```text
+```
+
+The endpoints provided by this microservice should now be available through Control Tower's URL.
+
+## Testing
+
+There are two ways to run the included tests:
 
-You can now access the microservice through the CT gateway.
+### Using native execution
 
+Follow the instruction above for setting up the runtime environment for native execution, then run:
+```
+yarn test
 ```
 
-### Configuration
+### Using Docker
+
+Follow the instruction above for setting up the runtime environment for Docker execution, then run:
+```
+./team.sh test
+```
+
+## Configuration
 
 It is necessary to define these environment variables:
 
@@ -38,9 +86,10 @@ It is necessary to define these environment variables:
 * API_GATEWAY_URI => Gateway Service API URL
 * API_GATEWAY_EXTERNAL_URI
 * API_GATEWAY_QUEUE_URL => Url of async queue
-* API_GATEWAY_QUEUE_PROVIDER => redis (only support redis)
 * API_GATEWAY_QUEUE_NAME => mail
 
+You can optionally set other variables, see [this file](config/custom-environment-variables.json) for an extended list.
+
 ## Quick Overview
 
 ### Teams Entity

app/Gruntfile.js

@@ -1,7 +1,7 @@
-
 module.exports = (grunt) => {
 
     grunt.file.setBase('..');
+    // eslint-disable-next-line import/no-extraneous-dependencies
     require('load-grunt-tasks')(grunt);
 
     grunt.initConfig({
@@ -14,14 +14,6 @@ module.exports = (grunt) => {
                     port: process.env.PORT,
                     output: 'started'
                 }
-            },
-            test: {
-                options: {
-                    script: 'app/index.js',
-                    node_env: 'test',
-                    port: 5000,
-                    output: 'started'
-                }
             }
         },
 
@@ -30,6 +22,7 @@ module.exports = (grunt) => {
                 options: {
                     reporter: 'spec',
                     quiet: false,
+                    timeout: 10000,
                     clearRequireCache: true,
                 },
                 src: ['app/test/e2e/**/*.spec.js']
@@ -59,15 +52,33 @@ module.exports = (grunt) => {
                 }
             },
 
+        },
+
+        nyc: {
+            cover: {
+                options: {
+                    include: ['app/src/**'],
+                    exclude: '*.test.*',
+                    reporter: ['lcov', 'text-summary'],
+                    reportDir: 'coverage',
+                    all: true
+                },
+                cmd: false,
+                args: ['grunt', '--gruntfile', 'app/Gruntfile.js', 'mochaTest:e2e']
+            }
         }
     });
 
-    grunt.registerTask('e2eTest', ['express:test', 'mochaTest:e2e']);
+    grunt.registerTask('e2eTest', ['mochaTest:e2e']);
+
+    grunt.registerTask('e2eTestCoverage', ['mocha_nyc:coverage']);
 
     grunt.registerTask('e2eTest-watch', ['watch:e2eTest']);
 
     grunt.registerTask('serve', ['express:dev', 'watch']);
 
     grunt.registerTask('default', 'serve');
 
+    grunt.loadNpmTasks('grunt-simple-nyc');
+
 };

app/src/app.js

@@ -4,9 +4,12 @@ const koaLogger = require('koa-logger');
 const config = require('config');
 const loader = require('loader');
 const mongoose = require('mongoose');
+const koaSimpleHealthCheck = require('koa-simple-healthcheck');
+
 mongoose.Promise = Promise;
 const ctRegisterMicroservice = require('ct-register-microservice-node');
 const ErrorSerializer = require('serializers/error.serializer');
+
 const mongoUri = process.env.MONGO_URI || `mongodb://${config.get('mongodb.host')}:${config.get('mongodb.port')}/${config.get('mongodb.database')}`;
 const validate = require('koa-validate');
 
@@ -39,11 +42,16 @@ app.use(async (ctx, next) => {
         try {
             error = JSON.parse(inErr);
         } catch (e) {
-            logger.error('Error parse');
+            logger.debug('Could not parse error message - is it JSON?: ', inErr);
             error = inErr;
         }
         ctx.status = error.status || ctx.status || 500;
-        logger.error(error);
+        if (ctx.status >= 500) {
+            logger.error(error);
+        } else {
+            logger.info(error);
+        }
+
         ctx.body = ErrorSerializer.serializeError(ctx.status, error.message);
         if (process.env.NODE_ENV === 'prod' && ctx.status === 500) {
             ctx.body = 'Unexpected error';
@@ -53,6 +61,7 @@ app.use(async (ctx, next) => {
 });
 
 app.use(koaLogger());
+app.use(koaSimpleHealthCheck());
 
 loader.loadRoutes(app);
 
@@ -69,7 +78,8 @@ const instance = app.listen(process.env.PORT, () => {
         url: process.env.LOCAL_URL,
         token: process.env.CT_TOKEN,
         active: true,
-    }).then(() => {}, (error) => {
+    }).then(() => {
+    }, (error) => {
         logger.error(error);
         process.exit(1);
     });

app/src/loader.js

@@ -1,4 +1,6 @@
+/* eslint-disable import/no-dynamic-require */
 const fs = require('fs');
+
 const routersPath = `${__dirname}/routes`;
 const logger = require('logger');
 const mount = require('koa-mount');

app/src/models/team.model.js

@@ -1,6 +1,7 @@
-'use strict';
+
 const mongoose = require('mongoose');
-const Schema = mongoose.Schema;
+
+const { Schema } = mongoose;
 
 const Team = new Schema({
     name: { type: String, required: false, trim: true },