Merge branch 'dev' of https://github.com/topcoder-platform/tc-project-service into dev

Author: Parth Shah

.babelrc

@@ -1,3 +1,9 @@
 {
-  "presets": ["es2015"]
+  "presets": ["es2015"],
+  "plugins": [
+    ["transform-runtime", {
+      "polyfill": false,
+      "regenerator": true
+    }]
+  ]
 }

README.md

@@ -1,4 +1,4 @@
-#Topcoder Projects Service
+# Topcoder Projects Service
 
 Microservice to manage CRUD operations for all things Projects.
 
@@ -21,19 +21,42 @@ Copy config/sample.local.js as config/local.js, update the properties and accord
 Once you start your PostgreSQL database through docker, it will create a projectsDB.
 *To create tables - note this will drop tables if they already exist*
 ```
-NODE_ENV=local npm run sync
+NODE_ENV=development npm run sync
 ```
 
 #### Redis
 Docker compose command will start a local redis instance as well. You should be able to connect to this instance using url `$(docker-machine ip):6379`
 
 #### Elasticsearch
 Docker compose includes elasticsearch instance as well. It will open ports 9200 & 9300 (kibana)
-When creating the projects index, use the mapping provided in the local folder 'projects-es-mappings.json'
-`curl -XPUT --data @./local/projects-es-mappings.json http://dockerhost:9200/projects/`
+
+#### Sync indices and mappings
+
+There is a helper script to sync the indices and mappings with the elasticsearch.
+
+Run `npm run elasticsearch:sync` from the root of project to execute the script.
+
+> NOTE: This will first clear all the indices and than recreate them. So use with caution.
 
 **NOTE**: In production these dependencies / services are hosted & managed outside tc-projects-service.
 
+### Test
+
+Each of the individual modules/services are unit tested.
+
+To run unit tests run `npm run test` from root of project.
+
+While tests are being executed the `NODE_ENV` environment variable has a value `test` and `config/test.js` configuration is loaded. The default test configuration refers to `projectsdb_test` postgres database. So make sure that this database exists before running the tests. Since we are using docker-compose for local deployment change `local/docker-compose.yaml` postgres service with updated database name and re-create the containers.
+
+```
+// stop already executing containers if any
+docker-compose stop -t 1
+// clear the containers
+docker-compose rm -f
+// re-run the services with build flag
+docker-compose up --build
+```
+
 #### JWT Authentication
 Authentication is handled via Authorization (Bearer) token header field. Token is a JWT token. Here is a sample token that is valid for a very long time for a user with administrator role.
 ```

circle.yml

@@ -1,7 +1,7 @@
 machine:
 
   node:
-    version: v5.7.0
+    version: v6.9.4
   environment:
     DB_MASTER_URL: postgres://ubuntu:@127.0.0.1:5432/circle_test
     #RABBITMQ_URL: amqp://localhost:5672
@@ -15,6 +15,12 @@ dependencies:
     - pip install awsebcli
   override:
     - npm install
+    - wget https://download.elastic.co/elasticsearch/release/org/elasticsearch/distribution/tar/elasticsearch/2.3.5/elasticsearch-2.3.5.tar.gz
+    - tar -xvf elasticsearch-2.3.5.tar.gz
+    - elasticsearch-2.3.5/bin/elasticsearch: {background: true}
+    # Make sure that Elasticsearch is up before running tests:
+    - sleep 10 && wget --waitretry=5 --retry-connrefused -v http://127.0.0.1:9200/
+
 
 deployment:
   development:

config/custom-environment-variables.json

@@ -5,7 +5,12 @@
   "version": "APP_VERSION",
   "captureLogs": "CAPTURE_LOGS",
   "logentriesToken": "LOGENTRIES_TOKEN",
-  "esUrl": "PROJECTS_ES_URL",
+  "elasticsearchConfig": {
+    "host": "PROJECTS_ES_URL",
+    "apiVersion": "2.3",
+    "indexName": "PROJECTS_ES_INDEX_NAME",
+    "docType": "projectV4"
+  },
   "rabbitmqURL": "RABBITMQ_URL",
   "directProjectServiceEndpoint": "DIRECT_PROJECT_SERVICE_ENDPOINT",
   "directProjectServiceTimeout": "DIRECT_PROJECT_SERVICE_TIMEOUt",

config/default.json

@@ -5,7 +5,6 @@
   "captureLogs": "false",
   "logentriesToken": "",
   "rabbitmqURL": "",
-  "esUrl": "",
   "pubsubQueueName": "project.service",
   "pubsubExchangeName": "projects",
   "fileServiceEndpoint": "",
@@ -17,6 +16,12 @@
   "attachmentsS3Bucket": "topcoder-prod-media",
   "projectAttachmentPathPrefix": "projects",
   "projectAttachmentPathSuffix": "attachments",
+  "elasticsearchConfig": {
+    "host": "",
+    "apiVersion": "2.3",
+    "indexName": "projects",
+    "docType": "projectV4"
+  },
   "systemUserClientId": "",
   "systemUserClientSecret": "",
   "userServiceUrl": "",

config/qa.json

@@ -13,8 +13,8 @@ if (process.env.NODE_ENV === 'test') {
     fileServiceEndpoint: 'https://api.topcoder-dev.com/v3/files/',
     topicServiceEndpoint: 'https://api.topcoder-dev.com/v4/topics/',
     directProjectServiceEndpoint: 'https://api.topcoder-dev.com/v3/direct',
-    userServiceUrl: 'https://api.topcoder-dev.com/v3/users',
     connectProjectsUrl: 'https://connect.topcoder-dev.com/projects/',
+    memberServiceEndpoint: 'http://dockerhost:3001/members',
     salesforceLead: {
       webToLeadUrl: 'https://www.salesforce.com/servlet/servlet.WebToLead?encoding=UTF-8',
       orgId: '00D2C0000000dO6',
@@ -29,6 +29,13 @@ if (process.env.NODE_ENV === 'test') {
       minPoolSize: 4,
       idleTimeout: 1000,
     },
+    elasticsearchConfig: {
+      host: 'dockerhost:9200',
+      // target elasticsearch 2.3 version
+      apiVersion: '2.3',
+      indexName: 'projects',
+      docType: 'projectV4'
+    },
   };
 }
 module.exports = config;

config/sample.local.js

@@ -3,7 +3,12 @@
     "logLevel": "debug",
     "captureLogs": "false",
     "logentriesToken": "",
-    "esUrl": "//localhost:9200",
+    "elasticsearchConfig": {
+      "host": "http://localhost:9200",
+      "apiVersion": "2.3",
+      "indexName": "projects_test",
+      "docType": "projectV4"
+    },
     "rabbitmqUrl": "amqp://localhost:5672",
     "dbConfig": {
         "masterUrl": "postgres://coder:mysecretpassword@localhost:5432/projectsdb_test",

config/test.json

@@ -1,22 +1,25 @@
-postgres:
-  image: "postgres:9.5"
-  ports:
-    - "5432:5432"
-  environment:
-    - POSTGRES_PASSWORD=mysecretpassword
-    - POSTGRES_USER=coder
-    - POSTGRES_DB=projectsdb
-#elasticsearch:
-#  image: "elasticsearch:2"
-#  ports:
-#    - "9200:9200"
-#    - "9300:9300"
-redis:
-  image: redis:2.8
-  ports:
-    - "6379:6379"
-rabbitmq:
-  image: rabbitmq:3
-  restart: always
-  ports:
-  - 5672:5672
+version: "2"
+services:
+  jsonserver:
+    build: "mock-services"
+    ports:
+      - "3001:3001"
+  db:
+    image: "postgres:9.5"
+    ports:
+      - "5432:5432"
+    environment:
+      - POSTGRES_PASSWORD=mysecretpassword
+      - POSTGRES_USER=coder
+      - POSTGRES_DB=projectsdb
+  esearch:
+    image: "elasticsearch:2.3"
+    ports:
+      - "9200:9200"
+      - "9300:9300"
+  queue:
+    image: "rabbitmq:3-management"
+    restart: always
+    ports:
+      - "5672:5672"
+      - "15672:15672"

local/docker-compose.yml

@@ -0,0 +1,27 @@
+{
+  "extends": "airbnb-base",
+  "env": {
+    "browser": false,
+    "node": true,
+    "es6": true,
+    "mocha": true
+  },
+  "rules": {
+    "import/no-unresolved": 0,
+    "no-param-reassign": 0,
+    "max-len": ["error", { "ignoreComments": true, "code": 120 }],
+    "valid-jsdoc": ["error", {
+      "requireReturn": true,
+      "requireReturnType": true,
+      "requireParamDescription": true,
+      "requireReturnDescription": true
+    }],
+    "require-jsdoc": ["error", {
+        "require": {
+            "FunctionDeclaration": true,
+            "MethodDefinition": true,
+            "ClassDeclaration": true
+        }
+    }]
+  }
+}