From 840ebc92fa5742a90c7ec64df708d3aa4f06f807 Mon Sep 17 00:00:00 2001 From: David Holland Date: Wed, 31 Jul 2024 19:30:03 -0400 Subject: [PATCH 1/2] Add some notes on what's needed to successfully run the crux-mir tests. --- README.md | 7 +++++++ crux-mir/README.md | 8 ++++++++ 2 files changed, 15 insertions(+) diff --git a/README.md b/README.md index d4b0be2ee..ed7f055c2 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,13 @@ Alternately, you can target a more specific sub-package instead of `all`. Testing and Coverage -------------------- +Testing is done via `cabal test`. + +To run the tests for crux-mir, you need to have built and installed +the mir-json tool such that it can be found on your $PATH. You also +need translated Rust libraries for the machine you're testing on. +See [the crux-mir README](crux-mir/README.md) for further information. + Testing with coverage tracking is done via `cabal test --enable-coverage ...` or `cabal configure --enable-coverage`, although additional workarounds will be needed as noted in https://github.com/galoisinc/crucible/issues/884 and diff --git a/crux-mir/README.md b/crux-mir/README.md index 922cc0d90..cf9d51c9f 100644 --- a/crux-mir/README.md +++ b/crux-mir/README.md @@ -104,6 +104,14 @@ To run `crux-mir`'s test suite: $ cabal v2-test +You need to have built and installed the mir-json tool such that it +can be found on your $PATH. +You also need translated libraries for the Rust target architecture +you're testing on. +Make sure that the `rlibs` symlink exists and points to the right +architecture's libraries. +If not, run the `translate_libs.sh` script as described above. + ### Expected Failures Some tests are not yet expected to succeed, as crux-mir is still under From 78231d517f4a42f3c050931f6122e7e587fd7106 Mon Sep 17 00:00:00 2001 From: David Holland Date: Thu, 1 Aug 2024 15:39:24 -0400 Subject: [PATCH 2/2] Refer specifically to the Installation section in previous. --- crux-mir/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/crux-mir/README.md b/crux-mir/README.md index cf9d51c9f..9b0f9a029 100644 --- a/crux-mir/README.md +++ b/crux-mir/README.md @@ -110,7 +110,8 @@ You also need translated libraries for the Rust target architecture you're testing on. Make sure that the `rlibs` symlink exists and points to the right architecture's libraries. -If not, run the `translate_libs.sh` script as described above. +If not, run the `translate_libs.sh` script as described above under +Installation. ### Expected Failures