-
Notifications
You must be signed in to change notification settings - Fork 79
tests: isolate persistence directories to prevent writes to user home #699
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.
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
Open
cbagwell
wants to merge
3
commits into
OpenHands:main
Choose a base branch
from
cbagwell:fix/test-home-config-writes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| """Root conftest.py - applies autouse fixtures to ALL tests including tui_e2e/.""" | ||
|
|
||
| import os.path | ||
|
|
||
| import pytest | ||
|
|
||
|
|
||
| @pytest.fixture(autouse=True) | ||
| def isolate_test_persistence(tmp_path, monkeypatch): | ||
| """Ensure all tests use isolated temp directories instead of ~/.openhands/. | ||
|
|
||
| This autouse fixture runs BEFORE every test and sets environment variables | ||
| to redirect all OpenHands persistence to an isolated temp directory. | ||
| This prevents tests from accidentally writing to the user's real | ||
| ~/.openhands/ directory - including tests that don't use mock_locations. | ||
|
|
||
| Mocks: | ||
| - OPENHANDS_PERSISTENCE_DIR -> isolated temp dir | ||
| - OPENHANDS_CONVERSATIONS_DIR -> isolated temp dir | ||
| - PERSISTENCE_DIR -> isolated temp dir (legacy env var) | ||
| - os.path.expanduser("~") -> isolated temp home (fallback when env not checked) | ||
| """ | ||
| home_dir = tmp_path / "home" | ||
| home_dir.mkdir() | ||
| persistence_dir = home_dir / ".openhands" | ||
| persistence_dir.mkdir(exist_ok=True) | ||
| conversations_dir = persistence_dir / "conversations" | ||
| conversations_dir.mkdir(exist_ok=True) | ||
|
|
||
| monkeypatch.setenv("OPENHANDS_PERSISTENCE_DIR", str(persistence_dir)) | ||
| monkeypatch.setenv("OPENHANDS_CONVERSATIONS_DIR", str(conversations_dir)) | ||
| monkeypatch.setenv("PERSISTENCE_DIR", str(persistence_dir)) | ||
|
|
||
| original_expanduser = os.path.expanduser | ||
|
|
||
| def mock_expanduser(path): | ||
| path_str = str(path) | ||
| if path_str == "~": | ||
| return str(home_dir) | ||
| elif path_str.startswith("~/"): | ||
| return str(home_dir / path_str[2:]) | ||
| return original_expanduser(path_str) | ||
|
|
||
| monkeypatch.setattr(os.path, "expanduser", mock_expanduser) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.