Add tests for the scudo-proc-macro crate

This change adds both ui-tests as well as integrations tests with
scudo, via ./abort_tests.sh.

Author: 1c3t3a

abort_tests.sh

@@ -22,25 +22,34 @@
 #
 # [1] https://llvm.org/docs/ScudoHardenedAllocator.html#error-types
 
-cargo build --release --bin crash || exit 1
+cargo build --release --bins || exit 1
 
 # Run the `crash` binary with the first arg. This binary will crash.
 # If the second arg is present in the crash message, the test passes.
 function run_test {
   tmp=$(mktemp)
-  target/release/crash $1 2>$tmp
-  if grep -q "$2" $tmp
+  target/release/$1 $2 2>$tmp
+  if grep -q "$3" $tmp
   then
-    echo "Test '$2' pass"
+    echo "Test '$3' pass"
   else
-    echo "Test '$2' failed"
+    echo "Test '$3' failed"
     exit 1
   fi
 }
 
-run_test double_free "invalid chunk state"
-run_test misaligned_ptr "misaligned pointer"
-run_test corrupted_chunk_header "corrupted chunk header"
-run_test delete_size_mismatch "invalid sized delete"
+function run_crash_test {
+  run_test crash $1 "$2"
+}
+
+function run_macro_test {
+  run_test macro "" "$1"
+}
+
+run_crash_test double_free "invalid chunk state"
+run_crash_test misaligned_ptr "misaligned pointer"
+run_crash_test corrupted_chunk_header "corrupted chunk header"
+run_crash_test delete_size_mismatch "invalid sized delete"
+run_macro_test "Scudo WARNING: found 1 unrecognized flag(s)"
 
 echo "All tests pass"

scudo-proc-macros/src/lib.rs

@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2022 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -124,3 +124,19 @@ pub fn set_scudo_options(attr: TokenStream, item: TokenStream) -> TokenStream {
 
     result
 }
+
+#[cfg(test)]
+mod tests {
+
+    #[test]
+    fn test_fail() {
+        let test_cases = trybuild::TestCases::new();
+        test_cases.compile_fail("tests/ui/*_fail.rs");
+    }
+
+    #[test]
+    fn test_pass() {
+        let test_cases = trybuild::TestCases::new();
+        test_cases.pass("tests/ui/*_pass.rs");
+    }
+}

scudo-proc-macros/tests/ui/multiple_options_pass.rs

@@ -0,0 +1,21 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+
+use scudo_proc_macros::set_scudo_options;
+
+#[set_scudo_options(name = 4.2, value = false)]
+fn main() {
+    
+}

scudo-proc-macros/tests/ui/no_equal_fail.rs

@@ -0,0 +1,21 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#![no_main]
+use scudo_proc_macros::set_scudo_options;
+
+#[set_scudo_options(name:true,value:3.14)]
+fn main() {
+
+}

scudo-proc-macros/tests/ui/no_equal_fail.stderr

@@ -0,0 +1,5 @@
+error: expected `=`
+  --> tests/ui/no_equal_fail.rs:18:25
+   |
+18 | #[set_scudo_options(name:true,value:3.14)]
+   |                         ^

scudo-proc-macros/tests/ui/no_ident_or_literal_fail.rs

@@ -0,0 +1,21 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#![no_main]
+use scudo_proc_macros::set_scudo_options;
+
+#[set_scudo_options(name = foo)]
+fn main() {
+    
+}

scudo-proc-macros/tests/ui/no_ident_or_literal_fail.stderr

@@ -0,0 +1,7 @@
+error: Expect a valid value like '3.14' or 'true'
+  --> tests/ui/no_ident_or_literal_fail.rs:18:1
+   |
+18 | #[set_scudo_options(name = foo)]
+   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+   |
+   = note: this error originates in the attribute macro `set_scudo_options` (in Nightly builds, run with -Z macro-backtrace for more info)

scudo-proc-macros/tests/ui/not_main_fail.rs

@@ -0,0 +1,21 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#![no_main]
+use scudo_proc_macros::set_scudo_options;
+
+#[set_scudo_options(name=true)]
+fn not_main() {
+
+}

scudo-proc-macros/tests/ui/not_main_fail.stderr

@@ -0,0 +1,5 @@
+error: This macro is only allowed to be used on the main method
+  --> tests/ui/not_main_fail.rs:19:4
+   |
+19 | fn not_main() {
+   |    ^^^^^^^^

scudo-proc-macros/tests/ui/single_option_pass.rs

@@ -0,0 +1,21 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+
+use scudo_proc_macros::set_scudo_options;
+
+#[set_scudo_options(name = 3.14)]
+fn main() {
+
+}