chore:SP-1022 Refactor on Jira Markdown output

Author: agustingroh

Diff for: CHANGELOG.md

@@ -9,9 +9,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Upcoming changes...
 
+## [1.19.4] - 2025-01-08
+### Added
+- Refactor on Jira Markdown output on inspect command
+
 ## [1.19.3] - 2025-01-07
 ### Added
-- Add Jira Markdown output on inspect command ç
+- Add Jira Markdown output on inspect command
 - This is useful for calls from integrations (i.e. Jenkins)
 
 ## [1.19.2] - 2025-01-06
@@ -435,4 +439,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [1.19.0]: https://github.com/scanoss/scanoss.py/compare/v1.18.1...v1.19.0
 [1.19.1]: https://github.com/scanoss/scanoss.py/compare/v1.19.0...v1.19.1
 [1.19.2]: https://github.com/scanoss/scanoss.py/compare/v1.19.1...v1.19.2
-[1.19.3]: https://github.com/scanoss/scanoss.py/compare/v1.19.2...v1.19.3
+[1.19.3]: https://github.com/scanoss/scanoss.py/compare/v1.19.2...v1.19.3
+[1.19.4]: https://github.com/scanoss/scanoss.py/compare/v1.19.3...v1.19.4

Diff for: src/scanoss/__init__.py

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

Diff for: src/scanoss/inspection/policy_check.py

@@ -289,11 +289,11 @@ def generate_jira_table(self, headers, rows, centered_columns=None):
             self.print_stderr('ERROR: Header are no set')
             return None
 
-        table_header = '|*' + col_sep.join(headers) + '*|\\n'
+        table_header = '|*' + col_sep.join(headers) + '*|\n'
         table = table_header
         for row in rows:
             if len(headers) == len(row):
-                table += '|' + '|'.join(row) + '|\\n'
+                table += '|' + '|'.join(row) + '|\n'
 
         return table
 

Diff for: src/scanoss/inspection/undeclared_component.py

@@ -82,11 +82,11 @@ def _get_jira_summary(self, components: list) -> str:
             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_str}\\n{{code}}\\n'
+                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_str}\\n{{code}}\\n'
+                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'
 

Diff for: tests/test_policy_inspect.py

@@ -340,8 +340,36 @@ def test_undeclared_policy_jira_markdown_output(self):
         status, results = undeclared.run()
         details = results['details']
         summary = results['summary']
-        expected_details_output = "|*Component*|*Version*|*License*|\\n|pkg:github/scanoss/scanner.c|1.3.3|BSD-2-Clause - GPL-2.0-only|\\n|pkg:github/scanoss/scanner.c|1.1.4|GPL-2.0-only|\\n|pkg:github/scanoss/wfp|6afc1f6|Zlib - GPL-2.0-only|\\n|pkg:npm/%40electron/rebuild|3.7.0|MIT|\\n|pkg:npm/%40emotion/react|11.13.3|MIT|\\n"
-        expected_summary_output = r"5 undeclared component(s) were found.\nAdd the following snippet into your `scanoss.json` file\n{code:json}\n{\n  \"bom\": {\n    \"include\": [\n      {\n        \"purl\": \"pkg:github/scanoss/scanner.c\"\n      },\n      {\n        \"purl\": \"pkg:github/scanoss/wfp\"\n      },\n      {\n        \"purl\": \"pkg:npm/%40electron/rebuild\"\n      },\n      {\n        \"purl\": \"pkg:npm/%40emotion/react\"\n      }\n    ]\n  }\n}\n{code}\n"
+        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)
@@ -353,7 +381,13 @@ def test_copyleft_policy_jira_markdown_output(self):
         copyleft = Copyleft(filepath=input_file_name, format_type='jira_md')
         status, results = copyleft.run()
         details = results['details']
-        expected_details_output = r"|*Component*|*Version*|*License*|*URL*|*Copyleft*|\n|pkg:github/scanoss/scanner.c|1.3.3|GPL-2.0-only|https://spdx.org/licenses/GPL-2.0-only.html|YES|\n|pkg:github/scanoss/scanner.c|1.1.4|GPL-2.0-only|https://spdx.org/licenses/GPL-2.0-only.html|YES|\n|pkg:github/scanoss/engine|5.4.0|GPL-2.0-only|https://spdx.org/licenses/GPL-2.0-only.html|YES|\n|pkg:github/scanoss/wfp|6afc1f6|GPL-2.0-only|https://spdx.org/licenses/GPL-2.0-only.html|YES|\n|pkg:github/scanoss/engine|4.0.4|GPL-2.0-only|https://spdx.org/licenses/GPL-2.0-only.html|YES|\n"
+        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)