Merge pull request #2698 from agschrei/add-cyclonedx-output-option

Add CycloneDx output option

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Author: pombredanne

AUTHORS.rst

@@ -6,6 +6,7 @@ The following organizations or individuals have contributed to ScanCode:
 - Agni Bhattacharyya @PyAgni
 - Akanksha Garg @akugarg
 - Alex Blekhman @a-tinsmith
+- Alexander Gschrei @agschrei
 - Armijn Hemmel @armijnhemel
 - Arnaud Jeansen @ajeans
 - Arnav Mandal @arnav-mandal1234

CHANGELOG.rst

@@ -73,7 +73,8 @@ Package detection:
 Outputs:
 ~~~~~~~~
 
-- There is a new CycloneDX 1.2 output as XML and JSON.
+ - Add new outputs for the CycloneDx format.
+   The CLI now exposes options to produce CycloneDx BOMs in either JSON or XML format
 
 
 Output version

docs/source/cli-reference/output-format.rst

@@ -576,4 +576,31 @@ Comparing Different ``json`` Output Formats
 
 ----
 
+``--cyclonedx FILE``
+--------------------
+    Scancode also supports the `CycloneDx <https://cyclonedx.org/specification/overview/>`_ output format
+
+    Please note that this output format is only useful when scanning with the ``--package`` option
+
+    This output format is particularly useful if you want to process ScanCode results
+    in downstream tools that can't process ScanCode's native JSON output,
+    but do support CycloneDx BOMs.
+
+    To run an example scan on the test resources try:
+    ``./scancode --package --cyclonedx=bom.json tests/formattedcode/data/cyclonedx/simple``
+
+    If you prefer XML output over JSON, please have a look at the ``--cyclonedx-xml`` option instead
+
+____
+
+``--cyclonedx-xml FILE``
+-------------------------
+
+    This option allows outputting CycloneDx BOMs in XML format instead of JSON
+
+    To run an example scan on the test resources try:
+    ``./scancode --package --cyclonedx-xml=bom.xml tests/formattedcode/data/cyclonedx/simple``
+
+____
+
 .. include::  /rst_snippets/custom_output_format.rst

docs/source/rst_snippets/output_format_options.rst

@@ -31,4 +31,10 @@ All Scan Output Options
 --html-app FILE         Write scan output as a mini HTML
                         application to FILE.
 
+--cyclonedx FILE        Write scan output as a CycloneDx 1.3 BOM
+                        in pretty-printed JSON format to FILE
+
+--cyclonedx-xml FILE    Write scan output as a CycloneDx 1.3 BOM
+                        in pretty-printed XML format to FILE
+
 .. include::  /rst_snippets/warning_snippets/output_htmlapp_dep.rst

setup.cfg

@@ -198,6 +198,8 @@ scancode_output =
     template = formattedcode.output_html:CustomTemplateOutput
     debian = formattedcode.output_debian:DebianCopyrightOutput
     yaml = formattedcode.output_yaml:YamlOutput
+    cyclonedx = formattedcode.output_cyclonedx:CycloneDxJsonOutput
+    cyclonedx-xml = formattedcode.output_cyclonedx:CycloneDxXmlOutput
 
 
 [tool:pytest]