feat: Support Dafny tests on test models for Rust (#460)

*Issue #, if available:* Resolves #458 *Description of changes:* Supports compiling the common Dafny tests in a test model for Rust. This involved having to change some properties of how we lay out the Rust crates: * ~Removed the `dafny_impl` sub-crate and moved `implementation_from_dafny.rs` into the main `src` directory - hence replacing `::simple_boolean_dafny` with `crate::implementation_from_dafny` everywhere. I originally had this separated to better divide Dafny-generated code from Smithy-generated code, but it made implementing externs hard/impossible, and Dafny tests make use of "wrapped services" which are essentially testing-only extern shims.~ * This turned out to be unnecessary, because it is reasonable to patch in additional `use ::simple_boolean_dafny::*;` and `use simple_boolean::*;` imports into the compiled tests. This is equivalent to the `pub use dafny_standard_library::implementation_from_dafny::*;` import the Makefile is adding, and will be replaced by a Dafny feature named something like `--rust-module-name` as some other other supported languages already have. * Added ~`tests/tests_from_dafny/_wrapped.rs`~ `wrapped::client::Client` with the implementation of the "wrapped service", which is implementing the Dafny-client interface using the Rust idiomatic client. * Since this is only used for testing, but implements a Dafny extern that is only defined by Dafny test code, I guarded this with a `wrapped-client` feature which the Dafny-compiled integration test enables, as per rust-lang/cargo#2911 (comment) * ~Removed `async` from the client interfaces - we'd originally kept these for better forwards-compatibility, but AFAICT it's impossible to implement the synchronous Dafny-generated trait methods with async methods. This just means that in the future we'll eventually have to provide separate async clients, but that's happened with the AWS SDKs frequently as well.~ * Worked around this by instantiating a `current_thread` Tokio `Runtime` as per https://tokio.rs/tokio/topics/bridging instead.
smithy-lang · Jul 12, 2024 · 81dd77f · 81dd77f
1 parent 10e908e
commit 81dd77f
Show file tree

Hide file tree

Showing 22 changed files with 1,627 additions and 1,261 deletions.
diff --git a/SmithyDafnyMakefile.mk b/SmithyDafnyMakefile.mk
@@ -242,6 +242,7 @@ transpile_test:
 		-functionSyntax:3 \
 		-useRuntimeLib \
 		-out $(OUT) \
+		$(DAFNY_OPTIONS) \
 		$(if $(strip $(STD_LIBRARY)) , -library:$(PROJECT_ROOT)/$(STD_LIBRARY)/src/Index.dfy, ) \
 		$(TRANSPILE_DEPENDENCIES) \
 
@@ -251,6 +252,10 @@ transpile_dependencies:
 	$(if $(strip $(STD_LIBRARY)), $(MAKE) -C $(PROJECT_ROOT)/$(STD_LIBRARY) transpile_implementation_$(LANG), )
 	$(patsubst %, $(MAKE) -C $(PROJECT_ROOT)/% transpile_implementation_$(LANG);, $(PROJECT_DEPENDENCIES))
 
+transpile_dependencies_test:
+	$(if $(strip $(STD_LIBRARY)), $(MAKE) -C $(PROJECT_ROOT)/$(STD_LIBRARY) transpile_test_$(LANG), )
+	$(patsubst %, $(MAKE) -C $(PROJECT_ROOT)/% transpile_test_$(LANG);, $(PROJECT_DEPENDENCIES))
+
 ########################## Code-Gen targets
 
 # The OUTPUT variables are created this way
@@ -296,6 +301,7 @@ _polymorph_wrapped:
 	$(OUTPUT_DAFNY_WRAPPED) \
 	$(OUTPUT_DOTNET_WRAPPED) \
 	$(OUTPUT_JAVA_WRAPPED) \
+	$(OUTPUT_RUST_WRAPPED) \
 	--model $(if $(DIR_STRUCTURE_V2),$(LIBRARY_ROOT)/dafny/$(SERVICE)/Model,$(LIBRARY_ROOT)/Model) \
 	--dependent-model $(PROJECT_ROOT)/$(SMITHY_DEPS) \
 	$(patsubst %, --dependent-model $(PROJECT_ROOT)/%/Model, $($(service_deps_var))) \
@@ -510,10 +516,11 @@ test_java:
 
 ########################## Rust targets
 
-# TODO: Dafny test transpilation needs manual patching to work too,
-# which isn't a high priority at this stage,
-# so don't include transpile_test_rust for now.
-transpile_rust: | transpile_implementation_rust transpile_dependencies_rust
+# Note that transpile_dependencies_test_rust is necessary
+# only because we are patching test code in the StandardLibrary,
+# so we don't transpile that code then the recursive call to polymorph_rust
+# on the StandardLibrary will fail because the patch does not apply.
+transpile_rust: | transpile_implementation_rust transpile_test_rust transpile_dependencies_rust transpile_dependencies_test_rust
 
 transpile_implementation_rust: TARGET=rs
 transpile_implementation_rust: OUT=implementation_from_dafny
@@ -535,6 +542,9 @@ transpile_test_rust: _transpile_test_all _mv_test_rust
 transpile_dependencies_rust: LANG=rust
 transpile_dependencies_rust: transpile_dependencies
 
+transpile_dependencies_test_rust: LANG=rust
+transpile_dependencies_test_rust: transpile_dependencies_test
+
 _mv_implementation_rust:
 	rm -rf runtimes/rust/dafny_impl/src
 	mkdir -p runtimes/rust/dafny_impl/src
@@ -544,10 +554,10 @@ _mv_implementation_rust:
 	rustfmt runtimes/rust/dafny_impl/src/implementation_from_dafny.rs
 	rm -rf implementation_from_dafny-rust
 _mv_test_rust:
-	rm -rf runtimes/rust/dafny_impl/tests
-	mkdir -p runtimes/rust/dafny_impl/tests
-	mv tests_from_dafny-rust/src/tests_from_dafny.rs runtimes/rust/dafny_impl/tests/tests_from_dafny.rs
-	rustfmt runtimes/rust/dafny_impl/tests/tests_from_dafny.rs
+	rm -f runtimes/rust/tests/tests_from_dafny/mod.rs
+	mkdir -p runtimes/rust/tests/tests_from_dafny
+	mv tests_from_dafny-rust/src/tests_from_dafny.rs runtimes/rust/tests/tests_from_dafny/mod.rs
+	rustfmt runtimes/rust/tests/tests_from_dafny/mod.rs
 	rm -rf tests_from_dafny-rust
 
 build_rust:

diff --git a/TestModels/SharedMakefile.mk b/TestModels/SharedMakefile.mk
@@ -69,3 +69,12 @@ _polymorph_dotnet: _polymorph
 _polymorph_dotnet: OUTPUT_DOTNET_WRAPPED=\
     $(if $(DIR_STRUCTURE_V2), --output-dotnet $(LIBRARY_ROOT)/runtimes/net/Generated/Wrapped/$(SERVICE)/, --output-dotnet $(LIBRARY_ROOT)/runtimes/net/Generated/Wrapped)
 _polymorph_dotnet: _polymorph_wrapped
+
+_polymorph_rust: OUTPUT_RUST=--output-rust $(LIBRARY_ROOT)/runtimes/rust
+_polymorph_rust: INPUT_DAFNY=\
+		--include-dafny $(PROJECT_ROOT)/$(STD_LIBRARY)/src/Index.dfy
+_polymorph_rust: _polymorph
+# TODO: This doesn't yet work for Rust because we are patching transpiled code,
+# so this target will complain about "patch does not apply" because it was already applied.
+# _polymorph_rust: OUTPUT_RUST_WRAPPED=--output-rust $(LIBRARY_ROOT)/runtimes/rust
+# _polymorph_rust: _polymorph_wrapped
diff --git a/TestModels/SimpleTypes/SimpleBoolean/codegen-patches/rust/dafny-4.5.0.patch b/TestModels/SimpleTypes/SimpleBoolean/codegen-patches/rust/dafny-4.5.0.patch
@@ -62,14 +62,54 @@ index 00000000..299b0baa
 +}
 diff --git b/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/conversions.rs a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/conversions.rs
 new file mode 100644
