[Storage] Improve Storage test utilities and refactor navigation methods (#2525)

Author: vincenttran-msft

sdk/storage/assets.json

@@ -1,6 +1,6 @@
 {
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "rust",
-  "Tag": "rust/azure_storage_blob_99380d9553",
+  "Tag": "rust/azure_storage_blob_e3372225c3",
   "TagPrefix": "rust/azure_storage_blob"
 }

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

@@ -28,8 +28,8 @@ use std::sync::Arc;
 
 /// A client to interact with a specific Azure storage blob, although that blob may not yet exist.
 pub struct BlobClient {
-    endpoint: Url,
-    client: GeneratedBlobClient,
+    pub(super) endpoint: Url,
+    pub(super) client: GeneratedBlobClient,
 }
 
 impl BlobClient {

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

@@ -20,10 +20,8 @@ use std::sync::Arc;
 
 /// A client to interact with a specified Azure storage container.
 pub struct BlobContainerClient {
-    endpoint: Url,
-    container_name: String,
-    credential: Arc<dyn TokenCredential>,
-    client: GeneratedBlobContainerClient,
+    pub(super) endpoint: Url,
+    pub(super) client: GeneratedBlobContainerClient,
 }
 
 impl BlobContainerClient {
@@ -67,8 +65,6 @@ impl BlobContainerClient {
 
         Ok(Self {
             endpoint: endpoint.parse()?,
-            container_name,
-            credential,
             client,
         })
     }
@@ -79,18 +75,11 @@ impl BlobContainerClient {
     ///
     /// * `blob_name` - The name of the blob.
     /// * `options` - Optional configuration for the client.
-    pub fn blob_client(
-        &self,
-        blob_name: String,
-        options: Option<BlobClientOptions>,
-    ) -> Result<BlobClient> {
-        BlobClient::new(
-            self.endpoint().as_str(),
-            self.container_name().to_string(),
-            blob_name,
-            self.credential.clone(),
-            options,
-        )
+    pub fn blob_client(&self, blob_name: String) -> BlobClient {
+        BlobClient {
+            endpoint: self.client.endpoint.clone(),
+            client: self.client.get_blob_client(blob_name),
+        }
     }
 
     /// Gets the endpoint of the Storage account this client is connected to.
@@ -100,7 +89,7 @@ impl BlobContainerClient {
 
     /// Gets the container name of the Storage account this client is connected to.
     pub fn container_name(&self) -> &str {
-        &self.container_name
+        &self.client.container_name
     }
 
     /// Creates a new container under the specified account. If the container with the same name already exists, the operation fails.

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

@@ -18,9 +18,8 @@ use std::sync::Arc;
 
 /// A client to interact with an Azure storage account.
 pub struct BlobServiceClient {
-    endpoint: Url,
-    credential: Arc<dyn TokenCredential>,
-    client: GeneratedBlobServiceClient,
+    pub(super) endpoint: Url,
+    pub(super) client: GeneratedBlobServiceClient,
 }
 
 impl BlobServiceClient {
@@ -57,7 +56,6 @@ impl BlobServiceClient {
 
         Ok(Self {
             endpoint: endpoint.parse()?,
-            credential,
             client,
         })
     }
@@ -68,17 +66,11 @@ impl BlobServiceClient {
     ///
     /// * `container_name` - The name of the container.
     /// * `options` - Optional configuration for the client.
-    pub fn blob_container_client(
-        &self,
-        container_name: String,
-        options: Option<BlobContainerClientOptions>,
-    ) -> Result<BlobContainerClient> {
-        BlobContainerClient::new(
-            self.endpoint().as_str(),
-            container_name,
-            self.credential.clone(),
-            options,
-        )
+    pub fn blob_container_client(&self, container_name: String) -> BlobContainerClient {
+        BlobContainerClient {
+            endpoint: self.client.endpoint.clone(),
+            client: self.client.get_blob_container_client(container_name),
+        }
     }
 
     /// Gets the endpoint of the Storage account this client is connected to.

sdk/storage/azure_storage_blob/tests/blob_client.rs

@@ -13,18 +13,15 @@ use azure_storage_blob::{
     },
     BlobClientSetMetadataOptions, BlobClientSetPropertiesOptions, BlockBlobClientUploadOptions,
 };
-use azure_storage_blob_test::{create_test_blob, get_blob_client, get_container_client};
+use azure_storage_blob_test::{create_test_blob, get_blob_name, get_container_client};
 use std::{collections::HashMap, error::Error};
 
 #[recorded::test]
 async fn test_get_blob_properties(ctx: TestContext) -> Result<(), Box<dyn Error>> {
     // Recording Setup
     let recording = ctx.recording();
-    let container_client = get_container_client(recording)?;
-    let blob_client = get_blob_client(
-        Some(container_client.container_name().to_string()),
-        recording,
-    )?;
+    let container_client = get_container_client(recording, false).await?;
+    let blob_client = container_client.blob_client(get_blob_name(recording));
 
     // Invalid Container Scenario
     let response = blob_client.get_properties(None).await;
@@ -58,12 +55,8 @@ async fn test_get_blob_properties(ctx: TestContext) -> Result<(), Box<dyn Error>
 async fn test_set_blob_properties(ctx: TestContext) -> Result<(), Box<dyn Error>> {
     // Recording Setup
     let recording = ctx.recording();
-    let container_client = get_container_client(recording)?;
-    let blob_client = get_blob_client(
-        Some(container_client.container_name().to_string()),
-        recording,
-    )?;
-    container_client.create_container(None).await?;
+    let container_client = get_container_client(recording, true).await?;
+    let blob_client = container_client.blob_client(get_blob_name(recording));
     create_test_blob(&blob_client).await?;
 
     // Set Content Settings
@@ -91,14 +84,9 @@ async fn test_set_blob_properties(ctx: TestContext) -> Result<(), Box<dyn Error>
 #[recorded::test]
 async fn test_upload_blob(ctx: TestContext) -> Result<(), Box<dyn Error>> {
     // Recording Setup
-
     let recording = ctx.recording();
-    let container_client = get_container_client(recording)?;
-    let blob_client = get_blob_client(
-        Some(container_client.container_name().to_string()),
-        recording,
-    )?;
-    container_client.create_container(None).await?;
+    let container_client = get_container_client(recording, true).await?;
+    let blob_client = container_client.blob_client(get_blob_name(recording));
 
     let data = b"hello rusty world";
 
@@ -164,14 +152,9 @@ async fn test_upload_blob(ctx: TestContext) -> Result<(), Box<dyn Error>> {
 #[recorded::test]
 async fn test_delete_blob(ctx: TestContext) -> Result<(), Box<dyn Error>> {
     // Recording Setup
-
     let recording = ctx.recording();
-    let container_client = get_container_client(recording)?;
-    let blob_client = get_blob_client(
-        Some(container_client.container_name().to_string()),
-        recording,
-    )?;
-    container_client.create_container(None).await?;
+    let container_client = get_container_client(recording, true).await?;
+    let blob_client = container_client.blob_client(get_blob_name(recording));
     create_test_blob(&blob_client).await?;
 
     // Existence Check
@@ -193,14 +176,18 @@ async fn test_delete_blob(ctx: TestContext) -> Result<(), Box<dyn Error>> {
 async fn test_download_blob(ctx: TestContext) -> Result<(), Box<dyn Error>> {
     // Recording Setup
     let recording = ctx.recording();
-    let container_client = get_container_client(recording)?;
-    let blob_client = get_blob_client(
-        Some(container_client.container_name().to_string()),
-        recording,
-    )?;
-    container_client.create_container(None).await?;
-    create_test_blob(&blob_client).await?;
+    let container_client = get_container_client(recording, true).await?;
+    let blob_client = container_client.blob_client(get_blob_name(recording));
+    let data = b"hello rusty world";
 
+    blob_client
+        .upload(
+            RequestContent::from(data.to_vec()),
+            false,
+            u64::try_from(data.len())?,
+            None,
+        )
+        .await?;
     let response = blob_client.download(None).await?;
 
     // Assert
@@ -222,12 +209,8 @@ async fn test_set_blob_metadata(ctx: TestContext) -> Result<(), Box<dyn Error>>
     // Recording Setup
 
     let recording = ctx.recording();
-    let container_client = get_container_client(recording)?;
-    let blob_client = get_blob_client(
-        Some(container_client.container_name().to_string()),
-        recording,
-    )?;
-    container_client.create_container(None).await?;
+    let container_client = get_container_client(recording, true).await?;
+    let blob_client = container_client.blob_client(get_blob_name(recording));
     let data = b"hello rusty world";
 
     // Upload Blob With Metadata
@@ -276,12 +259,8 @@ async fn test_set_blob_metadata(ctx: TestContext) -> Result<(), Box<dyn Error>>
 async fn test_put_block_list(ctx: TestContext) -> Result<(), Box<dyn Error>> {
     // Recording Setup
     let recording = ctx.recording();
-    let container_client = get_container_client(recording)?;
-    let blob_client = get_blob_client(
-        Some(container_client.container_name().to_string()),
-        recording,
-    )?;
-    container_client.create_container(None).await?;
+    let container_client = get_container_client(recording, true).await?;
+    let blob_client = container_client.blob_client(get_blob_name(recording));
 
     let block_1 = b"AAA";
     let block_2 = b"BBB";
@@ -349,12 +328,8 @@ async fn test_put_block_list(ctx: TestContext) -> Result<(), Box<dyn Error>> {
 async fn test_get_block_list(ctx: TestContext) -> Result<(), Box<dyn Error>> {
     // Recording Setup
     let recording = ctx.recording();
-    let container_client = get_container_client(recording)?;
-    let blob_client = get_blob_client(
-        Some(container_client.container_name().to_string()),
-        recording,
-    )?;
-    container_client.create_container(None).await?;
+    let container_client = get_container_client(recording, true).await?;
+    let blob_client = container_client.blob_client(get_blob_name(recording));
 
     let block_1 = b"AAA";
     let block_2 = b"BBB";
@@ -432,12 +407,8 @@ async fn test_get_block_list(ctx: TestContext) -> Result<(), Box<dyn Error>> {
 async fn test_set_access_tier(ctx: TestContext) -> Result<(), Box<dyn Error>> {
     // Recording Setup
     let recording = ctx.recording();
-    let container_client = get_container_client(recording)?;
-    let blob_client = get_blob_client(
-        Some(container_client.container_name().to_string()),
-        recording,
-    )?;
-    container_client.create_container(None).await?;
+    let container_client = get_container_client(recording, true).await?;
+    let blob_client = container_client.blob_client(get_blob_name(recording));
     create_test_blob(&blob_client).await?;
 
     let original_response = blob_client.get_properties(None).await?;

sdk/storage/azure_storage_blob/tests/blob_container_client.rs

@@ -14,7 +14,7 @@ use std::{collections::HashMap, error::Error};
 async fn test_create_container(ctx: TestContext) -> Result<(), Box<dyn Error>> {
     // Recording Setup
     let recording = ctx.recording();
-    let container_client = get_container_client(recording)?;
+    let container_client = get_container_client(recording, false).await?;
 
     container_client.create_container(None).await?;
 
@@ -26,7 +26,7 @@ async fn test_create_container(ctx: TestContext) -> Result<(), Box<dyn Error>> {
 async fn test_get_container_properties(ctx: TestContext) -> Result<(), Box<dyn Error>> {
     // Recording Setup
     let recording = ctx.recording();
-    let container_client = get_container_client(recording)?;
+    let container_client = get_container_client(recording, false).await?;
 
     // Container Doesn't Exists Scenario
     let response = container_client.get_properties(None).await;
@@ -54,8 +54,7 @@ async fn test_get_container_properties(ctx: TestContext) -> Result<(), Box<dyn E
 async fn test_set_container_metadata(ctx: TestContext) -> Result<(), Box<dyn Error>> {
     // Recording Setup
     let recording = ctx.recording();
-    let container_client = get_container_client(recording)?;
-    container_client.create_container(None).await?;
+    let container_client = get_container_client(recording, true).await?;
 
     // Set Metadata With Values
     let update_metadata = HashMap::from([("hello".to_string(), "world".to_string())]);

sdk/storage/azure_storage_blob_test/src/lib.rs

@@ -7,7 +7,7 @@ use azure_core::{
 };
 use azure_core_test::Recording;
 use azure_storage_blob::{
-    models::BlockBlobClientUploadResult, BlobClient, BlobClientOptions, BlobContainerClient,
+    models::BlockBlobClientUploadResult, BlobClient, BlobContainerClient,
     BlobContainerClientOptions, BlobServiceClient, BlobServiceClientOptions,
 };
 
@@ -27,6 +27,18 @@ fn recorded_test_setup(recording: &Recording) -> (ClientOptions, String) {
     (client_options, endpoint)
 }
 
+pub fn get_blob_name(recording: &Recording) -> String {
+    recording
+        .random_string::<12>(Some("blob"))
+        .to_ascii_lowercase()
+}
+
+pub fn get_container_name(recording: &Recording) -> String {
+    recording
+        .random_string::<17>(Some("container"))
+        .to_ascii_lowercase()
+}
+
 /// Returns an instance of a BlobServiceClient.
 ///
 /// # Arguments
@@ -50,53 +62,27 @@ pub fn get_blob_service_client(recording: &Recording) -> Result<BlobServiceClien
 /// # Arguments
 ///
 /// * `recording` - A reference to a Recording instance.
-pub fn get_container_client(recording: &Recording) -> Result<BlobContainerClient> {
-    let container_name = recording
-        .random_string::<17>(Some("container"))
-        .to_ascii_lowercase();
+/// * `create` - An optional flag to determine whether the container should also be created.
+pub async fn get_container_client(
+    recording: &Recording,
+    create: bool,
+) -> Result<BlobContainerClient> {
+    let container_name = get_container_name(recording);
     let (options, endpoint) = recorded_test_setup(recording);
     let container_client_options = BlobContainerClientOptions {
         client_options: options.clone(),
         ..Default::default()
     };
-    BlobContainerClient::new(
+    let container_client = BlobContainerClient::new(
         &endpoint,
         container_name,
         recording.credential(),
         Some(container_client_options),
-    )
-}
-
-/// Returns an instance of a BlobClient.
-///
-/// # Arguments
-///
-/// * `container_name` - The name of the container containing this blob.
-/// * `recording` - A reference to a Recording instance.
-pub fn get_blob_client(
-    container_name: Option<String>,
-    recording: &Recording,
-) -> Result<BlobClient> {
-    let container_name = container_name.unwrap_or(
-        recording
-            .random_string::<17>(Some("container"))
-            .to_ascii_lowercase(),
-    );
-    let blob_name = recording
-        .random_string::<12>(Some("blob"))
-        .to_ascii_lowercase();
-    let (options, endpoint) = recorded_test_setup(recording);
-    let blob_client_options = BlobClientOptions {
-        client_options: options.clone(),
-        ..Default::default()
-    };
-    BlobClient::new(
-        &endpoint,
-        container_name,
-        blob_name,
-        recording.credential(),
-        Some(blob_client_options),
-    )
+    )?;
+    if create {
+        container_client.create_container(None).await?;
+    }
+    Ok(container_client)
 }
 
 /// Creates a test blob with no options, containing the data "b'hello rusty world'" with content length 17.