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: data lost caused by Longhorn CSI plugin doing a wrong re-encryption of volume in rare race condition #106

Merged
merged 2 commits into from
Feb 14, 2025

Conversation

PhanLe1010
Copy link
Contributor

@PhanLe1010 PhanLe1010 commented Feb 14, 2025

This PR must be merged before the PR longhorn/longhorn-manager#3566

longhorn/longhorn#10416

…ion of volume in rare race condition

see more details at
longhorn/longhorn-manager#3566

longhorn-10416

Signed-off-by: Phan Le <phan.le@suse.com>
@PhanLe1010 PhanLe1010 requested a review from derekbit February 14, 2025 05:16
Copy link

coderabbitai bot commented Feb 14, 2025

Walkthrough

The change introduces a new method IsLuks in the Executor struct within the ns/crypto.go file. This method checks if a given device is encrypted using LUKS by constructing and executing the cryptsetup isLuks command through the existing Cryptsetup method. It evaluates the command’s execution result—returning true when successful, false when the exit code is 1, or false with an error for other issues. Additionally, the change imports the os/exec and github.com/pkg/errors packages for command execution and error management.

Changes

File Path Change Summary
ns/crypto.go Added IsLuks method to the Executor struct that constructs and executes the cryptsetup isLuks command, handling different error cases.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant E as Executor
    participant C as Cryptsetup
    participant OS as OS/Exec

    U->>E: Call IsLuks(devicePath, timeout)
    E->>C: Execute "cryptsetup isLuks" with constructed args
    C->>OS: Run the command
    OS-->>C: Return exit code and error information
    C-->>E: Return result based on execution (success, exit code 1, or error)
    E-->>U: Return true if successful, false for exit code 1, or error for other issues
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 anywhere in the PR title to generate the title automatically.

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.

@PhanLe1010 PhanLe1010 requested a review from innobead February 14, 2025 05:16
Copy link

codecov bot commented Feb 14, 2025

Codecov Report

Attention: Patch coverage is 0% with 14 lines in your changes missing coverage. Please review.

Project coverage is 76.73%. Comparing base (5fafd2e) to head (09ea3c8).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
ns/crypto.go 0.00% 14 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #106      +/-   ##
==========================================
- Coverage   77.25%   76.73%   -0.52%     
==========================================
  Files          37       37              
  Lines        2071     2085      +14     
==========================================
  Hits         1600     1600              
- Misses        342      356      +14     
  Partials      129      129              
Flag Coverage Δ
unittests 76.73% <0.00%> (-0.52%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Longhorn 10416

Signed-off-by: Derek Su <derek.su@suse.com>
@derekbit derekbit requested a review from c3y1huang February 14, 2025 06:58
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)
ns/crypto.go (1)

54-69: LGTM! Implementation is secure and well-documented.

The implementation correctly uses namespace-isolated execution and includes proper error handling with documentation references. The timeout parameter helps prevent hanging, making it robust for production use.

Consider adding parameter validation.

To make the method more robust, consider adding validation for the input parameters:

 func (nsexec *Executor) IsLuks(devicePath string, timeout time.Duration) (bool, error) {
+	if devicePath == "" {
+		return false, errors.New("device path cannot be empty")
+	}
+	if timeout <= 0 {
+		return false, errors.New("timeout must be positive")
+	}
 	args := []string{"isLuks", devicePath}
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8380661 and 09ea3c8.

📒 Files selected for processing (1)
  • ns/crypto.go (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Build binaries

@derekbit derekbit merged commit c86a06c into longhorn:main Feb 14, 2025
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants