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

adds a note on building and running tests #6577

Merged
merged 1 commit into from
Dec 9, 2024
Merged

adds a note on building and running tests #6577

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# PolyTracker

Check failure on line 1 in README.md

View workflow job for this annotation

GitHub Actions / Trunk Check

prettier 

Incorrect formatting, autoformat by running 'trunk fmt'

<p align="center">
<img src="logo/polytracker_name.png?raw=true" width="256" title="PolyTracker">
Expand Down Expand Up @@ -298,6 +298,27 @@
recommend replicating the install process from the
[PolyTracker Dockerfile](Dockerfile).

## Running Tests
Running both the Python and C++ unit tests should be done inside the PolyTracker
Docker container.

The Catch2 unit tests in `unittests/` live in
`/polytracker-build/unittests/src/taintdag/` within the container. Run the test binary
within the Docker container with
```shell-script
cd /polytracker-build/unittests/src/taintdag/ && ./tests-taintdag
```

The Python unit tests in `tests/` require local test C++ programs that the test
fixtures will instrument. Run them using Pytest in the working
```shell-script
pytest tests
```
Or use pytest to run a single test file with
```shell-script
pytest tests/test_foo.py
```

## Current Status and Known Issues

PolyTracker currently only runs on Linux, because that is the only system
Expand Down
Loading