Merge #42

42: Tests for 22 r=Urhengulas a=Urhengulas

Also partially depends on #40 and fixes #26, by implementing tests for #22.

Co-authored-by: Johann Hemmann <johann.hemmann@code.berlin>

Cargo.toml

@@ -19,6 +19,7 @@ tempfile = "3.2"
 
 [dev-dependencies]
 assert_cmd = "1.0"
+rstest = "0.10"
 
 [workspace]
 members = [".", "xtest"]

test-flip-link-app/.memory.x

@@ -0,0 +1,7 @@
+MEMORY
+{
+  FLASH : ORIGIN = 0x00000000, LENGTH = 256K
+  RAM : ORIGIN = 0x20000000, LENGTH = 64K
+}
+
+INCLUDE empty.x

test-flip-link-app/Cargo.toml

@@ -9,7 +9,15 @@ version = "0.1.0"
 cortex-m = "0.7"
 cortex-m-rt = "0.6"
 cortex-m-semihosting = "0.3"
-lm3s6965 = "0.1"
 panic-semihosting = { version = "0.5", features = ["exit"] }
 
+# optional
+lm3s6965 = { version = "0.1", optional = true }
+
+[build-dependencies]
+anyhow = "1.0"
+
+[features]
+default = ["lm3s6965"]
+
 [workspace] # needed to exclude package from parent workspace

test-flip-link-app/build.rs

@@ -0,0 +1,19 @@
+fn main() -> anyhow::Result<()> {
+    // include following if hal is excluded (aka. default features are disabled)
+    #[cfg(not(feature = "lm3s6965"))]
+    {
+        use std::{env, fs::File, io::Write, path::PathBuf};
+
+        let out = PathBuf::from(env::var_os("OUT_DIR").expect("`OUT_DIR` is not set"));
+
+        File::create(out.join("memory.x"))?.write_all(include_bytes!(".memory.x"))?;
+        File::create(out.join("empty.x"))?.write_all(include_bytes!(".empty.x"))?;
+
+        println!("cargo:rustc-link-search={}", out.display());
+        println!("cargo:rerun-if-changed=.memory.x");
+        println!("cargo:rerun-if-changed=.empty.x");
+        println!("cargo:rerun-if-changed=build.rs");
+    }
+
+    Ok(())
+}

test-flip-link-app/examples/crash.rs

@@ -4,6 +4,7 @@
 use core::ptr;
 
 use cortex_m_rt::entry;
+#[cfg(feature = "lm3s6965")]
 use lm3s6965 as _;
 use panic_semihosting as _;
 

test-flip-link-app/examples/exception.rs

@@ -5,6 +5,7 @@
 use cortex_m::{peripheral::syst::SystClkSource, Peripherals};
 use cortex_m_rt::{entry, exception};
 use cortex_m_semihosting::hprint;
+#[cfg(feature = "lm3s6965")]
 use lm3s6965 as _;
 use panic_semihosting as _;
 

test-flip-link-app/examples/hello.rs

@@ -3,6 +3,7 @@
 
 use cortex_m_rt::entry;
 use cortex_m_semihosting::{debug, hprintln};
+#[cfg(feature = "lm3s6965")]
 use lm3s6965 as _;
 use panic_semihosting as _;
 

test-flip-link-app/examples/panic.rs

@@ -2,6 +2,7 @@
 #![no_std]
 
 use cortex_m_rt::entry;
+#[cfg(feature = "lm3s6965")]
 use lm3s6965 as _;
 use panic_semihosting as _;
 

tests/verify.rs

@@ -1,19 +1,23 @@
 use std::fs;
 
+use rstest::rstest;
+
 /// Path to test app
 const CRATE: &str = "test-flip-link-app";
 /// Example firmware in `$CRATE/examples`
 const FILES: [&str; 4] = ["crash", "exception", "hello", "panic"];
 /// Compilation target firmware is build for
 const TARGET: &str = "thumbv7m-none-eabi";
 
-#[test]
-fn should_link_example_firmware() -> anyhow::Result<()> {
+#[rstest]
+#[case::normal(true)]
+#[case::custom_linkerscript(false)]
+fn should_link_example_firmware(#[case] default_features: bool) -> anyhow::Result<()> {
     // Arrange
     cargo::check_flip_link();
 
     // Act
-    let cmd = cargo::build_example_firmware(CRATE);
+    let cmd = cargo::build_example_firmware(CRATE, default_features);
 
     // Assert
     cmd.success();
@@ -28,7 +32,7 @@ fn should_verify_memory_layout() -> anyhow::Result<()> {
     cargo::check_flip_link();
 
     // Act
-    cargo::build_example_firmware(CRATE).success();
+    cargo::build_example_firmware(CRATE, true).success();
 
     // Assert
     for elf_path in elf::paths() {
@@ -58,13 +62,19 @@ mod cargo {
 
     /// Build all examples in `$REPO/$rel_path`
     #[must_use]
-    pub fn build_example_firmware(rel_path: &str) -> Assert {
+    pub fn build_example_firmware(rel_path: &str, default_features: bool) -> Assert {
         // append `rel_path` to the current working directory
         let mut firmware_dir = std::env::current_dir().unwrap();
         firmware_dir.push(rel_path);
 
+        // disable default features or use `-v` as a no-op
+        let default_features = match default_features {
+            false => "--no-default-features",
+            true => "-v",
+        };
+
         Command::new("cargo")
-            .args(&["build", "--examples"])
+            .args(&["build", "--examples", default_features])
             .current_dir(firmware_dir)
             .unwrap()
             .assert()

xtest/src/main.rs

@@ -26,7 +26,10 @@ mod cargo {
     }
 
     pub fn test() -> anyhow::Result<()> {
-        let status = Command::new("cargo").arg("test").status()?;
+        let status = Command::new("cargo")
+            // `--test-threads=1` prevents race conditions accessing the elf-file
+            .args(&["test", "--", "--test-threads=1"])
+            .status()?;
         match status.success() {
             false => Err(anyhow!("running `cargo test`")),
             true => Ok(()),