ref(client): Debug, Eq, Hash, PartialEq for ImageLayer; convert annotations to BTreeMap

Cargo.toml

@@ -61,6 +61,7 @@ clap = { version = "4.0", features = ["derive"] }
 rstest = "0.18.1"
 docker_credential = "1.0"
 hmac = "0.12"
+itertools = "0.12.1"
 tracing-subscriber = { version = "0.3", features = ["env-filter"] }
 tempfile = "3.3"
 testcontainers = "0.15"

examples/wasm/main.rs

@@ -1,7 +1,7 @@
 use oci_distribution::{annotations, secrets::RegistryAuth, Client, Reference};
 
 use docker_credential::{CredentialRetrievalError, DockerCredential};
-use std::collections::HashMap;
+use std::collections::BTreeMap;
 use tracing::{debug, warn};
 use tracing_subscriber::prelude::*;
 use tracing_subscriber::{fmt, EnvFilter};
@@ -84,14 +84,14 @@ pub async fn main() {
             let auth = build_auth(&reference, &cli);
 
             let annotations = if annotations.is_empty() {
-                let mut values: HashMap<String, String> = HashMap::new();
+                let mut values: BTreeMap<String, String> = BTreeMap::new();
                 values.insert(
                     annotations::ORG_OPENCONTAINERS_IMAGE_TITLE.to_string(),
                     module.clone(),
                 );
                 Some(values)
             } else {
-                let mut values: HashMap<String, String> = HashMap::new();
+                let mut values: BTreeMap<String, String> = BTreeMap::new();
                 for annotation in annotations {
                     let tmp: Vec<_> = annotation.splitn(2, '=').collect();
                     if tmp.len() == 2 {

examples/wasm/push.rs

@@ -4,15 +4,15 @@ use oci_distribution::{
     secrets::RegistryAuth,
     Client, Reference,
 };
-use std::collections::HashMap;
+use std::collections::BTreeMap;
 use tracing::info;
 
 pub(crate) async fn push_wasm(
     client: &mut Client,
     auth: &RegistryAuth,
     reference: &Reference,
     module: &str,
-    annotations: Option<HashMap<String, String>>,
+    annotations: Option<BTreeMap<String, String>>,
 ) {
     info!(?reference, ?module, "pushing wasm module");
 

src/client.rs

@@ -29,8 +29,9 @@ use reqwest::{RequestBuilder, Url};
 use serde::Deserialize;
 use serde::Serialize;
 use sha2::Digest;
-use std::collections::HashMap;
+use std::collections::{BTreeMap, HashMap};
 use std::convert::TryFrom;
+use std::hash::Hash;
 use std::sync::Arc;
 use tokio::io::{AsyncWrite, AsyncWriteExt};
 use tokio::sync::RwLock;
@@ -86,23 +87,23 @@ pub struct TagResponse {
 }
 
 /// The data and media type for an image layer
-#[derive(Clone)]
+#[derive(Clone, Debug, Eq, Hash, PartialEq)]
 pub struct ImageLayer {
     /// The data of this layer
     pub data: Vec<u8>,
     /// The media type of this layer
     pub media_type: String,
     /// This OPTIONAL property contains arbitrary metadata for this descriptor.
     /// This OPTIONAL property MUST use the [annotation rules](https://github.com/opencontainers/image-spec/blob/main/annotations.md#rules)
-    pub annotations: Option<HashMap<String, String>>,
+    pub annotations: Option<BTreeMap<String, String>>,
 }
 
 impl ImageLayer {
     /// Constructs a new ImageLayer struct with provided data and media type
     pub fn new(
         data: Vec<u8>,
         media_type: String,
-        annotations: Option<HashMap<String, String>>,
+        annotations: Option<BTreeMap<String, String>>,
     ) -> Self {
         ImageLayer {
             data,
@@ -113,12 +114,12 @@ impl ImageLayer {
 
     /// Constructs a new ImageLayer struct with provided data and
     /// media type application/vnd.oci.image.layer.v1.tar
-    pub fn oci_v1(data: Vec<u8>, annotations: Option<HashMap<String, String>>) -> Self {
+    pub fn oci_v1(data: Vec<u8>, annotations: Option<BTreeMap<String, String>>) -> Self {
         Self::new(data, IMAGE_LAYER_MEDIA_TYPE.to_string(), annotations)
     }
     /// Constructs a new ImageLayer struct with provided data and
     /// media type application/vnd.oci.image.layer.v1.tar+gzip
-    pub fn oci_v1_gzip(data: Vec<u8>, annotations: Option<HashMap<String, String>>) -> Self {
+    pub fn oci_v1_gzip(data: Vec<u8>, annotations: Option<BTreeMap<String, String>>) -> Self {
         Self::new(data, IMAGE_LAYER_GZIP_MEDIA_TYPE.to_string(), annotations)
     }
 
@@ -137,15 +138,15 @@ pub struct Config {
     pub media_type: String,
     /// This OPTIONAL property contains arbitrary metadata for this descriptor.
     /// This OPTIONAL property MUST use the [annotation rules](https://github.com/opencontainers/image-spec/blob/main/annotations.md#rules)
-    pub annotations: Option<HashMap<String, String>>,
+    pub annotations: Option<BTreeMap<String, String>>,
 }
 
 impl Config {
     /// Constructs a new Config struct with provided data and media type
     pub fn new(
         data: Vec<u8>,
         media_type: String,
-        annotations: Option<HashMap<String, String>>,
+        annotations: Option<BTreeMap<String, String>>,
     ) -> Self {
         Config {
             data,
@@ -156,15 +157,15 @@ impl Config {
 
     /// Constructs a new Config struct with provided data and
     /// media type application/vnd.oci.image.config.v1+json
-    pub fn oci_v1(data: Vec<u8>, annotations: Option<HashMap<String, String>>) -> Self {
+    pub fn oci_v1(data: Vec<u8>, annotations: Option<BTreeMap<String, String>>) -> Self {
         Self::new(data, IMAGE_CONFIG_MEDIA_TYPE.to_string(), annotations)
     }
 
     /// Construct a new Config struct with provided [`ConfigFile`] and
     /// media type `application/vnd.oci.image.config.v1+json`
     pub fn oci_v1_from_config_file(
         config_file: ConfigFile,
-        annotations: Option<HashMap<String, String>>,
+        annotations: Option<BTreeMap<String, String>>,
     ) -> Result<Self> {
         let data = serde_json::to_vec(&config_file)?;
         Ok(Self::new(
@@ -2929,4 +2930,89 @@ mod test {
             .await
             .expect("Failed to pull manifest");
     }
+
+    #[tokio::test]
+    async fn test_hashable_image_layer() {
+        use itertools::Itertools;
+
+        // First two should be identical; others differ
+        let image_layers = Vec::from([
+            ImageLayer {
+                data: Vec::from([0, 1, 2, 3]),
+                media_type: "media_type".to_owned(),
+                annotations: Some(BTreeMap::from([
+                    ("0".to_owned(), "1".to_owned()),
+                    ("2".to_owned(), "3".to_owned()),
+                ])),
+            },
+            ImageLayer {
+                data: Vec::from([0, 1, 2, 3]),
+                media_type: "media_type".to_owned(),
+                annotations: Some(BTreeMap::from([
+                    ("2".to_owned(), "3".to_owned()),
+                    ("0".to_owned(), "1".to_owned()),
+                ])),
+            },
+            ImageLayer {
+                data: Vec::from([0, 1, 2, 3]),
+                media_type: "different_media_type".to_owned(),
+                annotations: Some(BTreeMap::from([
+                    ("0".to_owned(), "1".to_owned()),
+                    ("2".to_owned(), "3".to_owned()),
+                ])),
+            },
+            ImageLayer {
+                data: Vec::from([0, 1, 2]),
+                media_type: "media_type".to_owned(),
+                annotations: Some(BTreeMap::from([
+                    ("0".to_owned(), "1".to_owned()),
+                    ("2".to_owned(), "3".to_owned()),
+                ])),
+            },
+            ImageLayer {
+                data: Vec::from([0, 1, 2, 3]),
+                media_type: "media_type".to_owned(),
+                annotations: Some(BTreeMap::from([
+                    ("1".to_owned(), "0".to_owned()),
+                    ("2".to_owned(), "3".to_owned()),
+                ])),
+            },
+        ]);
+
+        assert_eq!(
+            &image_layers[0], &image_layers[1],
+            "image_layers[0] should equal image_layers[1]"
+        );
+        assert_ne!(
+            &image_layers[0], &image_layers[2],
+            "image_layers[0] should not equal image_layers[2]"
+        );
+        assert_ne!(
+            &image_layers[0], &image_layers[3],
+            "image_layers[0] should not equal image_layers[3]"
+        );
+        assert_ne!(
+            &image_layers[0], &image_layers[4],
+            "image_layers[0] should not equal image_layers[4]"
+        );
+        assert_ne!(
+            &image_layers[2], &image_layers[3],
+            "image_layers[2] should not equal image_layers[3]"
+        );
+        assert_ne!(
+            &image_layers[2], &image_layers[4],
+            "image_layers[2] should not equal image_layers[4]"
+        );
+        assert_ne!(
+            &image_layers[3], &image_layers[4],
+            "image_layers[3] should not equal image_layers[4]"
+        );
+
+        let deduped: Vec<ImageLayer> = image_layers.clone().into_iter().unique().collect();
+        assert_eq!(
+            image_layers.len() - 1,
+            deduped.len(),
+            "after deduplication, there should be one less image layer"
+        );
+    }
 }

src/manifest.rs

@@ -1,5 +1,5 @@
 //! OCI Manifest
-use std::collections::HashMap;
+use std::collections::BTreeMap;
 
 use crate::{
     client::{Config, ImageLayer},
@@ -113,7 +113,7 @@ pub struct OciImageManifest {
     /// MUST either be absent or be an empty map."
     /// TO accomodate either, this is optional.
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub annotations: Option<HashMap<String, String>>,
+    pub annotations: Option<BTreeMap<String, String>>,
 }
 
 impl Default for OciImageManifest {
@@ -137,7 +137,7 @@ impl OciImageManifest {
     pub fn build(
         layers: &[ImageLayer],
         config: &Config,
-        annotations: Option<HashMap<String, String>>,
+        annotations: Option<BTreeMap<String, String>>,
     ) -> Self {
         let mut manifest = OciImageManifest::default();
 
@@ -276,7 +276,7 @@ pub struct OciDescriptor {
     /// This OPTIONAL property MUST use the annotation rules.
     /// <https://github.com/opencontainers/image-spec/blob/main/annotations.md#rules>
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub annotations: Option<HashMap<String, String>>,
+    pub annotations: Option<BTreeMap<String, String>>,
 }
 
 impl std::fmt::Display for OciDescriptor {
@@ -334,7 +334,7 @@ pub struct OciImageIndex {
     /// MUST either be absent or be an empty map."
     /// TO accomodate either, this is optional.
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub annotations: Option<HashMap<String, String>>,
+    pub annotations: Option<BTreeMap<String, String>>,
 }
 
 /// The manifest entry of an `ImageIndex`.
@@ -375,7 +375,7 @@ pub struct ImageIndexEntry {
     /// This OPTIONAL property contains arbitrary metadata for the image index.
     /// This OPTIONAL property MUST use the [annotation rules](https://github.com/opencontainers/image-spec/blob/main/annotations.md#rules).
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub annotations: Option<HashMap<String, String>>,
+    pub annotations: Option<BTreeMap<String, String>>,
 }
 
 impl std::fmt::Display for ImageIndexEntry {