Retrieve additional information about the scan and store results in S3

Author: callmekatootie

README.md

@@ -35,8 +35,31 @@ The following parameters can be set in config files or in env variables:
 - LOG_LEVEL: the log level
 - PORT: the server port
 - SUBMISSION_API_URL: Submission API URL
+
+- SONARQUBE_HOST: SonarQube host. Default: http://localhost:9000
+- SONARQUBE_TOKEN: SonarQube access token. Optional parameter, must be set when ACL is configured for the project.
+More details about access tokens - https://docs.sonarqube.org/latest/user-guide/user-token/
+
+- AWS_S3_BUCKET: AWS S3 Bucket name. Bucket must be already exist
+- AWS_S3_PREFIX: AWS S3 Key prefix. Optional parameter. Must end with slash
+
 - All variables starting with prefix `AUTH0` corresponds to Auth0 related credentials
 
+### AWS Credentials
+* Please refer to following [documentation](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/getting-your-credentials.html) in order to get AWS credentials.
+* Depending on your Operating System, create AWS credentials file in the path listed below
+```
+Linux, Unix, and macOS users: ~/.aws/credentials
+Windows users: C:\Users\USER_NAME\.aws\credentials
+```
+Credentials file should look like below
+```
+[default]
+aws_access_key_id = SOME_ACCESS_KEY_ID
+aws_secret_access_key = SOME_SECRET_ACCESS_KEY
+```
+* Credentials can be set in environment variables. [Documentation](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-environment.html)
+
 ## Local deployment
 
 1. From the project root directory, run the following command to install the dependencies
@@ -75,6 +98,12 @@ To run unit tests
 npm run test
 ```
 
+## Code coverage
+
+```
+npm run coverage
+```
+
 ## Local Deployment with Docker
 
 To run the Submission quality processor using docker, follow the below steps
@@ -83,7 +112,7 @@ To run the Submission quality processor using docker, follow the below steps
 
 2. Rename the file `sample.api.env` to `api.env`
 
-3. Set the required Auth0 and Submission API URL in the file `api.env`
+3. Set the required Auth0, Submission API URL, SonarQube config and AWS S3 configuration in the file `api.env`
 
 4. Once that is done, run the following command
 

config/default.js

@@ -8,7 +8,13 @@ module.exports = {
 
   SUBMISSION_API_URL: process.env.SUBMISSION_API_URL || 'https://api.topcoder-dev.com/v5',
 
-  AUTH0_URL: process.env.AUTH0_URL, // Auth0 credentials for Leaderboard Service
+  SONARQUBE_HOST: process.env.SONARQUBE_HOST || 'http://localhost:9000',
+  SONARQUBE_TOKEN: process.env.SONARQUBE_TOKEN,
+
+  AWS_S3_BUCKET: process.env.AWS_S3_BUCKET,
+  AWS_S3_PREFIX: process.env.AWS_S3_PREFIX || '',
+
+  AUTH0_URL: process.env.AUTH0_URL,
   AUTH0_AUDIENCE: process.env.AUTH0_AUDIENCE,
   TOKEN_CACHE_TIME: process.env.TOKEN_CACHE_TIME,
   AUTH0_CLIENT_ID: process.env.AUTH0_CLIENT_ID,

config/test.js

@@ -3,5 +3,6 @@
  */
 
 module.exports = {
-  AUTH0_URL: 'http://test' // Since we use Nock, just dummy value stored
+  AUTH0_URL: 'http://test', // Since we use Nock, just dummy value stored
+  AWS_S3_BUCKET: 'dummy-bucket'
 }

docker/sample.api.env

@@ -3,3 +3,5 @@ AUTH0_AUDIENCE=<Auth0 Audience>
 AUTH0_CLIENT_ID=<Auth0 Client ID>
 AUTH0_CLIENT_SECRET=<Auth0 Client Secret>
 SUBMISSION_API_URL=<Submission API Endpoint>
+AWS_S3_BUCKET=<S3 bucket>
+SONARQUBE_HOST=<SonarQube Host>