Merge pull request #458 from nursoltan-s/feature/es-db-compare

Report ES/DB - Upload to AWS S3

Author: maxceem

config/default.json

@@ -74,5 +74,6 @@
       "BUDGET": 123
     }
   },
-  "DEFAULT_M2M_USERID": -101
+  "DEFAULT_M2M_USERID": -101,
+  "REPORT_S3_BUCKET": "S3 BUCKET NAME"
 }

scripts/es-db-compare/README.md

@@ -20,6 +20,11 @@ during the comparation. You may need to modify/add/delete items in the list.
 
 - `PROJECT_START_ID` and `PROJECT_END_ID` must exist together.
 - At least one of `PROJECT_START_ID` with `PROJECT_END_ID` or `PROJECT_LAST_ACTIVITY_AT` needs be set before running the script.
+- If you want to upload report to AWS S3 You need to Set `REPORT_S3_BUCKET`, `ACCESS_KEY_ID`, `SECRET_ACCESS_KEY` keys to `config/default.js` file.
+- Report file will uploaded to `REPORT_S3_BUCKET` in `es-db-report-<NODE_ENV>-<DD-MM-YYYY-HH-MM-SS>.html` format.
+    `<NODE_ENV>` - replace with the value for `NODE_ENV` env variable
+    `<DD-MM-YYYY-HH-MM-SS>` - current date and time in such format
+- If `REPORT_S3_BUCKET` variable is not set. Report will be stored in local filesystem.
 
 ## Usage
 

scripts/es-db-compare/index.js

@@ -8,6 +8,8 @@
 import Joi from 'joi';
 import lodash from 'lodash';
 import config from 'config';
+import AWS from 'aws-sdk';
+import moment from 'moment';
 
 import models from '../../src/models';
 import util from '../../src/util';
@@ -298,8 +300,35 @@ async function main() {
     metadata: dataForMetadata,
     project: dataForProject,
   });
-  fs.writeFileSync(reportPathname, report);
-  console.log(`report is written to ${reportPathname}`);
+
+  if (config.has('REPORT_S3_BUCKET')) {
+    // Make sure set AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY in Environment Variables
+    const s3 = new AWS.S3();
+
+    const fileName =
+      `es-db-report-${process.env.NODE_ENV || 'development'}-${moment().format('DD-MM-YYYY-HH-MM-SS')}.html`;
+
+    const params = {
+      Bucket: config.get('REPORT_S3_BUCKET'),
+      Key: fileName,
+      Body: report,
+      ContentType: 'text/html',
+    };
+
+    await new Promise((resolve, reject) => {
+      s3.putObject(params, (error) => {
+        if (error) {
+          reject(error);
+        } else {
+          console.log(`Report uploaded successfully on S3. FileName is: ${fileName}`);
+          resolve();
+        }
+      });
+    });
+  } else {
+    fs.writeFileSync(reportPathname, report);
+    console.log(`Report is written to local file ${reportPathname}`);
+  }
 }
 
 main().then(() => {

scripts/es-db-compare/verification/Verification.md

@@ -1,6 +1,7 @@
 # Verification
 
 ## Steps
+- Set `REPORT_S3_BUCKET`, `ACCESS_KEY_ID`, `SECRET_ACCESS_KEY` keys to `config/default.js` file. If you don't set report will be generated in local file
 - Start ES and DB services: `docker-compose -f local/docker-compose.yml up`
 - Insert ES and DB data:
 
@@ -17,4 +18,4 @@
   PROJECT_LAST_ACTIVITY_AT=0 npm run es-db-compare
   ```
 
-- See `./report.html` under the root project directory.
+- See uploaded file in AWS Console or See `./report.html` under the root project directory.