feat: move output.BomRefDiscriminator to contrib.bom.utils.BomRefDiscriminator

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

Author: jkowalleck

cyclonedx/output/json.py

@@ -19,6 +19,7 @@
 from json import dumps as json_dumps, loads as json_loads
 from typing import TYPE_CHECKING, Any, Literal, Optional, Union
 
+from ..contrib.bom.utils import BomRefDiscriminator
 from ..exception.output import FormatNotSupportedException
 from ..schema import OutputFormat, SchemaVersion
 from ..schema.schema import (
@@ -33,7 +34,7 @@
     SchemaVersion1Dot6,
     SchemaVersion1Dot7,
 )
-from . import BaseOutput, BomRefDiscriminator
+from . import BaseOutput
 
 if TYPE_CHECKING:  # pragma: no cover
     from ..model.bom import Bom

cyclonedx/output/xml.py

@@ -20,6 +20,7 @@
 from xml.dom.minidom import parseString as dom_parseString  # nosec B408
 from xml.etree.ElementTree import Element as XmlElement, tostring as xml_dumps  # nosec B405
 
+from ..contrib.bom.utils import BomRefDiscriminator
 from ..schema import OutputFormat, SchemaVersion
 from ..schema.schema import (
     SCHEMA_VERSIONS,
@@ -33,7 +34,7 @@
     SchemaVersion1Dot6,
     SchemaVersion1Dot7,
 )
-from . import BaseOutput, BomRefDiscriminator
+from . import BaseOutput
 
 if TYPE_CHECKING:  # pragma: no cover
     from ..model.bom import Bom

tests/__init__.py

@@ -25,7 +25,7 @@
 
 from sortedcontainers import SortedSet
 
-from cyclonedx.output import BomRefDiscriminator as _BomRefDiscriminator
+from cyclonedx.contrib.bom.utils import BomRefDiscriminator as _BomRefDiscriminator
 from cyclonedx.schema import OutputFormat, SchemaVersion
 
 if TYPE_CHECKING:

tests/test_contrib_bom_utils.py

@@ -0,0 +1,49 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+from unittest import TestCase
+
+from cyclonedx.contrib.bom.utils import BomRefDiscriminator
+from cyclonedx.model.bom_ref import BomRef
+
+
+class TestBomRefDiscriminator(TestCase):
+
+    def test_discriminate_and_reset_with(self) -> None:
+        bomref1 = BomRef('djdlkfjdslkf')
+        bomref2 = BomRef('djdlkfjdslkf')
+        self.assertEqual(bomref1.value, bomref2.value, 'blank')
+        discr = BomRefDiscriminator([bomref1, bomref2])
+        self.assertEqual(bomref1.value, bomref2.value, 'init')
+        discr.discriminate()
+        self.assertNotEqual(bomref1.value, bomref2.value, 'should be discriminated')
+        discr.reset()
+        self.assertEqual('djdlkfjdslkf', bomref1.value)
+        self.assertEqual('djdlkfjdslkf', bomref2.value)
+
+    def test_discriminate_and_reset_manually(self) -> None:
+        bomref1 = BomRef('djdlkfjdslkf')
+        bomref2 = BomRef('djdlkfjdslkf')
+        self.assertEqual(bomref1.value, bomref2.value, 'blank')
+        discr = BomRefDiscriminator([bomref1, bomref2])
+        self.assertEqual(bomref1.value, bomref2.value, 'init')
+        with discr:
+            self.assertNotEqual(bomref1.value, bomref2.value, 'should be discriminated')
+        discr.reset()
+        self.assertEqual('djdlkfjdslkf', bomref1.value)
+        self.assertEqual('djdlkfjdslkf', bomref2.value)

tests/test_output.py

@@ -24,7 +24,7 @@
 
 from cyclonedx.model.bom import Bom
 from cyclonedx.model.bom_ref import BomRef
-from cyclonedx.output import BomRefDiscriminator, make_outputter
+from cyclonedx.output import make_outputter
 from cyclonedx.schema import OutputFormat, SchemaVersion
 
 
@@ -49,30 +49,3 @@ def test_fails_on_wrong_args(self, of: OutputFormat, sv: SchemaVersion, raises_r
         bom = Mock(spec=Bom)
         with self.assertRaisesRegex(*raises_regex):
             make_outputter(bom, of, sv)
-
-
-class TestBomRefDiscriminator(TestCase):
-
-    def test_discriminate_and_reset_with(self) -> None:
-        bomref1 = BomRef('djdlkfjdslkf')
-        bomref2 = BomRef('djdlkfjdslkf')
-        self.assertEqual(bomref1.value, bomref2.value, 'blank')
-        discr = BomRefDiscriminator([bomref1, bomref2])
-        self.assertEqual(bomref1.value, bomref2.value, 'init')
-        discr.discriminate()
-        self.assertNotEqual(bomref1.value, bomref2.value, 'should be discriminated')
-        discr.reset()
-        self.assertEqual('djdlkfjdslkf', bomref1.value)
-        self.assertEqual('djdlkfjdslkf', bomref2.value)
-
-    def test_discriminate_and_reset_manually(self) -> None:
-        bomref1 = BomRef('djdlkfjdslkf')
-        bomref2 = BomRef('djdlkfjdslkf')
-        self.assertEqual(bomref1.value, bomref2.value, 'blank')
-        discr = BomRefDiscriminator([bomref1, bomref2])
-        self.assertEqual(bomref1.value, bomref2.value, 'init')
-        with discr:
-            self.assertNotEqual(bomref1.value, bomref2.value, 'should be discriminated')
-        discr.reset()
-        self.assertEqual('djdlkfjdslkf', bomref1.value)
-        self.assertEqual('djdlkfjdslkf', bomref2.value)