CM-20749 - print results refactor (#69)

Author: MichalBor

cli/config.yaml

@@ -6,5 +6,13 @@ scans:
     - sca
     - sast
 result_printer:
-  lines_to_display: 3
-  show_secret: False
+  default:
+    lines_to_display: 3
+    show_secret: False
+  secret:
+    pre_receive:
+      lines_to_display: 1
+      show_secret: False
+    commit_history:
+      lines_to_display: 1
+      show_secret: False

cli/cycode.py

@@ -74,7 +74,7 @@ def code_scan(context: click.Context, scan_type, client_id, secret, show_secret,
     if show_secret:
         context.obj["show_secret"] = show_secret
     else:
-        context.obj["show_secret"] = config["result_printer"]["show_secret"]
+        context.obj["show_secret"] = config["result_printer"]["default"]["show_secret"]
 
     if soft_fail:
         context.obj["soft_fail"] = soft_fail

cli/printers/base_printer.py

@@ -6,6 +6,11 @@
 
 class BasePrinter(ABC):
 
+    context: click.Context
+
+    def __init__(self, context: click.Context):
+        self.context = context
+
     @abstractmethod
-    def print_results(self, context: click.Context, results: List[DocumentDetections]):
+    def print_results(self, results: List[DocumentDetections]):
         pass

cli/printers/json_printer.py

@@ -7,17 +7,23 @@
 
 
 class JsonPrinter(BasePrinter):
-    def print_results(self, context: click.Context, results: List[DocumentDetections]):
+
+    scan_id: str
+
+    def __init__(self, context: click.Context):
+        super().__init__(context)
+        self.scan_id = context.obj.get('scan_id')
+
+    def print_results(self, 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 = self._get_json_result(context, detections_dict)
+        json_result = self._get_json_result(detections_dict)
         click.secho(json_result)
 
-    def _get_json_result(self, context, detections):
-        scan_id = context.obj.get('scan_id')
+    def _get_json_result(self, detections):
         result = {
-            'scan_id': str(scan_id),
+            'scan_id': str(self.scan_id),
             'detections': detections
         }
 

cli/printers/results_printer.py

@@ -6,19 +6,19 @@
 
 class ResultsPrinter:
     printers = {
-        'text': TextPrinter(),
-        'json': JsonPrinter()
+        'text': TextPrinter,
+        'json': JsonPrinter
     }
 
     def print_results(self, context: click.Context, detections_results_list: List[DocumentDetections],
                       output_type: str):
-        printer = self.get_printer(output_type)
-        printer.print_results(context, detections_results_list)
+        printer = self.get_printer(output_type, context)
+        printer.print_results(detections_results_list)
 
-    def get_printer(self, output_type: str):
+    def get_printer(self, output_type: str, context: click.Context):
         printer = self.printers.get(output_type)
         if not printer:
             raise ValueError(f'the provided output is not supported - {output_type}')
 
-        return printer
+        return printer(context)
 

cli/printers/text_printer.py

@@ -13,32 +13,40 @@ class TextPrinter(BasePrinter):
     WHITE_COLOR_NAME = 'white'
     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})")
+    scan_id: str
+    scan_type: str
+    command_scan_type: str
+    show_secret: bool = False
+
+    def __init__(self, context: click.Context):
+        super().__init__(context)
+        self.scan_id = context.obj.get('scan_id')
+        self.scan_type = context.obj.get('scan_type')
+        self.command_scan_type = context.info_name
+        self.show_secret = context.obj.get('show_secret', False)
+
+    def print_results(self, results: List[DocumentDetections]):
+        click.secho(f"Scan Results: (scan_id: {self.scan_id})")
 
         if not results:
             click.secho("Good job! No issues were found!!! 👏👏👏", fg=self.GREEN_COLOR_NAME)
             return
 
-        scan_type = context.obj.get('scan_type')
-        show_secret = context.obj.get('show_secret', False)
-        lines_to_display = config.get('result_printer', {}).get('lines_to_display')
         for document_detections in results:
-            self._print_document_detections(document_detections, scan_type, show_secret, lines_to_display)
+            self._print_document_detections(document_detections)
 
-        if context.obj.get('report_url'):
-            click.secho(f"Report URL: {context.obj.get('report_url')}")
+        if self.context.obj.get('report_url'):
+            click.secho(f"Report URL: {self.context.obj.get('report_url')}")
 
-    def _print_document_detections(self, document_detections: DocumentDetections, scan_type: str, show_secret: bool,
-                                   lines_to_display: int):
+    def _print_document_detections(self, document_detections: DocumentDetections):
         document = document_detections.document
+        lines_to_display = self._get_lines_to_display_count()
         for detection in document_detections.detections:
-            self._print_detection_summary(detection, document.path, scan_type)
-            self._print_detection_code_segment(detection, document, scan_type, show_secret, lines_to_display)
+            self._print_detection_summary(detection, document.path)
+            self._print_detection_code_segment(detection, document, lines_to_display)
 
-    def _print_detection_summary(self, detection: Detection, document_path: str, scan_type: str):
-        detection_name = detection.type if scan_type == SECRET_SCAN_TYPE else detection.message
+    def _print_detection_summary(self, detection: Detection, document_path: str):
+        detection_name = detection.type if self.scan_type == SECRET_SCAN_TYPE else detection.message
         detection_sha = detection.detection_details.get('sha512')
         detection_sha_message = f'\nSecret SHA: {detection_sha}' if detection_sha else ''
         detection_commit_id = detection.detection_details.get('commit_id')
@@ -48,62 +56,41 @@ def _print_detection_summary(self, detection: Detection, document_path: str, sca
             f'(rule ID: {detection.detection_rule_id}) in file: {click.format_filename(document_path)} ' +
             f'{detection_sha_message}{detection_commit_id_message}  ⛔ ')
 
-    def _print_detection_code_segment(self, detection: Detection, document: Document, scan_type: str,
-                                      show_secret: bool, code_segment_size: int):
-        detection_details = detection.detection_details
-        detection_line = detection_details.get('line', -1) if scan_type == SECRET_SCAN_TYPE else \
-            detection_details.get('line_in_file', -1)
-        detection_position = detection_details.get('start_position', -1)
-        violation_length = detection_details.get('length', -1)
-
-        document_content = document.content
-        document_lines = document_content.splitlines()
-        start_line = self._get_code_segment_start_line(detection_line, code_segment_size)
-        detection_position_in_line = self._get_position_in_line(document_content, detection_position)
-
-        click.echo()
-        for i in range(code_segment_size):
-            current_line_index = start_line + i
-            if current_line_index >= len(document_lines):
-                break
+    def _print_detection_code_segment(self, detection: Detection, document: Document, code_segment_size: int):
+        if document.is_git_diff_format:
+            self._print_detection_from_git_diff(detection, document)
+            return
 
-            current_line = document_lines[current_line_index]
-            is_detection_line = current_line_index == detection_line
-            self._print_line_of_code_segment(document, current_line, current_line_index + 1, detection_position_in_line,
-                                             violation_length, show_secret, scan_type, is_detection_line)
-        click.echo()
+        self._print_detection_from_file(detection, document, code_segment_size)
 
     def _get_code_segment_start_line(self, detection_line: int, code_segment_size: int):
         start_line = detection_line - math.ceil(code_segment_size / 2)
         return 0 if start_line < 0 else start_line
 
     def _print_line_of_code_segment(self, document: Document, line: str, line_number: int,
-                                    detection_position_in_line: int, violation_length: int, show_secret: bool,
-                                    scan_type: str, is_detection_line: bool):
+                                    detection_position_in_line: int, violation_length: int, is_detection_line: bool):
         if is_detection_line:
