Test: Add test to macros::since and macros::expand

Author: drmingdrmer

macros/Cargo.toml

@@ -22,6 +22,12 @@ quote = { workspace = true }
 semver = { workspace = true }
 syn = { workspace = true, features = ["full", "extra-traits"] }
 
+
+[dev-dependencies]
+macrotest = "1"
+trybuild = "1.0"
+
+
 [features]
 
 # Do not add `Send` bounds.

macros/README.md

@@ -0,0 +1,12 @@
+# openraft_macros
+
+This crate provides a set of macros to support Openraft.
+
+# Test
+
+- Macro expansions are tested with [`macrotest`] crate.
+- Macro compile errors are tested with [`trybuild`] crate.
+
+
+[`macrotest`]: https://crates.io/crates/macrotest
+[`trybuild`]: https://crates.io/crates/trybuild 

macros/src/expand.rs

@@ -182,6 +182,8 @@ impl Parse for Expand {
             {
                 let content;
                 let _parenthesis = parenthesized!(content in input);
+                let content_str = content.to_string();
+                let content_span = content.span();
 
                 let k = content.parse::<TypeOrExpr>()?;
                 let mut args = vec![k.clone()];
@@ -201,6 +203,16 @@ impl Parse for Expand {
                     args.push(v);
                 }
 
+                if args.len() != b.idents.len() {
+                    return Err(syn::Error::new(
+                        content_span,
+                        format!(
+                            "Expected the same number of arguments(`{}`) as template variables(`{:?}`)",
+                            content_str, b.idents
+                        ),
+                    ));
+                }
+
                 // Ignore duplicates if keyed
                 if b.present_keys.contains(&k) && b.keyed {
                     continue;

macros/tests/expand/expand/keyed_let_0.expanded.rs

@@ -0,0 +1 @@
+fn main() {}

macros/tests/expand/expand/keyed_let_0.rs

@@ -0,0 +1,6 @@
+fn main() {
+    openraft_macros::expand!(
+        KEYED,
+        (K, T, V) => {let K: T = V;},
+    );
+}

macros/tests/expand/expand/keyed_let_1.expanded.rs

@@ -0,0 +1,3 @@
+fn main() {
+    let a: u64 = 1;
+}

macros/tests/expand/expand/keyed_let_1.rs

@@ -0,0 +1,7 @@
+fn main() {
+    openraft_macros::expand!(
+        KEYED,
+        (K, T, V) => {let K: T = V;},
+        (a, u64, 1),
+    );
+}

macros/tests/expand/expand/keyed_let_dup_a.expanded.rs

@@ -0,0 +1,4 @@
+fn main() {
+    let a: u64 = 1;
+    let b: String = "foo".to_string();
+}

macros/tests/expand/expand/keyed_let_dup_a.rs

@@ -0,0 +1,9 @@
+fn main() {
+    openraft_macros::expand!(
+        KEYED,
+        (K, T, V) => {let K: T = V;},
+        (a, u64, 1),
+        (b, String, "foo".to_string()),
+        (a, u32, 2), // duplicate `a` will be ignored
+    );
+}

macros/tests/expand/expand/not_keyed_let_dup_a.expanded.rs

@@ -0,0 +1,5 @@
+fn main() {
+    let a: u64 = 1;
+    let b: String = "foo".to_string();
+    let a: u32 = 2;
+}

macros/tests/expand/expand/not_keyed_let_dup_a.rs

@@ -0,0 +1,9 @@
+fn main() {
+    openraft_macros::expand!(
+        !KEYED,
+        (K, T, V) => {let K: T = V;},
+        (a, u64, 1),
+        (b, String, "foo".to_string()),
+        (a, u32, 2),
+    );
+}

macros/tests/expand/expand/variable_empty.expanded.rs

@@ -0,0 +1,5 @@
+fn main() {
+    c;
+    c;
+    u8;
+}

macros/tests/expand/expand/variable_empty.rs

@@ -0,0 +1,8 @@
+fn main() {
+    openraft_macros::expand!(
+        !KEYED,
+        (K, T, V) => {K; T; V;},
+        (c, , ,),
+        (c, , u8 ),
+    );
+}

macros/tests/expand/expand/variable_type_attributes.expanded.rs

@@ -0,0 +1,8 @@
+fn main() {
+    let c: u8;
+    #[allow(dead_code)]
+    let c: u16;
+    #[allow(dead_code)]
+    #[allow(dead_code)]
+    let c: u16;
+}

macros/tests/expand/expand/variable_type_attributes.rs

@@ -0,0 +1,9 @@
+fn main() {
+    openraft_macros::expand!(
+        !KEYED,
+        (K, M, T) => {M let K: T;},
+        (c, , u8, ),
+        (c, #[allow(dead_code)] , u16),
+        (c, #[allow(dead_code)] #[allow(dead_code)] , u16),
+    );
+}

macros/tests/expand/fail/arg0_invalid_keyed.rs

@@ -0,0 +1,11 @@
+fn main() {
+    openraft_macros::expand!(
+        !FOO,
+        (K, T, V) => {K; T; V;},
+    );
+
+    openraft_macros::expand!(
+        FOO,
+        (K, T, V) => {K; T; V;},
+    );
+}

macros/tests/expand/fail/arg0_invalid_keyed.stderr

@@ -0,0 +1,11 @@
+error: Expected KEYED
+ --> tests/expand/fail/arg0_invalid_keyed.rs:3:10
+  |
+3 |         !FOO,
+  |          ^^^
+
+error: Expected KEYED
+ --> tests/expand/fail/arg0_invalid_keyed.rs:8:9
+  |
+8 |         FOO,
+  |         ^^^

macros/tests/expand/fail/variable_absent.rs

@@ -0,0 +1,8 @@
+fn main() {
+    openraft_macros::expand!(
+        !KEYED,
+        (K, T, V) => {K; T; V;},
+        (c, , ),
+        (c, , u8, ),
+    );
+}

macros/tests/expand/fail/variable_absent.stderr

@@ -0,0 +1,5 @@
+error: Expected the same number of arguments(`c, ,`) as template variables(`["K", "T", "V"]`)
+ --> tests/expand/fail/variable_absent.rs:5:10
+  |
+5 |         (c, , ),
+  |          ^

macros/tests/since/expand/valid_semver.expanded.rs

@@ -0,0 +1,2 @@
+/// Since: 1.0.0
+const A: i32 = 0;

macros/tests/since/expand/valid_semver.rs

@@ -0,0 +1,2 @@
+#[openraft_macros::since(version = "1.0.0")]
+const A: i32 = 0;

macros/tests/since/expand/with_date.expanded.rs

@@ -0,0 +1,2 @@
+/// Since: 1.0.0, Date(2021-01-01)
+const A: i32 = 0;

macros/tests/since/expand/with_date.rs

@@ -0,0 +1,2 @@
+#[openraft_macros::since(version = "1.0.0", date = "2021-01-01")]
+const A: i32 = 0;

macros/tests/since/expand/with_doc.expanded.rs

@@ -0,0 +1,14 @@
+/// Doc
+///
+/// By default, `Send` bounds will be added to the trait and to the return bounds of any async
+/// functions defined withing the trait.
+///
+/// If the `singlethreaded` feature is enabled, the trait definition remains the same without any
+/// added `Send` bounds.
+///
+/// # Example
+///
+/// - list
+///
+/// Since: 1.0.0, Date(2021-01-01)
+const A: i32 = 0;

macros/tests/since/expand/with_doc.rs

@@ -0,0 +1,13 @@
+/// Doc
+///
+/// By default, `Send` bounds will be added to the trait and to the return bounds of any async
+/// functions defined withing the trait.
+///
+/// If the `singlethreaded` feature is enabled, the trait definition remains the same without any
+/// added `Send` bounds.
+///
+/// # Example
+///
+/// - list
+#[openraft_macros::since(version = "1.0.0", date = "2021-01-01")]
+const A: i32 = 0;

macros/tests/since/fail/invalid_date.rs

@@ -0,0 +1,2 @@
+#[openraft_macros::since(version = "1.0.0", date = "2021-01--")]
+fn main() {}

macros/tests/since/fail/invalid_date.stderr

@@ -0,0 +1,5 @@
+error: `date`(`2021-01--`) is not valid date string. Expected format: yyyy-mm-dd
+ --> tests/since/fail/invalid_date.rs:1:52
+  |
+1 | #[openraft_macros::since(version = "1.0.0", date = "2021-01--")]
+  |                                                    ^^^^^^^^^^^

macros/tests/since/fail/invalid_sem_ver.rs

@@ -0,0 +1,2 @@
+#[openraft_macros::since(version = "1.0.0..0")]
+fn main() {}

macros/tests/since/fail/invalid_sem_ver.stderr

@@ -0,0 +1,5 @@
+error: `version`(`1.0.0..0`) is not valid semver.
+ --> tests/since/fail/invalid_sem_ver.rs:1:36
+  |
+1 | #[openraft_macros::since(version = "1.0.0..0")]
+  |                                    ^^^^^^^^^^

macros/tests/test_default_types.rs

@@ -0,0 +1,10 @@
+#[test]
+fn fail() {
+    let t = trybuild::TestCases::new();
+    t.compile_fail("tests/expand/fail/*.rs");
+}
+
+#[test]
+fn pass() {
+    macrotest::expand("tests/expand/expand/*.rs");
+}

macros/tests/test_expand.rs

@@ -1,30 +1,10 @@
-use openraft_macros::since;
-
-/// Doc
-///
-/// By default, `Send` bounds will be added to the trait and to the return bounds of any async
-/// functions defined withing the trait.
-///
-/// If the `singlethreaded` feature is enabled, the trait definition remains the same without any
-/// added `Send` bounds.
-///
-/// # Example
-///
-/// - list
-#[since(version = "1.0.0", date = "2021-01-01")]
-#[allow(dead_code)]
-const A: i32 = 0;
-
-#[since(version = "1.0.0")]
-#[allow(dead_code)]
-fn foo() {}
-
-/*
-
-#[since(version = "1.0.0..0")]
-fn bad_semver() {}
-
-#[since(version = "1.0.0", date = "2021-01--")]
-fn bad_date() {}
-
- */
+#[test]
+fn fail() {
+    let t = trybuild::TestCases::new();
+    t.compile_fail("tests/since/fail/*.rs");
+}
+
+#[test]
+fn pass() {
+    macrotest::expand("tests/since/expand/*.rs");
+}