From 188a96eee2cbe2ad09a64e0c6b2b3b970fb4672b Mon Sep 17 00:00:00 2001 From: "Panagiotis \"Ivory\" Vasilopoulos" Date: Fri, 20 Sep 2024 16:23:58 +0200 Subject: [PATCH] docs(readme): add cargo test instructions I came across a mysterious error that affected fs-test. As I was experimenting with code affecting file reads and writes, I falsely assumed that the issue was isolated to this test in particular. I forgot that the rest of the tests would not get executed if the first one were to fail. --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 7edb9c6c..2951440e 100644 --- a/README.md +++ b/README.md @@ -163,6 +163,22 @@ cargo run -- -v data/x86_64/hello_world cargo run -- -v data/x86_64/hello_c ``` +### Testing Uhyve using `cargo test` + +Some Hermit apps that were specifically created for integration testing can be found in [tests](tests). + +As per usual, all of these integration tests can be executed at once using `cargo test`: + +```sh +cargo test --test '*' +``` + +If one of these tests fails locally under mysterious circumstances, it may be worth appending +the [--no-fail-fast][no-fail-fast] flag to the command above. This may help you establish +whether the root cause can be attributed to your environment. + +[no-fail-fast]: https://doc.rust-lang.org/cargo/commands/cargo-test.html#options + ### Debugging Hermit apps Basic support of (single-core) applications is already integrated into Uhyve.