Dockerize updates

Author: jmgasper

.dockerignore

@@ -0,0 +1,3 @@
+node_modules
+.git
+.gitignore

Dockerfile

@@ -0,0 +1,17 @@
+# Use the base image with Node.js 8.12
+FROM node:8.12
+
+# Set working directory for future use
+WORKDIR /topcoder-x-ui
+
+COPY package.json .
+COPY package-lock.json .
+
+# Install the dependencies from package.json
+RUN npm install
+
+COPY . .
+
+RUN npm run build
+
+ENTRYPOINT npm start

build.sh

@@ -0,0 +1,84 @@
+#!/bin/bash
+set -eo pipefail
+
+# This script expects 2 arguments:
+#   $BUILD_TYPE: The build type, like "local", "dev", "test", "prod". Required.
+#   $ENV_FOLDER: The folder containing env files. Optional.
+#
+# If $ENV_FOLDER is not present, then environment values will be used;
+# otherwise the topcoder-x-ui.env.default and topcoder-x-ui.env.$BUILD_TYPE
+# files within $ENV_FOLDER will be used.
+
+BUILD_TYPE=$1
+ENV_FOLDER="$2"
+APP="topcoder-x-ui"
+
+if [ -z "$BUILD_TYPE" ]; then
+  echo "Must provide the build type to build"
+  exit 1
+fi
+
+ENV_FILE=".env.$BUILD_TYPE.tmp"
+DEFAULT_FILE=".env.default.tmp"
+rm -f "$ENV_FILE"
+rm -f "$DEFAULT_FILE"
+
+if [ -z "$ENV_FOLDER" ]; then
+  # Use environment values
+  touch "$ENV_FILE"
+  touch "$DEFAULT_FILE"
+
+  # Loop the environment values, find the ones start with DEFAULT_ and $BUILD_TYPE_
+  # Assuming given $BUILD_TYPE is "prod" and environment has following values:
+  #   DEFAULT_VERSION=1.0
+  #   DEFAULT_SECRET=111111
+  #   PROD_PORT=80
+  #   PROD_SECRET=654321
+  #   LOCAL_PORT=8080
+  #   LOCAL_SECRET=123456
+  # Then the generated .env file will have following content:
+  #   VERSION=1.0
+  #   PORT=80
+  #   SECRET=654321
+  BUILD_TYPE_UPPER=`echo $BUILD_TYPE | awk '{print toupper($0)}'`
+  for var in $(compgen -e); do
+    if [[ "$var" =~ ^DEFAULT\_.* ]]; then
+      tripVar=${var#DEFAULT_}
+      echo $tripVar=${!var} >> "$DEFAULT_FILE"
+    fi
+    if [[ "$var" =~ ^$BUILD_TYPE_UPPER\_.* ]]; then
+      tripVar=${var#"$BUILD_TYPE_UPPER"_}
+      echo $tripVar=${!var} >> "$ENV_FILE"
+    fi
+  done
+
+else
+  if [ ! -d "$ENV_FOLDER" ]; then
+    echo "$ENV_FOLDER does not exist"
+    exit 1
+  fi
+
+  P_DEFAULT_FILE="$ENV_FOLDER/$APP.env.default"
+  P_ENV_FILE="$ENV_FOLDER/$APP.env.$BUILD_TYPE"
+
+  if [ ! -f "$P_DEFAULT_FILE" ]; then
+    echo "$P_DEFAULT_FILE does not exist"
+    exit 1
+  fi
+  cp -f "$P_DEFAULT_FILE" "$DEFAULT_FILE"
+
+  if [ ! -f "$P_ENV_FILE" ]; then
+      echo "Will only use default env since $P_ENV_FILE does not exist"
+      touch "$ENV_FILE"
+  else
+      cp -f "$P_ENV_FILE" "$ENV_FILE"
+  fi
+fi
+
+awk -F= '!a[$1]++' "$ENV_FILE" "$DEFAULT_FILE" > .env
+
+rm -f "$ENV_FILE"
+rm -f "$DEFAULT_FILE"
+
+# Build docker image
+docker build -t $APP:$BUILD_TYPE -f Dockerfile .

configuration.md

@@ -16,15 +16,16 @@ The following config parameters are supported, they are defined in `src/config.j
 | WEBSITE                                | used as base to construct various URLs     | http://topcoderx.topcoder-dev.com/ |
 | GITLAB_API_BASE_URL                    | The Gitlab API base URL                    | https://gitlab.com|
 | MONGODB_URI                            | The MongoDB URI.  This needs to be the same MongoDB used by topcoder-x-receiver, topcoder-x-processor, and topcoder-x-site                           | mongodb://127.0.0.1:27017/topcoderx |
-|TOPIC  | The Kafka topic where events are published.  This must be the same as the configured value for topcoder-x-processor| |
+|TOPIC  | The Kafka topic where events are published.  This must be the same as the configured value for topcoder-x-processor| tc-x-events |
 |KAFKA_OPTIONS | Kafka connection options| |
 |KAFKA_HOST | The Kafka host to connect to| localhost:9092 |
 |KAFKA_CLIENT_CERT | The Kafka SSL certificate to use when connecting| Read from kafka_client.cer file, but this can be set as a string like it is on Heroku |
 |KAFKA_CLIENT_CERT_KEY | The Kafka SSL certificate key to use when connecting| Read from kafka_client.key file, but this can be set as a string like it is on Heroku|
+|KAFKA_CLIENT_CERT_KEY_PASS | The passphrase of certificate key | |
 | HOOK_BASE_URL            | The base URL of the topcoder-x-receiver, used when adding webhooks automatically to repositories | |
 | TOPCODER_ENV | The topcoder environment to use, can support 'dev' or 'prod' | 'dev'                     |
-|LABELS| Labels we are going to add to the repository in the form of array of object with `name` and `color` property. Color should be hex code without hash||
-|ALLOWED_TOPCODER_ROLES| The allowed Topcoder role to use Topcoder X app| see configuration |
+|LABELS| Labels we are going to add to the repository in the form of array of object with `name` and `color` property. Color should be hex code without hash|See configuration. Note when setup by environment, it must be a valid JSON string format.|
+|ALLOWED_TOPCODER_ROLES| The allowed Topcoder role to use Topcoder X app| See configuration. Note when setup by environment, it must be a valid JSON string format. |
 |COPILOT_ROLE| The role to identify copilot|'copilot'|
 |HELP_LINK| The link for help| 'https://github.com/topcoder-platform/topcoder-x-ui/wiki'|
 

package-lock.json

@@ -49,6 +49,7 @@
         "core-js": "^2.4.1",
         "cors": "^2.8.4",
         "debug": "~2.6.3",
+        "dotenv": "^6.0.0",
         "express": "^4.15.4",
         "express-jwt": "^5.3.0",
         "express-session": "^1.15.5",

package.json

@@ -1,6 +1,7 @@
 /*
  * Copyright (c) 2017 TopCoder, Inc. All rights reserved.
  */
+require('dotenv').config();
 const fs = require('fs');
 /**
  * Define config.
@@ -30,13 +31,13 @@ module.exports = {
     ssl: {
       cert: process.env.KAFKA_CLIENT_CERT || fs.readFileSync('./kafka_client.cer'), // eslint-disable-line no-sync
       key: process.env.KAFKA_CLIENT_CERT_KEY || fs.readFileSync('./kafka_client.key'), // eslint-disable-line no-sync
-      passphrase: 'secret', // NOTE:* This configuration specifies the private key passphrase used while creating it.
+      passphrase: process.env.KAFKA_CLIENT_CERT_KEY_PASS || 'secret', // NOTE:* This configuration specifies the private key passphrase used while creating it.
     },
   },
   HOOK_BASE_URL: process.env.HOOK_BASE_URL || 'http://topcoderx.topcoder-dev.com',
   TOPCODER_ENV: process.env.TOPCODER_ENV || 'dev',
-  LABELS: process.env.LABELS || [{ name: 'tcx_OpenForPickup', color: '428BCA' }, { name: 'tcx_Assigned', color: '004E00' }, { name: 'tcx_ReadyForReview', color: 'D1D100' }, { name: 'tcx_Paid', color: '7F8C8D' }, { name: 'tcx_Feedback', color: 'FF0000' }, { name: 'tcx_FixAccepted', color: '69D100' }],
-  ALLOWED_TOPCODER_ROLES: process.env.ALLOWED_TOPCODER_ROLES || ['administrator', 'admin', 'connect manager', 'connect admin', 'copilot', 'connect copilot'],
+  LABELS: process.env.LABELS ? JSON.parse(process.env.LABELS) : [{ name: 'tcx_OpenForPickup', color: '428BCA' }, { name: 'tcx_Assigned', color: '004E00' }, { name: 'tcx_ReadyForReview', color: 'D1D100' }, { name: 'tcx_Paid', color: '7F8C8D' }, { name: 'tcx_Feedback', color: 'FF0000' }, { name: 'tcx_FixAccepted', color: '69D100' }],
+  ALLOWED_TOPCODER_ROLES: process.env.ALLOWED_TOPCODER_ROLES ? JSON.parse(process.env.ALLOWED_TOPCODER_ROLES) : ['administrator', 'admin', 'connect manager', 'connect admin', 'copilot', 'connect copilot'],
   COPILOT_ROLE: process.env.COPILOT_ROLE || 'copilot',
   HELP_LINK: process.env.HELP_LINK || 'https://github.com/topcoder-platform/topcoder-x-ui/wiki',
 };