-            self._print_detection_line(document, line, line_number, detection_position_in_line, violation_length,
-                                       show_secret, scan_type)
+            self._print_detection_line(document, line, line_number, detection_position_in_line, violation_length)
         else:
             self._print_line(document, line, line_number)
 
     def _print_detection_line(self, document: Document, line: str, line_number: int, detection_position_in_line: int,
-                              violation_length: int, show_secret: bool, scan_type: str):
+                              violation_length: int):
         click.echo(
             f'{self._get_line_number_style(line_number)} '
-            f'{self._get_detection_line_style(line, document.is_git_diff_format, scan_type, detection_position_in_line, violation_length, show_secret)}')
+            f'{self._get_detection_line_style(line, document.is_git_diff_format, detection_position_in_line, violation_length)}')
 
     def _print_line(self, document: Document, line: str, line_number: int):
         click.echo(
             f'{self._get_line_number_style(line_number)} {self._get_line_style(line, document.is_git_diff_format)}')
 
-    def _get_detection_line_style(self, line: str, is_git_diff: bool, scan_type: str, start_position: int, length: int,
-                                  show_secret: bool = False):
+    def _get_detection_line_style(self, line: str, is_git_diff: bool, start_position: int, length: int):
         line_color = self._get_line_color(line, is_git_diff)
