feat: implement HTTP server for remote UEFI shell capability #6
Conversation
|
We don't publish DEVs .whl. |
1 similar comment
|
We don't publish DEVs .whl. |
adrianlasota
force-pushed
the
MFD-7178
branch
from
7904675 to
b38783f
Compare
|
We don't publish DEVs .whl. |
1 similar comment
|
We don't publish DEVs .whl. |
There was a problem hiding this comment.
Pull Request Overview
This PR implements a remote shell (RShell) capability that enables HTTP-based command execution between a Python client and Flask server, with specific support for UEFI shell environments.
Key changes:
- Added RShellConnection class for managing remote command execution via HTTP
- Implemented Flask-based server for handling command queues and client connections
- Created UEFI-compatible HTTP client with specialized handling for UEFI shell limitations
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| mfd_connect/rshell_server.py | Flask REST server managing command queues, health checks, and result collection |
| mfd_connect/rshell_client.py | HTTP client designed for UEFI shell with polling and command execution capabilities |
| mfd_connect/rshell.py | RShellConnection class providing remote command execution interface |
| examples/rshell_example.py | Usage example demonstrating RShellConnection functionality |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| def get_command_to_execute(): | ||
| """Get the next command to execute for the connected client.""" | ||
| ip_address = str(request.remote_addr) | ||
| global client_connected |
There was a problem hiding this comment.
The variable client_connected is referenced but never defined. This will cause a NameError at runtime.
| global client_connected | |
| # global client_connected # Removed: not defined or used |
Copilot uses AI. Check for mistakes.
| print(f"Client connected: {ip_address}") | ||
| clients.append(ip_address) |
There was a problem hiding this comment.
The client IP address is always appended to the clients list, even if it already exists. This will create duplicate entries. The append should be inside the if block.
| print(f"Client connected: {ip_address}") | |
| clients.append(ip_address) | |
| clients.append(ip_address) |
Copilot uses AI. Check for mistakes.
| except Exception as exp: | ||
| conn.request( | ||
| "POST", | ||
| str("Exception"), |
There was a problem hiding this comment.
The URL path should be '/post_result' instead of 'Exception' to match the server endpoint.
| str("Exception"), | |
| "post_result", |
Copilot uses AI. Check for mistakes.
| if env is not None: | ||
| logger.log( | ||
| level=log_levels.MODULE_DEBUG, | ||
| msg="Environment variables are not supported for RShellConnection and will be ignored.", | ||
| ) |
There was a problem hiding this comment.
This check for env is not None is duplicated. The second occurrence (lines 134-138) should be removed as it's identical to lines 128-132.
| if env is not None: | |
| logger.log( | |
| level=log_levels.MODULE_DEBUG, | |
| msg="Environment variables are not supported for RShellConnection and will be ignored.", | |
| ) |
Copilot uses AI. Check for mistakes.
| msg="Skipping logging is not supported for RShellConnection and will be ignored.", | ||
| ) | ||
|
|
||
| if expected_return_codes is not None: |
There was a problem hiding this comment.
The parameter expected_return_codes uses ellipsis (...) as default value but is checked against None. This will always be False since ellipsis is not None.
Copilot uses AI. Check for mistakes.
| timeout_string = " " if timeout is None else f" with timeout {timeout} seconds" | ||
| logger.log(level=log_levels.CMD, msg=f"Executing >{self._ip}> '{command}', {timeout_string}") |
There was a problem hiding this comment.
The log message formatting is incorrect. It should be f\"Executing >{self._ip}> '{command}'{timeout_string}\" to properly concatenate the timeout information.
| timeout_string = " " if timeout is None else f" with timeout {timeout} seconds" | |
| logger.log(level=log_levels.CMD, msg=f"Executing >{self._ip}> '{command}', {timeout_string}") | |
| logger.log(level=log_levels.CMD, msg=f"Executing >{self._ip}> '{command}'{timeout_string}") |
Copilot uses AI. Check for mistakes.
Signed-off-by: Lasota, Adrian <[email protected]>
adrianlasota
force-pushed
the
MFD-7178
branch
from
b38783f to
1fea908
Compare
|
We don't publish DEVs .whl. |
1 similar comment
|
We don't publish DEVs .whl. |
This pull request introduces a new remote shell (RShell) connection feature, enabling remote command execution via HTTP between a Python client (including UEFI shell support) and a Flask-based server. The implementation includes the RShell connection class, a sample client, and a server for managing command queues and results.
RShell Connection Implementation
RShellConnectionclass tomfd_connect/rshell.py, providing methods to start/connect to the RShell server, execute commands remotely, and manage connection lifecycle. This class includes extensive logging and supports command execution via HTTP requests.Sample Client and Server
mfd_connect/rshell_client.py, a sample HTTP client designed to run on UEFI shell, which polls for commands, executes them locally, and posts results back to the server. It includes compatibility handling for UEFI shell's limitations.mfd_connect/rshell_server.py, a Flask REST server that manages command queues for each client, provides health checks, serves commands for execution, and collects results. The server supports multiple clients and tracks command status.Usage Example
examples/rshell_example.pydemonstrating how to use the newRShellConnectionclass to connect to a remote RShell server, execute a command, and disconnect.