Use correct return type from enrollment

[jschlyter]

Summary by CodeRabbit

• New Features

  • Updated enrollment process to return a more comprehensive enrollment result
  • Enhanced data handling during node enrollment

• Refactor

  • Modified return types for enrollment-related functions to provide more detailed information

[coderabbitai]

Walkthrough

The pull request modifies the enrollment process in the nodeman/client.py module by introducing a new NodeEnrollmentResult type. This change updates the return type of the enroll and command_enroll functions from NodeConfiguration to NodeEnrollmentResult. The modification suggests a more comprehensive approach to capturing enrollment data, potentially including additional information beyond the previous configuration structure.

Changes

File	Change Summary
nodeman/client.py	- Added import for NodeEnrollmentResult from nodeman.models - Updated enroll() function return type and implementation - Modified command_enroll() function to use NodeEnrollmentResult

Sequence Diagram

sequenceDiagram
    participant Client
    participant EnrollmentService
    participant NodeMan
    
    Client->>NodeMan: Initiate enrollment
    NodeMan->>EnrollmentService: Request enrollment
    EnrollmentService-->>NodeMan: Return enrollment result
    NodeMan->>Client: Return NodeEnrollmentResult

Loading

Possibly related PRs

• Send enrollment key as JWK #34: Changes in command_enroll handling of enrollment response structure
• Generic enrollment keys #36: Modifications to NodeBootstrapInformation related to key type handling

Poem

🐰 A Rabbit's Enrollment Tale 🔑

From config to result, a type's new flight,
Enrollment dancing with data so bright
Certificates wrapped in a brand new shell
Our node's journey, now with stories to tell!

Hop hop, code evolves! 🚀

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 37f0ced and d3f0911.

📒 Files selected for processing (1)

• nodeman/client.py (2 hunks)

🔇 Additional comments (2)

nodeman/client.py (2)

17-17: LGTM: Import change aligns with the new return type.

The addition of NodeEnrollmentResult to the imports is consistent with the PR objective.

---

Line range hint 192-192: Fix type mismatch in command_enroll() function.

The function signature declares NodeConfiguration as the return type, but it returns the result from enroll() which is now NodeEnrollmentResult.

Update the function signature to match the actual return type:

-def command_enroll(args: argparse.Namespace) -> NodeConfiguration:
+def command_enroll(args: argparse.Namespace) -> NodeEnrollmentResult:

Verify NodeEnrollmentResult model attributes.

The function uses x509_certificate and x509_ca_certificate attributes from the result. Let's verify these attributes exist in the new model.

Also applies to: 219-219

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

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.