-index 00000000..c1acac7b
+index 00000000..86f87891
 --- /dev/null
 +++ a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/conversions.rs
-@@ -0,0 +1,4 @@
+@@ -0,0 +1,6 @@
 +// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
 +pub mod get_boolean;
 +
 +pub mod simple_boolean_config;
++
++pub(crate) mod error;
+\ No newline at end of file
+diff --git b/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/conversions/error.rs a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/conversions/error.rs
+new file mode 100644
+index 00000000..d6fd32b7
+--- /dev/null
++++ a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/conversions/error.rs
+@@ -0,0 +1,30 @@
++/// Wraps up an arbitrary Rust Error value as a Dafny Error
++pub fn to_opaque_error<E: std::error::Error + 'static>(value: E) -> 
++  ::std::rc::Rc<::simple_boolean_dafny::r#_simple_dtypes_dboolean_dinternaldafny_dtypes::Error>
++{
++  let error_obj: ::dafny_runtime::Object<dyn::std::any::Any> =
++    ::dafny_runtime::Object(Some(::std::rc::Rc::new(
++        ::std::cell::UnsafeCell::new(value),
++    )));
++  ::std::rc::Rc::new(
++    ::simple_boolean_dafny::r#_simple_dtypes_dboolean_dinternaldafny_dtypes::Error::Opaque {
++        obj: error_obj,
++    },
++  )
++}
++
++/// Wraps up an arbitrary Rust Error value as a Dafny Result<T, Error>.Failure
++pub fn to_opaque_error_result<T: dafny_runtime::DafnyType, E: std::error::Error + 'static>(value: E) -> 
++  ::std::rc::Rc<
++    dafny_standard_library::implementation_from_dafny::_Wrappers_Compile::Result<
++      T,
++      ::std::rc::Rc<::simple_boolean_dafny::r#_simple_dtypes_dboolean_dinternaldafny_dtypes::Error>
++    >
++  >
++{
++  ::std::rc::Rc::new(
++    dafny_standard_library::implementation_from_dafny::_Wrappers_Compile::Result::Failure {
++      error: to_opaque_error(value)
++    }
++  )
++}
+\ No newline at end of file
 diff --git b/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/conversions/get_boolean.rs a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/conversions/get_boolean.rs
 new file mode 100644
 index 00000000..065d3ad3
