scanoss 1.40.0__tar.gz → 1.40.1__tar.gz

{scanoss-1.40.0/src/scanoss.egg-info → scanoss-1.40.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scanoss
-Version: 1.40.0
+Version: 1.40.1
 Summary: Simple Python library to leverage the SCANOSS APIs
 Home-page: https://scanoss.com
 Author: SCANOSS

{scanoss-1.40.0 → scanoss-1.40.1}/src/scanoss/__init__.py

@@ -22,4 +22,4 @@ SPDX-License-Identifier: MIT
   THE SOFTWARE.
 """
 
-__version__ = '1.40.0'
+__version__ = '1.40.1'

{scanoss-1.40.0 → scanoss-1.40.1}/src/scanoss/cli.py

@@ -35,12 +35,6 @@ import pypac
 from scanoss.cryptography import Cryptography, create_cryptography_config_from_args
 from scanoss.delta import Delta
 from scanoss.export.dependency_track import DependencyTrackExporter
-from scanoss.inspection.dependency_track.project_violation import (
-    DependencyTrackProjectViolationPolicyCheck,
-)
-from scanoss.inspection.raw.component_summary import ComponentSummary
-from scanoss.inspection.raw.license_summary import LicenseSummary
-from scanoss.inspection.raw.match_summary import MatchSummary
 from scanoss.scanners.container_scanner import (
     DEFAULT_SYFT_COMMAND,
     DEFAULT_SYFT_TIMEOUT,
@@ -75,8 +69,14 @@ from .csvoutput import CsvOutput
 from .cyclonedx import CycloneDx
 from .filecount import FileCount
 from .gitlabqualityreport import GitLabQualityReport
-from .inspection.raw.copyleft import Copyleft
-from .inspection.raw.undeclared_component import UndeclaredComponent
+from .inspection.policy_check.dependency_track.project_violation import (
+    DependencyTrackProjectViolationPolicyCheck,
+)
+from .inspection.policy_check.scanoss.copyleft import Copyleft
+from .inspection.policy_check.scanoss.undeclared_component import UndeclaredComponent
+from .inspection.summary.component_summary import ComponentSummary
+from .inspection.summary.license_summary import LicenseSummary
+from .inspection.summary.match_summary import MatchSummary
 from .results import Results
 from .scancodedeps import ScancodeDeps
 from .scanner import FAST_WINNOWING, Scanner
@@ -1753,7 +1753,6 @@ def inspect_copyleft(parser, args):
             exclude=args.exclude,  # Licenses to ignore
             explicit=args.explicit,  # Explicit license list
         )
-
         # Execute inspection and exit with appropriate status code
         status, _ = i_copyleft.run()
         sys.exit(status)

scanoss-1.40.1/src/scanoss/data/build_date.txt

@@ -0,0 +1 @@
+date: 20251029145743, utime: 1761749863

{scanoss-1.40.0 → scanoss-1.40.1}/src/scanoss/gitlabqualityreport.py

@@ -74,16 +74,21 @@ class GitLabQualityReport(ScanossBase):
         Initialise the GitLabCodeQuality class
         """
         super().__init__(debug, trace, quiet)
+        self.print_trace(f"GitLabQualityReport initialized with debug={debug}, trace={trace}, quiet={quiet}")
 
 
     def _get_code_quality(self, file_name: str, result: dict) -> CodeQuality or None:
+        self.print_trace(f"_get_code_quality called for file: {file_name}")
+        self.print_trace(f"Processing result: {result}")
+
         if not result.get('file_hash'):
             self.print_debug(f"Warning: no hash found for result: {result}")
             return None
 
         if result.get('id') == 'file':
+            self.print_debug(f"Processing file match for: {file_name}")
             description = f"File match found in: {file_name}"
-            return CodeQuality(
+            code_quality = CodeQuality(
                 description=description,
                 check_name=file_name,
                 fingerprint=result.get('file_hash'),
@@ -95,17 +100,21 @@ class GitLabQualityReport(ScanossBase):
                     )
                 )
             )
