adding tests

.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+on: [push]
+
+name: CI
+
+jobs:
+  build_and_test:
+    name: hot-lib-reloader tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+      - uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: -- --no-capture

.gitignore

@@ -5,3 +5,4 @@ Cargo.lock
 DEV.org
 *.org
 examples/bevy-extended/
+/.idea/

Cargo.toml

@@ -20,6 +20,7 @@ thiserror = "1.0.32"
 
 [dev-dependencies]
 env_logger = "^0.9"
+recursive_lib = { path = "tests/recursive_lib" }
 
 [workspace]
 resolver = "2"

examples/minimal/src/main.rs

@@ -1,6 +1,4 @@
-use hot_lib_reloader::hot_module;
-
-#[hot_module(dylib = "lib")]
+#[hot_lib_reloader::hot_module(dylib = "lib")]
 mod hot_lib {
     hot_functions_from_file!("../lib/src/lib.rs");
 }

src/lib.rs

@@ -33,7 +33,7 @@ For a detailed discussion see https://robert.kra.hn/posts/hot-reloading-rust/.
 
 Assuming you use a workspace with the following layout:
 
-```
+```ignore
 ├── Cargo.toml
 └── src
 │   └── main.rs
@@ -87,7 +87,7 @@ lib = { path = "lib" }
 
 You can then define and use the lib reloader like so (`./src/main.rs`):
 
-```no_run
+```ignore
 hot_lib_reloader::define_lib_reloader! {
     unsafe MyLibLoader {
         // Will look for "liblib.so" (Linux), "lib.dll" (Windows), ...

src/lib_reloader.rs

@@ -210,7 +210,10 @@ impl LibReloader {
     ///
     /// Users of this API must specify the correct type of the function or variable loaded.
     pub unsafe fn get_symbol<T>(&self, name: &[u8]) -> Result<Symbol<T>, HotReloaderError> {
-        Ok(self.lib.as_ref().unwrap().get(name)?)
+        match &self.lib {
+            None => Err(HotReloaderError::LibraryNotLoaded),
+            Some(lib) => Ok(lib.get(name)?),
+        }
     }
 }
 

tests/common.rs

@@ -0,0 +1,26 @@
+pub fn recompile(dir: impl AsRef<std::path::Path>) {
+    std::process::Command::new("cargo")
+        .arg("build")
+        .current_dir(dir)
+        .spawn()
+        .and_then(|proc| proc.wait_with_output())
+        .expect("cargo build failed");
+}
+
+pub fn modify_file_and_do(
+    file: impl AsRef<std::path::Path>,
+    modify_file_fn: impl FnOnce(&str) -> String,
+    do_fn: impl FnOnce() + std::panic::UnwindSafe,
+) {
+    let file = file.as_ref().canonicalize().expect("cannot find lib file");
+
+    let content = std::fs::read_to_string(&file).expect("cannot read file");
+    let new_content = modify_file_fn(content.as_str());
+    std::fs::write(&file, new_content).expect("cannot write lib file");
+
+    let res = std::panic::catch_unwind(do_fn);
+
+    std::fs::write(&file, content).expect("cannot restore file");
+
+    res.expect("modify_file_and_do: do_fn panicked");
+}

tests/recursive.rs

@@ -0,0 +1,29 @@
+mod common;
+
+#[hot_lib_reloader::hot_module(dylib = "recursive_lib")]
+mod hot_lib {
+    hot_functions_from_file!("./recursive_lib/src/lib.rs");
+}
+
+#[test]
+fn test() {
+    let n = hot_lib::do_more_stuff(Box::new(hot_lib::do_stuff));
+    assert_eq!(n, 5);
+
+    common::modify_file_and_do(
+        "tests/recursive_lib/src/lib.rs",
+        |content| {
+            content.replace(
+                "pub fn do_stuff() -> i32 { 3 }",
+                "pub fn do_stuff() -> i32 { 5 }",
+            )
+        },
+        || {
+            common::recompile("tests/recursive_lib");
+            std::thread::sleep(std::time::Duration::from_secs(1));
+
+            let n = hot_lib::do_more_stuff(Box::new(hot_lib::do_stuff));
+            assert_eq!(n, 7);
+        },
+    );
+}

tests/recursive_lib/Cargo.toml

@@ -0,0 +1,9 @@
+[package]
+name = "recursive_lib"
+version = "0.1.0"
+edition = "2021"
+
+[lib]
+crate-type = ["rlib", "dylib"]
+
+[dependencies]

tests/recursive_lib/src/lib.rs

@@ -0,0 +1,9 @@
+#[rustfmt::skip]
+#[no_mangle]
+pub fn do_stuff() -> i32 { 3 }
+
+#[no_mangle]
+pub fn do_more_stuff(callback: Box<dyn Fn() -> i32>) -> i32 {
+    let n = callback();
+    n + 2
+}