@@ -287,10 +327,10 @@ index 00000000..4d66eb2e
 \ No newline at end of file
 diff --git b/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/lib.rs a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/lib.rs
 new file mode 100644
-index 00000000..1d16c191
+index 00000000..53977d7d
 --- /dev/null
 +++ a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/lib.rs
-@@ -0,0 +1,17 @@
+@@ -0,0 +1,20 @@
 +#![allow(deprecated)]
 +
 +// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
@@ -306,6 +346,9 @@ index 00000000..1d16c191
 +
 +mod conversions;
 +
++#[cfg(feature = "wrapped-client")]
++pub mod wrapped;
++
 +pub use client::Client;
 +pub use types::simple_boolean_config::SimpleBooleanConfig;
 diff --git b/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/operation.rs a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/operation.rs
@@ -719,3 +762,118 @@ index 00000000..6bf027f6
 +        ::std::result::Result::Ok(SimpleBooleanConfig {})
 +    }
 +}
+diff --git b/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/wrapped.rs a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/wrapped.rs
+new file mode 100644
+index 00000000..39355176
+--- /dev/null
++++ a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/wrapped.rs
+@@ -0,0 +1 @@
++pub mod client;
+\ No newline at end of file
+diff --git b/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/wrapped/client.rs a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/wrapped/client.rs
+new file mode 100644
+index 00000000..49c75f76
+--- /dev/null
++++ a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/wrapped/client.rs
+@@ -0,0 +1,88 @@
++use tokio::runtime::Runtime;
++
++pub struct Client {
++    wrapped: crate::client::Client,
++
++    /// A `current_thread` runtime for executing operations on the
++    /// asynchronous client in a blocking manner.
++    rt: Runtime
++}
++
++impl dafny_runtime::UpcastObject<dyn ::simple_boolean_dafny::r#_simple_dtypes_dboolean_dinternaldafny_dtypes::ISimpleTypesBooleanClient> for Client {
++  ::dafny_runtime::UpcastObjectFn!(dyn ::simple_boolean_dafny::r#_simple_dtypes_dboolean_dinternaldafny_dtypes::ISimpleTypesBooleanClient);
++}
++
++impl dafny_runtime::UpcastObject<dyn std::any::Any> for Client {
++    ::dafny_runtime::UpcastObjectFn!(dyn ::std::any::Any);
++}
++
++impl Client {
++  pub fn from_conf(config: &::std::rc::Rc<
++    ::simple_boolean_dafny::r#_simple_dtypes_dboolean_dinternaldafny_dtypes::SimpleBooleanConfig,
++  >) -> 
++::std::rc::Rc<::simple_boolean_dafny::r#_Wrappers_Compile::Result<
++  ::dafny_runtime::Object<dyn ::simple_boolean_dafny::r#_simple_dtypes_dboolean_dinternaldafny_dtypes::ISimpleTypesBooleanClient>,
++  ::std::rc::Rc<::simple_boolean_dafny::r#_simple_dtypes_dboolean_dinternaldafny_dtypes::Error>
++>> {
++    let rt_result = tokio::runtime::Builder::new_current_thread()
++          .enable_all()
++          .build();
++    let rt = match rt_result {
++        Ok(x) => x,
++        Err(error) => return crate::conversions::error::to_opaque_error_result(error),
++    };
++    let result = crate::client::Client::from_conf(
++      crate::conversions::simple_boolean_config::_simple_boolean_config::from_dafny(
++          config.clone(),
++      ),
++    );
++    match result {
++      Ok(client) =>  {
++        let wrap = crate::wrapped::client::Client {
++          wrapped: client,
++          rt
++        };
++        std::rc::Rc::new(
++          ::simple_boolean_dafny::_Wrappers_Compile::Result::Success {
++            value: ::dafny_runtime::upcast_object()(::dafny_runtime::object::new(wrap))
++          }
++        )
++      },
++      Err(error) => crate::conversions::error::to_opaque_error_result(error)
++    }
++  }
++}
++
++impl ::simple_boolean_dafny::r#_simple_dtypes_dboolean_dinternaldafny_dtypes::ISimpleTypesBooleanClient
++    for Client
++{
++    fn GetBoolean(
++        &mut self,
++        input: &std::rc::Rc<
++            ::simple_boolean_dafny::r#_simple_dtypes_dboolean_dinternaldafny_dtypes::GetBooleanInput,
++        >,
++    ) -> std::rc::Rc<
++        ::simple_boolean_dafny::r#_Wrappers_Compile::Result<
++            std::rc::Rc<
++                ::simple_boolean_dafny::r#_simple_dtypes_dboolean_dinternaldafny_dtypes::GetBooleanOutput,
++            >,
++            std::rc::Rc<::simple_boolean_dafny::r#_simple_dtypes_dboolean_dinternaldafny_dtypes::Error>,
++        >,
++    >{
++        let inner_input =
++            crate::conversions::get_boolean::_get_boolean_input::from_dafny(input.clone());
++        let result = self.rt.block_on(crate::operation::get_boolean::GetBoolean::send(&self.wrapped, inner_input));
++        match result {
++            Err(error) => ::std::rc::Rc::new(
++                ::simple_boolean_dafny::_Wrappers_Compile::Result::Failure {
++                    error: crate::conversions::get_boolean::to_dafny_error(error),
++                },
++            ),
++            Ok(client) => ::std::rc::Rc::new(
++                ::simple_boolean_dafny::_Wrappers_Compile::Result::Success {
++                    value: crate::conversions::get_boolean::_get_boolean_output::to_dafny(client),
++                },
++            ),
++        }
++    }
++}
+diff --git b/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/tests/tests_from_dafny/mod.rs a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/tests/tests_from_dafny/mod.rs
+index ce6d90a2..7f1ba031 100644
+--- b/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/tests/tests_from_dafny/mod.rs
++++ a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/tests/tests_from_dafny/mod.rs
+@@ -1,5 +1,8 @@
+ #![allow(warnings, unconditional_panic)]
+ #![allow(nonstandard_style)]
++use ::simple_boolean_dafny::*;
++use simple_boolean::*;
++mod _wrapped;
+
+ pub mod r#_simple_dtypes_dboolean_dinternaldafny_dwrapped {
+     pub struct _default {}
diff --git a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/Cargo.toml b/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/Cargo.toml
@@ -5,6 +5,9 @@ edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
+[features]
+wrapped-client = []
+
 [dependencies]
 aws-smithy-runtime = {version = "1.6.0", features = ["client"] }
 aws-smithy-runtime-api = {version = "1.7.0", features = ["client"] }
