add pager to atmos describe stack command by samtholiya · Pull Request #1265 · cloudposse/atmos

samtholiya · 2025-05-22T20:17:55Z

what

we adding pager capability to atmos describe stack command.

why

This will give users a better view of the content.

references

DEV-3221

Summary by CodeRabbit

Refactor
- Improved the structure and modularity of the "describe stacks" command, separating command-line parsing, validation, and execution logic for better maintainability.
- Introduced clearer error handling and validation for command options.
- Enhanced internal interfaces to support more flexible testing and execution.
- Renamed and clarified flag handling functions for affected commands.
Tests
- Added comprehensive unit tests for the "describe stacks" command and its argument parsing.
- Updated and improved test coverage for command execution logic.
- Introduced mocks for execution interfaces to facilitate testing.

…-config-command

…mand' of https://github.com/cloudposse/atmos into feature/dev-3131-add-pager-to-atmos-describe-config-command

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

…-config-command

…mand' of https://github.com/cloudposse/atmos into feature/dev-3131-add-pager-to-atmos-describe-config-command

…-config-command

…and' of https://github.com/cloudposse/atmos into feature/dev-3221-add-pager-to-atmos-describe-stack-command

mergify · 2025-06-03T19:59:53Z

💥 This pull request now has conflicts. Could you fix it @samtholiya? 🙏

…-stack-command

cmd/describe_stacks.go

cmd/describe_stacks_test.go

+			tt.setFlags(fs)
+
+			// Call the function
+			if tt.expectedPanic {


internal/exec/describe_stacks.go

coderabbitai · 2025-06-03T20:06:49Z

📝 Walkthrough

Walkthrough

This update refactors the describe_stacks command to use a new argument struct and execution interface, modularizes CLI flag parsing, and introduces targeted unit tests and mocks. It also renames a flag-parsing function for describe_affected for clarity, with corresponding test updates. No business logic is changed.

Changes

File(s)	Change Summary
`cmd/describe_affected.go`, `cmd/describe_affected_test.go`	Renamed function `setFlagValueInCliArgs` to `setDescribeAffectedFlagValueInCliArgs` and updated test calls accordingly.
`cmd/describe_stacks.go`	Refactored command execution to use dependency-injected runnable, modularized CLI flag parsing into `setCliArgsForDescribeStackCli`, added error handling helper, and updated imports.
`cmd/describe_stacks_test.go`	Added unit tests for the new runnable and CLI argument parsing logic, including error and panic scenarios.
`internal/exec/describe_stacks.go`	Replaced monolithic command function with `DescribeStacksArgs` struct, `DescribeStacksExec` interface, and implementation; removed direct CLI dependency.
`internal/exec/describe_stacks_test.go`	Replaced CLI-based test with direct unit test for the new execution struct using mocks.
`internal/exec/mock_describe_stacks.go`	Added GoMock-generated mock for the `DescribeStacksExec` interface.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant FlagParser
    participant DescribeStacksExec
    participant Output

    User->>CLI: Run "describe stacks" command
    CLI->>FlagParser: Parse CLI flags
    FlagParser->>CLI: Return DescribeStacksArgs
    CLI->>DescribeStacksExec: Execute(args, config)
    DescribeStacksExec->>Output: Render results (with paging/format)
    Output-->>User: Show results

Possibly related PRs

Add process-templates, --process-functions and --skip flags to atmos describe affected, atmos describe component and atmos describe stacks commands #1006: Adds new flags and updates flag handling for describe commands, including describe_affected, which overlaps with this PR's renaming and refactoring of CLI flag parsing logic.

Suggested reviewers

osterman
aknysh

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)

DEV-3221: GraphQL Error (Code: 502) -

<title>502 Server Error</title>

Error: Server Error

The server encountered a temporary error and could not complete your request.
Please try again in 30 seconds.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1f4b159 and 9a76db8.

📒 Files selected for processing (5)

