Move Advisory & Signature to common specs

This moves `Advisory` & `Signature` related types from the 1.4 folder to
`common`. These types are the same for version 1.4 to 1.6.

Signed-off-by: Sebastian Ziebell <[email protected]>

Author: justahero

cyclonedx-bom/src/specs/v1_4/advisory.rs renamed to cyclonedx-bom/src/specs/common/advisory.rs

@@ -1,8 +1,28 @@
+/*
+ * This file is part of CycloneDX Rust Cargo.
+ *
+ * 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
+ */
+
+pub(crate) mod advisory;
 pub(crate) mod attached_text;
 pub(crate) mod code;
 pub(crate) mod dependency;
 pub(crate) mod external_reference;
 pub(crate) mod hash;
 pub(crate) mod organization;
 pub(crate) mod property;
+pub(crate) mod signature;
 pub(crate) mod tool;

cyclonedx-bom/src/specs/common/mod.rs

@@ -1,6 +1,6 @@
 ---
-source: cyclonedx-bom/src/specs/v1_4/advisory.rs
-assertion_line: 219
+source: cyclonedx-bom/src/specs/common/advisory.rs
+assertion_line: 215
 expression: xml_output
 ---
 <?xml version="1.0" encoding="utf-8"?>

cyclonedx-bom/src/specs/v1_4/signature.rs renamed to cyclonedx-bom/src/specs/common/signature.rs

@@ -28,10 +28,11 @@ use crate::{
 use crate::{
     specs::common::{
         dependency::Dependencies, external_reference::ExternalReferences, property::Properties,
+        signature::Signature,
     },
     specs::v1_4::{
         component::Components, composition::Compositions, metadata::Metadata, service::Services,
-        signature::Signature, vulnerability::Vulnerabilities,
+        vulnerability::Vulnerabilities,
     },
     xml::ToXml,
 };
@@ -378,13 +379,13 @@ pub(crate) mod test {
                 corresponding_external_references, example_external_references,
             },
             property::test::{corresponding_properties, example_properties},
+            signature::test::{corresponding_signature, example_signature},
         },
         specs::v1_4::{
             component::test::{corresponding_components, example_components},
             composition::test::{corresponding_compositions, example_compositions},
             metadata::test::{corresponding_metadata, example_metadata},
             service::test::{corresponding_services, example_services},
-            signature::test::{corresponding_signature, example_signature},
         },
         xml::test::{read_document_from_string, write_element_to_string},
     };

cyclonedx-bom/src/specs/v1_4/snapshots/cyclonedx_bom__specs__v1_4__advisory__test__it_should_write_xml_full.snap renamed to cyclonedx-bom/src/specs/common/snapshots/cyclonedx_bom__specs__common__advisory__test__it_should_write_xml_full.snap

