Implemented writing SBOM to a file.

Author: madpah

cyclonedx/output/__init__.py

@@ -15,6 +15,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 import importlib
+import os
 from abc import ABC, abstractmethod
 from enum import Enum
 
@@ -52,9 +53,21 @@ def set_bom(self, bom: Bom):
     def output_as_string(self) -> str:
         pass
 
-    @abstractmethod
-    def output_to_file(self, filename: str):
-        pass
+    def output_to_file(self, filename: str, allow_overwrite: bool = False):
+        # Check directory writable
+        output_filename = os.path.realpath(filename)
+        output_directory = os.path.dirname(output_filename)
+
+        if not os.access(output_directory, os.W_OK):
+            raise PermissionError
+
+        if os.path.exists(output_filename) and not allow_overwrite:
+            raise FileExistsError
+
+        with open(output_filename, mode='w') as f_out:
+            f_out.write(self.output_as_string())
+
+        f_out.close()
 
 
 def get_instance(bom: Bom = None, output_format: OutputFormat = OutputFormat.XML,

cyclonedx/output/json.py

@@ -26,9 +26,6 @@ class Json(BaseOutput, BaseSchemaVersion):
     def output_as_string(self) -> str:
         return json.dumps(self._get_json())
 
-    def output_to_file(self, filename: str):
-        raise NotImplementedError
-
     def _get_json(self) -> dict:
         components = list(map(self._get_component_as_dict, self.get_bom().get_components()))
 

cyclonedx/output/xml.py

@@ -39,9 +39,6 @@ def output_as_string(self) -> str:
 
         return Xml.XML_VERSION_DECLARATION + ElementTree.tostring(bom, 'unicode')
 
-    def output_to_file(self, filename: str):
-        raise NotImplementedError
-
     def _component_supports_bom_ref_attribute(self) -> bool:
         return True