Merge pull request #4484 from mbyx/ctest_macro_expansion

Add macro expansion and ctest entrypoint.

Author: tgross35

ci/run.sh

@@ -95,7 +95,7 @@ esac
 
 # garando_errors only compiles on `cfg(any(unix, windows))`
 case "$target" in
-    *wasm*) cmd="$cmd --exclude ctest --exclude ctest-test"
+    *wasm*) cmd="$cmd --exclude ctest --exclude ctest-test --exclude ctest-next"
 esac
 
 # # FIXME(ctest): duplicate symbol errors for statics, e.g. T1_static_mut_u8, on Unix-

ctest-next/src/generator.rs

@@ -0,0 +1,26 @@
+use std::path::Path;
+
+use crate::{expand, Result};
+
+/// A builder used to generate a test suite.
+#[non_exhaustive]
+pub struct TestGenerator {}
+
+impl Default for TestGenerator {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
+impl TestGenerator {
+    /// Creates a new blank test generator.
+    pub fn new() -> Self {
+        Self {}
+    }
+
+    /// Generate all tests for the given crate and output the Rust side to a file.
+    pub fn generate<P: AsRef<Path>>(&self, crate_path: P, _output_file_path: P) -> Result<()> {
+        let _expanded = expand(crate_path)?;
+        Ok(())
+    }
+}

ctest-next/src/lib.rs

@@ -1,14 +1,19 @@
-pub fn add(left: usize, right: usize) -> usize {
-    left + right
-}
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-
-    #[test]
-    fn it_works() {
-        let result = add(2, 2);
-        assert_eq!(result, 4);
-    }
-}
+#![warn(missing_docs)]
+#![warn(unreachable_pub)]
+
+//! # ctest2 - an FFI binding validator
+//!
+//! This library is intended to be used as a build dependency in a separate
+//! project from the main repo to generate tests which can be used to validate
+//! FFI bindings in Rust against the headers from which they come from.
+
+mod generator;
+mod macro_expansion;
+
+pub use generator::TestGenerator;
+pub use macro_expansion::expand;
+
+/// A possible error that can be encountered in our library.
+pub type Error = Box<dyn std::error::Error>;
+/// A type alias for `std::result::Result` that defaults to our error type.
+pub type Result<T, E = Error> = std::result::Result<T, E>;

ctest-next/src/macro_expansion.rs

@@ -0,0 +1,23 @@
+use std::{env, fs::canonicalize, path::Path, process::Command};
+
+use crate::Result;
+
+/// Use rustc to expand all macros and pretty print the crate into a single file.
+pub fn expand<P: AsRef<Path>>(crate_path: P) -> Result<String> {
+    let rustc = env::var("RUSTC").unwrap_or_else(|_| String::from("rustc"));
+
+    let output = Command::new(rustc)
+        .env("RUSTC_BOOTSTRAP", "1")
+        .arg("-Zunpretty=expanded")
+        .arg(canonicalize(crate_path)?)
+        .output()?;
+
+    if !output.status.success() {
+        let error = std::str::from_utf8(&output.stderr)?;
+        return Err(error.into());
+    }
+
+    let expanded = std::str::from_utf8(&output.stdout)?.to_string();
+
+    Ok(expanded)
+}

ctest-next/tests/basic.rs

@@ -0,0 +1,39 @@
+use ctest_next::TestGenerator;
+
+#[test]
+fn test_entrypoint_hierarchy() {
+    let generator = TestGenerator::new();
+
+    generator
+        .generate("./tests/input/hierarchy/lib.rs", "hierarchy_out.rs")
+        .unwrap();
+}
+
+#[test]
+fn test_entrypoint_simple() {
+    let generator = TestGenerator::new();
+
+    generator
+        .generate("./tests/input/simple.rs", "simple_out.rs")
+        .unwrap();
+}
+
+#[test]
+fn test_entrypoint_macro() {
+    let generator = TestGenerator::new();
+
+    generator
+        .generate("./tests/input/macro.rs", "macro_out.rs")
+        .unwrap();
+}
+
+#[test]
+fn test_entrypoint_invalid_syntax() {
+    let generator = TestGenerator::new();
+
+    let fails = generator
+        .generate("./tests/input/invalid_syntax.rs", "invalid_syntax_out.rs")
+        .is_err();
+
+    assert!(fails)
+}

ctest-next/tests/input/hierarchy/bar/mod.rs

@@ -0,0 +1,2 @@
+#[allow(non_camel_case_types)]
+pub type in6_addr = u32;

ctest-next/tests/input/hierarchy/foo.rs

@@ -0,0 +1,10 @@
+use crate::bar::in6_addr;
+use std::os::raw::c_void;
+
+pub const ON: bool = true;
+
+unsafe extern "C" {
+    fn malloc(size: usize) -> *mut c_void;
+
+    static in6addr_any: in6_addr;
+}

ctest-next/tests/input/hierarchy/lib.rs

@@ -0,0 +1,4 @@
+//! Ensure that our crate is able to handle definitions spread across many files
+
+mod bar;
+mod foo;

ctest-next/tests/input/invalid_syntax.rs

@@ -0,0 +1,9 @@
+struct Foo {
+    a: int,
+    b: u8;
+}
+
+unin Bar {
+    x: u8,
+    y: u8
+}

ctest-next/tests/input/macro.rs

@@ -0,0 +1,12 @@
+macro_rules! vector {
+    ($name:ident, $ty:ty) => {
+        #[repr(C)]
+        struct $name {
+            x: $ty,
+            y: $ty,
+        }
+    };
+}
+
+vector!(VecU8, u8);
+vector!(VecU16, u16);

ctest-next/tests/input/simple.rs

@@ -0,0 +1,15 @@
+use std::os::raw::c_char;
+
+pub type Byte = u8;
+
+#[repr(C)]
+pub struct Person {
+    name: *const c_char,
+    age: u8,
+}
+
+#[repr(C)]
+pub union Word {
+    word: u16,
+    byte: [Byte; 2],
+}