-        if scan_type != SECRET_SCAN_TYPE or start_position < 0 or length < 0:
+        if self.scan_type != SECRET_SCAN_TYPE or start_position < 0 or length < 0:
             return self._get_line_style(line, is_git_diff, line_color)
 
         violation = line[start_position: start_position + length]
-        if not show_secret:
+        if not self.show_secret:
             violation = obfuscate_text(violation)
         line_to_violation = line[0: start_position]
         line_from_violation = line[start_position + length:]
@@ -132,3 +119,53 @@ def _get_position_in_line(self, text: str, position: int) -> int:
 
     def _get_line_number_style(self, line_number: int):
         return f'{click.style(str(line_number), fg=self.WHITE_COLOR_NAME, bold=False)} {click.style("|", fg=self.RED_COLOR_NAME, bold=False)}'
+
+    def _get_lines_to_display_count(self) -> int:
+        result_printer_configuration = config.get('result_printer')
+        lines_to_display_of_scan = result_printer_configuration.get(self.scan_type, {}) \
+            .get(self.command_scan_type, {}).get('lines_to_display')
+        if lines_to_display_of_scan:
+            return lines_to_display_of_scan
+
+        return result_printer_configuration.get('default').get('lines_to_display')
+
+    def _print_detection_from_file(self, detection: Detection, document: Document, code_segment_size: int):
+        detection_details = detection.detection_details
+        detection_line = detection_details.get('line', -1) if self.scan_type == SECRET_SCAN_TYPE else \
+            detection_details.get('line_in_file', -1)
+        detection_position = detection_details.get('start_position', -1)
+        violation_length = detection_details.get('length', -1)
+
+        file_content = document.content
+        file_lines = file_content.splitlines()
+        start_line = self._get_code_segment_start_line(detection_line, code_segment_size)
+        detection_position_in_line = self._get_position_in_line(file_content, detection_position)
+
+        click.echo()
+        for i in range(code_segment_size):
+            current_line_index = start_line + i
+            if current_line_index >= len(file_lines):
+                break
+
+            current_line = file_lines[current_line_index]
+            is_detection_line = current_line_index == detection_line
+            self._print_line_of_code_segment(document, current_line, current_line_index + 1, detection_position_in_line,
+                                             violation_length, is_detection_line)
+        click.echo()
+
+    def _print_detection_from_git_diff(self, detection: Detection, document: Document):
+        detection_details = detection.detection_details
+        detection_line_number = detection_details.get('line', -1)
+        detection_line_number_in_original_file = detection_details.get('line_in_file', -1)
+        detection_position = detection_details.get('start_position', -1)
+        violation_length = detection_details.get('length', -1)
+
+        git_diff_content = document.content
+        git_diff_lines = git_diff_content.splitlines()
+        detection_line = git_diff_lines[detection_line_number]
+        detection_position_in_line = self._get_position_in_line(git_diff_content, detection_position)
+
+        click.echo()
+        self._print_detection_line(document, detection_line, detection_line_number_in_original_file,
+                                   detection_position_in_line, violation_length)
+        click.echo()