feat: application watch opts

[pasha-codefresh]

User description

Checklist:

• Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
• The title of the PR states what changed and the related issues number (used for the release note).
• The title of the PR conforms to the Toolchain Guide
• I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
• I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
• Does this PR require documentation updates?
• I've updated documentation as required by this PR.
• I have signed off all my commits as required by DCO
• I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
• My build is green (troubleshooting builds).
• My new feature complies with the feature status guidelines.
• I have added a brief description of why this PR is necessary and/or what this PR solves.
• Optional. My organization is added to USERS.md.
• Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

---

Type

enhancement

---

Description

• Introduced a new struct watchOpts to consolidate watch options for applications, enhancing code readability and maintainability.
• Modified existing functions to utilize the new watchOpts struct, reducing the complexity of function signatures.
• Added unit tests to ensure the correct behavior of default and overridden watch options.

---

Changes walkthrough

	Relevant files
Enhancement	app.go Refactor Application Watch Options into Struct                      cmd/argocd/commands/app.go Introduced watchOpts struct to consolidate watch options. Modified NewApplicationWaitCommand to use watchOpts instead of individual flags. Added getWatchOpts function to set default watch options when none are specified. Updated waitOnApplicationStatus and checkResourceStatus functions to utilize watchOpts. +45/-32
Tests	app_test.go Add Tests for Application Watch Options Refactoring            cmd/argocd/commands/app_test.go Added tests for default and overridden watch options using watchOpts. +30/-0

---

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-pro]

PR-Agent was enabled for this repository. To use it, please link your git user with your CodiumAI identity here.

PR Description updated to latest commit (c312ef3)

• Copy walkthrough table to "Files Changed" Tab

[pasha-codefresh]

/review

[codiumai-pr-agent-pro]

PR-Agent was enabled for this repository. To use it, please link your git user with your CodiumAI identity here.

PR Review

⏱️ Estimated effort to review [1-5]	2, because the changes are mostly focused on refactoring the way application watch options are handled, introducing a new structure to encapsulate these options and modifying the corresponding functions to use this new structure. The logic changes are straightforward and localized, making the review process relatively easy. However, understanding the context and testing the changes thoroughly would require some effort.
🧪 Relevant tests	Yes
🔍 Possible issues	Possible Bug: The getWatchOpts function assumes default values for watch options when none are provided. This behavior is correct as per the current implementation, but any future changes to the default behavior of watch options need to reflect in this function as well, which could be easily overlooked.
	Consistency Issue: The introduction of the watchOpts struct for encapsulating watch options is a good practice. However, it's important to ensure that all parts of the codebase that deal with watch options are updated to use this new structure for consistency.
🔒 Security concerns	No

---

✨ Review tool usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

• When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

• With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

See the review usage page for a comprehensive guide on using this tool.

[codiumai-pr-agent-pro]

PR Code Suggestions