+            self.print_trace(f"Created file CodeQuality object: {code_quality}")
+            return code_quality
 
         if not result.get('lines'):
             self.print_debug(f"Warning: No lines found for result: {result}")
             return None
         lines = scanoss_scan_results_utils.get_lines(result.get('lines'))
+        self.print_trace(f"Extracted lines: {lines}")
         if len(lines) == 0:
             self.print_debug(f"Warning: empty lines for result: {result}")
             return None
         end_line = lines[len(lines) - 1] if len(lines) > 1 else lines[0]
         description = f"Snippet found in: {file_name} - lines {lines[0]}-{end_line}"
-        return CodeQuality(
+        self.print_debug(f"Processing snippet match for: {file_name}, lines: {lines[0]}-{end_line}")
+        code_quality = CodeQuality(
             description=description,
             check_name=file_name,
             fingerprint=result.get('file_hash'),
@@ -117,35 +126,47 @@ class GitLabQualityReport(ScanossBase):
                 )
             )
         )
+        self.print_trace(f"Created snippet CodeQuality object: {code_quality}")
+        return code_quality
 
     def _write_output(self, data: list[CodeQuality], output_file: str = None) -> bool:
         """Write the Gitlab Code Quality Report to output."""
+        self.print_trace(f"_write_output called with {len(data)} items, output_file: {output_file}")
         try:
             json_data = [item.to_dict() for item in data]
+            self.print_trace(f"JSON data: {json_data}")
             file = open(output_file, 'w') if output_file else sys.stdout
             print(json.dumps(json_data, indent=2), file=file)
             if output_file:
                 file.close()
+                self.print_debug(f"Wrote output to file: {output_file}")
+            else:
+                self.print_debug("Wrote output to 'stdout'")
             return True
         except Exception as e:
             self.print_stderr(f'Error writing output: {str(e)}')
             return False
 
     def _produce_from_json(self, data: dict, output_file: str = None) -> bool:
+        self.print_trace(f"_produce_from_json called with output_file: {output_file}")
+        self.print_debug(f"Processing {len(data)} files from JSON data")
         code_quality = []
         for file_name, results in data.items():
+            self.print_trace(f"Processing file: {file_name} with {len(results)} results")
             for result in results:
                 if not result.get('id'):
                     self.print_debug(f"Warning: No ID found for result: {result}")
                     continue
                 if result.get('id') != 'snippet' and result.get('id') != 'file':
-                    self.print_debug(f"Skipping non-snippet/file match: {result}")
+                    self.print_debug(f"Skipping non-snippet/file match: {file_name}, id: '{result['id']}'")
                     continue
                 code_quality_item = self._get_code_quality(file_name, result)
                 if code_quality_item:
                     code_quality.append(code_quality_item)
+                    self.print_trace(f"Added code quality item for {file_name}")
                 else:
                     self.print_debug(f"Warning: No Code Quality found for result: {result}")
+        self.print_debug(f"Generated {len(code_quality)} code quality items")
         self._write_output(data=code_quality,output_file=output_file)
         return True
 
@@ -156,11 +177,15 @@ class GitLabQualityReport(ScanossBase):
         :param output_file: Output file (optional)
         :return: True if successful, False otherwise
         """
+        self.print_trace(f"_produce_from_str called with output_file: {output_file}")
         if not json_str:
             self.print_stderr('ERROR: No JSON string provided to parse.')
             return False
+        self.print_debug(f"Parsing JSON string of length: {len(json_str)}")
         try:
             data = json.loads(json_str)
+            self.print_debug("Successfully parsed JSON data")
+            self.print_trace(f"Parsed data structure: {type(data)}")
         except Exception as e:
             self.print_stderr(f'ERROR: Problem parsing input JSON: {e}')
             return False
@@ -174,12 +199,16 @@ class GitLabQualityReport(ScanossBase):
         :param output_file:
         :return: True if successful, False otherwise
         """
