feat: add support for Python virtual environment in testsuite setup #956
Conversation
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
WalkthroughThe changes add optional support in Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant dev.sh
participant Python
participant venv
Developer->>dev.sh: Run with or without --use-global-env
alt Use global environment
dev.sh->>Python: pip install -r requirements.txt (global)
dev.sh->>Python: Run integration testsuite (global)
else Use virtual environment
dev.sh->>venv: setup_venv(./venv)
venv-->>dev.sh: venv created & activated
dev.sh->>Python: pip install -r requirements.txt (inside venv)
dev.sh->>Python: Run integration testsuite (inside venv)
dev.sh->>venv: cleanup_venv() on exit/interruption
end
Estimated code review effort2 (~20 minutes) Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
dev.sh (1)
119-122: Offer a short flag for ergonomicsConsider adding
-eas a shorthand for--use-venv, mirroring the existing pattern (-t/-s/-v). Small DX win, zero cost.- --use-venv) + -e|--use-venv) USE_VENV=true shift ;;
|
Cases of failure (e.g., ~/superfile$ ./dev.sh --testsuite --use-global-env
🚀 Starting superfile development workflow
==> Tidying Go modules...
✓ Go modules tidied
==> Formatting Go code...
✓ Code formatted
==> Running golangci-lint...
✓ Linting passed
==> Running unit tests...
? github.com/yorukot/superfile [no test files]
? github.com/yorukot/superfile/src/cmd [no test files]
? github.com/yorukot/superfile/src/config [no test files]
? github.com/yorukot/superfile/src/config/icon [no test files]
ok github.com/yorukot/superfile/src/internal (cached)
ok github.com/yorukot/superfile/src/internal/common (cached)
? github.com/yorukot/superfile/src/internal/ui [no test files]
ok github.com/yorukot/superfile/src/internal/ui/prompt (cached)
ok github.com/yorukot/superfile/src/internal/ui/rendering (cached)
ok github.com/yorukot/superfile/src/internal/ui/sidebar (cached)
ok github.com/yorukot/superfile/src/internal/utils (cached)
? github.com/yorukot/superfile/src/pkg/file_preview [no test files]
? github.com/yorukot/superfile/src/pkg/string_function [no test files]
✓ Unit tests passed
==> Running integration testsuite...
==> Installing testsuite requirements globally...
⚠ Using global Python environment - consider removing --use-global-env flag to use virtual environment
⚠ Failed to install testsuite requirements - continuing anyway
Traceback (most recent call last):
File "/home/khitoshi/superfile/testsuite/main.py", line 64, in <module>
main()
File "/home/khitoshi/superfile/testsuite/main.py", line 58, in main
success = run_tests(spf_path, only_run_tests=args.tests)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/khitoshi/superfile/testsuite/core/runner.py", line 57, in run_tests
spf_manager = TmuxSPFManager(str(spf_path))
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/khitoshi/superfile/testsuite/core/tmux_manager.py", line 33, in __init__
raise RuntimeError(
RuntimeError: libtmux version 0.31.0 or higher is required. Current version: 0.30.2. Please upgrade with: pip install 'libtmux>=0.31.0'
✗ Integration testsuite failedSuccessful Cases ~/superfile$ ./dev.sh --testsuite --use-global-env
🚀 Starting superfile development workflow
==> Tidying Go modules...
✓ Go modules tidied
==> Formatting Go code...
✓ Code formatted
==> Running golangci-lint...
✓ Linting passed
==> Running unit tests...
? github.com/yorukot/superfile [no test files]
? github.com/yorukot/superfile/src/cmd [no test files]
? github.com/yorukot/superfile/src/config [no test files]
? github.com/yorukot/superfile/src/config/icon [no test files]
ok github.com/yorukot/superfile/src/internal (cached)
ok github.com/yorukot/superfile/src/internal/common (cached)
? github.com/yorukot/superfile/src/internal/ui [no test files]
ok github.com/yorukot/superfile/src/internal/ui/prompt (cached)
ok github.com/yorukot/superfile/src/internal/ui/rendering (cached)
ok github.com/yorukot/superfile/src/internal/ui/sidebar (cached)
ok github.com/yorukot/superfile/src/internal/utils (cached)
? github.com/yorukot/superfile/src/pkg/file_preview [no test files]
? github.com/yorukot/superfile/src/pkg/string_function [no test files]
✓ Unit tests passed
==> Running integration testsuite...
==> Installing testsuite requirements globally...
⚠ Using global Python environment - consider removing --use-global-env flag to use virtual environment
⚠ Failed to install testsuite requirements - continuing anyway
[2025-07-23 12:38:44 - INFO] Testcases : [ChooserFileTest, CopyWTest, DeleteDirTest, EmptyPanelTest, CompressExtractTest, CommandTest, CopyDirTest, RenameTest, CutTest, CopyTest, DeleteTest]
[2025-07-23 12:38:44 - INFO] Running test ChooserFileTest
[2025-07-23 12:38:48 - INFO] Passed test ChooserFileTest
[2025-07-23 12:38:48 - INFO] Running test CopyWTest
[2025-07-23 12:38:50 - INFO] Passed test CopyWTest
[2025-07-23 12:38:50 - INFO] Running test DeleteDirTest
[2025-07-23 12:38:51 - INFO] Passed test DeleteDirTest
[2025-07-23 12:38:51 - INFO] Running test EmptyPanelTest
[2025-07-23 12:38:53 - INFO] Passed test EmptyPanelTest
[2025-07-23 12:38:53 - INFO] Running test CompressExtractTest
[2025-07-23 12:38:55 - INFO] Passed test CompressExtractTest
[2025-07-23 12:38:55 - INFO] Running test CommandTest
[2025-07-23 12:38:57 - INFO] Passed test CommandTest
[2025-07-23 12:38:57 - INFO] Running test CopyDirTest
[2025-07-23 12:38:58 - INFO] Passed test CopyDirTest
[2025-07-23 12:38:58 - INFO] Running test RenameTest
[2025-07-23 12:39:00 - INFO] Passed test RenameTest
[2025-07-23 12:39:00 - INFO] Running test CutTest
[2025-07-23 12:39:02 - INFO] Passed test CutTest
[2025-07-23 12:39:02 - INFO] Running test CopyTest
[2025-07-23 12:39:04 - INFO] Passed test CopyTest
[2025-07-23 12:39:04 - INFO] Running test DeleteTest
[2025-07-23 12:39:06 - INFO] Passed test DeleteTest
[2025-07-23 12:39:06 - INFO] Finished running 11 test. 11 passed
✓ Integration testsuite passed
==> Building spf binary...
✓ Build completed successfully
🎉 All steps completed successfully!
Binary location: ./bin/spf
Binary size: 23M |
…ve pane retrieval in TmuxSPFManager
~/superfile$ ./dev.sh --testsuite
🚀 Starting superfile development workflow
==> Tidying Go modules...
✓ Go modules tidied
==> Formatting Go code...
✓ Code formatted
==> Running golangci-lint...
✓ Linting passed
==> Running unit tests...
? github.com/yorukot/superfile [no test files]
? github.com/yorukot/superfile/src/cmd [no test files]
? github.com/yorukot/superfile/src/config [no test files]
? github.com/yorukot/superfile/src/config/icon [no test files]
ok github.com/yorukot/superfile/src/internal (cached)
ok github.com/yorukot/superfile/src/internal/common (cached)
? github.com/yorukot/superfile/src/internal/ui [no test files]
ok github.com/yorukot/superfile/src/internal/ui/prompt (cached)
ok github.com/yorukot/superfile/src/internal/ui/rendering (cached)
ok github.com/yorukot/superfile/src/internal/ui/sidebar (cached)
ok github.com/yorukot/superfile/src/internal/utils (cached)
? github.com/yorukot/superfile/src/pkg/file_preview [no test files]
? github.com/yorukot/superfile/src/pkg/string_function [no test files]
✓ Unit tests passed
==> Running integration testsuite...
==> Using existing virtual environment at ./venv
==> Upgrading pip in virtual environment...
✓ Pip upgraded successfully
==> Installing testsuite requirements in virtual environment...
✓ Testsuite requirements installed in virtual environment
[2025-07-23 12:46:00 - INFO] Testcases : [ChooserFileTest, CopyWTest, DeleteDirTest, EmptyPanelTest, CompressExtractTest, CommandTest, CopyDirTest, RenameTest, CutTest, CopyTest, DeleteTest]
[2025-07-23 12:46:00 - INFO] Running test ChooserFileTest
[2025-07-23 12:46:04 - INFO] Passed test ChooserFileTest
[2025-07-23 12:46:04 - INFO] Running test CopyWTest
[2025-07-23 12:46:06 - INFO] Passed test CopyWTest
[2025-07-23 12:46:06 - INFO] Running test DeleteDirTest
[2025-07-23 12:46:07 - INFO] Passed test DeleteDirTest
[2025-07-23 12:46:07 - INFO] Running test EmptyPanelTest
[2025-07-23 12:46:09 - INFO] Passed test EmptyPanelTest
[2025-07-23 12:46:09 - INFO] Running test CompressExtractTest
[2025-07-23 12:46:11 - INFO] Passed test CompressExtractTest
[2025-07-23 12:46:11 - INFO] Running test CommandTest
[2025-07-23 12:46:13 - INFO] Passed test CommandTest
[2025-07-23 12:46:13 - INFO] Running test CopyDirTest
[2025-07-23 12:46:15 - INFO] Passed test CopyDirTest
[2025-07-23 12:46:15 - INFO] Running test RenameTest
[2025-07-23 12:46:16 - INFO] Passed test RenameTest
[2025-07-23 12:46:16 - INFO] Running test CutTest
[2025-07-23 12:46:18 - INFO] Passed test CutTest
[2025-07-23 12:46:18 - INFO] Running test CopyTest
[2025-07-23 12:46:22 - INFO] Passed test CopyTest
[2025-07-23 12:46:22 - INFO] Running test DeleteTest
[2025-07-23 12:46:24 - INFO] Passed test DeleteTest
[2025-07-23 12:46:24 - INFO] Finished running 11 test. 11 passed
✓ Integration testsuite passed
==> Building spf binary...
✓ Build completed successfully
🎉 All steps completed successfully!
Binary location: ./bin/spf
Binary size: 23M |
Khitoshi
changed the title
… pane retrieval in TmuxSPFManager
~/superfile$ ./dev.sh --testsuite --use-global-env --verbose
....
[2025-07-23 01:54:28 - DEBUG] spf_manager info : [], Current file structure :
D-dir1
D-dir2
F-dir1/file1(1).txt
F-dir1/file1.txt
[2025-07-23 01:54:28 - INFO] Passed test CopyTest
[2025-07-23 01:54:28 - INFO] Running test DeleteTest
[2025-07-23 01:54:28 - DEBUG] Current file structure :
F-file_to_delete.txt
[2025-07-23 01:54:28 - DEBUG] windows_command : /home/khitoshi/superfile/bin/spf -c /home/khitoshi/superfile/src/superfile_config/config.toml --hf /home/khitoshi/superfile/src/superfile_config/hotkeys.toml
[2025-07-23 01:54:28 - DEBUG] spf_session initialised : Session($0 spf_session)
[2025-07-23 01:54:29 - DEBUG] sendind key : 'a'
[2025-07-23 01:54:29 - DEBUG] sendind key : '\x04'
[2025-07-23 01:54:29 - DEBUG] sendind key : '\r'
[2025-07-23 01:54:29 - DEBUG] sendind key : '\x1b'
[2025-07-23 01:54:30 - DEBUG] Finished Execution
[2025-07-23 01:54:30 - DEBUG] spf_manager info : [], Current file structure :
[2025-07-23 01:54:30 - INFO] Passed test DeleteTest
[2025-07-23 01:54:30 - INFO] Finished running 11 test. 11 passed
✓ Integration testsuite passed
==> Building spf binary...
✓ Build completed successfully |
Khitoshi
changed the title
lazysegtree
reviewed
Jul 23, 2025
dev.sh
Outdated
| if pip3 install -r requirements.txt > /dev/null 2>&1; then | ||
| print_success "Testsuite requirements installed" | ||
| # Setup virtual environment if requested | ||
| if [ "$USE_VENV" = true ]; then |
There was a problem hiding this comment.
Hey @Khitoshi Thanks for this. I would prefer if its other way around.
--use-global-env or a better name -> Uses global
default -> Uses venv
Default using global sounds bad.
There was a problem hiding this comment.
that makes more sense. I’ll switch the default to venv and add a --use-global-env flag.
lazysegtree
approved these changes
Jul 23, 2025
There was a problem hiding this comment.
LGTM. Tested. I would have @yorukot also take a look as he wrote this script.
yorukot
approved these changes
Jul 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
close #917
Description
This PR resolves the issue with Python package management in the
dev.shscript by adding support for Python virtual environments when running the integration testsuite.Changes Made
Added Virtual Environment Support
--use-venvcommand line flag to enable Python virtual environment usagesetup_venv()function to create and activate virtual environmentscleanup_venv()function to properly deactivate virtual environmentstestsuite/venvwhen enabledEnhanced Testsuite Execution
--use-venvflag is used:testsuite/venvUpdated Documentation
--use-venvoption to help messageUsage Examples
Summary by CodeRabbit