Add build.rs to compiletest, add github job

Author: t-moe

.github/workflows/ci.yml

@@ -5,7 +5,7 @@
 
 on:
   push:
-    branches: [ master, staging, trying ]
+    branches: [ master, staging, trying, next ]
   pull_request:
   merge_group:
 
@@ -68,6 +68,26 @@ jobs:
       - name: Run cargo check for example
         run: cargo check --target ${{ matrix.target_and_example.target}} --no-default-features --features ${{matrix.log_kind}} --manifest-path ${{matrix.target_and_example.example}} --locked --all-targets
 
+  ui_tests:
+    name: Compile Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Install target
+        uses: dtolnay/rust-toolchain@v1
+        with:
+          target: riscv32imac-unknown-none-elf
+          toolchain: stable
+          components: rust-src
+
+      - name: Cache Dependencies
+        uses: Swatinem/rust-cache@v2.7.5
+
+      - name: Run Compile tests
+        run: cd tests-build && cargo test
+
   fmt:
     name: Rustfmt
     runs-on: ubuntu-latest

macros/src/attributes/tests/parse/items.rs

@@ -132,7 +132,7 @@ pub(crate) fn parse_item(mut f: ItemFn) -> Result<Func, syn::Error> {
             if check_fn_sig(&f.sig).is_err() || f.sig.inputs.len() > 1 {
                 return Err(parse::Error::new(
                     f.sig.ident.span(),
-                    "`#[test]` function must have signature `async fn(state: &mut Type)` (async/parameter are optional)",
+                    "`#[test]` function must have signature `async fn(state: Type)` (async/parameter are optional)",
                 ));
             }
 

src/export.rs

@@ -1,7 +1,7 @@
 use crate::{export, TestOutcome};
 
 #[cfg_attr(feature = "std", path = "std.rs")]
-#[cfg_attr(not(feature = "std"), path = "semihosting.rs")]
+#[cfg_attr(feature = "semihosting", path = "semihosting.rs")]
 pub mod hosting;
 
 // Reexport the embassy stuff
@@ -33,7 +33,7 @@ pub fn check_outcome<T: TestOutcome>(outcome: T) -> ! {
 */
 
 #[export_name = "main"]
-unsafe extern "C" fn __embedded_test_entry() -> ! {
+pub unsafe extern "C" fn __embedded_test_entry() -> ! {
     ensure_linker_file_was_added_to_rustflags();
 }
 

tests-build/cases/pass/embassy.rs

@@ -2,6 +2,7 @@
 ```cargo
 [dependencies]
 embassy-executor = { version = "0.7", features = ["executor-thread", "arch-riscv32"] }
+esp-hal = { version = "0.23.1", features = ["esp32c6"] } # for critical section implementation
 embedded-test = { path = "../../..", features = ["embassy"] }
 
 [lib]
@@ -15,6 +16,7 @@ harness = false
 #[cfg(test)]
 #[embedded_test::tests]
 mod tests1 {
+    use esp_hal::*; // needs to be in scope, to prevent linker error about missing `critical_section` implementation
 
     struct Context;
 
@@ -28,6 +30,11 @@ mod tests1 {
         assert!(true)
     }
 
+    #[test]
+    fn takes_state2(_state: Context) {
+        assert!(true)
+    }
+
     #[test]
     async fn takes_no_state() {
         assert!(true)
@@ -46,7 +53,7 @@ mod tests2 {
     }
 
     #[test]
-    async fn takes_state2(_state: Context) {
+    async fn takes_state3(_state: Context) {
         assert!(true)
     }
 

tests-build/cases/pass/embassy_custom_executor.rs

@@ -17,7 +17,7 @@ harness = false
 #[cfg(test)]
 #[embedded_test::tests(executor=esp_hal_embassy::Executor::new())]
 mod tests {
-    use esp_hal::*;
+    //use esp_hal::*;
 
     struct Context;
 

tests-build/src/build_rs.rs

@@ -0,0 +1,33 @@
+use std::path::Path;
+
+pub(crate) struct BuildRs {
+    linker_files: Vec<String>,
+}
+
+impl BuildRs {
+    pub fn new() -> Self {
+        Self {
+            linker_files: Vec::new(),
+        }
+    }
+
+    pub fn add_linker_file(&mut self, file: &str) {
+        self.linker_files.push(file.to_string());
+    }
+
+    pub fn write(&self, build_rs_path: &Path) -> anyhow::Result<()> {
+        let statements = self.generate_linker_args();
+        let contents = format!("fn main() {{ {statements} }}");
+        std::fs::write(build_rs_path, contents)?;
+        Ok(())
+    }
+
+    pub fn generate_linker_args(&self) -> String {
+        self.linker_files
+            .iter()
+            .map(|file| format!("cargo:rustc-link-arg=-T{}", file))
+            .map(|arg| format!("println!(\"{}\");\n", arg))
+            .collect::<Vec<String>>()
+            .join("\n")
+    }
+}

tests-build/src/lib.rs

@@ -1,3 +1,4 @@
+mod build_rs;
 mod manifest;
 
 use crate::manifest::Manifest;
@@ -25,6 +26,17 @@ fn run_test(test_file: &Path, should_pass: bool) {
     let manifest_path = temp_dir.join("Cargo.toml");
     manifest.write(&manifest_path).unwrap();
 
+    //TODO: only link embedded-test.x for some tests, to check for errors if missing
+
+    let mut build_rs = build_rs::BuildRs::new();
+    if manifest.dependencies.contains_key("esp-hal") {
+        build_rs.add_linker_file("linkall.x");
+    }
+    build_rs.add_linker_file("embedded-test.x");
+
+    let build_rs_path = temp_dir.join("build.rs");
+    build_rs.write(&build_rs_path).unwrap();
+
     let output = Command::new("cargo")
         .args(&[
             "test",
@@ -39,6 +51,11 @@ fn run_test(test_file: &Path, should_pass: bool) {
         ])
         .output()
         .unwrap();
+    println!(
+        "Running test {} in {}",
+        test_file.display(),
+        manifest_path.display()
+    );
 
     if should_pass {
         if output.status.success() {

tests-build/src/manifest.rs

@@ -41,7 +41,7 @@ pub(crate) struct BinOrTest {
 #[derive(Serialize, Deserialize, Debug)]
 pub(crate) struct Manifest {
     package: Option<Package>,
-    dependencies: Map<String, Dependency>,
+    pub dependencies: Map<String, Dependency>,
     #[serde(skip_serializing_if = "Option::is_none")]
     lib: Option<Lib>,
     #[serde(rename = "bin", default, skip_serializing_if = "Vec::is_empty")]