Merge pull request #206 from noib3/allow-should-panic-in-tests

Add support for `#[should_panic]` in tests
noib3 · Dec 22, 2024 · 61cc490 · 61cc490
2 parents 57e6aaf + 5a34783
commit 61cc490
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 6 deletions.
diff --git a/crates/macros/src/test.rs b/crates/macros/src/test.rs
@@ -2,7 +2,7 @@ use proc_macro::TokenStream;
 use proc_macro2::{Ident, Span};
 use quote::{quote, ToTokens};
 use syn::parse::{Parse, ParseStream};
-use syn::{parse_macro_input, ItemFn, LitStr, Token};
+use syn::{parse_macro_input, AttrStyle, ItemFn, LitStr, Meta, Token};
 
 use crate::common::{DuplicateError, Keyed, KeyedAttribute};
 use crate::plugin::NvimOxi;
@@ -14,24 +14,43 @@ pub fn test(attrs: TokenStream, item: TokenStream) -> TokenStream {
     let ItemFn { attrs: test_attrs, sig, block, .. } =
         parse_macro_input!(item as syn::ItemFn);
 
+    let should_panic = test_attrs.iter().any(|attr| {
+        let AttrStyle::Outer = &attr.style else { return false };
+        let Meta::Path(path) = &attr.meta else { return false };
+        path.segments.iter().any(|segment| segment.ident == "should_panic")
+    });
+
     let test_attrs = test_attrs
         .into_iter()
         .map(ToTokens::into_token_stream)
         .collect::<proc_macro2::TokenStream>();
 
     let test_name = sig.ident;
 
-    let plugin_name = Ident::new(&format!("__{test_name}"), Span::call_site());
+    let test_ret = if should_panic {
+        quote!()
+    } else {
+        quote! {
+            -> ::core::result::Result<(), ::std::string::String>
+        }
+    };
+
+    let nvim_oxi = &attrs.nvim_oxi;
 
     let ret = &sig.output;
 
-    let nvim_oxi = &attrs.nvim_oxi;
+    let plugin_name = Ident::new(&format!("__{test_name}"), Span::call_site());
 
     let extra_cmd = match &attrs.cmd {
         Some(Cmd { cmd, .. }) => quote! { ::core::option::Option::Some(#cmd) },
         None => quote! { ::core::option::Option::None },
     };
 
+    let maybe_ignore_err =
+        should_panic.then(|| quote!(let _ = )).unwrap_or_default();
+
+    let maybe_semicolon = should_panic.then(|| quote!(;)).unwrap_or_default();
+
     #[cfg(feature = "test-terminator")]
     let plugin_body = match &sig.inputs.first() {
         Some(terminator) => quote! {
@@ -59,13 +78,13 @@ pub fn test(attrs: TokenStream, item: TokenStream) -> TokenStream {
     quote! {
         #[test]
         #test_attrs
-        fn #test_name() -> ::core::result::Result<(), ::std::string::String> {
-            #nvim_oxi::tests::test_macro::test_body(
+        fn #test_name() #test_ret {
+            #maybe_ignore_err #nvim_oxi::tests::test_macro::test_body(
                 env!("CARGO_CRATE_NAME"),
                 env!("CARGO_MANIFEST_PATH"),
                 stringify!(#plugin_name),
                 #extra_cmd,
-            )
+            )#maybe_semicolon
         }
 
         #[#nvim_oxi::plugin(nvim_oxi = #nvim_oxi)]

diff --git a/tests/src/macro.rs b/tests/src/macro.rs
@@ -1,5 +1,11 @@
 //! Tests about the `#[nvim_oxi::test]` macro.
 
+#[should_panic]
+#[nvim_oxi::test]
+fn panic_is_propagated() {
+    panic!();
+}
+
 #[nvim_oxi::test]
 fn printing_to_stderr_is_ok() {
     eprintln!("AA!");