tests: compoennt versions optional (#350)

* chore: exclude `venv*` from QA; add typing to QA

Signed-off-by: Jan Kowalleck <[email protected]>

* tests: component versions are optional

Signed-off-by: Jan Kowalleck <[email protected]>

---------

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

.isort.cfg

@@ -6,7 +6,7 @@ skip_gitignore = false
 skip_glob =
     build/*,dist/*,__pycache__,.eggs,*.egg-info*,
     *_cache,*.cache,
-    .git/*,.tox/*,.venv/*,venv/*
+    .git/*,.tox/*,.venv/*,venv/*,.venv*/*,venv*/*,
     _OLD/*,_TEST/*,
     docs/*
 combine_as_imports = true
@@ -18,3 +18,4 @@ multi_line_output = 3
 src_paths =
     cyclonedx
     tests
+    typings

CONTRIBUTING.md

@@ -23,7 +23,7 @@ Get it all applied via:
 
 ```shell
 poetry run isort .
-poetry run flake8 cyclonedx/ tests/
+poetry run flake8 cyclonedx/ tests/ typings/
 ```
 
 ## Documentation

tests/test_model_component.py

@@ -109,9 +109,7 @@ class TestModelComponent(TestCase):
 
     @patch('cyclonedx.model.component.uuid4', return_value=MOCK_UUID_7)
     def test_empty_basic_component(self, mock_uuid: Mock) -> None:
-        c = Component(
-            name='test-component', version='1.2.3'
-        )
+        c = Component(name='test-component')
         mock_uuid.assert_called()
         self.assertEqual(c.name, 'test-component')
         self.assertEqual(c.type, ComponentType.LIBRARY)
@@ -121,7 +119,7 @@ def test_empty_basic_component(self, mock_uuid: Mock) -> None:
         self.assertIsNone(c.author)
         self.assertIsNone(c.publisher)
         self.assertIsNone(c.group)
-        self.assertEqual(c.version, '1.2.3')
+        self.assertIsNone(c.version)
         self.assertIsNone(c.description)
         self.assertIsNone(c.scope)
         self.assertSetEqual(c.hashes, set())
@@ -136,20 +134,16 @@ def test_empty_basic_component(self, mock_uuid: Mock) -> None:
 
     @patch('cyclonedx.model.component.uuid4', return_value=MOCK_UUID_7)
     def test_multiple_basic_components(self, mock_uuid: Mock) -> None:
-        c1 = Component(
-            name='test-component', version='1.2.3'
-        )
+        c1 = Component(name='test-component')
         self.assertEqual(c1.name, 'test-component')
-        self.assertEqual(c1.version, '1.2.3')
+        self.assertIsNone(c1.version)
         self.assertEqual(c1.type, ComponentType.LIBRARY)
         self.assertEqual(len(c1.external_references), 0)
         self.assertEqual(len(c1.hashes), 0)
 
-        c2 = Component(
-            name='test2-component', version='3.2.1'
-        )
+        c2 = Component(name='test2-component')
         self.assertEqual(c2.name, 'test2-component')
-        self.assertEqual(c2.version, '3.2.1')
+        self.assertIsNone(c2.version)
         self.assertEqual(c2.type, ComponentType.LIBRARY)
         self.assertEqual(len(c2.external_references), 0)
         self.assertEqual(len(c2.hashes), 0)
@@ -159,52 +153,42 @@ def test_multiple_basic_components(self, mock_uuid: Mock) -> None:
         mock_uuid.assert_called()
 
     def test_external_references(self) -> None:
-        c = Component(
-            name='test-component', version='1.2.3'
-        )
+        c = Component(name='test-component')
         c.external_references.add(ExternalReference(
             type=ExternalReferenceType.OTHER,
             url=XsUri('https://cyclonedx.org'),
             comment='No comment'
         ))
         self.assertEqual(c.name, 'test-component')
-        self.assertEqual(c.version, '1.2.3')
+        self.assertIsNone(c.version)
         self.assertEqual(c.type, ComponentType.LIBRARY)
         self.assertEqual(len(c.external_references), 1)
         self.assertEqual(len(c.hashes), 0)
 
-        c2 = Component(
-            name='test2-component', version='3.2.1'
-        )
+        c2 = Component(name='test2-component')
         self.assertEqual(c2.name, 'test2-component')
-        self.assertEqual(c2.version, '3.2.1')
+        self.assertIsNone(c2.version)
         self.assertEqual(c2.type, ComponentType.LIBRARY)
         self.assertEqual(len(c2.external_references), 0)
         self.assertEqual(len(c2.hashes), 0)
 
-    def test_empty_basic_component_no_version(self) -> None:
-        c = Component(
-            name='test-component'
-        )
+    def test_empty_component_with_version(self) -> None:
+        c = Component(name='test-component', version='1.2.3')
         self.assertEqual(c.name, 'test-component')
-        self.assertIsNone(c.version, None)
+        self.assertEqual(c.version, '1.2.3')
         self.assertEqual(c.type, ComponentType.LIBRARY)
         self.assertEqual(len(c.external_references), 0)
         self.assertEqual(len(c.hashes), 0)
 
     def test_component_equal_1(self) -> None:
-        c = Component(
-            name='test-component', version='1.2.3'
-        )
+        c = Component(name='test-component')
         c.external_references.add(ExternalReference(
             type=ExternalReferenceType.OTHER,
             url=XsUri('https://cyclonedx.org'),
             comment='No comment'
         ))
 
-        c2 = Component(
-            name='test-component', version='1.2.3'
-        )
+        c2 = Component(name='test-component')
         c2.external_references.add(ExternalReference(
             type=ExternalReferenceType.OTHER,
             url=XsUri('https://cyclonedx.org'),
@@ -289,18 +273,18 @@ def test_sort(self) -> None:
         self.assertListEqual(sorted_components, expected_components)
 
     def test_nested_components_1(self) -> None:
-        comp_b = Component(name="comp_b", version="1.0.0")
-        comp_c = Component(name="comp_c", version="1.0.0")
+        comp_b = Component(name="comp_b")
+        comp_c = Component(name="comp_c")
         comp_b.components.add(comp_c)
 
         self.assertEqual(1, len(comp_b.components))
         self.assertEqual(2, len(comp_b.get_all_nested_components(include_self=True)))
         self.assertEqual(1, len(comp_b.get_all_nested_components(include_self=False)))
 
     def test_nested_components_2(self) -> None:
-        comp_a = Component(name="comp_a", version="1.2.3")
-        comp_b = Component(name="comp_b", version="1.0.0")
-        comp_c = Component(name="comp_c", version="1.0.0")
+        comp_a = Component(name="comp_a")
+        comp_b = Component(name="comp_b")
+        comp_c = Component(name="comp_c")
         comp_b.components.add(comp_c)
         comp_b.components.add(comp_a)
 

tests/test_output_json.py

@@ -384,17 +384,20 @@ def test_bom_v1_2_issue_275_components(self) -> None:
             fixture='bom_issue_275_components.json'
         )
 
-    # Helper methods
+    # region Helper methods
+
     def _validate_json_bom(self, bom: Bom, schema_version: SchemaVersion, fixture: str) -> None:
         outputter = get_instance(bom=bom, output_format=OutputFormat.JSON, schema_version=schema_version)
         self.assertEqual(outputter.schema_version, schema_version)
         with open(
                 join(dirname(__file__), f'fixtures/json/{schema_version.to_version()}/{fixture}')) as expected_json:
-            self.assertValidAgainstSchema(bom_json=outputter.output_as_string(), schema_version=schema_version)
-            self.assertEqualJsonBom(expected_json.read(), outputter.output_as_string())
-            expected_json.close()
+            output_as_string = outputter.output_as_string()
+            self.assertValidAgainstSchema(bom_json=output_as_string, schema_version=schema_version)
+            self.assertEqualJsonBom(expected_json.read(), output_as_string)
 
     def _validate_json_bom_not_supported(self, bom: Bom, schema_version: SchemaVersion) -> None:
         with self.assertRaises(FormatNotSupportedException):
             outputter = get_instance(bom=bom, output_format=OutputFormat.JSON, schema_version=schema_version)
             outputter.output_as_string()
+
+    # endregion Helper methods

tests/test_output_xml.py

@@ -522,14 +522,17 @@ def test_bom_v1_0_issue_275_components(self) -> None:
                 fixture='bom_issue_275_components.xml'
             )
 
-    # Helper methods
+    # region Helper methods
+
     def _validate_xml_bom(self, bom: Bom, schema_version: SchemaVersion, fixture: str) -> None:
         outputter = get_instance(bom=bom, schema_version=schema_version)
         self.assertEqual(outputter.schema_version, schema_version)
         with open(
                 join(dirname(__file__), f'fixtures/xml/{schema_version.to_version()}/{fixture}')) as expected_xml:
-            self.assertValidAgainstSchema(bom_xml=outputter.output_as_string(), schema_version=schema_version)
+            output_as_string = outputter.output_as_string()
+            self.assertValidAgainstSchema(bom_xml=output_as_string, schema_version=schema_version)
             self.assertEqualXmlBom(
-                expected_xml.read(), outputter.output_as_string(), namespace=outputter.get_target_namespace()
+                expected_xml.read(), output_as_string, namespace=outputter.get_target_namespace()
             )
-            expected_xml.close()
+
+    # endregion Helper methods

tox.ini

@@ -44,7 +44,7 @@ commands =
 exclude =
     build,dist,__pycache__,.eggs,*.egg-info*,
     *_cache,*.cache,
-    .git,.tox,.venv,venv
+    .git,.tox,.venv,venv,.venv*,venv*,
     _OLD,_TEST,
     docs
 max-line-length = 120