codexctl icon indicating copy to clipboard operation
codexctl copied to clipboard

Added manual dd update

Open Jayy001 opened this issue 1 year ago • 3 comments

Todo

  • [ ] Use mount command instead of the env variables
  • [ ] Update the restore script to do the same
  • [ ] Make disable automatic update part a function
  • [ ] Test it actually works
  • [ ] Add debug function. Show hardware in log message.
  • [ ] Automate testing with docker container!

Summary by CodeRabbit

  • New Features

    • Added a new transfer command to enable transferring files from the host to the device, with support for specifying a custom SSH port.
    • Introduced a manual downgrade process for device updates, allowing manual installation when required by device compatibility.
  • Improvements

    • Enhanced logging for update image extraction and analysis.
    • Added support for custom SSH ports across device management and connection features.
    • Improved error handling and user feedback during file transfer and update processes.

Jayy001 avatar Dec 09 '24 22:12 Jayy001

Walkthrough

The changes introduce a new transfer command to enable transferring files from the host to a remote device, with support for specifying a custom SSH port. The update process is enhanced with a manual downgrade path for certain update scenarios. Logging is improved, and several methods are updated to accept a logger and port parameter.

Changes

File(s) Change Summary
codexctl/__init__.py Added transfer subcommand and --port argument; enhanced call_func to support file transfer and manual update process; updated argument parsing and help text; passed logger to get_update_image.
codexctl/analysis.py Modified get_update_image to accept a logger parameter and use it for warnings instead of the warnings module.
codexctl/device.py Added SSH port support in DeviceManager and related methods; added transfer_file_to_remote and install_manual_update methods; improved SSH authentication and progress reporting; updated reachability checks and connection logic.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Manager
    participant DeviceManager
    participant RemoteDevice

    User->>CLI: codexctl transfer <file> <destination> --port <port>
    CLI->>Manager: call_func('transfer', args)
    Manager->>DeviceManager: transfer_file_to_remote(file, destination)
    DeviceManager->>RemoteDevice: SFTP upload file to destination (on port)
    DeviceManager-->>Manager: Done
    Manager-->>CLI: Print "Done!"
sequenceDiagram
    participant User
    participant CLI
    participant Manager
    participant DeviceManager
    participant Analysis
    participant RemoteDevice

    User->>CLI: codexctl install <update_file> [--port <port>]
    CLI->>Manager: call_func('install', args)
    Manager->>Analysis: get_update_image(update_file, logger)
    alt Manual downgrade needed
        Manager->>DeviceManager: install_manual_update(update_image)
        DeviceManager->>RemoteDevice: Upload image, run dd, reboot, reconnect, disable updates
    else Normal install
        Manager->>DeviceManager: install_sw_update or install_ohma_update
    end
    DeviceManager-->>Manager: Install complete
    Manager-->>CLI: Print completion message
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Dec 09 '24 22:12 coderabbitai[bot]

Jayy remember to uncomment 242-247 and remove 248-249 of __init__.py once you're done

Jayy001 avatar Dec 09 '24 22:12 Jayy001

Extra additions

  • Added custom port option for use with rmDocker
  • Added empty password support for use with rmDocker

Jayy001 avatar Dec 09 '24 22:12 Jayy001