@@ -25,7 +25,7 @@ use crate::{
     specs::common::{
         attached_text::AttachedText, code::Commits, code::Patches,
         external_reference::ExternalReferences, hash::Hashes, organization::OrganizationalEntity,
-        property::Properties,
+        property::Properties, signature::Signature,
     },
     specs::v1_4::license::Licenses,
     xml::{
@@ -42,8 +42,6 @@ use crate::{
 use serde::{Deserialize, Serialize};
 use xml::{reader, writer::XmlEvent};
 
-use super::signature::Signature;
-
 #[derive(Debug, Deserialize, Serialize, PartialEq)]
 #[serde(transparent)]
 pub(crate) struct Components(Vec<Component>);
@@ -1209,11 +1207,9 @@ pub(crate) mod test {
             hash::test::{corresponding_hashes, example_hashes},
             organization::test::{corresponding_entity, example_entity},
             property::test::{corresponding_properties, example_properties},
-        },
-        specs::v1_4::{
-            license::test::{corresponding_licenses, example_licenses},
             signature::test::{corresponding_signature, example_signature},
         },
+        specs::v1_4::license::test::{corresponding_licenses, example_licenses},
         xml::test::{read_element_from_string, write_element_to_string},
     };
 

cyclonedx-bom/src/specs/v1_4/bom.rs

@@ -19,6 +19,7 @@
 use crate::{
     errors::XmlReadError,
     models,
+    specs::common::signature::Signature,
     utilities::{convert_optional, convert_optional_vec, convert_vec},
     xml::{
         attribute_or_error, closing_tag_or_error, read_lax_validation_list_tag, read_simple_tag,
@@ -29,8 +30,6 @@ use crate::{
 use serde::{Deserialize, Serialize};
 use xml::{reader, writer::XmlEvent};
 
-use super::signature::Signature;
-
 #[derive(Debug, Deserialize, Serialize, PartialEq)]
 #[serde(transparent)]
 pub(crate) struct Compositions(Vec<Composition>);
@@ -302,10 +301,8 @@ impl FromXml for BomReference {
 
 #[cfg(test)]
 pub(crate) mod test {
-    use crate::{
-        specs::v1_4::signature::test::{corresponding_signature, example_signature},
-        xml::test::{read_element_from_string, write_element_to_string},
-    };
+    use crate::specs::common::signature::test::{corresponding_signature, example_signature};
+    use crate::xml::test::{read_element_from_string, write_element_to_string};
 
     use super::*;
 

cyclonedx-bom/src/specs/v1_4/component.rs

@@ -16,14 +16,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-pub(crate) mod advisory;
 pub(crate) mod bom;
 pub(crate) mod component;
 pub(crate) mod composition;
 pub(crate) mod license;
 pub(crate) mod metadata;
 pub(crate) mod service;
-pub(crate) mod signature;
 pub(crate) mod vulnerability;
 pub(crate) mod vulnerability_analysis;
 pub(crate) mod vulnerability_credits;

cyclonedx-bom/src/specs/v1_4/composition.rs

@@ -32,12 +32,10 @@ use xml::{reader, writer::XmlEvent};
 
 use crate::specs::common::{
     external_reference::ExternalReferences, organization::OrganizationalEntity,
-    property::Properties,
+    property::Properties, signature::Signature,
 };
 use crate::specs::v1_4::license::Licenses;
 
-use super::signature::Signature;
-
 #[derive(Debug, Deserialize, Serialize, PartialEq)]
 #[serde(transparent)]
 pub(crate) struct Services(Vec<Service>);
@@ -530,11 +528,9 @@ pub(crate) mod test {
             },
             organization::test::{corresponding_entity, example_entity},
             property::test::{corresponding_properties, example_properties},
-        },
-        specs::v1_4::{
-            license::test::{corresponding_licenses, example_licenses},
             signature::test::{corresponding_signature, example_signature},
         },
+        specs::v1_4::license::test::{corresponding_licenses, example_licenses},
         xml::test::{read_element_from_string, write_element_to_string},
     };
 

cyclonedx-bom/src/specs/v1_4/mod.rs

@@ -30,12 +30,11 @@ use crate::{
 use serde::{Deserialize, Serialize};
 use xml::{reader, writer::XmlEvent};
 
-use crate::specs::common::{property::Properties, tool::Tools};
+use crate::specs::common::{advisory::Advisories, property::Properties, tool::Tools};
 use crate::specs::v1_4::{
-    advisory::Advisories, vulnerability_analysis::VulnerabilityAnalysis,
-    vulnerability_credits::VulnerabilityCredits, vulnerability_rating::VulnerabilityRatings,
-    vulnerability_reference::VulnerabilityReferences, vulnerability_source::VulnerabilitySource,
-    vulnerability_target::VulnerabilityTargets,
+    vulnerability_analysis::VulnerabilityAnalysis, vulnerability_credits::VulnerabilityCredits,
+    vulnerability_rating::VulnerabilityRatings, vulnerability_reference::VulnerabilityReferences,
+    vulnerability_source::VulnerabilitySource, vulnerability_target::VulnerabilityTargets,
 };
 
 #[derive(Debug, Deserialize, Serialize, PartialEq)]
@@ -499,11 +498,11 @@ pub(crate) mod test {
     use super::*;
     use crate::{
         specs::common::{
+            advisory::test::{corresponding_advisories, example_advisories},
             property::test::{corresponding_properties, example_properties},
             tool::test::{corresponding_tools, example_tools},
         },
         specs::v1_4::{
-            advisory::test::{corresponding_advisories, example_advisories},
             vulnerability_analysis::test::{
                 corresponding_vulnerability_analysis, example_vulnerability_analysis,
             },