@@ -13,6 +16,9 @@ dafny_runtime = { path = "../../../../dafny-dependencies/dafny_runtime_rust"}
 dafny_standard_library = { path = "../../../../dafny-dependencies/StandardLibrary/runtimes/rust"}
 simple_boolean_dafny = { path = "./dafny_impl"}
 
-[dev-dependencies.tokio]
+[dev-dependencies]
+simple_boolean = { path = ".", features = ["wrapped-client"] }
+
+[dependencies.tokio]
 version = "1.26.0"
-features = ["full"]
+features = ["full"]
diff --git a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/dafny_impl/Cargo.toml b/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/dafny_impl/Cargo.toml
@@ -10,4 +10,4 @@ dafny_runtime = { path = "../../../../../dafny-dependencies/dafny_runtime_rust"}
 dafny_standard_library = { path = "../../../../../dafny-dependencies/StandardLibrary/runtimes/rust"}
 
 [lib]
-path = "src/implementation_from_dafny.rs"
+path = "src/implementation_from_dafny.rs"
diff --git a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/conversions.rs b/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/conversions.rs
@@ -2,3 +2,5 @@
 pub mod get_boolean;
 
 pub mod simple_boolean_config;
+
+pub(crate) mod error;
diff --git a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/conversions/error.rs b/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/conversions/error.rs
@@ -0,0 +1,30 @@
+/// Wraps up an arbitrary Rust Error value as a Dafny Error
+pub fn to_opaque_error<E: std::error::Error + 'static>(value: E) -> 
+  ::std::rc::Rc<::simple_boolean_dafny::r#_simple_dtypes_dboolean_dinternaldafny_dtypes::Error>
+{
+  let error_obj: ::dafny_runtime::Object<dyn::std::any::Any> =
+    ::dafny_runtime::Object(Some(::std::rc::Rc::new(
+        ::std::cell::UnsafeCell::new(value),
+    )));
+  ::std::rc::Rc::new(
+    ::simple_boolean_dafny::r#_simple_dtypes_dboolean_dinternaldafny_dtypes::Error::Opaque {
+        obj: error_obj,
+    },
+  )
+}
+
+/// Wraps up an arbitrary Rust Error value as a Dafny Result<T, Error>.Failure
+pub fn to_opaque_error_result<T: dafny_runtime::DafnyType, E: std::error::Error + 'static>(value: E) -> 
+  ::std::rc::Rc<
+    dafny_standard_library::implementation_from_dafny::_Wrappers_Compile::Result<
+      T,
+      ::std::rc::Rc<::simple_boolean_dafny::r#_simple_dtypes_dboolean_dinternaldafny_dtypes::Error>
+    >
+  >
+{
+  ::std::rc::Rc::new(
+    dafny_standard_library::implementation_from_dafny::_Wrappers_Compile::Result::Failure {
+      error: to_opaque_error(value)
+    }
+  )
+}
diff --git a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/lib.rs b/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/lib.rs
@@ -13,5 +13,8 @@ pub mod operation;
 
 mod conversions;
 
+#[cfg(feature = "wrapped-client")]
+pub mod wrapped;
+
 pub use client::Client;
 pub use types::simple_boolean_config::SimpleBooleanConfig;
diff --git a/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/wrapped.rs b/TestModels/SimpleTypes/SimpleBoolean/runtimes/rust/src/wrapped.rs
@@ -0,0 +1 @@
+pub mod client;