Add support for serde traits to cyclonedx-bom types

Author: Naxdy

Cargo.lock

@@ -36,3 +36,7 @@ strum = { version = "0.28.0", features = ["derive"] }
 insta = { version = "1.33.0", features = ["glob", "json"] }
 pretty_assertions = "1.4.0"
 test-utils = {path = "test-utils"}
+
+[features]
+default = []
+serde = ["ordered-float/serde"]

cyclonedx-bom/Cargo.toml

@@ -18,6 +18,7 @@
 
 use std::convert::TryFrom;
 
+#[cfg(feature = "serde")] use serde::{Deserialize, Serialize};
 use thiserror::Error;
 use time::{format_description::well_known::Iso8601, OffsetDateTime};
 
@@ -39,6 +40,7 @@ use crate::validation::ValidationError;
 /// assert_eq!(date_time.to_string(), timestamp);
 /// ```
 #[derive(Clone, Debug, PartialEq, Eq, Hash)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct DateTime(pub(crate) String);
 
 pub fn validate_date_time(date_time: &DateTime) -> Result<(), ValidationError> {

cyclonedx-bom/src/external_models/date_time.rs

@@ -17,13 +17,15 @@
  */
 
 use crate::validation::ValidationError;
+#[cfg(feature = "serde")] use serde::{Deserialize, Serialize};
 use std::fmt::Display;
 use std::ops::Deref;
 
 /// A string that does not contain carriage return, line feed, or tab characters
 ///
 /// Defined via the [XML schema](https://www.w3.org/TR/xmlschema-2/#normalizedString)
 #[derive(Clone, Debug, Default, PartialEq, Eq, Hash)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct NormalizedString(pub(crate) String);
 
 impl NormalizedString {

cyclonedx-bom/src/external_models/normalized_string.rs

@@ -18,6 +18,7 @@
 
 use std::convert::TryFrom;
 
+#[cfg(feature = "serde")] use serde::{Deserialize, Serialize};
 use spdx::{Expression, ParseMode};
 use thiserror::Error;
 
@@ -37,6 +38,7 @@ use crate::{models::bom::BomReference, validation::ValidationError};
 /// # Ok::<(), SpdxIdentifierError>(())
 /// ```
 #[derive(Clone, Debug, PartialEq, Eq, Hash)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct SpdxIdentifier(pub(crate) String);
 
 impl SpdxIdentifier {
@@ -111,6 +113,7 @@ pub enum SpdxIdentifierError {
 /// # Ok::<(), SpdxExpressionError>(())
 /// ```
 #[derive(Clone, Debug, PartialEq, Eq, Hash)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct SpdxExpression {
     pub(crate) bom_ref: Option<BomReference>,
     pub(crate) expression: String,

cyclonedx-bom/src/external_models/spdx.rs

@@ -19,6 +19,7 @@
 use std::{convert::TryFrom, str::FromStr};
 
 use fluent_uri::UriRef as Url;
+#[cfg(feature = "serde")] use serde::{Deserialize, Serialize};
 use purl::{GenericPurl, GenericPurlBuilder};
 use thiserror::Error;
 
@@ -32,6 +33,7 @@ pub fn validate_purl(purl: &Purl) -> Result<(), ValidationError> {
 }
 
 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct Purl(pub(crate) String);
 
 impl Purl {
@@ -72,6 +74,7 @@ pub fn validate_uri(uri: &Uri) -> Result<(), ValidationError> {
 }
 
 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct Uri(pub(crate) String);
 
 impl Uri {

cyclonedx-bom/src/external_models/uri.rs

@@ -20,13 +20,15 @@ use crate::external_models::normalized_string::validate_normalized_string;
 use crate::external_models::uri::validate_uri;
 use crate::external_models::{normalized_string::NormalizedString, uri::Uri};
 use crate::validation::{Validate, ValidationContext, ValidationResult};
+#[cfg(feature = "serde")] use serde::{Deserialize, Serialize};
 
 use super::bom::SpecVersion;
 
 /// Represents an advisory, a notification of a threat to a component, service, or system.
 ///
 /// Defined via the [XML schema](https://cyclonedx.org/docs/1.4/xml/#type_advisoryType)
 #[derive(Clone, Debug, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct Advisory {
     pub title: Option<NormalizedString>,
     pub url: Uri,
@@ -58,6 +60,7 @@ impl Validate for Advisory {
 }
 
 #[derive(Clone, Debug, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct Advisories(pub Vec<Advisory>);
 
 impl Validate for Advisories {

cyclonedx-bom/src/models/advisory.rs

@@ -27,10 +27,12 @@ use crate::{
     prelude::{Validate, ValidationResult},
     validation::ValidationContext,
 };
+#[cfg(feature = "serde")] use serde::{Deserialize, Serialize};
 
 use super::bom::SpecVersion;
 
 #[derive(Clone, Debug, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct Annotations(pub Vec<Annotation>);
 
 impl Validate for Annotations {
@@ -44,6 +46,7 @@ impl Validate for Annotations {
 }
 
 #[derive(Clone, Debug, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct Annotation {
     pub bom_ref: Option<String>,
     pub subjects: Vec<String>,
@@ -64,6 +67,7 @@ impl Validate for Annotation {
 
 /// Represents an Annotator: organization, individual, component or service.
 #[derive(Clone, Debug, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub enum Annotator {
     Organization(OrganizationalEntity),
     Individual(OrganizationalContact),

cyclonedx-bom/src/models/annotation.rs

@@ -22,10 +22,12 @@ use crate::{
     external_models::normalized_string::{validate_normalized_string, NormalizedString},
     validation::{Validate, ValidationContext, ValidationError, ValidationResult},
 };
+#[cfg(feature = "serde")] use serde::{Deserialize, Serialize};
 
 use super::bom::SpecVersion;
 
 #[derive(Clone, Debug, PartialEq, Eq, Hash)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct AttachedText {
     pub content_type: Option<NormalizedString>,
     pub encoding: Option<Encoding>,
@@ -82,6 +84,7 @@ pub fn validate_encoding(encoding: &Encoding) -> Result<(), ValidationError> {
 }
 
 #[derive(Clone, Debug, PartialEq, Eq, strum::Display, Hash)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[strum(serialize_all = "kebab-case")]
 pub enum Encoding {
     Base64,

cyclonedx-bom/src/models/attached_text.rs

@@ -20,10 +20,12 @@ use crate::{
     prelude::{Validate, ValidationResult},
     validation::{ValidationContext, ValidationError},
 };
+#[cfg(feature = "serde")] use serde::{Deserialize, Serialize};
 
 use super::bom::SpecVersion;
 
 #[derive(Clone, Debug, PartialEq, Eq, Hash)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct Attachment {
     pub content: String,
     pub content_type: Option<String>,