[smithy-rs] Rollup of 2 commits

Includes commits:
  61007da6 Add configuration ability to `mock_client` macro (#4001)
  80392478 Fix s3 `checksum-mode` header in presigned requests (#4000)

Co-authored-by: Landon James <[email protected]>
Co-authored-by: Russell Cohen <[email protected]>

Author: 3 people

examples/examples/cloudwatchlogs/Cargo.toml

@@ -32,4 +32,4 @@ path = "../../test-utils"
 version = "0.1.0"
 
 [dev-dependencies]
-aws-smithy-mocks-experimental= { version = "0.2.1", path = "../../../sdk/aws-smithy-mocks-experimental" }
+aws-smithy-mocks-experimental= { version = "0.2.2", path = "../../../sdk/aws-smithy-mocks-experimental" }

examples/examples/ses/Cargo.toml

@@ -12,7 +12,7 @@ tracing = "0.1.40"
 tmpfile = "0.0.2"
 open = "5.1.2"
 aws-smithy-http= { version = "0.60.12", path = "../../../sdk/aws-smithy-http" }
-aws-smithy-mocks-experimental= { version = "0.2.1", path = "../../../sdk/aws-smithy-mocks-experimental" }
+aws-smithy-mocks-experimental= { version = "0.2.2", path = "../../../sdk/aws-smithy-mocks-experimental" }
 aws-config= { version = "1.5.16", path = "../../../sdk/aws-config", features = ["behavior-version-latest"] }
 aws-sdk-sesv2= { version = "1.66.0", path = "../../../sdk/sesv2", features = ["test-util"] }
 

sdk/aws-smithy-mocks-experimental/Cargo.toml

@@ -5,7 +5,7 @@ doc-scrape-examples = true
 
 [package]
 name = "aws-smithy-mocks-experimental"
-version = "0.2.1"
+version = "0.2.2"
 authors = ["AWS Rust SDK Team <[email protected]>"]
 description = "Experimental testing utilities for smithy-rs generated clients"
 edition = "2021"

sdk/aws-smithy-mocks-experimental/README.md

@@ -1,6 +1,41 @@
 # aws-smithy-mocks
 
-Experiment for mocking Smithy Clients using interceptors. See [`tests/get-object-mocks.rs`](tests/get-object-mocks.rs) for example usage.
+This package allows testing clients generated by smithy-rs (including all packages of the AWS Rust SDK) by using interceptors to return stub responses. This approach is quite useful for testing both happy-path and simple error scenarios and avoids the need for mocking the entire client or using traits.
+
+As an example, consider this simple usage with S3:
+
+```rust
+#[tokio::test]
+async fn test_s3() {
+     let s3_real_object = mock!(Client::get_object).then_output(|| {
+         GetObjectOutput::builder()
+             .body(ByteStream::from_static(b"test-test-test"))
+             .build()
+     });
+    let s3 = mock_client!(aws_sdk_s3, [&s3_real_object]);
+    let data = s3
+        .get_object()
+        .bucket("test-bucket")
+        .key("correct-key")
+        .send()
+        .await
+        .expect("success response")
+        .body
+        .collect()
+        .await
+        .expect("successful read")
+        .to_vec();
+    assert_eq!(data, b"test-test-test");
+    assert_eq!(s3_real_object.num_calls(), 1);
+}
+```
+
+You can find more examples in the `tests` folder of this crate.
+
+## Shortcomings of this approach
+This approach is not well suited for testing precise error handling, especially when considering retries or interactions with HTTP responses—This approach hijacks the request response flow entirely and is not a faithful model in these cases.
+
+If you need to test behavior around retries or connection management, you should use HTTP-connection based mocking instead.
 
 <!-- anchor_start:footer -->
 This crate is part of the [AWS SDK for Rust](https://awslabs.github.io/aws-sdk-rust/) and the [smithy-rs](https://github.com/smithy-lang/smithy-rs) code generator.

sdk/aws-smithy-mocks-experimental/src/lib.rs

@@ -3,6 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+//! This crate allows mocking of smithy clients.
+
 /* Automatically managed default lints */
 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
 /* End of automatically managed default lints */
@@ -94,23 +96,51 @@ macro_rules! mock {
 ///   .then_error(||GetObjectError::NoSuchKey(NoSuchKey::builder().build()));
 /// let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&get_object_error_path, &get_object_happy_path]);
 /// ```
+///
+/// **Create a client but customize a specific setting**:
+/// ```rust,ignore
+/// use aws_sdk_s3::operation::get_object::GetObjectOutput;
+/// use aws_sdk_s3::Client;
+/// use aws_smithy_types::byte_stream::ByteStream;
+/// use aws_smithy_mocks_experimental::{mock_client, mock, RuleMode};
+/// let get_object_happy_path = mock!(Client::get_object)
+///   .match_requests(|req|req.bucket() == Some("test-bucket") && req.key() == Some("test-key"))
+///   .then_output(||GetObjectOutput::builder().body(ByteStream::from_static(b"12345-abcde")).build());
+/// let client = mock_client!(
+///     aws_sdk_s3,
+///     RuleMode::Sequential,
+///     &[&get_object_happy_path],
+///     // Perhaps you need to force path style
+///     |client_builder|client_builder.force_path_style(true)
+/// );
+/// ```
+///
 #[macro_export]
 macro_rules! mock_client {
     ($aws_crate: ident, $rules: expr) => {
         mock_client!($aws_crate, $crate::RuleMode::Sequential, $rules)
     };
     ($aws_crate: ident, $rule_mode: expr, $rules: expr) => {{
+        mock_client!($aws_crate, $rule_mode, $rules, |conf| conf)
+    }};
+    ($aws_crate: ident, $rule_mode: expr, $rules: expr, $additional_configuration: expr) => {{
         let mut mock_response_interceptor =
             $crate::MockResponseInterceptor::new().rule_mode($rule_mode);
         for rule in $rules {
             mock_response_interceptor = mock_response_interceptor.with_rule(rule)
         }
+        // allow callers to avoid explicitly specifying the type
+        fn coerce<T: Fn($aws_crate::config::Builder) -> $aws_crate::config::Builder>(f: T) -> T {
+            f
+        }
         $aws_crate::client::Client::from_conf(
-            $aws_crate::config::Config::builder()
-                .with_test_defaults()
-                .region($aws_crate::config::Region::from_static("us-east-1"))
-                .interceptor(mock_response_interceptor)
-                .build(),
+            coerce($additional_configuration)(
+                $aws_crate::config::Config::builder()
+                    .with_test_defaults()
+                    .region($aws_crate::config::Region::from_static("us-east-1"))
+                    .interceptor(mock_response_interceptor),
+            )
+            .build(),
         )
     }};
 }

sdk/s3/src/operation/get_object.rs

@@ -140,6 +140,13 @@ impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for GetObje
                             .load::<::aws_smithy_types::checksum_config::ResponseChecksumValidation>()
                             .unwrap_or(&::aws_smithy_types::checksum_config::ResponseChecksumValidation::WhenSupported);
 
+                        let is_presigned_req = cfg.load::<crate::presigning::PresigningMarker>().is_some();
+
+                        // For presigned requests we do not enable the checksum-mode header.
+                        if is_presigned_req {
+                            return ::std::result::Result::Ok(());
+                        }
+
                         // If validation setting is WhenSupported (or unknown) we enable response checksum
                         // validation. If it is WhenRequired we do not enable (since there is no way to
                         // indicate that a response checksum is required).

sdk/s3/tests/express.rs

@@ -182,11 +182,8 @@ async fn presigning() {
         ][..],
         &query_params
     );
-    // Presigned request has one header and that is the x-amz-checksum-mode
-    // header with default value ENABLED
-    assert_eq!(presigned.headers().count(), 1);
-    let headers = presigned.headers().collect::<Vec<(&str, &str)>>();
-    assert_eq!(headers.get(0).unwrap(), &("x-amz-checksum-mode", "ENABLED"));
+    // Presigned request has no headers by default
+    assert_eq!(presigned.headers().count(), 0);
 }
 
 fn operation_request_with_checksum(

sdk/s3/tests/presigning.rs

@@ -100,13 +100,13 @@ async fn test_presigning() {
         ][..],
         &query_params
     );
-    assert_eq!(presigned.headers().count(), 1);
+    assert_eq!(presigned.headers().count(), 0);
     let headers = presigned.headers().collect::<HashMap<_, _>>();
-    assert_eq!(headers.get("x-amz-checksum-mode").unwrap(), &"ENABLED");
 
     // Checksum headers should not be included by default in presigned requests
     assert_eq!(headers.get("x-amz-sdk-checksum-algorithm"), None);
     assert_eq!(headers.get("x-amz-checksum-crc32"), None);
+    assert_eq!(headers.get("x-amz-checksum-mode"), None);
 }
 
 #[tokio::test]

versions.toml

@@ -1,4 +1,4 @@
-smithy_rs_revision = '935c2651d62e63d1891e11d0e12ac50a940ceaa4'
+smithy_rs_revision = '8039247882fe6bb3c83f71601a9ae0a3327d6be0'
 aws_doc_sdk_examples_revision = '9cd7f3841f9e6ba950edbf265b251b811db357fc'
 
 [manual_interventions]
@@ -1997,7 +1997,7 @@ model_hash = '34648839402316ab9da4bef0fe11beb9bc3ec1d05b3ff7d09664ab74c0cb3d2b'
 [crates.aws-sdk-s3]
 category = 'AwsSdk'
 version = '1.75.0'
-source_hash = 'acb0a00457996a2f03b70635220081e9de447648dad9f175c6d37a917ecf439d'
+source_hash = '0960bc2685bd70a5dcb85e289f5187107dd1e2d6282db1cba9f8bd84829ae2f5'
 model_hash = '0b6147c08cab02d5e98d5f341db4ba1cf84f56772e0469883cb5bb5d4ef690b5'
 
 [crates.aws-sdk-s3control]
@@ -2532,8 +2532,8 @@ source_hash = '4ccb6d7086aa9b1488c994a914f6bbc457b0d892daa5be7306e5be62b677fea6'
 
 [crates.aws-smithy-mocks-experimental]
 category = 'SmithyRuntime'
-version = '0.2.1'
-source_hash = '7fa397d78403e57648a4f565bf7f2978bc0702a15ce7cd775274253cfbca57aa'
+version = '0.2.2'
+source_hash = '25816d50f13dd87e2059ba310861e0166c088b0829770eeca63f27833f566cb8'
 
 [crates.aws-smithy-protocol-test]
 category = 'SmithyRuntime'
@@ -2992,3 +2992,4 @@ aws-sdk-workspaces = '1.70.0'
 aws-sdk-workspacesthinclient = '1.60.0'
 aws-sdk-workspacesweb = '1.63.0'
 aws-sdk-xray = '1.60.0'
+aws-smithy-mocks-experimental = '0.2.2'