scanoss 1.19.2__tar.gz → 1.19.4__tar.gz

{scanoss-1.19.2/src/scanoss.egg-info → scanoss-1.19.4}/PKG-INFO

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

{scanoss-1.19.2 → scanoss-1.19.4}/src/scanoss/__init__.py

@@ -22,4 +22,4 @@
    THE SOFTWARE.
 """
 
-__version__ = "1.19.2"
+__version__ = "1.19.4"

{scanoss-1.19.2 → scanoss-1.19.4}/src/scanoss/cli.py

@@ -334,7 +334,7 @@ def setup_args() -> None:
 
     for p in [p_copyleft, p_undeclared]:
         p.add_argument('-i', '--input', nargs='?', help='Path to results file')
-        p.add_argument('-f', '--format',required=False ,choices=['json', 'md'], default='json', help='Output format (default: json)')
+        p.add_argument('-f', '--format',required=False ,choices=['json', 'md', 'jira_md'], default='json', help='Output format (default: json)')
         p.add_argument('-o', '--output', type=str, help='Save details into a file')
         p.add_argument('-s', '--status', type=str, help='Save summary data into Markdown file')
 

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

@@ -0,0 +1 @@
+date: 20250108144949, utime: 1736347789

{scanoss-1.19.2 → scanoss-1.19.4}/src/scanoss/inspection/copyleft.py

@@ -58,6 +58,7 @@ class Copyleft(PolicyCheck):
         self.exclude = exclude
         self.explicit = explicit
 
+
     def _json(self, components: list) -> Dict[str, Any]:
         """
            Format the components with copyleft licenses as JSON.
@@ -100,6 +101,33 @@ class Copyleft(PolicyCheck):
             'summary' : f'{len(components)} component(s) with copyleft licenses were found.\n'
         }
 
+    def _jira_markdown(self, components: list) -> Dict[str,Any]:
+        """
+        Format the components with copyleft licenses as Markdown.
+
+        :param components: List of components with copyleft licenses
+        :return: Dictionary with formatted Markdown details and summary
+        """
+        headers = ['Component', 'Version', 'License', 'URL', 'Copyleft']
+        centered_columns = [1, 4]
+        rows: [[]]= []
+        for component in components:
+            for lic in component['licenses']:
+                row = [
+                    component['purl'],
+                    component['version'],
+                    lic['spdxid'],
+                    lic['url'],
+                    'YES' if lic['copyleft'] else 'NO'
+                ]
+                rows.append(row)
+            # End license loop
+        # End component loop
+        return  {
+            'details': f'{self.generate_jira_table(headers,rows,centered_columns)}',
+            'summary' : f'{len(components)} component(s) with copyleft licenses were found.\n'
+        }
+
     def _filter_components_with_copyleft_licenses(self, components: list) -> list:
         """
            Filter the components list to include only those with copyleft licenses.

{scanoss-1.19.2 → scanoss-1.19.4}/src/scanoss/inspection/policy_check.py

@@ -76,7 +76,7 @@ class PolicyCheck(ScanossBase):
         ScanossBase: A base class providing common functionality for SCANOSS-related operations.
     """
 
-    VALID_FORMATS = {'md', 'json'}
+    VALID_FORMATS = {'md', 'json', 'jira_md'}
 
     def __init__(self, debug: bool = False, trace: bool = True, quiet: bool = False, filepath: str = None,
                  format_type: str = None, status: str = None, output: str = None, name: str = None):
@@ -134,6 +134,19 @@ class PolicyCheck(ScanossBase):
         """
         pass
 
+    @abstractmethod
+    def _jira_markdown(self, components: list) -> Dict[str, Any]:
+        """
+        Generate Markdown output for the policy check results.
+
+        This method should be implemented by subclasses to create a Markdown representation
+        of the policy check results.
+
+        :param components: List of components to be included in the output.
+        :return: A dictionary representing the Markdown output.
+        """
+        pass
+
     def _append_component(self,components: Dict[str, Any], new_component: Dict[str, Any],
                            id: str, status: str) -> Dict[str, Any]:
         """