cmd/describe_stacks.go (2 hunks)
cmd/describe_stacks_test.go (1 hunks)
internal/exec/describe_stacks.go (1 hunks)
internal/exec/describe_stacks_test.go (1 hunks)
internal/exec/mock_describe_stacks.go (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

internal/exec/mock_describe_stacks.go
internal/exec/describe_stacks.go

🧰 Additional context used

🧬 Code Graph Analysis (1)

internal/exec/describe_stacks_test.go (3)

pkg/pager/mock_pager.go (1)

NewMockPageCreator (25-29)

pkg/schema/schema.go (1)

AtmosConfiguration (23-57)

internal/exec/describe_stacks.go (1)

DescribeStacksArgs (17-30)

🪛 golangci-lint (1.64.8)

cmd/describe_stacks_test.go

[warning] 108-108: if tt.expectedPanic has complex nested blocks (complexity: 4)

(nestif)

🪛 GitHub Check: golangci-lint

cmd/describe_stacks_test.go

[warning] 108-108:
if tt.expectedPanic has complex nested blocks (complexity: 4)

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: Build (windows-latest, windows)
GitHub Check: Summary

🔇 Additional comments (6)

internal/exec/describe_stacks_test.go (1)

12-30: Clean test refactoring with proper mocking.

The refactored test effectively isolates the execution logic from CLI concerns using well-structured mocks. This approach provides better test coverage of the core functionality without the complexity of command-line parsing.

cmd/describe_stacks_test.go (3)

15-37: Good test coverage for runnable command generation.

The test properly verifies that the mock execution function is called exactly once, ensuring the command wiring works correctly.

39-86: Comprehensive table-driven tests for CLI argument parsing.

The test cases cover various scenarios including flag combinations, defaults, and explicit settings. This provides solid coverage for the argument parsing logic.

127-161: Direct panic testing approach works well.

The separate test case for unsupported flag types effectively validates the error handling without adding complexity to the table-driven tests.

cmd/describe_stacks.go (2)

22-29: Excellent dependency injection approach.

The higher-order function pattern with explicit dependencies makes the command much more testable and modular.

65-69: Good error handling centralization.

The extracted printErrorAndExit function provides consistent error handling across the command execution flow.

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
- 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? Create a ticket on our support page 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 docstrings to generate docstrings for this 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 or @auto-summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @auto-title 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.

…-stack-command

samtholiya and others added 30 commits April 14, 2025 23:21

add pager to describe config command

3abddd4

add model test

2c3c2a2

[autofix.ci] apply automated fixes

180bc51

Merge branch 'main' into feature/dev-3131-add-pager-to-atmos-describe…

0d70b34

…-config-command

update structure

6cdf3a3

Merge branch 'feature/dev-3131-add-pager-to-atmos-describe-config-com…

223fe38

…mand' of https://github.com/cloudposse/atmos into feature/dev-3131-add-pager-to-atmos-describe-config-command

update with unit test cases

0e28d7d

[autofix.ci] apply automated fixes

2b5d34d

remove unwanted interface

1981bbe

Merge branch 'feature/dev-3131-add-pager-to-atmos-describe-config-com…

c035f9f

…mand' of https://github.com/cloudposse/atmos into feature/dev-3131-add-pager-to-atmos-describe-config-command

fix tests

474d45e

updated describe config

7de12fb

implement status with help

44cbfa9

[autofix.ci] apply automated fixes

7b9c10e

error view added

9b03310

Merge branch 'feature/dev-3131-add-pager-to-atmos-describe-config-com…

57c7cac

…mand' of https://github.com/cloudposse/atmos into feature/dev-3131-add-pager-to-atmos-describe-config-command

Update pkg/pager/model.go

67a37cf

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Merge branch 'main' into feature/dev-3131-add-pager-to-atmos-describe…

00f5920

…-config-command

fix tests

9639a6e

Merge branch 'feature/dev-3131-add-pager-to-atmos-describe-config-com…

5c4c67c

…mand' of https://github.com/cloudposse/atmos into feature/dev-3131-add-pager-to-atmos-describe-config-command

fix lint

94c247b

fix golangci-lint

f7be563

updated pager variable

af69dc6

fix tests

b101302

fixed test cases

a2ab7b3

Merge branch 'main' into feature/dev-3131-add-pager-to-atmos-describe…

4b01ade

…-config-command

update the pager variable logic

d20c96a

updated the pager logic

8a84f67

updated test case

dcccd4a

fix pager bool

5ef05c5

samtholiya added 2 commits May 29, 2025 23:59

Merge branch 'feature/dev-3221-add-pager-to-atmos-describe-stack-comm…

5f873e7

…and' of https://github.com/cloudposse/atmos into feature/dev-3221-add-pager-to-atmos-describe-stack-command

update describe stacks test

0485934

Base automatically changed from feature/dev-3182-add-pager-to-atmos-describe-affected-command to main June 3, 2025 19:59

mergify bot removed the stacked label Jun 3, 2025

mergify bot added the conflict This PR has conflicts label Jun 3, 2025

Merge branch 'main' into feature/dev-3221-add-pager-to-atmos-describe…

07f9552

…-stack-command

github-actions bot added the size/l label Jun 3, 2025

mergify bot removed the conflict This PR has conflicts label Jun 3, 2025

[autofix.ci] apply automated fixes

1f4b159

samtholiya added the minor New features that do not break anything label Jun 3, 2025

github-advanced-security bot found potential problems Jun 3, 2025

View reviewed changes

coderabbitai bot previously approved these changes Jun 3, 2025

View reviewed changes

mergify bot removed the triage Needs triage label Jun 3, 2025

samtholiya dismissed coderabbitai[bot]’s stale review via 49850ea June 3, 2025 20:31

fix lint

50daec2

samtholiya force-pushed the feature/dev-3221-add-pager-to-atmos-describe-stack-command branch from c67e305 to 50daec2 Compare June 3, 2025 20:34

[autofix.ci] apply automated fixes

9a76db8

coderabbitai bot approved these changes Jun 3, 2025

View reviewed changes

Benbentwo approved these changes Jun 4, 2025

View reviewed changes

Merge branch 'main' into feature/dev-3221-add-pager-to-atmos-describe…

7d83f2a

…-stack-command

Benbentwo merged commit 8957ff6 into main Jun 5, 2025
82 of 83 checks passed

Benbentwo deleted the feature/dev-3221-add-pager-to-atmos-describe-stack-command branch June 5, 2025 17:08

This was referenced Jun 7, 2025

add pager to describe workflow #1266

Merged

bugfix: Pager not working on describe workflows #1293

Closed

coderabbitai bot mentioned this pull request Jun 19, 2025

update help with pager #1276

Merged

coderabbitai bot mentioned this pull request Sep 1, 2025

[describe-stacks] Fix: switch --component-types to StringSlice to match []string and support multi-values #1432

Merged

coderabbitai bot mentioned this pull request Sep 23, 2025

fix: disable pager mouse interactions and add global --pager flag #1430

Merged

6 tasks

coderabbitai bot mentioned this pull request Oct 3, 2025

Add --provenance flag to atmos describe component #1584

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

add pager to atmos describe stack command#1265

add pager to atmos describe stack command#1265
Benbentwo merged 143 commits intomainfrom
feature/dev-3221-add-pager-to-atmos-describe-stack-command

samtholiya commented May 22, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

mergify bot commented Jun 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check warning

Uh oh!

Uh oh!

coderabbitai bot commented Jun 3, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested reviewers

Review ran into problems

Error: Server Error

The server encountered a temporary error and could not complete your request.
Please try again in 30 seconds.

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

samtholiya commented May 22, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

what

why

references

Summary by CodeRabbit

Uh oh!

mergify bot commented Jun 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check warning

Uh oh!

Uh oh!

coderabbitai bot commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested reviewers

Review ran into problems

Error: Server Error

The server encountered a temporary error and could not complete your request.Please try again in 30 seconds.

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

samtholiya commented May 22, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 3, 2025 •

edited

Loading

The server encountered a temporary error and could not complete your request.
Please try again in 30 seconds.