Skip to content

Add venv requirements for running framework tests #4078

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

Merged
merged 2 commits into from
Aug 27, 2025
Merged

Add venv requirements for running framework tests #4078

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0512121
Fix typo `cp` to `cd` in CONTRIBUTING.md
pjromano Aug 26, 2025
017317c
Mention Python venv requirements for running tests
pjromano Aug 26, 2025
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
17 changes: 15 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,11 +147,24 @@ The automatic checking system will run all our unit tests and integration tests
process will take time. Try to run the unit tests locally during development before submitting a PR and use the
automatic checks as a safety net.

Building and running the tests has the same Python virtual environment requirements as developing an F´ project, which
is usually set up by fprime-bootstrap. Steps to set up the environment outside a project are included below.

The tests can be run using the following commands:

```bash
# Go into the fprime directory
cp MY_FPRIME_DIRECTORY
cd MY_FPRIME_DIRECTORY

# Set up and activate a Python virtual environment, if none already:
python3 -m venv .venv
source .venv/bin/activate

# Make sure Python packages from ./requirements.txt are installed and up-to-date:
pip install -Ur requirements.txt

# Initialize googletest submodule:
git submodule update --init --recursive

# Run CI tests on fprime
./ci/tests/Framework.bash
Expand Down Expand Up @@ -191,4 +204,4 @@ cp MY_FPRIME_DIRECTORY
fprime-util generate -DFPRIME_SKIP_TOOLS_VERSION_CHECK=1
# Build the project
fprime-util build -j4
```
```
Loading