@@ -270,6 +283,20 @@ class PolicyCheck(ScanossBase):
         table_rows.extend(col_sep + col_sep.join(row) + col_sep for row in rows)
         return '\n'.join(table_rows)
 
+    def generate_jira_table(self, headers, rows, centered_columns=None):
+        col_sep = '*|*'
+        if headers is None:
+            self.print_stderr('ERROR: Header are no set')
+            return None
+
+        table_header = '|*' + col_sep.join(headers) + '*|\n'
+        table = table_header
+        for row in rows:
+            if len(headers) == len(row):
+                table += '|' + '|'.join(row) + '|\n'
+
+        return table
+
     def _get_formatter(self)-> Callable[[List[dict]], Dict[str,Any]] or None:
         """
         Get the appropriate formatter function based on the specified format.
@@ -282,7 +309,8 @@ class PolicyCheck(ScanossBase):
         # a map of which format function to return
         function_map = {
             'json': self._json,
-            'md': self._markdown
+            'md': self._markdown,
+            'jira_md': self._jira_markdown,
         }
         return function_map[self.format_type]
 

{scanoss-1.19.2 → scanoss-1.19.4}/src/scanoss/inspection/undeclared_component.py

@@ -71,6 +71,26 @@ class UndeclaredComponent(PolicyCheck):
         # end component loop
         return undeclared_components
 
+    def _get_jira_summary(self, components: list) -> str:
+        """
+                Get a summary of the undeclared components.
+
+                :param components: List of all components
+                :return: Component summary markdown
+                """
+        if len(components) > 0:
+            if self.sbom_format == 'settings':
+                json_str = (json.dumps(self._generate_scanoss_file(components), indent=2).replace('\n', '\\n')
+                            .replace('"', '\\"'))
+                return f'{len(components)} undeclared component(s) were found.\nAdd the following snippet into your `scanoss.json` file\n{{code:json}}\n{json.dumps(self._generate_scanoss_file(components), indent=2)}\n{{code}}\n'
+            else:
+                json_str = (json.dumps(self._generate_scanoss_file(components), indent=2).replace('\n', '\\n')
+                            .replace('"', '\\"'))
+                return f'{len(components)} undeclared component(s) were found.\nAdd the following snippet into your `sbom.json` file\n{{code:json}}\n{json.dumps(self._generate_scanoss_file(components), indent=2)}\n{{code}}\n'
+
+        return f'{len(components)} undeclared component(s) were found.\\n'
+
+
     def _get_summary(self, components: list) -> str:
         """
         Get a summary of the undeclared components.
@@ -122,6 +142,24 @@ class UndeclaredComponent(PolicyCheck):
             'summary': self._get_summary(components),
         }
 
+    def _jira_markdown(self, components: list) -> Dict[str,Any]:
+        """
+         Format the undeclared components as Markdown.
+
+         :param components: List of undeclared components
+         :return: Dictionary with formatted Markdown details and summary
+         """
+        headers = ['Component', 'Version', 'License']
+        rows: [[]]= []
+        # TODO look at using SpdxLite license name lookup method
+        for component in components:
+            licenses = " - ".join(lic.get('spdxid', 'Unknown') for lic in component['licenses'])
+            rows.append([component['purl'], component['version'], licenses])
+        return  {
+            'details': f'{self.generate_jira_table(headers,rows)}',
+            'summary': self._get_jira_summary(components),
+        }
+
     def _get_unique_components(self, components: list) -> list:
         """
          Generate a list of unique components.

{scanoss-1.19.2 → scanoss-1.19.4/src/scanoss.egg-info}/PKG-INFO

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

{scanoss-1.19.2 → scanoss-1.19.4}/tests/test_policy_inspect.py

@@ -153,7 +153,7 @@ class MyTestCase(unittest.TestCase):
        Inspect for undeclared components empty path
     """
     def test_copyleft_policy_empty_path(self):
