Fix: Improve error handling for missing SSH client and add unit tests for shell command
#200
Conversation
This file contains 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
- Refactored the `ls` command to include argument routing directly within the `RunE` function for improved clarity and maintainability. - Replaced `if-else` statements in `handleLsArg` with a cleaner `switch` statement. - Updated the help output to properly display valid arguments for the `ls` command, enhancing user guidance. - Improved error handling, particularly for invalid arguments and admin-only operations. - Refactored `NewCmdLs` to include dynamic routing and improved user experience. - Introduced new unit tests for various `ls` command scenarios, ensuring coverage for no args, valid args, invalid args, and specific flag handling. - Added a `NewTestTerminal` function to facilitate testing by providing an easily configurable terminal instance with buffers for `stdout`, `stderr`, and verbose output.
… for `shell` command - Added error handling for scenarios where the SSH client is not installed or not available in the PATH. - Updated unit tests to cover SSH client availability and workspace not found errors. - Minor code cleanup and formatting improvements in the `ls` and `shell` commands.
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.
Summary
NOTE: The first 3 commits are based off the preceding PR #198.
Resolves #185
This PR addresses the issue where running the
brev shellcommand in a Docker environment without an installed SSH client would cause a panic. Additionally, it improves the error handling when the specified workspace cannot be found.Key changes
SSH Client Check:
Unit Tests:
Code Cleanup:
Impact
brev shellin environments without an SSH client will now receive a clear error message guiding them to install the required software.