CM-12769 - add scan_id to printed results (#18)

add scan_id to printed results

Author: MichalBor

cli/code_scanner.py

@@ -142,7 +142,7 @@ def scan_documents(context: click.Context, documents_to_scan: List[Document],
     error_message = None
     all_detections_count = 0
     output_detections_count = 0
-    scan_id = uuid4()
+    scan_id = _get_scan_id(context)
     zipped_documents = InMemoryZip()
 
     try:
@@ -452,3 +452,9 @@ def _report_scan_status(context: click.Context, scan_type: str, scan_id: str, sc
     except Exception as e:
         logger.debug('Failed to report scan status, %s', {'exception_message': str(e)})
         pass
+
+
+def _get_scan_id(context: click.Context):
+    scan_id = uuid4()
+    context.obj['scan_id'] = scan_id
+    return scan_id

cli/printers/json_printer.py

@@ -11,5 +11,14 @@ def print_results(self, context: click.Context, results: List[DocumentDetections
         detections = [detection for document_detections in results for detection in document_detections.detections]
         detections_schema = DetectionSchema(many=True)
         detections_dict = detections_schema.dump(detections)
-        json_result = json.dumps(detections_dict, indent=4)
-        click.secho(json_result, fg='white')
+        json_result = self._get_json_result(context, detections_dict)
+        click.secho(json_result)
+
+    def _get_json_result(self, context, detections):
+        scan_id = context.obj.get('scan_id')
+        result = {
+            'scan_id': str(scan_id),
+            'detections': detections
+        }
+
+        return json.dumps(result, indent=4)

cli/printers/text_printer.py

@@ -14,8 +14,11 @@ class TextPrinter(BasePrinter):
     GREEN_COLOR_NAME = 'green'
 
     def print_results(self, context: click.Context, results: List[DocumentDetections]):
+        scan_id = context.obj.get('scan_id')
+        click.secho(f"Scan Results: (scan_id: {scan_id})")
+
         if not results:
-            click.secho("Good job! No issues were found!!! 👏👏👏", fg='green')
+            click.secho("Good job! No issues were found!!! 👏👏👏", fg=self.GREEN_COLOR_NAME)
             return
 
         scan_type = context.obj.get('scan_type')