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

Check nsAccountLock attribute for user status #89

Merged
merged 3 commits into from
Feb 20, 2025

Conversation

griveralfie
Copy link
Contributor

@griveralfie griveralfie commented Feb 20, 2025

This collects the nsAccountLock attribute, which is used by FreeIPA and Red Hat Identity to indicate whether an account is disabled
https://docs.redhat.com/en/documentation/red_hat_directory_server/11/html/administration_guide/user_account_management-inactivating_users_and_roles

The userStatus value will be updated accordingly

Summary by CodeRabbit

  • New Features
    • Improved user account status determination by incorporating evaluation logic for an additional account lock attribute now supported for FreeIPA environments. This enhancement ensures that users’ account states are more accurately identified as enabled or disabled.

Copy link

coderabbitai bot commented Feb 20, 2025

Walkthrough

The pull request introduces a new constant, attrNSAccountLock, to the connector logic for FreeIPA. The parseUserStatus function is modified to evaluate the nsAccountLockFlag, setting user status to STATUS_ENABLED when the flag is "false" and STATUS_DISABLED when "true." Comments are updated to indicate support for both Microsoft’s UserAccountControlFlag and FreeIPA’s nsAccountLock. The overall structure of the user resource functionality remains unchanged, ensuring compatibility while enhancing the user status evaluation process.

Changes

File(s) Change Summary
pkg/connector/user.go Added FreeIPA constant attrNSAccountLock; updated comment to reflect support for FreeIPA user status parsing; modified parseUserStatus to handle nsAccountLockFlag.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Client Code
    participant Parser as parseUserStatus
    Client->>Parser: Invoke parseUserStatus with flags (Microsoft & FreeIPA)
    alt nsAccountLockFlag present
        Parser->>Parser: Evaluate nsAccountLockFlag
        Note right of Parser: "false" => STATUS_ENABLED<br>"true"  => STATUS_DISABLED
    else
        Parser->>Parser: Evaluate UserAccountControlFlag
    end
    Parser-->>Client: Return user status
Loading

Poem

Oh, hop to the code, my friend so dear,
A new constant for FreeIPA is here!
With flags that flip, like a soft, sweet tune,
User status now dances under the moon.
I nibble bugs away with glee 🐰✨,
Celebrating changes, quick as can be!


📜 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 e9f8733 and 651a73c.

📒 Files selected for processing (1)
  • pkg/connector/user.go (3 hunks)
🔇 Additional comments (2)
pkg/connector/user.go (2)

44-45: LGTM! Well-organized constant declaration.

The new constant follows the existing naming convention and is properly grouped under a clear comment section for FreeIPA specific attributes.


81-81: LGTM! Clear and accurate documentation.

The comment clearly documents both supported attributes for user status determination.

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

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)
pkg/connector/user.go (1)

83-83: Enhance error handling and readability of FreeIPA status parsing.

While the basic logic is correct, consider these improvements:

  1. Add error handling for unexpected nsAccountLock values.
  2. Simplify the if-else structure for better readability.

Consider this refactor:

 nsAccountLockFlag := user.GetEqualFoldAttributeValue(attrNSAccountLock)

 if userAccountControlFlag != "" {
   // ... existing Microsoft logic ...
 } else if nsAccountLockFlag != "" {
+  // Handle FreeIPA's nsAccountLock attribute
+  switch strings.ToLower(nsAccountLockFlag) {
+  case "false":
     userStatus = v2.UserTrait_Status_STATUS_ENABLED
-  } else if nsAccountLockFlag == "true" {
+  case "true":
     userStatus = v2.UserTrait_Status_STATUS_DISABLED
+  default:
+    return userStatus, fmt.Errorf("unexpected nsAccountLock value: %s", nsAccountLockFlag)
+  }
 }

Also applies to: 98-102

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8641e7f and c464783.

📒 Files selected for processing (1)
  • pkg/connector/user.go (3 hunks)
🔇 Additional comments (2)
pkg/connector/user.go (2)

44-45: LGTM! Clear and well-documented constant declaration.

The constant follows the established naming convention and is appropriately documented as a FreeIPA-specific attribute.


81-81: LGTM! Clear documentation of supported status attributes.

The comment effectively communicates that both Microsoft's UserAccountControlFlag and FreeIPA's nsAccountLock are now supported for determining user status.

Copy link
Contributor

@ggreer ggreer left a comment

Choose a reason for hiding this comment

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

LGTM, though it'd be nice to handle different casing of the nsAccountLockFlag value. It looks like some implementations use "TRUE" and "FALSE", and maybe even "True" and "False"

Co-authored-by: Geoff Greer <geoff@greer.fm>
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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c464783 and e9f8733.

📒 Files selected for processing (1)
  • pkg/connector/user.go (3 hunks)
🧰 Additional context used
🪛 golangci-lint (1.62.2)
pkg/connector/user.go

107-107: expected ';', found 'else'

(typecheck)

🔇 Additional comments (2)
pkg/connector/user.go (2)

44-45: LGTM!

The new constant follows the existing naming convention and is well-documented.


81-83: LGTM!

The updated comment clearly documents both Microsoft and FreeIPA attribute support.

@griveralfie
Copy link
Contributor Author

LGTM, though it'd be nice to handle different casing of the nsAccountLockFlag value. It looks like some implementations use "TRUE" and "FALSE", and maybe even "True" and "False"

Yeah that looks better! I've added this

@ggreer ggreer merged commit 416135b into ConductorOne:main Feb 20, 2025
2 of 3 checks passed
@griveralfie griveralfie deleted the nsaccountlock branch February 24, 2025 12:46
@griveralfie griveralfie restored the nsaccountlock branch February 24, 2025 12:46
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.

2 participants