Skip to content
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

Fix RAUC tryboot handler set-state idempotency, add more checks #3891

Merged
merged 1 commit into from
Feb 24, 2025

Conversation

sairon
Copy link
Member

@sairon sairon commented Feb 24, 2025

When RPi is booted in the tryboot state and the set-state operation is called for the second time, the tryboot files don't exists anymore and the handler exits with an error code, printing an error in the Supervisor logs. Fix handling of this case and add few more checks to make the handler a bit more robust/traceable.

Summary by CodeRabbit

  • Bug Fixes
    • Refined the logic for system startup to ensure a smooth boot process.
    • Added robust checks for critical startup files to prevent proceeding with invalid states, enhancing overall boot reliability.

When RPi is booted in the tryboot state and the set-state operation is called
for the second time, the tryboot files don't exists anymore and the handler
exits with an error code, printing an error in the Supervisor logs. Fix
handling of this case and add few more checks to make the handler a bit more
robust/traceable.
@sairon sairon added the board/raspberrypi Raspberry Pi Boards label Feb 24, 2025
@sairon sairon requested a review from agners February 24, 2025 12:51
Copy link

coderabbitai bot commented Feb 24, 2025

📝 Walkthrough

Walkthrough

The pull request refines the boot state handling in the rpi-tryboot.sh script. The logic has been inverted so that when the boot state is not "good," the script removes the .good file and exits early. Additionally, the script now verifies that both cmdline-tryboot.txt and tryboot.txt exist before proceeding; if either is missing, it exits. The .good file is created only when the boot state is explicitly "good" and all checks pass.

Changes

File(s) Summary
buildroot-external/…/rpi-tryboot.sh Inverts boot state logic: removes .good file when state is not "good" and exits early; adds existence checks for cmdline-tryboot.txt and tryboot.txt before proceeding, creating .good only if state is "good".

Sequence Diagram(s)

sequenceDiagram
    participant S as rpi-tryboot.sh
    participant FS as File System

    S->>S: Evaluate new_state
    alt new_state is not "good"
        S->>FS: Remove .good file
        S-->>S: Exit script
    else new_state is "good"
        S->>FS: Check existence of cmdline-tryboot.txt
        alt cmdline-tryboot.txt missing
            S->>FS: Check existence of .good file
            alt .good file missing
                S-->>S: Exit script
            end
        end
        S->>FS: Check existence of tryboot.txt
        alt tryboot.txt missing
            S-->>S: Exit script
        else
            S->>FS: Create .good file
            S-->>S: Continue processing
        end
    end
Loading
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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 or @coderabbitai title 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
buildroot-external/board/raspberrypi/rpi5-64/rootfs-overlay/usr/lib/rauc/rpi-tryboot.sh (1)

86-114: Robust File Existence and State Commitment Checks.

This block adds several important checks:

  • It verifies that cmdline-tryboot.txt is present. If it is missing but a .good file exists, it exits gracefully assuming the operation was already handled; otherwise, it logs an error and exits.
  • It similarly ensures that tryboot.txt is present before proceeding.
  • It validates that the rcauc.slot value extracted from cmdline-tryboot.txt matches the expected slot, which prevents state mismatches.

These additions greatly enhance error handling and the robustness of the state commitment process.

Consider refactoring the nested conditions to reduce complexity and improve readability—possibly by combining file checks into a compound conditional.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8531e7b and 825b516.

📒 Files selected for processing (1)
  • buildroot-external/board/raspberrypi/rpi5-64/rootfs-overlay/usr/lib/rauc/rpi-tryboot.sh (3 hunks)
🔇 Additional comments (2)
buildroot-external/board/raspberrypi/rpi5-64/rootfs-overlay/usr/lib/rauc/rpi-tryboot.sh (2)

76-80: Early Exit for Non-"good" State.

The check on these lines ensures that if the state being set is not "good", then the script immediately removes the .good file and exits. This early exit supports idempotency by preventing further unintended modifications.


115-117: Conditional Creation of the .good File.

This final segment creates the .good file only when new_state is exactly "good", which is consistent with the intended behavior of marking a successful tryboot state. This ensures that the file is only created after all the preceding checks have passed and the intended state is confirmed.

Copy link
Member

@agners agners left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sairon sairon merged commit 56e3a37 into dev Feb 24, 2025
3 checks passed
@sairon sairon deleted the rpi5-tryboot-fix-set-state branch February 24, 2025 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants