diff --git a/rust-runtime/Cargo.toml b/rust-runtime/Cargo.toml index 52cf0a5ed2..5d4422821d 100644 --- a/rust-runtime/Cargo.toml +++ b/rust-runtime/Cargo.toml @@ -17,5 +17,6 @@ members = [ "aws-smithy-runtime-api", "aws-smithy-types", "aws-smithy-types-convert", + "aws-smithy-mocks-experimental", "aws-smithy-xml", ] diff --git a/rust-runtime/aws-smithy-mocks-experimental/Cargo.toml b/rust-runtime/aws-smithy-mocks-experimental/Cargo.toml new file mode 100644 index 0000000000..b097b6b118 --- /dev/null +++ b/rust-runtime/aws-smithy-mocks-experimental/Cargo.toml @@ -0,0 +1,25 @@ +[package] +name = "aws-smithy-mocks-experimental" +version = "0.0.0-smithy-rs-head" +authors = ["AWS Rust SDK Team "] +description = "Experimental testing utilities for smithy-rs generated clients" +edition = "2021" +license = "Apache-2.0" +repository = "https://github.com/smithy-lang/smithy-rs" +publish = false + +[dependencies] +aws-smithy-types = "1" +aws-smithy-runtime-api = { version = "1", features = ["http-02x"] } +aws-smithy-runtime = { version = "1", features = ["test-util"] } +http = "0.2.9" + +[dev-dependencies] +aws-sdk-s3 = { version = "1", features = ["test-util"] } +tokio = { version = "1", features = ["full"]} + +[package.metadata.docs.rs] +all-features = true +targets = ["x86_64-unknown-linux-gnu"] +rustdoc-args = ["--cfg", "docsrs"] +# End of docs.rs metadata diff --git a/rust-runtime/aws-smithy-mocks-experimental/LICENSE b/rust-runtime/aws-smithy-mocks-experimental/LICENSE new file mode 100644 index 0000000000..67db858821 --- /dev/null +++ b/rust-runtime/aws-smithy-mocks-experimental/LICENSE @@ -0,0 +1,175 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. diff --git a/rust-runtime/aws-smithy-mocks-experimental/README.md b/rust-runtime/aws-smithy-mocks-experimental/README.md new file mode 100644 index 0000000000..0c4ca12d30 --- /dev/null +++ b/rust-runtime/aws-smithy-mocks-experimental/README.md @@ -0,0 +1,7 @@ +# 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 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. + diff --git a/rust-runtime/aws-smithy-mocks-experimental/src/lib.rs b/rust-runtime/aws-smithy-mocks-experimental/src/lib.rs new file mode 100644 index 0000000000..0a70a52786 --- /dev/null +++ b/rust-runtime/aws-smithy-mocks-experimental/src/lib.rs @@ -0,0 +1,220 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + +/* Automatically managed default lints */ +#![cfg_attr(docsrs, feature(doc_auto_cfg))] +/* End of automatically managed default lints */ +use std::fmt::{Debug, Formatter}; +use std::future::Future; +use std::marker::PhantomData; +use std::sync::atomic::{AtomicUsize, Ordering}; +use std::sync::Arc; + +use aws_smithy_runtime_api::box_error::BoxError; +use aws_smithy_runtime_api::client::interceptors::context::{ + BeforeDeserializationInterceptorContextMut, BeforeSerializationInterceptorContextMut, Error, + FinalizerInterceptorContextMut, Input, Output, +}; +use aws_smithy_runtime_api::client::interceptors::Intercept; +use aws_smithy_runtime_api::client::orchestrator::{HttpResponse, OrchestratorError}; +use aws_smithy_runtime_api::client::result::SdkError; +use aws_smithy_runtime_api::client::runtime_components::RuntimeComponents; +use aws_smithy_runtime_api::http::{Response, StatusCode}; +use aws_smithy_types::body::SdkBody; +use aws_smithy_types::config_bag::{ConfigBag, Storable, StoreReplace}; + +#[macro_export] +macro_rules! mock { + ($operation: expr) => { + #[allow(unreachable_code)] + { + $crate::RuleBuilder::new( + || $operation(todo!()).as_input().clone().build().unwrap(), + || $operation(todo!()).send(), + ) + } + }; +} + +type MatchFn = Arc bool + Send + Sync>; +type OutputFn = Arc Result> + Send + Sync>; + +impl Debug for MockResponseInterceptor { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + write!(f, "{} functions", self.rules.len()) + } +} + +#[derive(Clone)] +pub enum MockOutput { + HttpResponse(Arc Result + Send + Sync>), + ModeledResponse(OutputFn), +} + +/// Interceptor which produces mock responses based on a list of rules +pub struct MockResponseInterceptor { + rules: Vec, +} + +pub struct RuleBuilder { + _ty: PhantomData<(I, O, E)>, + input_filter: MatchFn, +} + +impl RuleBuilder +where + I: Send + Sync + Debug + 'static, + O: Send + Sync + Debug + 'static, + E: Send + Sync + Debug + std::error::Error + 'static, +{ + pub fn new(_input_hint: impl Fn() -> I, _output_hint: impl Fn() -> F) -> Self + where + F: Future>>, + { + Self { + _ty: Default::default(), + input_filter: Arc::new(|i: &Input| i.downcast_ref::().is_some()), + } + } + + /// Add an additional filter to constrain which inputs match this rule + pub fn match_requests(mut self, filter: impl Fn(&I) -> bool + Send + Sync + 'static) -> Self { + self.input_filter = Arc::new(move |i: &Input| match i.downcast_ref::() { + Some(typed_input) => filter(typed_input), + _ => false, + }); + self + } + + /// If the rule matches, then return a specific HTTP response. + /// + /// This is the recommended way of testing error behavior. + pub fn then_http_response( + self, + response: impl Fn() -> HttpResponse + Send + Sync + 'static, + ) -> Rule { + Rule::new( + self.input_filter, + MockOutput::HttpResponse(Arc::new(move || Ok(response()))), + ) + } + + /// If a rule matches, then return a specific output + pub fn then_output(self, output: impl Fn() -> O + Send + Sync + 'static) -> Rule { + Rule::new( + self.input_filter, + MockOutput::ModeledResponse(Arc::new(move || Ok(Output::erase(output())))), + ) + } +} + +#[derive(Clone)] +pub struct Rule { + matcher: MatchFn, + output: MockOutput, + used_count: Arc, +} + +impl Rule { + fn new(matcher: MatchFn, output: MockOutput) -> Self { + Self { + matcher, + output, + used_count: Default::default(), + } + } + fn record_usage(&self) { + self.used_count.fetch_add(1, Ordering::Relaxed); + } + + /// Returns the number of times this rule has been hit. + pub fn num_calls(&self) -> usize { + self.used_count.load(Ordering::Relaxed) + } +} + +#[derive(Debug)] +struct RunIndex(usize); +impl Storable for RunIndex { + type Storer = StoreReplace; +} + +impl MockResponseInterceptor { + pub fn new() -> Self { + Self { rules: vec![] } + } + pub fn with_rule(mut self, rule: &Rule) -> Self { + self.rules.push(rule.clone()); + self + } +} + +impl Intercept for MockResponseInterceptor { + fn name(&self) -> &'static str { + "test" + } + + fn modify_before_serialization( + &self, + context: &mut BeforeSerializationInterceptorContextMut<'_>, + _runtime_components: &RuntimeComponents, + cfg: &mut ConfigBag, + ) -> Result<(), BoxError> { + for (idx, rule) in self.rules.iter().enumerate() { + if (rule.matcher)(context.inner().input().unwrap()) { + cfg.interceptor_state().store_put(RunIndex(idx)); + return Ok(()); + } + } + Ok(()) + } + fn modify_before_deserialization( + &self, + context: &mut BeforeDeserializationInterceptorContextMut<'_>, + _runtime_components: &RuntimeComponents, + cfg: &mut ConfigBag, + ) -> Result<(), BoxError> { + if let Some(idx) = cfg.load::() { + let rule = &self.rules[idx.0]; + let result = match &rule.output { + MockOutput::HttpResponse(output_fn) => output_fn(), + _ => return Ok(()), + }; + rule.record_usage(); + match result { + Ok(http_response) => *context.response_mut() = http_response, + Err(e) => context + .inner_mut() + .set_output_or_error(Err(OrchestratorError::response(e))), + } + } + Ok(()) + } + + fn modify_before_attempt_completion( + &self, + context: &mut FinalizerInterceptorContextMut<'_>, + _runtime_components: &RuntimeComponents, + _cfg: &mut ConfigBag, + ) -> Result<(), BoxError> { + if let Some(idx) = _cfg.load::() { + let rule = &self.rules[idx.0]; + let result = match &rule.output { + MockOutput::ModeledResponse(output_fn) => output_fn(), + _ => return Ok(()), + }; + + rule.record_usage(); + if result.is_err() { + context.inner_mut().set_response(Response::new( + StatusCode::try_from(500).unwrap(), + SdkBody::from("stubbed error response"), + )) + } + context.inner_mut().set_output_or_error(result); + } + Ok(()) + } +} diff --git a/rust-runtime/aws-smithy-mocks-experimental/tests/get-object-mocks.rs b/rust-runtime/aws-smithy-mocks-experimental/tests/get-object-mocks.rs new file mode 100644 index 0000000000..c8c234dcc3 --- /dev/null +++ b/rust-runtime/aws-smithy-mocks-experimental/tests/get-object-mocks.rs @@ -0,0 +1,86 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + +use aws_sdk_s3::config::Region; +use aws_sdk_s3::operation::get_object::{GetObjectError, GetObjectOutput}; +use aws_sdk_s3::{Client, Config}; +use aws_smithy_types::body::SdkBody; +use aws_smithy_types::byte_stream::ByteStream; + +use aws_smithy_mocks_experimental::{mock, MockResponseInterceptor}; + +const S3_NO_SUCH_KEY: &'static str = r#" + + NoSuchKey + The resource you requested does not exist + /mybucket/myfoto.jpg + 4442587FB7D0A2F9 +"#; + +#[tokio::test] +async fn create_mock_s3_get_object() { + let s3_404 = mock!(Client::get_object) + .match_requests(|inp| { + inp.bucket() == Some("test-bucket") && inp.key() != Some("correct-key") + }) + .then_http_response(|| { + http::Response::builder() + .status(400) + .body(SdkBody::from(S3_NO_SUCH_KEY)) + .unwrap() + .try_into() + .unwrap() + }); + + let s3_real_object = mock!(Client::get_object) + .match_requests(|inp| { + inp.bucket() == Some("test-bucket") && inp.key() == Some("correct-key") + }) + .then_output(|| { + GetObjectOutput::builder() + .body(ByteStream::from_static(b"test-test-test")) + .build() + }); + + let get_object_mocks = MockResponseInterceptor::new() + .with_rule(&s3_404) + .with_rule(&s3_real_object); + + let s3 = aws_sdk_s3::Client::from_conf( + Config::builder() + .with_test_defaults() + .region(Region::new("us-east-1")) + .interceptor(get_object_mocks) + .build(), + ); + + let error = s3 + .get_object() + .bucket("test-bucket") + .key("foo") + .send() + .await + .expect_err("404"); + assert!(matches!( + error.into_service_error(), + GetObjectError::NoSuchKey(_) + )); + assert_eq!(s3_404.num_calls(), 1); + + 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); +} diff --git a/tools/ci-build/sdk-lints/src/readmes.rs b/tools/ci-build/sdk-lints/src/readmes.rs index 2d5073a715..ca4292aa12 100644 --- a/tools/ci-build/sdk-lints/src/readmes.rs +++ b/tools/ci-build/sdk-lints/src/readmes.rs @@ -8,7 +8,8 @@ use anyhow::{Context, Result}; use std::fs; use std::path::{Path, PathBuf}; -const CRATES_TO_BE_USED_DIRECTLY: &[&str] = ["aws-config"].as_slice(); +const CRATES_TO_BE_USED_DIRECTLY: &[&str] = + ["aws-config", "aws-smithy-mocks-experimental"].as_slice(); pub(crate) struct ReadmesExist; impl Lint for ReadmesExist {