Merge pull request #130 from appirio-tech/dev

Support added for Specification Review for Design Challenges

Author: Dushyant Bhalgami

README.md

@@ -8,17 +8,14 @@ Microservice for supporting Topcoder Online Review platform.
 
 # Local Deployment
 
-### Start Informix instance via Docker
-
-- Set an IP for Docker by setting the environment variable `DOCKER_IP`. Recommended to set to `0.0.0.0`
-
-- Command to set the environment variable `DOCKER_IP`
+### Configure the local/run.sh
 
+- configure the docker ip
 ```
-export DOCKER_IP=0.0.0.0
+export IP=192.168.99.100
 ```
 
-- To run Informix locally, go to the `local` folder and execute the following command:
+- To run Informix and kafka locally, go to the `local` folder and execute the following command:
 
 ```
 docker-compose up
@@ -61,98 +58,36 @@ docker exec -it local_informix dbaccess tcs_catalog test_data.sql
 - Docker environment is ready to be used in our service.
 
 ### Configuration Variables
-The configuration file `service/src/main/resources/review-service.yaml` contain the necessary configuration to run the microservice locally. Below configuration variables need to be set using environment variables.
-
-|Name	               | Description                               |
-|--------------------|:-----------------------------------------:|
-|AUTH_DOMAIN         | Authentication domain of JWT, Dont set unless you have valid tokens with given AUTH_DOMAIN, Defaulted to 'topcoder-dev.com' |
-|IP                  | The IP of your docker container           |
-|OLTP_USER           | The Informix OLTP user                    |
-|OLTP_PW             | The Informix OLTP user password           |
-|OLTP_URL            | The JDBC URL of Informix OLTP database    |
-|DW_USER             | The Informix DW user                      |
-|DW_PW               | The Informix DW user password             |
-|DW_URL              | The JDBC URL of Informix DW database      |
-|TC_JWT_KEY          | Secret used in JWT Service, Used for signature verification as well |
-
-In Linux, Set the environment variables as
+The configuration file `service/src/main/resources/review-service.yaml` contain the necessary configuration to get the M2M token. The dummy values should be replaced with real ones
 
 ```
-export AUTH_DOMAIN=...
-export IP=...
-export OLTP_USER=...
-export OLTP_PW=...
-export OLTP_URL=...
-export DW_USER=...
-export DW_PW=...
-export DW_URL=...
-```
-
-### Working credentials for local deployment
-
-```
-export IP=0.0.0.0
-export OLTP_USER=informix
-export OLTP_PW=1nf0rm1x
-export OLTP_URL=jdbc:informix-sqli://$IP:2021/tcs_catalog:INFORMIXSERVER=informixoltp_tcp;IFX_LOCK_MODE_WAIT=5;OPTCOMPIND=0;STMT_CACHE=1
-export DW_USER=informix
-export DW_PW=1nf0rm1x
-export DW_URL=jdbc:informix-sqli://$IP:2021/common_dw:INFORMIXSERVER=informixoltp_tcp;IFX_LOCK_MODE_WAIT=5;OPTCOMPIND=0;STMT_CACHE=1
-export TC_JWT_KEY=secret
-```
-
-### Set up Local Maven repository for Appirio Maven
-
-- Since maven.appirio.net is not accessible, We need to set up a local maven repository with the zip file `temp-maven-repo-master.zip`
-
-- Unzip the contents to any of the directory in your System. **In Linux, the directory should not be a mounted directory like pen drive, hard disk, etc..**
-
-- Open `pom.xml` in `service` directory and replace the `<url>` of Local repository with `absolute path of the unzipped file`. E.g. If you have unzipped the files to `/home/user/temp-maven-repo-master`, then POM entry will look like
-
-```
-<repository>
-	<id>1_temp_appirio_maven_repo</id>
-	<name>Appirio Maven Local Repository</name>
-	<url>file:///home/user/temp-maven-repo-master</url>
-</repository>
+m2mAuthConfig:
+  clientId: "${M2M_AUTH_CLIENT_ID:-dummy}"
+  clientSecret: "${M2M_AUTH_CLIENT_SECRET:-dummy}"
+  audience: "${M2M_AUTH_AUDIENCE:-dummy}"
+  m2mAuthDomain: "${M2M_AUTH_DOMAIN:-topcoder-dev.auth0.com}"
+  tokenExpireTimeInMinutes: "${M2M_AUTH_TOKEN_EXPIRE_TIME_IN_MINS:-60}"
+  auth0ProxyServerUrl: "${M2M_AUTH_PROXY_SEREVR_URL:-dummy}"
 ```
 
 ### Build Microservice
 
 In the `service` folder of this project, run the following command to build the service.
 
 ```
-mvn clean package
+mvn clean package -DskipTests
 ```
 
 ### Start Microservice
-
-- Before starting please ensure that all environment variables listed above is set properly and docker is up and running.
-
-- Then start the service using the following command in the 'service' folder:
-
+Enter the local directory and run run.sh
 ```
-java -jar ./target/review-microservice-*.jar server ./src/main/resources/review-service.yaml
+cd local
+./run.sh
 ```
 
 ### Verification
 
-Though there are many endpoints, For starters, it's sufficient to verify two end points.
-
-- Endpoint `/v3/scorecards` doesn't require Authentication
-
-- Endpoint `/v3/reviews` require Authentication
-
-Use the postman collection in `Postman` directory to verify the end points.
-
-- **Ensure to import the postman environment before testing the endpoints**
-
-- Request `Get list of all Scorecards` returns all scorecard templates present in the database
-
-**Loaded test data has details for 3 submissions for a single competition reviewed by 2 reviewers**
-
-- Request `Get list of all reviews Reviewer1` return the reviews done by Reviewer 1.
+Import postman/review-microservice.postman_collection.json and postman/review-microservice.postman_environment.json, verify each endpoint. 
 
-- Request `Get list of all reviews Reviewer2` return the reviews done by Reviewer 2.
+- **Ensure to select the postman environment before testing the endpoints**
 
- **Note: Some of the fields in returned output will be NULL, It's expected. That's how the internal controllers and services are written**

local/run.sh

@@ -8,5 +8,6 @@ export DW_URL=jdbc:informix-sqli://$IP:2021/common_dw:INFORMIXSERVER=informixolt
 export TC_JWT_KEY=secret
 export GROUP_SERVICE_ENDPOINT="http://$IP:8080/v3/groups?memberId=%s&membershipType=User-Group"
 export PARENT_GROUP_SERVICE_ENDPOINT="http://$IP:8080/v3/groups/%s/getParentGroup?oneLevel=false"
+export ZOOKEEPER_HOSTS_LIST=$IP
 
 java -jar ../service/target/review-microservice-*.jar server ../service/src/main/resources/review-service.yaml