Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some notes on what's needed to successfully run the crux-mir tests. #1230

Merged
merged 2 commits into from
Aug 1, 2024
+16 −0
Merged

Add some notes on what's needed to successfully run the crux-mir tests. #1230

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
840ebc9
Add some notes on what's needed to successfully run the crux-mir tests.
sauclovian-g Jul 31, 2024
78231d5
Refer specifically to the Installation section in previous.
sauclovian-g Aug 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions crux-mir/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider calling out the "Installation" section explicitly, since that's where translate_libs.sh is described.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, done.


### Expected Failures

Some tests are not yet expected to succeed, as crux-mir is still under
Expand Down
Loading