+        self.print_trace(f"produce_from_file called with json_file: {json_file}, output_file: {output_file}")
+        self.print_debug(f"Input JSON file: {json_file}, output_file: {output_file}")
         if not json_file:
             self.print_stderr('ERROR: No JSON file provided to parse.')
             return False
         if not os.path.isfile(json_file):
             self.print_stderr(f'ERROR: JSON file does not exist or is not a file: {json_file}')
             return False
+        self.print_debug(f"Reading JSON file: {json_file}")
         with open(json_file, 'r') as f:
-            success = self._produce_from_str(f.read(), output_file)
+            json_content = f.read()
+            success = self._produce_from_str(json_content, output_file)
         return success

{scanoss-1.40.0/src/scanoss/inspection → scanoss-1.40.1/src/scanoss/inspection/policy_check}/dependency_track/project_violation.py

@@ -26,9 +26,9 @@ import time
 from datetime import datetime
 from typing import Any, Dict, List, Optional, TypedDict
 
-from ...services.dependency_track_service import DependencyTrackService
-from ..policy_check import PolicyCheck, PolicyStatus
-from ..utils.markdown_utils import generate_jira_table, generate_table
+from ....services.dependency_track_service import DependencyTrackService
+from ...utils.markdown_utils import generate_jira_table, generate_table
+from ..policy_check import PolicyCheck, PolicyOutput, PolicyStatus
 
 # Constants
 PROCESSING_RETRY_DELAY = 5  # seconds