Category	Suggestions
Enhancement	Add a method to check if watchOpts is in its default state. Consider adding a method to the watchOpts struct to check if it is in its default state. This method can improve readability and encapsulate the state check logic within the watchOpts struct itself. cmd/argocd/commands/app.go [1228] -if (watch == watchOpts{}) { +if watch.isDefault() {
	Add JSON tags to the watchOpts struct fields. To ensure that the watchOpts struct can be easily extended in the future, consider adding JSON tags to its fields. This will make it easier to serialize/deserialize the struct, which can be useful for logging, configuration, or interfacing with APIs. cmd/argocd/commands/app.go [102-107] type watchOpts struct { - sync bool - health bool - operation bool - suspended bool + Sync bool `json:"sync"` + Health bool `json:"health"` + Operation bool `json:"operation"` + Suspended bool `json:"suspended"` }
Best practice	Use constants for health and sync status strings. To improve code maintainability, consider using constants for the health and sync status strings used in comparisons. This approach can help avoid typos and make it easier to update these values in the future. cmd/argocd/commands/app.go [1655-1656] -healthCheckPassed = healthStatus == string(health.HealthStatusHealthy) || -healthStatus == string(health.HealthStatusSuspended) +const ( + HealthStatusHealthy = string(health.HealthStatusHealthy) + HealthStatusSuspended = string(health.HealthStatusSuspended) +) +healthCheckPassed = healthStatus == HealthStatusHealthy || healthStatus == HealthStatusSuspended
	Define a constant for the default timeout value. For better code readability and to avoid magic values, consider defining a constant for the default timeout value used in waitOnApplicationStatus. This makes it easier to understand and change the default value in the future. cmd/argocd/commands/app.go [1287] -command.Flags().UintVar(&timeout, "timeout", defaultCheckTimeoutSeconds, "Time out after this many seconds") +const defaultTimeoutSeconds = defaultCheckTimeoutSeconds +command.Flags().UintVar(&timeout, "timeout", defaultTimeoutSeconds, "Time out after this many seconds")
Possible issue	Use a reliable method to check if operationStatus is nil. To avoid potential issues with pointer comparison, consider using a more reliable method to check if the operationStatus is nil in checkResourceStatus. For example, you could check if the pointer is not nil before accessing its fields or use a dedicated method for this purpose. cmd/argocd/commands/app.go [1664] -operational := !watch.operation || operationStatus == nil +operational := !watch.operation || (operationStatus != nil && operationStatus.IsNil())

---

✨ Improve tool usage guide:

---

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

• When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

• With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

See the improve usage page for a comprehensive guide on using this tool.

[codiumai-pr-agent-pro]

PR-Agent was enabled for this repository. To use it, please link your git user with your CodiumAI identity here.

PR Review

⏱️ Estimated effort to review [1-5]	3, because the PR introduces a new structure for handling watch options in the application wait command, which involves changes across multiple functions and files. Understanding the impact of these changes on the existing logic and ensuring that all scenarios are covered requires a moderate level of effort.
🧪 Relevant tests	Yes
🔍 Possible issues	Possible Bug: The getWatchOpts function assumes that if all fields in the watchOpts struct are false, it should enable all options except suspended. This might not be the intended behavior in all cases, especially if the user explicitly sets all options to false.
🔒 Security concerns	No

Code feedback:

---

relevant file	cmd/argocd/commands/app.go
suggestion	Consider validating user input for the watchOpts struct to handle cases where users might explicitly set all options to false. This could involve adding a new flag to indicate that the user has provided specific watch options, thereby preventing the automatic enabling of all options except suspended. [important]
relevant line	if (watch == watchOpts{}) {

---

relevant file	cmd/argocd/commands/app.go
suggestion	To improve code readability and maintainability, consider extracting the logic for setting default watch options into a separate method or function. This could help in clearly separating the concerns and making the codebase more modular. [medium]
relevant line	if (watch == watchOpts{}) {

---

relevant file	cmd/argocd/commands/app.go
suggestion	For better code clarity and to avoid potential bugs, explicitly check for the presence of command-line flags to determine if the user has set any watch options, rather than inferring from the default struct values. This approach would make the behavior more predictable and easier to understand. [important]
relevant line	if (watch == watchOpts{}) {

---

relevant file	cmd/argocd/commands/app_test.go
suggestion	Add more comprehensive tests covering various combinations of watch options, including cases where users might explicitly set all options to false. This would ensure the robustness of the getWatchOpts function and prevent potential bugs. [important]
relevant line	func TestDefaultWaitOptions(t *testing.T) {

---

---

✨ Review tool usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

• When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

• With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

See the review usage page for a comprehensive guide on using this tool.

[pasha-codefresh]

/describe

[codiumai-pr-agent-pro]

PR-Agent was enabled for this repository, but no eligible user found. Please link your git user with your CodiumAI identity here.

[pasha-codefresh]

/improve

[codiumai-pr-agent-pro]

PR-Agent was enabled for this repository, but no eligible user found. Please link your git user with your CodiumAI identity here.

[pasha-codefresh]

/describe

[codiumai-pr-agent-pro]

PR Description updated to latest commit (c312ef3)

• Copy walkthrough table to "Files Changed" Tab

[pasha-codefresh]

/improve

[codiumai-pr-agent-pro]

PR Code Suggestions

Category	Suggestions
Enhancement	Add a String() method to the watchOpts struct for better debugging and logging. Consider adding a String() method to the watchOpts struct to improve debugging and logging capabilities. This method should return a string representation of the current state of the watchOpts instance, including the values of sync, health, operation, and suspended fields. cmd/argocd/commands/app.go [102-107] type watchOpts struct { sync bool health bool operation bool suspended bool } +func (w watchOpts) String() string { + return fmt.Sprintf("sync: %t, health: %t, operation: %t, suspended: %t", w.sync, w.health, w.operation, w.suspended) +} +
	Implement a method to efficiently check if watchOpts is empty. To ensure that the watchOpts struct can be easily compared with other instances or checked for emptiness, consider implementing a custom equality method or using a more efficient way to check for an empty struct instance in the getWatchOpts function. cmd/argocd/commands/app.go [1228] -if (watch == watchOpts{}) { +if watch.isEmpty() { +} +// Implement isEmpty method for watchOpts +func (w watchOpts) isEmpty() bool { + return !w.sync && !w.health && !w.operation && !w.suspended +} +
	Add a method to merge two watchOpts instances for enhanced flexibility. To ensure the flexibility and extensibility of the watchOpts struct, consider adding a method to merge two watchOpts instances. This method would be useful in scenarios where you want to combine the watch options from different sources or defaults with user-specified options. cmd/argocd/commands/app.go [102-107] type watchOpts struct { sync bool health bool operation bool suspended bool } +// Merge merges another watchOpts into this one, prioritizing the other instance's values +func (w *watchOpts) Merge(other watchOpts) { + if other.sync { + w.sync = true + } + if other.health { + w.health = true + } + if other.operation { + w.operation = true + } + if other.suspended { + w.suspended = true + } +} +
Maintainability	Extract health status check logic into a separate method for clarity. For better code readability and maintainability, consider extracting the logic that checks the health status in checkResourceStatus into a separate method. This will make the code cleaner and easier to understand. cmd/argocd/commands/app.go [1654-1660] -if watch.suspended && watch.health { - healthCheckPassed = healthStatus == string(health.HealthStatusHealthy) || - healthStatus == string(health.HealthStatusSuspended) -} else if watch.suspended { - healthCheckPassed = healthStatus == string(health.HealthStatusSuspended) -} else if watch.health { - healthCheckPassed = healthStatus == string(health.HealthStatusHealthy) +healthCheckPassed = checkHealthStatus(watch, healthStatus) + +// New method to encapsulate health status logic +func checkHealthStatus(watch watchOpts, healthStatus string) bool { + if watch.suspended && watch.health { + return healthStatus == string(health.HealthStatusHealthy) || + healthStatus == string(health.HealthStatusSuspended) + } else if watch.suspended { + return healthStatus == string(health.HealthStatusSuspended) + } else if watch.health { + return healthStatus == string(health.HealthStatusHealthy) + } + return false }
	Use more descriptive variable names for instances of watchOpts. To improve the maintainability and readability of the code, consider using a more descriptive variable name than watch for instances of watchOpts. A more descriptive name can help clarify the purpose and usage of the variable throughout the code. cmd/argocd/commands/app.go [1226] -func getWatchOpts(watch watchOpts) watchOpts { +func getWatchOpts(opts watchOpts) watchOpts {

---

✨ Improve tool usage guide:

---

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

• When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

• With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

See the improve usage page for a comprehensive guide on using this tool.

[pasha-codefresh]

/ask what this pr is solving ?

[codiumai-pr-agent-pro]

Question: what this pr is solving ?

Answer:
This Pull Request introduces a new struct watchOpts that consolidates the different watch options (sync, health, operation, suspended) into a single entity. This struct is then used to refactor the existing code, making it more readable and maintainable.

The PR also introduces a new function getWatchOpts(watch watchOpts) watchOpts which sets default values for the watch options if none are provided by the user. By default, it sets sync, health, and operation to true, and suspended to false.

This PR is solving the problem of handling multiple watch options in a more structured and efficient way. It improves the code quality by reducing redundancy and enhancing readability.

---

✨ Ask tool usage guide:

---

Overview:
The ask tool answers questions about the PR, based on the PR code changes.
It can be invoked manually by commenting on any PR:

/ask "..."

Note that the tool does not have "memory" of previous questions, and answers each question independently.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the ask usage page for a comprehensive guide on using this tool.