Updated PolicyCheck return codes and simplified duplicate code

Author: Alex-1089

docs/source/index.rst

@@ -156,7 +156,7 @@ Calculates hashes for a directory or file and shows them on the STDOUT.
      - Fingerprint all hidden files/folders
 
 -----------------------------------------
-Detect dependecies: dependencies, dp, dep
+Detect dependencies: dependencies, dp, dep
 -----------------------------------------
 
 Scan source code for dependencies, but do not decorate them.

src/scanoss/inspection/policy_check.py

@@ -39,7 +39,6 @@ class PolicyStatus(Enum):
         POLICY_FAIL (int): Indicates that the policy check failed (value: 1).
         ERROR (int): Indicates that an error occurred during the policy check (value: 2).
     """
-
     POLICY_SUCCESS = 0
     POLICY_FAIL = 2
     ERROR = 1
@@ -223,6 +222,39 @@ def _is_valid_format(self) -> bool:
             self.print_stderr(f'ERROR: Invalid format "{self.format_type}". Valid formats are: {valid_formats_str}')
             return False
         return True
+
+    def _generate_formatter_report(self, components: list[Dict]):
+        """
+        Generates a formatted report for a given component based on the defined formatter.
+
+        Parameters:
+            components (List[dict]): A list of dictionaries representing the components to be
+            processed and formatted. Each dictionary contains detailed information that adheres
+            to the format requirements for the specified formatter.
+
+        Returns:
+            Tuple[int, dict]: A tuple where the first element represents the policy status code
+            and the second element is a dictionary containing formatted results information,
+            typically with keys 'details' and 'summary'.
+
+        Raises:
+            KeyError: When a required key is missing from the provided component, causing the
+            formatter to fail.
+            ValueError: If an invalid component is passed and renders unable to process.
+        """
+        # Get a formatter for the output results
+        formatter = self._get_formatter()
+        if formatter is None:
+            return PolicyStatus.ERROR.value, {}
+        # Format the results
+        data = formatter(components)
+        ## Save outputs if required
+        self.print_to_file_or_stdout(data['details'], self.output)
+        self.print_to_file_or_stderr(data['summary'], self.status)
+        # Check to see if we have policy violations
+        if len(components) > 0:
+            return PolicyStatus.POLICY_FAIL.value, data
+        return PolicyStatus.POLICY_SUCCESS.value, data
 #
 # End of PolicyCheck Class
 #

src/scanoss/inspection/raw/copyleft.py

@@ -64,7 +64,7 @@ def __init__( # noqa: PLR0913
         explicit: str = None,
     ):
         """
-        Initialize the Copyleft class.
+        Initialise the Copyleft class.
 
         :param debug: Enable debug mode
         :param trace: Enable trace mode (default True)
@@ -111,25 +111,7 @@ def _markdown(self, components: list[Component]) -> Dict[str, Any]:
         :param components: List of components with copyleft licenses
         :return: Dictionary with formatted Markdown details and summary
         """
-        # A component is considered unique by its combination of PURL (Package URL) and license
-        component_licenses = self._group_components_by_license(components)
-        headers = ['Component', 'License', 'URL', 'Copyleft']
-        centered_columns = [1, 4]
-        rows: [[]] = []
-        for comp_lic_item in component_licenses:
-                row = [
-                    comp_lic_item['purl'],
-                    comp_lic_item['spdxid'],
-                    comp_lic_item['url'],
-                    'YES' if comp_lic_item['copyleft'] else 'NO',
-                ]
-                rows.append(row)
-            # End license loop
-        # End component loop
-        return {
-            'details': f'### Copyleft licenses\n{self.generate_table(headers, rows, centered_columns)}\n',
-            'summary': f'{len(component_licenses)} component(s) with copyleft licenses were found.\n',
-        }
+        return self._md_summary_generator(components, self.generate_table)
 
     def _jira_markdown(self, components: list[Component]) -> Dict[str, Any]:
         """
