Ability to clear metadata fields (#2216)

* Ability to clear metadata fields

* Format

* Better CLI interface for add metadata

* New test case

Author: vigoo

crates/wasm-metadata/src/add_metadata.rs

@@ -1,72 +1,54 @@
 use crate::{rewrite_wasm, Producers};
 use anyhow::Result;
+use std::fmt::Debug;
 
 /// Add metadata (module name, producers) to a WebAssembly file.
 ///
 /// Supports both core WebAssembly modules and components. In components,
 /// metadata will be added to the outermost component.
-#[cfg_attr(feature = "clap", derive(clap::Parser))]
 #[derive(Debug, Clone, Default)]
 #[non_exhaustive]
 pub struct AddMetadata {
     /// Add a module or component name to the names section
-    #[cfg_attr(feature = "clap", clap(long, value_name = "NAME"))]
-    pub name: Option<String>,
+    pub name: AddMetadataField<String>,
 
     /// Add a programming language to the producers section
-    #[cfg_attr(feature = "clap", clap(long, value_parser = parse_key_value, value_name = "NAME=VERSION"))]
     pub language: Vec<(String, String)>,
 
     /// Add a tool and its version to the producers section
-    #[cfg_attr(feature = "clap", clap(long = "processed-by", value_parser = parse_key_value, value_name="NAME=VERSION"))]
     pub processed_by: Vec<(String, String)>,
 
     /// Add an SDK and its version to the producers section
-    #[cfg_attr(feature="clap", clap(long, value_parser = parse_key_value, value_name="NAME=VERSION"))]
     pub sdk: Vec<(String, String)>,
 
     /// Contact details of the people or organization responsible,
     /// encoded as a freeform string.
-    #[cfg_attr(feature = "clap", clap(long, value_name = "NAME"))]
     #[cfg(feature = "oci")]
-    pub authors: Option<crate::Authors>,
+    pub authors: AddMetadataField<crate::Authors>,
 
     /// A human-readable description of the binary
-    #[cfg_attr(feature = "clap", clap(long, value_name = "NAME"))]
     #[cfg(feature = "oci")]
-    pub description: Option<crate::Description>,
+    pub description: AddMetadataField<crate::Description>,
 
     /// License(s) under which contained software is distributed as an SPDX License Expression.
-    #[cfg_attr(feature = "clap", clap(long, value_name = "NAME"))]
     #[cfg(feature = "oci")]
-    pub licenses: Option<crate::Licenses>,
+    pub licenses: AddMetadataField<crate::Licenses>,
 
     /// URL to get source code for building the image
-    #[cfg_attr(feature = "clap", clap(long, value_name = "NAME"))]
     #[cfg(feature = "oci")]
-    pub source: Option<crate::Source>,
+    pub source: AddMetadataField<crate::Source>,
 
     /// URL to find more information on the binary
-    #[cfg_attr(feature = "clap", clap(long, value_name = "NAME"))]
     #[cfg(feature = "oci")]
-    pub homepage: Option<crate::Homepage>,
+    pub homepage: AddMetadataField<crate::Homepage>,
 
     /// Source control revision identifier for the packaged software.
-    #[cfg_attr(feature = "clap", clap(long, value_name = "NAME"))]
     #[cfg(feature = "oci")]
-    pub revision: Option<crate::Revision>,
+    pub revision: AddMetadataField<crate::Revision>,
 
     /// Version of the packaged software
-    #[cfg_attr(feature = "clap", clap(long, value_name = "NAME"))]
     #[cfg(feature = "oci")]
-    pub version: Option<crate::Version>,
-}
-
-#[cfg(feature = "clap")]
-pub(crate) fn parse_key_value(s: &str) -> Result<(String, String)> {
-    s.split_once('=')
-        .map(|(k, v)| (k.to_owned(), v.to_owned()))
-        .ok_or_else(|| anyhow::anyhow!("expected KEY=VALUE"))
+    pub version: AddMetadataField<crate::Version>,
 }
 
 impl AddMetadata {
@@ -78,3 +60,32 @@ impl AddMetadata {
         rewrite_wasm(self, &add_producers, input)
     }
 }
+
+/// Defines how to modify a field of the component/module metadata
+#[derive(Debug, Clone)]
+pub enum AddMetadataField<T: Debug + Clone> {
+    /// Keep the existing value of the field
+    Keep,
+    /// Remove the existing value of the field
+    Clear,
+    /// Set the field to a new value
+    Set(T),
+}
+
+impl<T: Debug + Clone> AddMetadataField<T> {
+    /// Returns true if the field should be cleared
+    pub fn is_clear(&self) -> bool {
+        matches!(self, Self::Clear)
+    }
+
+    /// Returns true if the field should be kept
+    pub fn is_keep(&self) -> bool {
+        matches!(self, Self::Keep)
+    }
+}
+
+impl<T: Debug + Clone> Default for AddMetadataField<T> {
+    fn default() -> Self {
+        Self::Keep
+    }
+}

crates/wasm-metadata/src/clap.rs

@@ -0,0 +1,169 @@
+use crate::AddMetadata;
+use std::fmt::Debug;
+
+/// Add metadata (module name, producers) to a WebAssembly file.
+///
+/// Supports both core WebAssembly modules and components. In components,
+/// metadata will be added to the outermost component.
+#[derive(clap::Parser, Debug, Clone, Default)]
+#[non_exhaustive]
+pub struct AddMetadataOpts {
+    /// Add a module or component name to the names section
+    #[clap(long, value_name = "NAME", conflicts_with = "clear_name")]
+    pub name: Option<String>,
+
+    /// Remove a module or component name from the names section
+    #[clap(long, conflicts_with = "name")]
+    pub clear_name: bool,
+
+    /// Add a programming language to the producers section
+    #[clap(long, value_parser = parse_key_value, value_name = "NAME=VERSION")]
+    pub language: Vec<(String, String)>,
+
+    /// Add a tool and its version to the producers section
+    #[clap(long = "processed-by", value_parser = parse_key_value, value_name="NAME=VERSION")]
+    pub processed_by: Vec<(String, String)>,
+
+    /// Add an SDK and its version to the producers section
+    #[clap(long, value_parser = parse_key_value, value_name="NAME=VERSION")]
+    pub sdk: Vec<(String, String)>,
+
+    /// Contact details of the people or organization responsible,
+    /// encoded as a freeform string.
+    #[clap(long, value_name = "NAME", conflicts_with = "clear_authors")]
+    #[cfg(feature = "oci")]
+    pub authors: Option<crate::Authors>,
+
+    /// Remove authors from the metadata
+    #[clap(long, conflicts_with = "authors")]
+    #[cfg(feature = "oci")]
+    pub clear_authors: bool,
+
+    /// A human-readable description of the binary
+    #[clap(long, value_name = "NAME", conflicts_with = "clear_description")]
+    #[cfg(feature = "oci")]
+    pub description: Option<crate::Description>,
+
+    /// Remove description from the metadata
+    #[clap(long, conflicts_with = "description")]
+    #[cfg(feature = "oci")]
+    pub clear_description: bool,
+
+    /// License(s) under which contained software is distributed as an SPDX License Expression.
+    #[clap(long, value_name = "NAME", conflicts_with = "clear_licenses")]
+    #[cfg(feature = "oci")]
+    pub licenses: Option<crate::Licenses>,
+
+    /// Remove licenses from the metadata
+    #[clap(long, conflicts_with = "licenses")]
+    #[cfg(feature = "oci")]
+    pub clear_licenses: bool,
+
+    /// URL to get source code for building the image
+    #[clap(long, value_name = "NAME", conflicts_with = "clear_source")]
+    #[cfg(feature = "oci")]
+    pub source: Option<crate::Source>,
+
+    /// Remove source from the metadata
+    #[clap(long, conflicts_with = "source")]
+    #[cfg(feature = "oci")]
+    pub clear_source: bool,
+
+    /// URL to find more information on the binary
+    #[clap(long, value_name = "NAME", conflicts_with = "clear_homepage")]
+    #[cfg(feature = "oci")]
+    pub homepage: Option<crate::Homepage>,
+
+    /// Remove homepage from the metadata
+    #[clap(long, conflicts_with = "homepage")]
+    #[cfg(feature = "oci")]
+    pub clear_homepage: bool,
+
+    /// Source control revision identifier for the packaged software.
+    #[clap(long, value_name = "NAME", conflicts_with = "clear_revision")]
+    #[cfg(feature = "oci")]
+    pub revision: Option<crate::Revision>,
+
+    /// Remove revision from the metadata
+    #[clap(long, conflicts_with = "revision")]
+    #[cfg(feature = "oci")]
+    pub clear_revision: bool,
+
+    /// Version of the packaged software
+    #[clap(long, value_name = "NAME", conflicts_with = "clear_version")]
+    #[cfg(feature = "oci")]
+    pub version: Option<crate::Version>,
+
+    /// Remove version from the metadata
+    #[clap(long, conflicts_with = "version")]
+    #[cfg(feature = "oci")]
+    pub clear_version: bool,
+}
+
+pub(crate) fn parse_key_value(s: &str) -> anyhow::Result<(String, String)> {
+    s.split_once('=')
+        .map(|(k, v)| (k.to_owned(), v.to_owned()))
+        .ok_or_else(|| anyhow::anyhow!("expected KEY=VALUE"))
+}
+
+impl From<AddMetadataOpts> for AddMetadata {
+    fn from(value: AddMetadataOpts) -> Self {
+        let mut add = AddMetadata::default();
+        if let Some(name) = value.name {
+            add.name = crate::AddMetadataField::Set(name);
+        } else if value.clear_name {
+            add.name = crate::AddMetadataField::Clear;
+        }
+
+        add.language = value.language;
+        add.processed_by = value.processed_by;
+        add.sdk = value.sdk;
+
+        #[cfg(feature = "oci")]
+        {
+            if let Some(authors) = value.authors {
+                add.authors = crate::AddMetadataField::Set(authors);
+            } else if value.clear_authors {
+                add.authors = crate::AddMetadataField::Clear;
+            }
+
+            if let Some(description) = value.description {
+                add.description = crate::AddMetadataField::Set(description);
+            } else if value.clear_description {
+                add.description = crate::AddMetadataField::Clear;
+            }
+
+            if let Some(licenses) = value.licenses {
+                add.licenses = crate::AddMetadataField::Set(licenses);
+            } else if value.clear_licenses {
+                add.licenses = crate::AddMetadataField::Clear;
+            }
+
+            if let Some(source) = value.source {
+                add.source = crate::AddMetadataField::Set(source);
+            } else if value.clear_source {
+                add.source = crate::AddMetadataField::Clear;
+            }
+
+            if let Some(homepage) = value.homepage {
+                add.homepage = crate::AddMetadataField::Set(homepage);
+            } else if value.clear_homepage {
+                add.homepage = crate::AddMetadataField::Clear;
+            }
+
+            if let Some(revision) = value.revision {
+                add.revision = crate::AddMetadataField::Set(revision);
+            } else if value.clear_revision {
+                add.revision = crate::AddMetadataField::Clear;
+            }
+
+            if let Some(version) = value.version {
+                add.version = crate::AddMetadataField::Set(version);
+            } else if value.clear_version {
+                add.version = crate::AddMetadataField::Clear;
+            }
+        }
+
+        add
+    }
+}

crates/wasm-metadata/src/lib.rs

@@ -26,17 +26,17 @@
 //! let wasm = fs::read("program.wasm")?;
 //!
 //! let mut add = AddMetadata ::default();
-//! add.name = Some("program".to_owned());
+//! add.name = AddMetadataField::Set("program".to_owned());
 //! add.language = vec![("tunalang".to_owned(), "1.0.0".to_owned())];
 //! add.processed_by = vec![("chashu-tools".to_owned(), "1.0.1".to_owned())];
 //! add.sdk = vec![];
-//! add.authors = Some(Authors::new("Chashu Cat"));
-//! add.description = Some(Description::new("Chashu likes tuna"));
-//! add.licenses = Some(Licenses::new("Apache-2.0 WITH LLVM-exception")?);
-//! add.source = Some(Source::new("https://github.com/chashu/chashu-tools")?);
-//! add.homepage = Some(Homepage::new("https://github.com/chashu/chashu-tools")?);
-//! add.revision = Some(Revision::new("de978e17a80c1118f606fce919ba9b7d5a04a5ad"));
-//! add.version = Some(Version::new("1.0.0"));
+//! add.authors = AddMetadataField::Set(Authors::new("Chashu Cat"));
+//! add.description = AddMetadataField::Set(Description::new("Chashu likes tuna"));
+//! add.licenses = AddMetadataField::Set(Licenses::new("Apache-2.0 WITH LLVM-exception")?);
+//! add.source = AddMetadataField::Set(Source::new("https://github.com/chashu/chashu-tools")?);
+//! add.homepage = AddMetadataField::Set(Homepage::new("https://github.com/chashu/chashu-tools")?);
+//! add.revision = AddMetadataField::Set(Revision::new("de978e17a80c1118f606fce919ba9b7d5a04a5ad"));
+//! add.version = AddMetadataField::Set(Version::new("1.0.0"));
 //!
 //! let wasm = add.to_wasm(&wasm)?;
 //! fs::write("program.wasm", &wasm)?;
@@ -46,13 +46,15 @@
 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![warn(missing_debug_implementations, missing_docs)]
 
-pub use add_metadata::AddMetadata;
+pub use add_metadata::{AddMetadata, AddMetadataField};
 pub use names::{ComponentNames, ModuleNames};
 pub use producers::{Producers, ProducersField};
 
 pub(crate) use rewrite::rewrite_wasm;
 
 mod add_metadata;
+#[cfg(feature = "clap")]
+mod clap;
 mod names;
 mod producers;
 mod rewrite;
@@ -73,5 +75,9 @@ mod metadata;
 pub use metadata::Metadata;
 #[cfg(feature = "oci")]
 mod payload;
+
 #[cfg(feature = "oci")]
 pub use payload::Payload;
+
+#[cfg(feature = "clap")]
+pub use clap::AddMetadataOpts;