[Storage] get_blob_properties for BlobClient

sdk/storage/.dict.txt

@@ -7,5 +7,7 @@ copyid
 deletetype
 incrementalcopy
 legalhold
+missingcontainer
 RAGRS
 restype
+testcontainer

sdk/storage/azure_storage_blob/Cargo.toml

@@ -10,11 +10,19 @@ rust-version.workspace = true
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+async-trait.workspace = true
 azure_storage_common.workspace = true
 azure_core = { workspace = true, features = ["xml"] }
+azure_identity = { workspace = true }
 serde = { workspace = true }
 time = { workspace = true }
 typespec_client_core = { workspace = true, features = ["derive"] }
+uuid = { workspace = true }
 
 [lints]
 workspace = true
+
+[dev-dependencies]
+tokio = { workspace = true, features = ["macros"] }
+azure_identity.workspace = true
+azure_core_test.workspace = true

sdk/storage/azure_storage_blob/src/clients/blob_client.rs

@@ -1,2 +1,67 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
+
+use crate::{
+    models::BlobProperties, pipeline::StorageHeadersPolicy, BlobBlobClientGetPropertiesOptions,
+    BlobClientOptions, GeneratedBlobClient,
+};
+use azure_core::{credentials::TokenCredential, BearerTokenCredentialPolicy, Policy, Result};
+use std::sync::Arc;
+
+pub struct BlobClient {
+    pub endpoint: String,
+    pub container_name: String,
+    pub blob_name: String,
+    client: GeneratedBlobClient,
+}
+
+impl BlobClient {
+    pub fn new(
+        endpoint: String,
+        container_name: String,
+        blob_name: String,
+        credential: Arc<dyn TokenCredential>,
+        options: Option<BlobClientOptions>,
+    ) -> Result<Self> {
+        let mut options = options.unwrap_or_default();
+
+        let storage_headers_policy = Arc::new(StorageHeadersPolicy);
+        options
+            .client_options
+            .per_call_policies
+            .push(storage_headers_policy);
+
+        let oauth_token_policy = BearerTokenCredentialPolicy::new(
+            credential.clone(),
+            ["https://storage.azure.com/.default"],
+        );
+        options
+            .client_options
+            .per_try_policies
+            .push(Arc::new(oauth_token_policy) as Arc<dyn Policy>);
+
+        let client = GeneratedBlobClient::new(&endpoint, credential, Some(options))?;
+
+        Ok(Self {
+            endpoint,
+            container_name,
+            blob_name,
+            client,
+        })
+    }
+
+    pub async fn get_blob_properties(
+        &self,
+        options: Option<BlobBlobClientGetPropertiesOptions<'_>>,
+    ) -> Result<BlobProperties> {
+        let response = self
+            .client
+            .get_blob_blob_client(self.container_name.clone(), self.blob_name.clone())
+            .get_properties(options)
+            .await?;
+
+        Ok(BlobProperties::build_from_response_headers(
+            response.headers(),
+        ))
+    }
+}

sdk/storage/azure_storage_blob/src/clients/mod.rs

@@ -4,3 +4,5 @@
 mod blob_client;
 mod blob_container_client;
 mod blob_service_client;
+
+pub use blob_client::BlobClient;

sdk/storage/azure_storage_blob/src/lib.rs

@@ -3,13 +3,15 @@
 // Licensed under the MIT License. See License.txt in the project root for license information.
 // Code generated by Microsoft (R) Rust Code Generator. DO NOT EDIT.
 
+pub mod clients;
 mod generated;
+pub mod pipeline;
 
-pub use crate::generated::clients::*;
+pub mod models;
 
-pub mod models {
-    pub use crate::generated::enums::*;
-    pub use crate::generated::models::*;
-}
+pub use crate::generated::clients::*;
+pub use blob_client::BlobClient as GeneratedBlobClient;
 
-pub use blob_client::BlobClient;
+pub use crate::blob_client::BlobClientOptions;
+pub use crate::clients::BlobClient;
+pub use crate::generated::clients::blob_blob_client::BlobBlobClientGetPropertiesOptions;

sdk/storage/azure_storage_blob/src/models/blob_properties.rs

