scanoss 1.19.2__py3-none-any.whl → 1.19.4__py3-none-any.whl

scanoss/__init__.py

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

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/data/build_date.txt

@@ -1 +1 @@
-date: 20250106152810, utime: 1736177290
+date: 20250108144949, utime: 1736347789

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/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/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.dist-info → scanoss-1.19.4.dist-info}/METADATA

@@ -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.dist-info → scanoss-1.19.4.dist-info}/RECORD

@@ -4,8 +4,8 @@ protoc_gen_swagger/options/annotations_pb2.py,sha256=b25EDD6gssUWnFby9gxgcpLIROT
 protoc_gen_swagger/options/annotations_pb2_grpc.py,sha256=1oboBPFxaTEXt9Aw7EAj8gXHDCNMhZD2VXqocC9l_gk,159
 protoc_gen_swagger/options/openapiv2_pb2.py,sha256=vYElGp8E1vGHszvWqX97zNG9GFJ7u2QcdK9ouq0XdyI,14939
 protoc_gen_swagger/options/openapiv2_pb2_grpc.py,sha256=1oboBPFxaTEXt9Aw7EAj8gXHDCNMhZD2VXqocC9l_gk,159
-scanoss/__init__.py,sha256=LFxlOiEE6o2gMJ8Ense9Lo40AszUfC5GnL9PSe6VDhQ,1163
-scanoss/cli.py,sha256=8uvO6VFDqGTw4ZLySr0xhS9KTm-gdwq9K3mYv_LdxW8,51498
+scanoss/__init__.py,sha256=lzQZL-XMupclTvPVGCfZB-UAGfik20RjvISPAt1i9Fo,1163
+scanoss/cli.py,sha256=eJB6s1DVKJd3FPO7wVea8ggeAfua_-7CC8I10uSmdDc,51509
 scanoss/components.py,sha256=ZHZ1KA69shxOASZK7USD9yPTITpAc_RXL5q5zpDK23o,12590
 scanoss/csvoutput.py,sha256=hBwr_Fc6mBdOdXgyQcdFrockYH-PJ0jblowlExJ6OPg,9925
 scanoss/cyclonedx.py,sha256=ZbFNinMz_R68ko4-ZPo2w4bBORpASh271VCmYYRTUCg,12746
@@ -51,20 +51,20 @@ scanoss/api/vulnerabilities/__init__.py,sha256=FLQtiDiv85Q1Chk-sJ9ky9WOV1mulZhEK
 scanoss/api/vulnerabilities/v2/__init__.py,sha256=FLQtiDiv85Q1Chk-sJ9ky9WOV1mulZhEKjiBihlwiaM,1139
 scanoss/api/vulnerabilities/v2/scanoss_vulnerabilities_pb2.py,sha256=CFhF80av8tenGvn9AIsGEtRJPuV2dC_syA5JLZb2lDw,5464
 scanoss/api/vulnerabilities/v2/scanoss_vulnerabilities_pb2_grpc.py,sha256=HlS4k4Zmx6RIAqaO9I96jD-eyF5yU6Xx04pVm7pdqOg,6864
-scanoss/data/build_date.txt,sha256=k__FF_aFKkdz2X5QYLvhJbr2RTp-ZKpxxX0zfOi1D3g,40
+scanoss/data/build_date.txt,sha256=I2tiS4Cw-x-eVSPBx4mOEQefstESmGedPYeWtb6B5W4,40
 scanoss/data/scanoss-settings-schema.json,sha256=ClkRYAkjAN0Sk704G8BE_Ok006oQ6YnIGmX84CF8h9w,8798
 scanoss/data/spdx-exceptions.json,sha256=s7UTYxC7jqQXr11YBlIWYCNwN6lRDFTR33Y8rpN_dA4,17953
 scanoss/data/spdx-licenses.json,sha256=A6Z0q82gaTLtnopBfzeIVZjJFxkdRW1g2TuumQc-lII,228794
 scanoss/inspection/__init__.py,sha256=z62680zKq4OmBOugSODvgpSwdsloZL7bvcaMbnx3xgU,1139
-scanoss/inspection/copyleft.py,sha256=dkiLkgNYz7cbIQZCzy6zThiIyHkqrper_xruZ9PQhAI,6563
-scanoss/inspection/policy_check.py,sha256=eo5VfEBwKoDSqIwRi0xwaVLy6EUR29HlH5Bl0Kpvx7I,14752
-scanoss/inspection/undeclared_component.py,sha256=HArm5xTxxpBBxbMggVYBy6zKEwcxsPYhHEJGawlm5bQ,7952
+scanoss/inspection/copyleft.py,sha256=e6CQXL7G3kUwet4gNqMfGsi1XvLAS71OLDeoRuK2WGY,7621
+scanoss/inspection/policy_check.py,sha256=mbtNwDydf2aBUCz9n2yNG6DV6rc7HH_ZaQuK2CSDBHw,15706
+scanoss/inspection/undeclared_component.py,sha256=QvlBgYpytQhaWlVqrz3p8JPIGbsX8v8U59n-4Q2llLc,9951
 scanoss/inspection/utils/license_utils.py,sha256=mIaoVWXMA6shkRQmgmiP2mWchjxX4ex8LWs91Nf6rq4,5093
 scanoss/utils/__init__.py,sha256=0hjb5ktavp7utJzFhGMPImPaZiHWgilM2HwvTp5lXJE,1122
 scanoss/utils/file.py,sha256=W-XFLgaTM_td31Y5rzd5DimO4_qXafQhBtKtY_p3JIQ,2184
-scanoss-1.19.2.dist-info/LICENSE,sha256=LLUaXoiyOroIbr5ubAyrxBOwSRLTm35ETO2FmLpy8QQ,1074
-scanoss-1.19.2.dist-info/METADATA,sha256=K3b-9aVszTUmdEO5Dq7liPxe3jBw4Z_ub9f_NY4zgaQ,6019
-scanoss-1.19.2.dist-info/WHEEL,sha256=A3WOREP4zgxI0fKrHUG8DC8013e3dK3n7a6HDbcEIwE,91
-scanoss-1.19.2.dist-info/entry_points.txt,sha256=Uy28xnaDL5KQ7V77sZD5VLDXPNxYYzSr5tsqtiXVzAs,48
-scanoss-1.19.2.dist-info/top_level.txt,sha256=V11PrQ6Pnrc-nDF9xnisnJ8e6-i7HqSIKVNqduRWcL8,27
-scanoss-1.19.2.dist-info/RECORD,,
+scanoss-1.19.4.dist-info/LICENSE,sha256=LLUaXoiyOroIbr5ubAyrxBOwSRLTm35ETO2FmLpy8QQ,1074
+scanoss-1.19.4.dist-info/METADATA,sha256=aodKN8xCOP_yUP5w9Ey4SCrIoXVAIBDjbVBk-xZcNl0,6019
+scanoss-1.19.4.dist-info/WHEEL,sha256=A3WOREP4zgxI0fKrHUG8DC8013e3dK3n7a6HDbcEIwE,91
+scanoss-1.19.4.dist-info/entry_points.txt,sha256=Uy28xnaDL5KQ7V77sZD5VLDXPNxYYzSr5tsqtiXVzAs,48
+scanoss-1.19.4.dist-info/top_level.txt,sha256=V11PrQ6Pnrc-nDF9xnisnJ8e6-i7HqSIKVNqduRWcL8,27
+scanoss-1.19.4.dist-info/RECORD,,