Add endpoint to fetch user's challenges

Author: ThomasKranitsas

.eslintrc.yaml

@@ -0,0 +1 @@
+extends: standard

README.md

@@ -36,6 +36,7 @@ The following parameters can be set in config files or in env variables:
 - ES.API_VERSION: Elasticsearch API version
 - ES.ES_INDEX: Elasticsearch index name
 - ES.ES_TYPE: Elasticsearch index type
+- ES.ES_REFRESH: Elasticsearch refresh method. Default to string `true`(i.e. refresh immediately)
 - FILE_UPLOAD_SIZE_LIMIT: the file upload size limit in bytes
 - RESOURCES_API_URL: TC resources API base URL
 - GROUPS_API_URL: TC groups API base URL
@@ -65,13 +66,15 @@ The following test parameters can be set in config file or in env variables:
 - M2M_FULL_ACCESS_TOKEN: M2M full access token
 - M2M_READ_ACCESS_TOKEN: M2M read access token
 - M2M_UPDATE_ACCESS_TOKEN: M2M update (including 'delete') access token
-
-## Local Elasticsearch and DynamoDB setup
-In the `local` folder, run `docker-compose up`
+- S3_ENDPOINT: endpoint of AWS S3 API, for unit and e2e test only; default to `localhost:9000`
 
 ## AWS S3 Setup
 Go to https://console.aws.amazon.com/ and login. Choose S3 from Service folder and click `Create bucket`. Following the instruction to create S3 bucket.
 
+## Local services setup
+In the `local` folder, run `docker-compose up`
+It starts Elasticsearch, DynamoDB and S3 compatible server.
+
 ## Mock api
 For postman verification, please use the mock api under mock-api folder. It provides mock endpoint to fetch challenge resources and groups.
 You need to ensure DynamoDB configuration in `mock-api/config/default.js` is consistent with `config/default.js`
@@ -109,13 +112,16 @@ Go to `mock-api` folder and run command `npm run start` to start the mock-api li
 
 ## Running tests
 
-Before running tests, AWS S3 bucket should be created, DynamoDB tables should be created, ES index should be initialized, mock API should be started and various config parameters are properly set.
-Important notes: You need to ensure DynamoDB configuration in `mock-api/config/default.js` is consistent with `config/default.js`
+### Prepare
+- Start Local services.
+- Start Mock API.
+- Create DynamoDB tables.
+- Initialize ES index.
+- Various config parameters should be properly set.
 
 Seeding db data is not needed.
 
 ### Running unit tests
-
 To run unit tests alone
 
 ```bash
@@ -129,7 +135,6 @@ npm run test:cov
 ```
 
 ### Running integration tests
-
 To run integration tests alone
 
 ```bash

Verification.md

@@ -13,6 +13,9 @@ Run command `npm run view-data <ModelName>` to view table data, ModelName can be
 
 Login to AWS Console, S3 service, view the bucket content.
 
+## ElasticSearch Verification
+
+Run command `npm run view-es-data` to view data store in ES.
 
 ## Bus Event Verification
 

config/default.js

@@ -33,9 +33,10 @@ module.exports = {
   ES: {
     // above AWS_REGION is used if we use AWS ES
     HOST: process.env.ES_HOST || 'localhost:9200',
-    API_VERSION: process.env.ES_API_VERSION || '6.7',
+    API_VERSION: process.env.ES_API_VERSION || '6.8',
     ES_INDEX: process.env.ES_INDEX || 'challenge',
-    ES_TYPE: process.env.ES_TYPE || '_doc' // ES 6.x accepts only 1 Type per index and it's mandatory to define it
+    ES_TYPE: process.env.ES_TYPE || '_doc', // ES 6.x accepts only 1 Type per index and it's mandatory to define it
+    ES_REFRESH: process.env.ES_REFRESH || 'true'
   },
 
   // in bytes

config/test.js

@@ -6,6 +6,16 @@ services:
       - "7777:7777"
     command: "-inMemory -port 7777"
   esearch:
-    image: "docker.elastic.co/elasticsearch/elasticsearch:6.3.1"
+    image: "docker.elastic.co/elasticsearch/elasticsearch:6.8.0"
     ports:
       - "9200:9200"
+    environment:
+      - "discovery.type=single-node"
+  minio1:
+    image: minio/minio
+    ports:
+      - "9000:9000"
+    environment:
+      MINIO_ACCESS_KEY: "FAKE_ACCESS_KEY"
+      MINIO_SECRET_KEY: "FAKE_SECRET_ACCESS_KEY"
+    command: "server /data"