@@ -138,27 +120,51 @@ def _jira_markdown(self, components: list[Component]) -> Dict[str, Any]:
         :param components: List of components with copyleft licenses
         :return: Dictionary with formatted Markdown details and summary
         """
+        return self._md_summary_generator(components, self.generate_jira_table)
+
+    def _md_summary_generator(self, components: list[Component], table_generator):
+        """
+        Generates a Markdown summary for components with a focus on copyleft licenses.
+
+        This function processes a list of components and groups them by their licenses.
+        For each group, the components are mapped with their license data and a tabular representation is created.
+        The generated Markdown summary includes a detailed table and a summary overview.
+
+        Parameters:
+        components: list[Component]
+            A list of Component objects to process for generating the summary.
+        table_generator
+            A callable function to generate tabular data for components.
+
+        Returns:
+        dict
+            A dictionary containing two keys:
+            - 'details': A detailed Markdown representation including a table of components
+              and associated copyleft license data.
+            - 'summary': A textual summary highlighting the total number of components
+              with copyleft licenses.
+        """
         # A component is considered unique by its combination of PURL (Package URL) and license
         component_licenses = self._group_components_by_license(components)
         headers = ['Component', 'License', 'URL', 'Copyleft']
         centered_columns = [1, 4]
-        rows: [[]] = []
+        rows = []
         for comp_lic_item in component_licenses:
-                row = [
-                    comp_lic_item['purl'],
-                    comp_lic_item['spdxid'],
-                    comp_lic_item['url'],
-                    'YES' if comp_lic_item['copyleft'] else 'NO',
-                ]
-                rows.append(row)
-            # End license loop
+            row = [
+                comp_lic_item['purl'],
+                comp_lic_item['spdxid'],
+                comp_lic_item['url'],
+                'YES' if comp_lic_item['copyleft'] else 'NO',
+            ]
+            rows.append(row)
+        # End license loop
         # End component loop
         return {
-            'details': f'{self.generate_jira_table(headers, rows, centered_columns)}',
+            'details': f'### Copyleft Licenses\n{table_generator(headers, rows, centered_columns)}.\n',
             'summary': f'{len(component_licenses)} component(s) with copyleft licenses were found.\n',
         }
 
-    def _get_components_with_copyleft_licenses(self, components: list) -> list[Component]:
+    def _get_components_with_copyleft_licenses(self, components: list) -> list[Dict]:
         """
         Filter the components list to include only those with copyleft licenses.
 
@@ -223,21 +229,8 @@ def run(self):
             return PolicyStatus.ERROR.value, {}
         # Get a list of copyleft components if they exist
         copyleft_components = self._get_components_with_copyleft_licenses(components)
-        # Get a formatter for the output results
-        formatter = self._get_formatter()
-        if formatter is None:
-            return PolicyStatus.ERROR.value, {}
-        # Format the results
-        data = formatter(copyleft_components)
-        ## Save outputs if required
-        self.print_to_file_or_stdout(data['details'], self.output)
-        self.print_to_file_or_stderr(data['summary'], self.status)
-        # Check to see if we have policy violations
-        if len(copyleft_components) <= 0:
-            return PolicyStatus.POLICY_FAIL.value, data
-        return PolicyStatus.POLICY_SUCCESS.value, data
-
-
+        # Format the results and save to files if required
+        return self._generate_formatter_report(copyleft_components)
 #
 # End of Copyleft Class
 #

src/scanoss/inspection/raw/undeclared_component.py

@@ -187,7 +187,7 @@ def _markdown(self, components: list[Component]) -> Dict[str, Any]:
         :return: Dictionary with formatted Markdown details and summary
         """
         headers = ['Component', 'License']
-        rows: [[]] = []
+        rows = []
         # TODO look at using SpdxLite license name lookup method
         component_licenses = self._group_components_by_license(components)
         for component in component_licenses:
@@ -205,7 +205,7 @@ def _jira_markdown(self, components: list) -> Dict[str, Any]:
         :return: Dictionary with formatted Markdown details and summary
         """
         headers = ['Component', 'License']
-        rows: [[]] = []
+        rows = []
         # TODO look at using SpdxLite license name lookup method
         component_licenses = self._group_components_by_license(components)
         for component in component_licenses:
@@ -295,23 +295,13 @@ def run(self):
         components = self._get_components()
         if components is None:
             return PolicyStatus.ERROR.value, {}