-        copyleft = UndeclaredComponent(filepath='', format_type='json')
+        copyleft = Copyleft(filepath='', format_type='json')
         success, results = copyleft.run()
         self.assertTrue(success,2)
 
@@ -332,5 +332,66 @@ class MyTestCase(unittest.TestCase):
         self.assertEqual(re.sub(r'\s|\\(?!`)|\\(?=`)', '', summary),
                          re.sub(r'\s|\\(?!`)|\\(?=`)', '', expected_summary_output))
 
+    def test_undeclared_policy_jira_markdown_output(self):
+        script_dir = os.path.dirname(os.path.abspath(__file__))
+        file_name = "result.json"
+        input_file_name = os.path.join(script_dir, 'data', file_name)
+        undeclared = UndeclaredComponent(filepath=input_file_name, format_type='jira_md')
+        status, results = undeclared.run()
+        details = results['details']
+        summary = results['summary']
+        expected_details_output = """|*Component*|*Version*|*License*|
+|pkg:github/scanoss/scanner.c|1.3.3|BSD-2-Clause - GPL-2.0-only|
+|pkg:github/scanoss/scanner.c|1.1.4|GPL-2.0-only|
+|pkg:github/scanoss/wfp|6afc1f6|Zlib - GPL-2.0-only|
+|pkg:npm/%40electron/rebuild|3.7.0|MIT|
+|pkg:npm/%40emotion/react|11.13.3|MIT|
+"""
+        expected_summary_output = """5 undeclared component(s) were found.
+Add the following snippet into your `scanoss.json` file
+{code:json}
+{
+  "bom": {
+    "include": [
+      {
+        "purl": "pkg:github/scanoss/scanner.c"
+      },
+      {
+        "purl": "pkg:github/scanoss/wfp"
+      },
+      {
+        "purl": "pkg:npm/%40electron/rebuild"
+      },
+      {
+        "purl": "pkg:npm/%40emotion/react"
+      }
+    ]
+  }
+}
+{code}
+"""
+        self.assertEqual(status, 0)
+        self.assertEqual(expected_details_output, details)
+        self.assertEqual(summary, expected_summary_output)
+
+    def test_copyleft_policy_jira_markdown_output(self):
+        script_dir = os.path.dirname(os.path.abspath(__file__))
+        file_name = "result.json"
+        input_file_name = os.path.join(script_dir, 'data', file_name)
+        copyleft = Copyleft(filepath=input_file_name, format_type='jira_md')
+        status, results = copyleft.run()
+        details = results['details']
+        expected_details_output = """|*Component*|*Version*|*License*|*URL*|*Copyleft*|
+|pkg:github/scanoss/scanner.c|1.3.3|GPL-2.0-only|https://spdx.org/licenses/GPL-2.0-only.html|YES|
+|pkg:github/scanoss/scanner.c|1.1.4|GPL-2.0-only|https://spdx.org/licenses/GPL-2.0-only.html|YES|
+|pkg:github/scanoss/engine|5.4.0|GPL-2.0-only|https://spdx.org/licenses/GPL-2.0-only.html|YES|
+|pkg:github/scanoss/wfp|6afc1f6|GPL-2.0-only|https://spdx.org/licenses/GPL-2.0-only.html|YES|
+|pkg:github/scanoss/engine|4.0.4|GPL-2.0-only|https://spdx.org/licenses/GPL-2.0-only.html|YES|
+"""
+        self.assertEqual(status, 0)
+        self.assertEqual(expected_details_output, details)
+
+
+
 if __name__ == '__main__':
     unittest.main()

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

@@ -1 +0,0 @@
-date: 20250106152810, utime: 1736177290