Refactor BomError variant to use SpecVersion

This changes the `BomV13SerializationError` to `BomSerializationError`
with added `SpecVersion` parameter.

* add test to check conversion fails

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

Author: justahero

cyclonedx-bom/src/errors.rs

@@ -16,6 +16,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+use crate::models::bom::SpecVersion;
+
 #[derive(Debug, thiserror::Error)]
 #[non_exhaustive]
 pub enum BomError {
@@ -25,8 +27,8 @@ pub enum BomError {
     #[error("Failed to serialize BOM to XML: {0}")]
     XmlSerializationError(String),
 
-    #[error("Failed to serialize BOM to v1.3: {0}")]
-    BomV13SerializationError(String),
+    #[error("Failed to serialize BOM with version {0:?}: {1}")]
+    BomSerializationError(SpecVersion, String),
 
     #[error("Unsupported Spec Version '{0}'")]
     UnsupportedSpecVersion(String),

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

@@ -19,7 +19,7 @@
 use std::convert::TryFrom;
 
 use crate::errors::BomError;
-use crate::errors::BomError::BomV13SerializationError;
+use crate::errors::BomError::BomSerializationError;
 use crate::utilities::try_convert_optional;
 use crate::{
     errors::XmlReadError,
@@ -166,7 +166,10 @@ impl TryFrom<models::component::Component> for Component {
 
     fn try_from(other: models::component::Component) -> Result<Self, Self::Error> {
         match other.version {
-            None => Err(BomV13SerializationError("version missing".to_string())),
+            None => Err(BomSerializationError(
+                models::bom::SpecVersion::V1_3,
+                "version missing".to_string(),
+            )),
             Some(version) => Ok(Self {
                 component_type: other.component_type.to_string(),
                 mime_type: other.mime_type.map(|m| MimeType(m.0)),
@@ -1171,6 +1174,7 @@ impl From<MimeType> for models::component::MimeType {
 #[cfg(test)]
 pub(crate) mod test {
     use crate::{
+        models::bom::SpecVersion,
         specs::v1_3::{
             attached_text::test::{corresponding_attached_text, example_attached_text},
             code::test::{
@@ -1463,4 +1467,16 @@ pub(crate) mod test {
         let expected = example_components();
         assert_eq!(actual, expected);
     }
+
+    #[test]
+    fn it_should_fail_conversion_without_version_field() {
+        let mut component = corresponding_component();
+        component.version = None;
+
+        let result = Component::try_from(component);
+        assert!(matches!(
+            result,
+            Err(BomError::BomSerializationError(SpecVersion::V1_3, _))
+        ));
+    }
 }