-        # Get undeclared component summary (if any)
+        # Get an undeclared component summary (if any)
         undeclared_components = self._get_undeclared_components(components)
         if undeclared_components is None:
             return PolicyStatus.ERROR.value, {}
         self.print_debug(f'Undeclared components: {undeclared_components}')
-        formatter = self._get_formatter()
-        if formatter is None:
-            return PolicyStatus.ERROR.value, {}
-        data = formatter(undeclared_components)
-        # Output the results
-        self.print_to_file_or_stdout(data['details'], self.output)
-        self.print_to_file_or_stderr(data['summary'], self.status)
-        # Determine if the filter found results or not
-        if len(undeclared_components) <= 0:
-            return PolicyStatus.POLICY_FAIL.value, data
-        return PolicyStatus.POLICY_SUCCESS.value, data
-
+        # Format the results and save to files if required
+        return self._generate_formatter_report(undeclared_components)
 #
 # End of UndeclaredComponent Class
 #

tests/test_policy_inspect.py

@@ -441,9 +441,9 @@ def test_dependency_track_project_violation_json_formatter(self, mock_service):
         mock_service.return_value = Mock()
         project_violation = DependencyTrackProjectViolationPolicyCheck(
             format_type='json',
-            dependency_track_api_key='test_key',
-            dependency_track_url='http://localhost',
-            dependency_track_project_id='test_project'
+            api_key='test_key',
+            url='http://localhost',
+            project_id='test_project'
         )
         test_violations = [
             {
@@ -476,9 +476,9 @@ def test_dependency_track_project_violation_markdown_formatter(self, mock_servic
         mock_service.return_value = Mock()
         project_violation = DependencyTrackProjectViolationPolicyCheck(
             format_type='md',
-            dependency_track_api_key='test_key',
-            dependency_track_url='http://localhost',
-            dependency_track_project_id='test_project'
+            api_key='test_key',
+            url='http://localhost',
+            project_id='test_project'
         )
         test_violations = [
             {
@@ -512,9 +512,9 @@ def test_dependency_track_project_violation_markdown_formatter(self, mock_servic
     def test_dependency_track_project_violation_sort_violations(self, mock_service):
         mock_service.return_value = Mock()
         project_violation = DependencyTrackProjectViolationPolicyCheck(
-            dependency_track_api_key='test_key',
-            dependency_track_url='http://localhost',
-            dependency_track_project_id='test_project'
+            api_key='test_key',
+            url='http://localhost',
+            project_id='test_project'
         )
         test_violations = [
             {'type': 'LICENSE', 'uuid': 'license-violation'},
@@ -533,9 +533,9 @@ def test_dependency_track_project_violation_empty_violations(self, mock_service)
         mock_service.return_value = Mock()
         project_violation = DependencyTrackProjectViolationPolicyCheck(
             format_type='json',
-            dependency_track_api_key='test_key',
-            dependency_track_url='http://localhost',
-            dependency_track_project_id='test_project'
+            api_key='test_key',
+            url='http://localhost',
+            project_id='test_project'
         )
         empty_violations = []
         result = project_violation._json(empty_violations)
@@ -548,9 +548,9 @@ def test_dependency_track_project_violation_markdown_empty(self, mock_service):
         mock_service.return_value = Mock()
         project_violation = DependencyTrackProjectViolationPolicyCheck(
             format_type='md',
-            dependency_track_api_key='test_key',
-            dependency_track_url='http://localhost',
-            dependency_track_project_id='test_project'
+            api_key='test_key',
+            url='http://localhost',
+            project_id='test_project'
         )
         empty_violations = []
         result = project_violation._markdown(empty_violations)
@@ -563,9 +563,9 @@ def test_dependency_track_project_violation_multiple_types(self, mock_service):
         mock_service.return_value = Mock()
         project_violation = DependencyTrackProjectViolationPolicyCheck(
             format_type='json',
-            dependency_track_api_key='test_key',
-            dependency_track_url='http://localhost',
-            dependency_track_project_id='test_project'
+            api_key='test_key',
+            url='http://localhost',
+            project_id='test_project'
         )
         test_violations = [
             {