Merge pull request #583 from justahero/sebastian/add-spec-version-type

Add spec version type

Author: Shnatsel

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,11 @@ 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),
 }
 
 #[derive(Debug, thiserror::Error)]
@@ -63,11 +68,19 @@ pub enum XmlWriteError {
 #[derive(Debug, thiserror::Error)]
 #[non_exhaustive]
 pub enum JsonReadError {
+    #[error("IO Error #{0}")]
+    IoError(#[from] std::io::Error),
+
     #[error("Failed to deserialize JSON: {error}")]
     JsonElementReadError {
         #[from]
         error: serde_json::Error,
     },
+    #[error("Invalid input format found: {error}")]
+    BomError {
+        #[from]
+        error: BomError,
+    },
 }
 
 #[derive(Debug, thiserror::Error)]

cyclonedx-bom/src/models/bom.rs

@@ -19,12 +19,15 @@
 use std::collections::HashSet;
 use std::convert::TryInto;
 use std::fmt;
+use std::str::FromStr;
 
 use once_cell::sync::Lazy;
 use regex::Regex;
+use serde::{Deserialize, Serialize};
 use serde_json::Value;
 use xml::{EmitterConfig, EventReader, EventWriter, ParserConfig};
 
+use crate::errors::BomError;
 use crate::models::component::{Component, Components};
 use crate::models::composition::{BomReference, Compositions};
 use crate::models::dependency::Dependencies;
@@ -39,6 +42,38 @@ use crate::validation::{
 };
 use crate::xml::{FromXmlDocument, ToXml};
 
+/// Represents the spec version of a BOM.
+#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone, Copy)]
+#[non_exhaustive]
+pub enum SpecVersion {
+    #[serde(rename = "1.3")]
+    V1_3,
+    #[serde(rename = "1.4")]
+    V1_4,
+}
+
+impl FromStr for SpecVersion {
+    type Err = BomError;
+
+    fn from_str(input: &str) -> Result<Self, Self::Err> {
+        match input {
+            "1.3" => Ok(SpecVersion::V1_3),
+            "1.4" => Ok(SpecVersion::V1_4),
+            s => Err(BomError::UnsupportedSpecVersion(s.to_string())),
+        }
+    }
+}
+
+impl ToString for SpecVersion {
+    fn to_string(&self) -> String {
+        let s = match self {
+            SpecVersion::V1_3 => "1.3",
+            SpecVersion::V1_4 => "1.4",
+        };
+        s.to_string()
+    }
+}
+
 #[derive(Debug, PartialEq, Eq)]
 pub struct Bom {
     pub version: u32,

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

@@ -17,6 +17,7 @@
  */
 
 use crate::errors::BomError;
+use crate::models::bom::SpecVersion;
 use crate::{
     models::{self},
     utilities::{convert_optional, try_convert_optional},
@@ -46,7 +47,7 @@ struct Vulnerabilities();
 #[serde(rename_all = "camelCase")]
 pub(crate) struct Bom {
     bom_format: BomFormat,
-    spec_version: String,
+    spec_version: SpecVersion,
     version: Option<u32>,
     serial_number: Option<UrnUuid>,
     #[serde(skip_serializing_if = "Option::is_none")]
@@ -72,7 +73,7 @@ impl From<models::bom::Bom> for Bom {
     fn from(other: models::bom::Bom) -> Self {
         Self {
             bom_format: BomFormat::CycloneDX,
-            spec_version: "1.3".to_string(),
+            spec_version: SpecVersion::V1_3,
             version: Some(other.version),
             serial_number: convert_optional(other.serial_number),
             metadata: convert_optional(other.metadata),
@@ -94,7 +95,7 @@ impl TryFrom<models::bom::Bom> for Bom {
     fn try_from(other: models::bom::Bom) -> Result<Self, Self::Error> {
         Ok(Self {
             bom_format: BomFormat::CycloneDX,
-            spec_version: "1.3".to_string(),
+            spec_version: SpecVersion::V1_3,
             version: Some(other.version),
             serial_number: convert_optional(other.serial_number),
             metadata: try_convert_optional(other.metadata)?,
@@ -329,7 +330,7 @@ impl FromXmlDocument for Bom {
             })?;
         Ok(Self {
             bom_format: BomFormat::CycloneDX,
-            spec_version: "1.3".to_string(),
+            spec_version: SpecVersion::V1_3,
             version,
             serial_number,
             metadata,
@@ -387,7 +388,7 @@ pub(crate) mod test {
     pub(crate) fn minimal_bom_example() -> Bom {
         Bom {
             bom_format: BomFormat::CycloneDX,
-            spec_version: "1.3".to_string(),
+            spec_version: SpecVersion::V1_3,
             version: Some(1),
             serial_number: Some(UrnUuid("fake-uuid".to_string())),
             metadata: None,
@@ -404,7 +405,7 @@ pub(crate) mod test {
     pub(crate) fn full_bom_example() -> Bom {
         Bom {
             bom_format: BomFormat::CycloneDX,
-            spec_version: "1.3".to_string(),
+            spec_version: SpecVersion::V1_3,
             version: Some(1),
             serial_number: Some(UrnUuid("fake-uuid".to_string())),
             metadata: Some(example_metadata()),

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, _))
+        ));
+    }
 }

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

@@ -17,7 +17,7 @@
  */
 
 use crate::{
-    models::{self},
+    models::{self, bom::SpecVersion},
     utilities::convert_optional,
     xml::{
         expected_namespace_or_error, optional_attribute, read_lax_validation_tag,
@@ -40,7 +40,7 @@ use xml::{reader, writer::XmlEvent};
 #[serde(rename_all = "camelCase")]
 pub(crate) struct Bom {
     bom_format: BomFormat,
-    spec_version: String,
+    spec_version: SpecVersion,
     version: Option<u32>,
     serial_number: Option<UrnUuid>,
     #[serde(skip_serializing_if = "Option::is_none")]
@@ -65,7 +65,7 @@ impl From<models::bom::Bom> for Bom {
     fn from(other: models::bom::Bom) -> Self {
         Self {
             bom_format: BomFormat::CycloneDX,
-            spec_version: "1.4".to_string(),
+            spec_version: SpecVersion::V1_4,
             version: Some(other.version),
             serial_number: convert_optional(other.serial_number),
             metadata: convert_optional(other.metadata),
@@ -316,7 +316,7 @@ impl FromXmlDocument for Bom {
             })?;
         Ok(Self {
             bom_format: BomFormat::CycloneDX,
-            spec_version: "1.4".to_string(),
+            spec_version: SpecVersion::V1_4,
             version,
             serial_number,
             metadata,
@@ -376,7 +376,7 @@ pub(crate) mod test {
     pub(crate) fn minimal_bom_example() -> Bom {
         Bom {
             bom_format: BomFormat::CycloneDX,
-            spec_version: "1.4".to_string(),
+            spec_version: SpecVersion::V1_4,
             version: Some(1),
             serial_number: Some(UrnUuid("fake-uuid".to_string())),
             metadata: None,
@@ -393,7 +393,7 @@ pub(crate) mod test {
     pub(crate) fn full_bom_example() -> Bom {
         Bom {
             bom_format: BomFormat::CycloneDX,
-            spec_version: "1.4".to_string(),
+            spec_version: SpecVersion::V1_4,
             version: Some(1),
             serial_number: Some(UrnUuid("fake-uuid".to_string())),
             metadata: Some(example_metadata()),