@@ -171,7 +171,7 @@ class DependencyTrackProjectViolationPolicyCheck(PolicyCheck[PolicyViolationDict
         self.url = url.strip().rstrip('/') if url else None
         self.dep_track_service = DependencyTrackService(self.api_key, self.url, debug=debug, trace=trace, quiet=quiet)
 
-    def _json(self, project_violations: list[PolicyViolationDict]) -> Dict[str, Any]:
+    def _json(self, project_violations: list[PolicyViolationDict]) -> PolicyOutput:
         """
         Format project violations as JSON.
         
@@ -181,12 +181,12 @@ class DependencyTrackProjectViolationPolicyCheck(PolicyCheck[PolicyViolationDict
         Returns:
             Dictionary containing JSON formatted results and summary
         """
-        return {
-            "details": json.dumps(project_violations, indent=2),
-            "summary": f'{len(project_violations)} policy violations were found.\n',
-        }
+        return PolicyOutput(
+            details= json.dumps(project_violations, indent=2),
+            summary= f'{len(project_violations)} policy violations were found.\n',
+        )
 
-    def _markdown(self, project_violations: list[PolicyViolationDict]) -> Dict[str, Any]:
+    def _markdown(self, project_violations: list[PolicyViolationDict]) -> PolicyOutput:
         """
         Format Dependency Track violations to Markdown format.
         
@@ -198,7 +198,7 @@ class DependencyTrackProjectViolationPolicyCheck(PolicyCheck[PolicyViolationDict
         """
         return self._md_summary_generator(project_violations, generate_table)
 
-    def _jira_markdown(self, data: list[PolicyViolationDict]) -> Dict[str, Any]:
+    def _jira_markdown(self, data: list[PolicyViolationDict]) -> PolicyOutput:
         """
         Format project violations for Jira Markdown.
         
@@ -357,8 +357,7 @@ class DependencyTrackProjectViolationPolicyCheck(PolicyCheck[PolicyViolationDict
             self.print_stderr(f'Error: Failed to get project uuid from: {dt_project}')
             raise ValueError(f'Error: Project {self.project_name}@{self.project_version} does not have a valid UUID')
 
-    @staticmethod
-    def _sort_project_violations(violations: List[PolicyViolationDict]) -> List[PolicyViolationDict]:
+    def _sort_project_violations(self,violations: List[PolicyViolationDict]) -> List[PolicyViolationDict]:
         """
         Sort project violations by priority.
         
@@ -377,7 +376,7 @@ class DependencyTrackProjectViolationPolicyCheck(PolicyCheck[PolicyViolationDict
             key=lambda x: -type_priority.get(x.get('type', 'OTHER'), 1)
         )
 
-    def _md_summary_generator(self, project_violations: list[PolicyViolationDict], table_generator):
+    def _md_summary_generator(self, project_violations: list[PolicyViolationDict], table_generator) -> PolicyOutput:
         """
         Generates a Markdown summary of project policy violations.
 
@@ -396,10 +395,10 @@ class DependencyTrackProjectViolationPolicyCheck(PolicyCheck[PolicyViolationDict
         """
         if project_violations is None:
             self.print_stderr('Warning: No project violations found. Returning empty results.')
-            return {
-                "details": "h3. Dependency Track Project Violations\n\nNo policy violations found.\n",
-                "summary": "0 policy violations were found.\n",
-            }
+            return PolicyOutput(
+                details= "h3. Dependency Track Project Violations\n\nNo policy violations found.\n",
+                summary= "0 policy violations were found.\n",
+            )
         headers = ['State', 'Risk Type', 'Policy Name', 'Component', 'Date']
         c_cols = [0, 1]
         rows: List[List[str]] = []
@@ -424,11 +423,11 @@ class DependencyTrackProjectViolationPolicyCheck(PolicyCheck[PolicyViolationDict
             ]
             rows.append(row)
         # End for loop
-        return {
-            "details": f'### Dependency Track Project Violations\n{table_generator(headers, rows, c_cols)}\n\n'
+        return PolicyOutput(
+            details= f'### Dependency Track Project Violations\n{table_generator(headers, rows, c_cols)}\n\n'
                        f'View project in Dependency Track [here]({self.url}/projects/{self.project_id}).\n',
-            "summary": f'{len(project_violations)} policy violations were found.\n'
-        }
+            summary= f'{len(project_violations)} policy violations were found.\n'
+        )
 
     def run(self) -> int:
         """
@@ -470,10 +469,11 @@ class DependencyTrackProjectViolationPolicyCheck(PolicyCheck[PolicyViolationDict
             self.print_stderr('Error: Invalid format specified.')
             return PolicyStatus.ERROR.value
         # Format and output data - handle empty results gracefully
-        data = formatter(self._sort_project_violations(dt_project_violations))
-        self.print_to_file_or_stdout(data['details'], self.output)
-        self.print_to_file_or_stderr(data['summary'], self.status)
+        policy_output = formatter(self._sort_project_violations(dt_project_violations))
+        self.print_to_file_or_stdout(policy_output.details, self.output)
+        self.print_to_file_or_stderr(policy_output.summary, self.status)
         # Return appropriate status based on violation count
         if len(dt_project_violations) > 0:
             return PolicyStatus.POLICY_FAIL.value
         return PolicyStatus.POLICY_SUCCESS.value
+

{scanoss-1.40.0/src/scanoss/inspection → scanoss-1.40.1/src/scanoss/inspection/policy_check}/policy_check.py

@@ -22,12 +22,12 @@ SPDX-License-Identifier: MIT
   THE SOFTWARE.
 """
 
-from abc import abstractmethod
+from abc import ABC, abstractmethod
 from enum import Enum
-from typing import Any, Callable, Dict, Generic, List, TypeVar
+from typing import Callable, Dict, Generic, List, NamedTuple, TypeVar
 
-from ..scanossbase import ScanossBase
-from .utils.license_utils import LicenseUtil
+from ...scanossbase import ScanossBase
+from ..utils.license_utils import LicenseUtil
 
 
 class PolicyStatus(Enum):
@@ -46,9 +46,13 @@ class PolicyStatus(Enum):
 # End of PolicyStatus Class
 #
 
+class PolicyOutput(NamedTuple):
+    details: str
+    summary: str
+
 T = TypeVar('T')
 
-class PolicyCheck(ScanossBase, Generic[T]):
+class PolicyCheck(ScanossBase, Generic[T], ABC):
     """
     A base class for implementing various software policy checks.
 
@@ -80,7 +84,7 @@ class PolicyCheck(ScanossBase, Generic[T]):
         self.output = output
 
     @abstractmethod
-    def run(self):
+    def run(self)-> tuple[int,PolicyOutput]:
         """
         Execute the policy check process.
 
@@ -91,14 +95,14 @@ class PolicyCheck(ScanossBase, Generic[T]):
         3. Formatting the results
         4. Saving the output to files if required
 
-        :return: A tuple containing:
+        :return: A named tuple containing two elements:
                  - First element: PolicyStatus enum value (SUCCESS, FAIL, or ERROR)
-                 - Second element: Dictionary containing the inspection results
+                 - Second element: PolicyOutput A tuple containing the policy results.
         """
         pass
 
     @abstractmethod
-    def _json(self, data: list[T]) -> Dict[str, Any]:
+    def _json(self, data: list[T]) -> PolicyOutput:
         """
         Format the policy checks results as JSON.
         This method should be implemented by subclasses to create a Markdown representation
@@ -112,7 +116,7 @@ class PolicyCheck(ScanossBase, Generic[T]):
         pass
 
     @abstractmethod
-    def _markdown(self, data: list[T]) -> Dict[str, Any]:
+    def _markdown(self, data: list[T]) -> PolicyOutput:
         """
         Generate Markdown output for the policy check results.
 
@@ -125,7 +129,7 @@ class PolicyCheck(ScanossBase, Generic[T]):
         pass
 
     @abstractmethod
-    def _jira_markdown(self, data: list[T]) -> Dict[str, Any]:
+    def _jira_markdown(self, data: list[T]) -> PolicyOutput:
         """
         Generate Markdown output for the policy check results.
 
@@ -137,7 +141,7 @@ class PolicyCheck(ScanossBase, Generic[T]):
         """
         pass
 
-    def _get_formatter(self) -> Callable[[List[dict]], Dict[str, Any]] or None:
+    def _get_formatter(self) -> Callable[[List[dict]], PolicyOutput]:
         """
         Get the appropriate formatter function based on the specified format.
 
@@ -145,7 +149,7 @@ class PolicyCheck(ScanossBase, Generic[T]):
         """
         valid_format = self._is_valid_format()
         if not valid_format:
-            return None
+            raise ValueError('Invalid format specified')
         # a map of which format function to return
         function_map = {
             'json': self._json,
@@ -205,14 +209,14 @@ class PolicyCheck(ScanossBase, Generic[T]):
         if formatter is None:
             return PolicyStatus.ERROR.value, {}
         # Format the results
-        data = formatter(components)
+        policy_output = 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)
+        self.print_to_file_or_stdout(policy_output.details, self.output)
+        self.print_to_file_or_stderr(policy_output.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
+            return PolicyStatus.POLICY_FAIL.value, policy_output
+        return PolicyStatus.POLICY_SUCCESS.value, policy_output
 #
 # End of PolicyCheck Class
 #

{scanoss-1.40.0/src/scanoss/inspection/raw → scanoss-1.40.1/src/scanoss/inspection/policy_check/scanoss}/copyleft.py

@@ -24,11 +24,11 @@ SPDX-License-Identifier: MIT
 
 import json
 from dataclasses import dataclass
-from typing import Any, Dict, List
+from typing import Dict, List
 
-from ..policy_check import PolicyStatus
-from ..utils.markdown_utils import generate_jira_table, generate_table
-from .raw_base import RawBase
+from ...policy_check.policy_check import PolicyCheck, PolicyOutput, PolicyStatus
+from ...utils.markdown_utils import generate_jira_table, generate_table
+from ...utils.scan_result_processor import ScanResultProcessor
 
 
 @dataclass
@@ -45,7 +45,7 @@ class Component:
     licenses: List[License]
     status: str
 
-class Copyleft(RawBase[Component]):
+class Copyleft(PolicyCheck[Component]):
     """
     SCANOSS Copyleft class
     Inspects components for copyleft licenses
@@ -78,17 +78,23 @@ class Copyleft(RawBase[Component]):
         :param exclude: Licenses to exclude from the analysis
         :param explicit: Explicitly defined licenses
         """
-        super().__init__(debug, trace, quiet, format_type,filepath, output ,status, name='Copyleft Policy')
+        super().__init__(
+            debug, trace, quiet, format_type, status, name='Copyleft Policy', output=output
+        )
         self.license_util.init(include, exclude, explicit)
         self.filepath = filepath
-        self.format = format
         self.output = output
         self.status = status
-        self.include = include
-        self.exclude = exclude
-        self.explicit = explicit
+        self.results_processor = ScanResultProcessor(
+            self.debug,
+            self.trace,
+            self.quiet,
+            self.filepath,
+            include,
+            exclude,
+            explicit)
 
-    def _json(self, components: list[Component]) -> Dict[str, Any]:
+    def _json(self, components: list[Component]) -> PolicyOutput:
         """
         Format the components with copyleft licenses as JSON.
 
@@ -96,16 +102,16 @@ class Copyleft(RawBase[Component]):
         :return: Dictionary with formatted JSON 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)
+        component_licenses = self.results_processor.group_components_by_license(components)
         details = {}
         if len(components) > 0:
             details = {'components': components}
-        return {
-            'details': f'{json.dumps(details, indent=2)}\n',
-            'summary': f'{len(component_licenses)} component(s) with copyleft licenses were found.\n',
-        }
+        return PolicyOutput(
+            details= f'{json.dumps(details, indent=2)}\n',
+            summary= f'{len(component_licenses)} component(s) with copyleft licenses were found.\n',
+        )
 
-    def _markdown(self, components: list[Component]) -> Dict[str, Any]:
+    def _markdown(self, components: list[Component]) -> PolicyOutput:
         """
         Format the components with copyleft licenses as Markdown.
 
@@ -114,7 +120,7 @@ class Copyleft(RawBase[Component]):
         """
         return self._md_summary_generator(components, generate_table)
 
-    def _jira_markdown(self, components: list[Component]) -> Dict[str, Any]:
+    def _jira_markdown(self, components: list[Component]) -> PolicyOutput:
         """
         Format the components with copyleft licenses as Markdown.
 
@@ -123,7 +129,7 @@ class Copyleft(RawBase[Component]):
         """
         return self._md_summary_generator(components, generate_jira_table)
 
-    def _md_summary_generator(self, components: list[Component], table_generator):
+    def _md_summary_generator(self, components: list[Component], table_generator) -> PolicyOutput:
         """
         Generates a Markdown summary for components with a focus on copyleft licenses.
 
@@ -138,15 +144,10 @@ class Copyleft(RawBase[Component]):
             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.
+            PolicyOutput
         """
         # A component is considered unique by its combination of PURL (Package URL) and license
-        component_licenses = self._group_components_by_license(components)
+        component_licenses = self.results_processor.group_components_by_license(components)
         headers = ['Component', 'License', 'URL', 'Copyleft']
         centered_columns = [1, 4]
         rows = []
@@ -160,10 +161,10 @@ class Copyleft(RawBase[Component]):
             rows.append(row)
         # End license loop
         # End component loop
-        return {
-            'details': f'### Copyleft Licenses\n{table_generator(headers, rows, centered_columns)}',
-            'summary': f'{len(component_licenses)} component(s) with copyleft licenses were found.\n',
-        }
+        return PolicyOutput(
+            details= f'### Copyleft Licenses\n{table_generator(headers, rows, centered_columns)}',
+            summary= f'{len(component_licenses)} component(s) with copyleft licenses were found.\n',
+        )
 
     def _get_components_with_copyleft_licenses(self, components: list) -> list[Dict]:
         """
@@ -202,14 +203,13 @@ class Copyleft(RawBase[Component]):
 
         :return: A list of processed components with license data, or `None` if `self.results` is not set.
         """
-        if self.results is None:
+        if self.results_processor.get_results() is None:
             return None
-
         components: dict = {}
         # Extract component and license data from file and dependency results. Both helpers mutate `components`
-        self._get_components_data(self.results, components)
-        self._get_dependencies_data(self.results, components)
-        return self._convert_components_to_list(components)
+        self.results_processor.get_components_data(components)
+        self.results_processor.get_dependencies_data(components)
+        return self.results_processor.convert_components_to_list(components)
 
     def run(self):
         """