Skip to content

Feat/sanjog/sso flag#116

Merged
sarosejoshi merged 5 commits intodevelopfrom
feat/sanjog/sso-flag
Jul 8, 2025
Merged

Feat/sanjog/sso flag#116
sarosejoshi merged 5 commits intodevelopfrom
feat/sanjog/sso-flag

Conversation

@sanjog-lama
Copy link
Contributor

@sanjog-lama sanjog-lama commented Jul 8, 2025

Description

  • Added name, start url and region flag on sso setup command
  • Made changes to the respective test file to match with the flag changes
  • removed the sso setup trigger for sso init command when there are no any profiles found
  • Changed readme and command md files with the flag changes for sso setup command

Summary by CodeRabbit

  • New Features

    • Enhanced the awsctl sso setup command to support non-interactive setup using --name, --start-url, and --region flags, with input validation for each.
    • Expanded and clarified documentation for SSO setup, including detailed usage, flag descriptions, examples, and validation rules.
  • Bug Fixes

    • Improved validation and error handling for SSO setup inputs, ensuring proper format and constraints.
  • Documentation

    • Updated and restructured command documentation and README for greater clarity and completeness.
  • Tests

    • Significantly expanded test coverage for SSO setup, including validation and argument parsing scenarios.
  • Refactor

    • Promoted several internal methods and variables to public scope for improved modularity and testability.
    • Standardized method and function naming conventions for consistency.

@sanjog-lama sanjog-lama requested a review from sarosejoshi July 8, 2025 10:23
@coderabbitai
Copy link

coderabbitai bot commented Jul 8, 2025

Walkthrough

This update introduces new command-line flags (--name, --start-url, --region) for the awsctl sso setup command, enabling both interactive and non-interactive setup modes. The codebase was refactored to support these flags, with expanded validation logic, updated method signatures, and improved documentation and tests. Several internal methods were made public, and new validation utilities were added.

Changes

File(s) Change Summary
README.md, docs/usage/commands.md Expanded documentation for awsctl sso setup, adding detailed flag descriptions, usage examples, and validation rules.
cmd/sso/setup.go, cmd/sso/setup_test.go Added/validated --name, --start-url, --region flags; updated tests for flag handling and validation.
internal/sso/client.go, internal/sso/interface.go Added SSOFlagOptions struct; updated SetupSSO interface and implementation to accept options; exported some methods.
internal/sso/sso.go Refactored SetupSSO to accept options; updated internal calls to exported method names; changed missing-profile behavior in InitSSO.
internal/sso/session.go, internal/sso/profile.go Refactored session/profile logic to accept explicit parameters; exported several methods for broader use.
internal/sso/utils.go, internal/sso/prompter.go Exported validation and utility functions; updated references to use exported names.
utils/general/general.go Added IsValidSessionName for session name validation using a new regex.
tests/mock/sso/sso.go Updated mock SetupSSO method to accept options struct.
*_test.go (various internal/sso test files) Changed test package to sso_test; updated all references to exported methods and types; no logic changes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant SSOClient
    participant Config

    User->>CLI: awsctl sso setup [--name --start-url --region]
    CLI->>CLI: Parse & validate flags
    CLI->>SSOClient: SetupSSO(SSOFlagOptions)
    alt All flags provided (non-interactive)
        SSOClient->>Config: Create session with provided options
    else Interactive mode
        SSOClient->>User: Prompt for missing options
        User->>SSOClient: Provide input
        SSOClient->>Config: Create session with user input
    end
    SSOClient->>CLI: Return setup result
    CLI->>User: Output success or error
Loading

Poem

🐇
Flags unfurl, a session’s born,
With names and URLs neatly sworn.
Regions checked and prompts refined,
Now setup’s swift—no lag behind!
Docs and tests all hop in line,
This bunny’s code is looking fine.
— Happy hopping!


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fde19c3 and 8b2144e.

📒 Files selected for processing (2)
  • .github/workflows/releaser-internal.yaml (1 hunks)
  • .goreleaser-internal.yaml (0 hunks)
💤 Files with no reviewable changes (1)
  • .goreleaser-internal.yaml

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 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? Join our Discord community 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 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.

@sarosejoshi sarosejoshi merged commit dadf984 into develop Jul 8, 2025
1 check passed
@sanjog-lama sanjog-lama deleted the feat/sanjog/sso-flag branch July 8, 2025 10:39
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