Merge pull request #17 from YuhanLiin/add-tests

cr1901 · web-flow · commit 0f018b635f35 · 2022-02-04T22:21:27.000-05:00
Add trybuild tests for macros
diff --git a/.github/workflows/test-macro.yml b/.github/workflows/test-macro.yml
@@ -0,0 +1,25 @@
+on: [push, pull_request]
+
+name: Run Macro Tests
+
+jobs:
+  testing:
+    name: testing
+    runs-on: ubuntu-18.04
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+
+      - name: Install toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly
+          override: true
+
+      - name: Test macro library
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: -p msp430-rt-macros --features device
diff --git a/macros/Cargo.toml b/macros/Cargo.toml
@@ -26,5 +26,15 @@ version = "0.8.4"
 features = ["extra-traits", "full"]
 version = "1.0.85"
 
+[dev-dependencies]
+msp430 = "0.3.0"
+
+[target.'cfg(not(target_os = "none"))'.dev-dependencies]
+trybuild = "1"
+
 [features]
 device = []
+
+[[test]]
+name = "compiletest"
+required-features = ["device"]
diff --git a/macros/src/lib.rs b/macros/src/lib.rs
@@ -58,7 +58,7 @@ use syn::{
 ///
 /// ``` no_run
 /// # #![no_main]
-/// # use msp430_macros::entry;
+/// # use msp430_rt_macros::entry;
 /// #[entry]
 /// fn main(_cs: CriticalSection) -> ! {
 ///     static mut FOO: u32 = 0;
@@ -127,9 +127,9 @@ pub fn entry(args: TokenStream, input: TokenStream) -> TokenStream {
             .collect::<Vec<_>>();
 
         quote!(
-            #[export_name = "main"]
+            #[no_mangle]
             #(#attrs)*
-            pub #unsafety fn #hash() -> ! {
+            pub #unsafety fn main() -> ! {
                 #unsafety fn #hash<'a>(#cs_param) -> ! {
                     #(#vars)*
                     #(#stmts)*
@@ -140,7 +140,7 @@ pub fn entry(args: TokenStream, input: TokenStream) -> TokenStream {
         .into()
     } else {
         parse::Error::new(
-            f.span(),
+            f.sig.span(),
             "`#[entry]` function must have signature `[unsafe] fn([<ident> : CriticalSection]) -> !`",
         )
         .to_compile_error()
@@ -227,9 +227,8 @@ pub fn interrupt(args: TokenStream, input: TokenStream) -> TokenStream {
             .into();
     }
 
-    let fspan = f.span();
+    let fspan = f.sig.span();
     let ident = f.sig.ident;
-    let ident_s = ident.to_string();
 
     let check = if ident == "DefaultHandler" {
         None
@@ -295,9 +294,9 @@ pub fn interrupt(args: TokenStream, input: TokenStream) -> TokenStream {
         let output = f.sig.output;
         let hash = random_ident();
         quote!(
-            #[export_name = #ident_s]
+            #[no_mangle]
             #(#attrs)*
-            #unsafety extern "msp430-interrupt" fn #hash() {
+            #unsafety extern "msp430-interrupt" fn #ident() {
                 #check
 
                 #unsafety fn #hash<'a>(#cs_param) #output {
@@ -330,7 +329,7 @@ pub fn interrupt(args: TokenStream, input: TokenStream) -> TokenStream {
 /// # Examples
 ///
 /// ```
-/// # use msp430_macros::pre_init;
+/// # use msp430_rt_macros::pre_init;
 /// #[pre_init]
 /// unsafe fn before_main() {
 ///     // do something here
@@ -361,7 +360,7 @@ pub fn pre_init(args: TokenStream, input: TokenStream) -> TokenStream {
 
     if !valid_signature {
         return parse::Error::new(
-            f.span(),
+            f.sig.span(),
             "`#[pre_init]` function must have signature `unsafe fn()`",
         )
         .to_compile_error()
@@ -420,7 +419,7 @@ fn extract_critical_section_arg(
                     Type::Path(TypePath { qself: None, path }),
                     _,
                     [],
-                ) if path.segments.len() == 1 && attrs.len() == 0 => {
+                ) if path.segments.len() == 1 && attrs.is_empty() => {
                     let seg = path.segments.first().unwrap();
                     match seg {
                         PathSegment {
diff --git a/macros/tests/compiletest.rs b/macros/tests/compiletest.rs
@@ -0,0 +1,5 @@
+#[test]
+fn ui() {
+    let t = trybuild::TestCases::new();
+    t.compile_fail("tests/ui/*.rs");
+}
diff --git a/macros/tests/ui/entry_args.rs b/macros/tests/ui/entry_args.rs
@@ -0,0 +1,8 @@
+#![no_main]
+
+use msp430_rt_macros::entry;
+
+#[entry(arg)]
+fn main() -> ! {
+    loop {}
+}
diff --git a/macros/tests/ui/entry_args.stderr b/macros/tests/ui/entry_args.stderr
@@ -0,0 +1,7 @@
+error: This attribute accepts no arguments
+ --> tests/ui/entry_args.rs:5:1
+  |
+5 | #[entry(arg)]
+  | ^^^^^^^^^^^^^
+  |
+  = note: this error originates in the attribute macro `entry` (in Nightly builds, run with -Z macro-backtrace for more info)
diff --git a/macros/tests/ui/entry_bad_param.rs b/macros/tests/ui/entry_bad_param.rs
@@ -0,0 +1,8 @@
+#![no_main]
+
+use msp430_rt_macros::entry;
+
+#[entry]
+fn main(i: u32) -> ! {
+    loop {}
+}
diff --git a/macros/tests/ui/entry_bad_param.stderr b/macros/tests/ui/entry_bad_param.stderr
@@ -0,0 +1,5 @@
+error: `#[entry]` function must have signature `[unsafe] fn([<ident> : CriticalSection]) -> !`
+ --> tests/ui/entry_bad_param.rs:6:1
+  |
+6 | fn main(i: u32) -> ! {
+  | ^^^^^^^^^^^^^^^^^^^^
diff --git a/macros/tests/ui/entry_bad_ret.rs b/macros/tests/ui/entry_bad_ret.rs
@@ -0,0 +1,6 @@
+#![no_main]
+
+use msp430_rt_macros::entry;
+
+#[entry]
+fn main() {}
diff --git a/macros/tests/ui/entry_bad_ret.stderr b/macros/tests/ui/entry_bad_ret.stderr
@@ -0,0 +1,5 @@
+error: `#[entry]` function must have signature `[unsafe] fn([<ident> : CriticalSection]) -> !`
+ --> tests/ui/entry_bad_ret.rs:6:1
+  |
+6 | fn main() {}
+  | ^^^^^^^^^
diff --git a/macros/tests/ui/entry_extern_c.rs b/macros/tests/ui/entry_extern_c.rs
@@ -0,0 +1,8 @@
+#![no_main]
+
+use msp430_rt_macros::entry;
+
+#[entry]
+extern "C" fn main() -> ! {
+    loop {}
+}
diff --git a/macros/tests/ui/entry_extern_c.stderr b/macros/tests/ui/entry_extern_c.stderr
@@ -0,0 +1,5 @@
+error: `#[entry]` function must have signature `[unsafe] fn([<ident> : CriticalSection]) -> !`
+ --> tests/ui/entry_extern_c.rs:6:1
+  |
+6 | extern "C" fn main() -> ! {
+  | ^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/macros/tests/ui/entry_twice.rs b/macros/tests/ui/entry_twice.rs
@@ -0,0 +1,13 @@
+#![no_main]
+
+use msp430_rt_macros::entry;
+
+#[entry]
+fn foo() -> ! {
+    loop {}
+}
+
+#[entry]
+fn bar() -> ! {
+    loop {}
+}
diff --git a/macros/tests/ui/entry_twice.stderr b/macros/tests/ui/entry_twice.stderr
@@ -0,0 +1,11 @@
+error[E0428]: the name `main` is defined multiple times
+  --> tests/ui/entry_twice.rs:10:1
+   |
+5  | #[entry]
+   | -------- previous definition of the value `main` here
+...
+10 | #[entry]
+   | ^^^^^^^^ `main` redefined here
+   |
+   = note: `main` must be defined only once in the value namespace of this module
+   = note: this error originates in the attribute macro `entry` (in Nightly builds, run with -Z macro-backtrace for more info)
diff --git a/macros/tests/ui/interrupt_args.rs b/macros/tests/ui/interrupt_args.rs
@@ -0,0 +1,13 @@
+#![no_main]
+
+use msp430_rt_macros::{entry, interrupt};
+
+#[entry]
+fn main() -> ! {
+    loop {}
+}
+
+#[interrupt(arg)]
+fn TIM2() -> ! {
+    loop {}
+}
diff --git a/macros/tests/ui/interrupt_args.stderr b/macros/tests/ui/interrupt_args.stderr
@@ -0,0 +1,7 @@
+error: This attribute accepts no arguments
+  --> tests/ui/interrupt_args.rs:10:1
+   |
+10 | #[interrupt(arg)]
+   | ^^^^^^^^^^^^^^^^^
+   |
+   = note: this error originates in the attribute macro `interrupt` (in Nightly builds, run with -Z macro-backtrace for more info)
diff --git a/macros/tests/ui/interrupt_bad_param.rs b/macros/tests/ui/interrupt_bad_param.rs
@@ -0,0 +1,13 @@
+#![no_main]
+
+use msp430_rt_macros::{entry, interrupt};
+
+#[entry]
+fn main() -> ! {
+    loop {}
+}
+
+#[interrupt]
+fn TIM2(i: u32) -> ! {
+    loop {}
+}
diff --git a/macros/tests/ui/interrupt_bad_param.stderr b/macros/tests/ui/interrupt_bad_param.stderr
@@ -0,0 +1,5 @@
+error: `#[interrupt]` handlers must have signature `[unsafe] fn([<name>: CriticalSection]) [-> !]`
+  --> tests/ui/interrupt_bad_param.rs:11:1
+   |
+11 | fn TIM2(i: u32) -> ! {
+   | ^^^^^^^^^^^^^^^^^^^^
diff --git a/macros/tests/ui/interrupt_bad_ret.rs b/macros/tests/ui/interrupt_bad_ret.rs
@@ -0,0 +1,13 @@
+#![no_main]
+
+use msp430_rt_macros::{entry, interrupt};
+
+#[entry]
+fn main() -> ! {
+    loop {}
+}
+
+#[interrupt]
+fn TIM2() -> bool {
+    true
+}
diff --git a/macros/tests/ui/interrupt_bad_ret.stderr b/macros/tests/ui/interrupt_bad_ret.stderr
@@ -0,0 +1,5 @@
+error: `#[interrupt]` handlers must have signature `[unsafe] fn([<name>: CriticalSection]) [-> !]`
+  --> tests/ui/interrupt_bad_ret.rs:11:1
+   |
+11 | fn TIM2() -> bool {
+   | ^^^^^^^^^^^^^^^^^
diff --git a/macros/tests/ui/interrupt_extern_c.rs b/macros/tests/ui/interrupt_extern_c.rs
@@ -0,0 +1,13 @@
+#![no_main]
+
+use msp430_rt_macros::{entry, interrupt};
+
+#[entry]
+fn main() -> ! {
+    loop {}
+}
+
+#[interrupt]
+extern "C" fn TIM2() -> ! {
+    loop {}
+}
diff --git a/macros/tests/ui/interrupt_extern_c.stderr b/macros/tests/ui/interrupt_extern_c.stderr
@@ -0,0 +1,5 @@
+error: `#[interrupt]` handlers must have signature `[unsafe] fn([<name>: CriticalSection]) [-> !]`
+  --> tests/ui/interrupt_extern_c.rs:11:1
+   |
+11 | extern "C" fn TIM2() -> ! {
+   | ^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/macros/tests/ui/interrupt_twice.rs b/macros/tests/ui/interrupt_twice.rs
@@ -0,0 +1,31 @@
+#![no_main]
+#![feature(abi_msp430_interrupt)]
+
+use msp430_rt_macros::{entry, interrupt};
+
+#[entry]
+fn main() -> ! {
+    loop {}
+}
+
+#[allow(non_camel_case_types)]
+enum interrupt {
+    TIM1,
+    TIM2,
+}
+
+#[interrupt]
+fn TIM1() {
+    // Different name, so it shouldn't be flagged
+    loop {}
+}
+
+#[interrupt]
+fn TIM2() {
+    loop {}
+}
+
+#[interrupt]
+fn TIM2() {
+    loop {}
+}
diff --git a/macros/tests/ui/interrupt_twice.stderr b/macros/tests/ui/interrupt_twice.stderr
@@ -0,0 +1,35 @@
+error[E0428]: the name `TIM2` is defined multiple times
+  --> tests/ui/interrupt_twice.rs:28:1
+   |
+23 | #[interrupt]
+   | ------------ previous definition of the value `TIM2` here
+...
+28 | #[interrupt]
+   | ^^^^^^^^^^^^ `TIM2` redefined here
+   |
+   = note: `TIM2` must be defined only once in the value namespace of this module
+   = note: this error originates in the attribute macro `interrupt` (in Nightly builds, run with -Z macro-backtrace for more info)
+
+error[E0570]: `"msp430-interrupt"` is not a supported ABI for the current target
+  --> tests/ui/interrupt_twice.rs:17:1
+   |
+17 | #[interrupt]
+   | ^^^^^^^^^^^^
+   |
+   = note: this error originates in the attribute macro `interrupt` (in Nightly builds, run with -Z macro-backtrace for more info)
+
+error[E0570]: `"msp430-interrupt"` is not a supported ABI for the current target
+  --> tests/ui/interrupt_twice.rs:23:1
+   |
+23 | #[interrupt]
+   | ^^^^^^^^^^^^
+   |
+   = note: this error originates in the attribute macro `interrupt` (in Nightly builds, run with -Z macro-backtrace for more info)
+
+error[E0570]: `"msp430-interrupt"` is not a supported ABI for the current target
+  --> tests/ui/interrupt_twice.rs:28:1
+   |
+28 | #[interrupt]
+   | ^^^^^^^^^^^^
+   |
+   = note: this error originates in the attribute macro `interrupt` (in Nightly builds, run with -Z macro-backtrace for more info)
diff --git a/macros/tests/ui/preinit_arg.rs b/macros/tests/ui/preinit_arg.rs
@@ -0,0 +1,11 @@
+#![no_main]
+
+use msp430_rt_macros::{entry, pre_init};
+
+#[entry]
+fn bar() -> ! {
+    loop {}
+}
+
+#[pre_init(arg)]
+unsafe fn foo() {}
diff --git a/macros/tests/ui/preinit_arg.stderr b/macros/tests/ui/preinit_arg.stderr
@@ -0,0 +1,7 @@
+error: This attribute accepts no arguments
+  --> tests/ui/preinit_arg.rs:10:1
+   |
+10 | #[pre_init(arg)]
+   | ^^^^^^^^^^^^^^^^
+   |
+   = note: this error originates in the attribute macro `pre_init` (in Nightly builds, run with -Z macro-backtrace for more info)
diff --git a/macros/tests/ui/preinit_bad_param.rs b/macros/tests/ui/preinit_bad_param.rs
@@ -0,0 +1,11 @@
+#![no_main]
+
+use msp430_rt_macros::{entry, pre_init};
+
+#[entry]
+fn bar() -> ! {
+    loop {}
+}
+
+#[pre_init]
+unsafe fn foo(i: u32) {}
diff --git a/macros/tests/ui/preinit_bad_param.stderr b/macros/tests/ui/preinit_bad_param.stderr
diff --git a/macros/tests/ui/preinit_bad_ret.rs b/macros/tests/ui/preinit_bad_ret.rs
diff --git a/macros/tests/ui/preinit_bad_ret.stderr b/macros/tests/ui/preinit_bad_ret.stderr
diff --git a/macros/tests/ui/preinit_safe.rs b/macros/tests/ui/preinit_safe.rs
diff --git a/macros/tests/ui/preinit_safe.stderr b/macros/tests/ui/preinit_safe.stderr