@@ -0,0 +1,52 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+use azure_core::headers::Headers;
+
+/// Properties of an Azure Storage blob.
+///
+#[derive(Clone, Default, Debug)]
+pub struct BlobProperties {
+    pub access_tier_inferred: String,
+    pub access_tier: String,
+    pub blob_type: String,
+    pub content_length: String,
+    pub content_md5: String,
+    pub content_type: String,
+    pub creation_time: String,
+    pub etag: String,
+    pub last_modified: String,
+    pub lease_state: String,
+    pub lease_status: String,
+    pub server_encrypted: String,
+}
+
+impl BlobProperties {
+    pub fn build_from_response_headers(response_headers: &Headers) -> BlobProperties {
+        let mut properties = BlobProperties {
+            ..Default::default()
+        };
+        for (key, value) in response_headers.iter() {
+            match key.as_str() {
+                "content-length" => properties.content_length = String::from(value.as_str()),
+                "content-md5" => properties.content_md5 = String::from(value.as_str()),
+                "content-type" => properties.content_type = String::from(value.as_str()),
+                "etag" => properties.etag = String::from(value.as_str()),
+                "last-modified" => properties.last_modified = String::from(value.as_str()),
+                "x-ms-access-tier-inferred" => {
+                    properties.access_tier_inferred = String::from(value.as_str())
+                }
+                "x-ms-access-tier" => properties.access_tier = String::from(value.as_str()),
+                "x-ms-blob-type" => properties.blob_type = String::from(value.as_str()),
+                "x-ms-creation-time" => properties.creation_time = String::from(value.as_str()),
+                "x-ms-lease-state" => properties.lease_state = String::from(value.as_str()),
+                "x-ms-lease-status" => properties.lease_status = String::from(value.as_str()),
+                "x-ms-server-encrypted" => {
+                    properties.server_encrypted = String::from(value.as_str())
+                }
+                _ => {}
+            }
+        }
+        properties
+    }
+}

sdk/storage/azure_storage_blob/src/models/mod.rs

@@ -0,0 +1,9 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+mod blob_properties;
+
+pub use crate::generated::enums::*;
+pub use crate::generated::models::*;
+
+pub use blob_properties::BlobProperties;

sdk/storage/azure_storage_blob/src/pipeline/mod.rs

@@ -0,0 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+mod storage_headers_policy;
+
+pub use storage_headers_policy::StorageHeadersPolicy;

sdk/storage/azure_storage_blob/src/pipeline/storage_headers_policy.rs

@@ -0,0 +1,34 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+use async_trait::async_trait;
+use azure_core::{headers::HeaderName, Context, Policy, PolicyResult, Request};
+use std::sync::Arc;
+use uuid::Uuid;
+
+#[derive(Debug, Clone)]
+pub struct StorageHeadersPolicy;
+
+#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
+#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
+impl Policy for StorageHeadersPolicy {
+    async fn send(
+        &self,
+        ctx: &Context,
+        request: &mut Request,
+        next: &[Arc<dyn Policy>],
+    ) -> PolicyResult {
+        let result = request
+            .headers()
+            .get_str(&HeaderName::from("x-ms-client-request-id"));
+
+        match result {
+            Ok(_) => {}
+            Err(_) => {
+                let request_id = Uuid::new_v4().to_string();
+                request.insert_header("x-ms-client-request-id", request_id);
+            }
+        }
+        next[0].send(ctx, request, &next[1..]).await
+    }
+}

sdk/storage/azure_storage_blob/tests/test_blob_client.rs

@@ -0,0 +1,67 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+use azure_core_test::recorded;
+use azure_identity::DefaultAzureCredentialBuilder;
+use azure_storage_blob::{BlobBlobClientGetPropertiesOptions, BlobClient, BlobClientOptions};
+use std::{env, error::Error};
+
+#[cfg(test)]
+mod tests {
+
+    use super::*;
+
+    #[recorded::test(live)]
+    async fn test_get_blob_properties() -> Result<(), Box<dyn Error>> {
+        // Setup
+        let storage_account_name = env::var("AZURE_STORAGE_ACCOUNT_NAME")
+            .expect("Failed to get environment variable: AZURE_STORAGE_ACCOUNT_NAME");
+        let endpoint = format!("https://{}.blob.core.windows.net/", storage_account_name);
+        let credential = DefaultAzureCredentialBuilder::default().build()?;
+
+        // Act
+        let blob_client = BlobClient::new(
+            endpoint,
+            String::from("testcontainer"),
+            String::from("test_blob.txt"),
+            credential,
+            Some(BlobClientOptions::default()),
+        )?;
+        let response = blob_client
+            .get_blob_properties(Some(BlobBlobClientGetPropertiesOptions::default()))
+            .await;
+
+        // Assert
+        assert!(response.is_ok());
+        Ok(())
+    }
+
+    #[recorded::test(live)]
+    async fn test_get_blob_properties_invalid_container() -> Result<(), Box<dyn Error>> {
+        // Setup
+        let storage_account_name = env::var("AZURE_STORAGE_ACCOUNT_NAME")
+            .expect("Failed to get environment variable: AZURE_STORAGE_ACCOUNT_NAME");
+        let endpoint = format!("https://{}.blob.core.windows.net/", storage_account_name);
+        let credential = DefaultAzureCredentialBuilder::default().build()?;
+
+        // Act
+        let blob_client = BlobClient::new(
+            endpoint,
+            String::from("missingcontainer"),
+            String::from("test_blob.txt"),
+            credential,
+            Some(BlobClientOptions::default()),
+        )?;
+        let response = blob_client
+            .get_blob_properties(Some(BlobBlobClientGetPropertiesOptions::default()))
+            .await;
+
+        // Assert
+        assert_eq!(
+            String::from("HttpResponse(NotFound, \"ContainerNotFound\")"),
+            response.unwrap_err().kind().to_string()
+        );
+
+        Ok(())
+    }
+}