Add format field to the serialized data

Author: Shnatsel

auditable-serde/src/lib.rs

@@ -36,6 +36,9 @@ use std::str::FromStr;
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
 pub struct VersionInfo {
     pub packages: Vec<Package>,
+    #[serde(default)]
+    #[serde(skip_serializing_if = "is_default")]
+    pub format: u32,
 }
 
 /// A single package in the dependency tree
@@ -117,7 +120,7 @@ pub enum DependencyKind {
     Runtime,
 }
 
-fn is_default<T: Default + PartialEq>(value: &T) -> bool {
+pub(crate) fn is_default<T: Default + PartialEq>(value: &T) -> bool {
     let default_value = T::default();
     value == &default_value
 }

auditable-serde/src/validation.rs

@@ -1,10 +1,13 @@
-use crate::{Package, VersionInfo};
+use crate::{Package, VersionInfo, is_default};
 use serde::{Deserialize, Serialize};
 use std::{convert::TryFrom, fmt::Display};
 
 #[derive(Serialize, Deserialize, Debug, PartialEq, Eq, PartialOrd, Ord, Clone)]
 pub struct RawVersionInfo {
     pub packages: Vec<Package>,
+    #[serde(default)]
+    #[serde(skip_serializing_if = "is_default")]
+    pub format: u32,
 }
 
 pub enum ValidationError {
@@ -36,6 +39,7 @@ impl TryFrom<RawVersionInfo> for VersionInfo {
         } else {
             Ok(VersionInfo {
                 packages: v.packages,
+                format: v.format,
             })
         }
     }
@@ -99,6 +103,7 @@ mod tests {
         let pkg1 = dummy_package(1, false, vec![0]);
         let raw = RawVersionInfo {
             packages: vec![pkg0, pkg1],
+            format: 0,
         };
         assert!(VersionInfo::try_from(raw).is_err());
     }
@@ -109,6 +114,7 @@ mod tests {
         let pkg1 = dummy_package(1, false, vec![]);
         let raw = RawVersionInfo {
             packages: vec![pkg0, pkg1],
+            format: 0,
         };
         assert!(VersionInfo::try_from(raw).is_ok());
     }

cargo-auditable/src/auditable_from_metadata.rs

@@ -218,7 +218,7 @@ pub fn encode_audit_data(
             package.dependencies.sort_unstable();
         }
     }
-    Ok(VersionInfo { packages })
+    Ok(VersionInfo { packages, format: 1 })
 }
 
 fn strongest_dep_kind(deps: &[cargo_metadata::DepKindInfo]) -> PrivateDepKind {

cargo-auditable/src/sbom_precursor.rs

@@ -89,7 +89,7 @@ impl From<SbomPrecursor> for VersionInfo {
             }
         }
 
-        VersionInfo { packages }
+        VersionInfo { packages, format: 8 }
     }
 }