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

Encapsulate debug flag handling #5390

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

twz123
Copy link
Member

@twz123 twz123 commented Dec 24, 2024

Description

Introduce internal.DebugFlags to replace debug and verbose logging flag handling. Move the flag definitions from the "PersistentFlagSet" to a struct method. Remove the debug flag handling from the root command and move it to the sub-commands. This allows for the removal of CallPersistentPreRun, since the commands no longer rely on proper chaining of the PersistentPreRun hooks. Remove some redundant calls to the "PersistentFlagSet" in some sub-commands.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Manual test
  • Auto test added

Checklist:

  • My code follows the style guidelines of this project
  • My commit messages are signed-off
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

Copy link
Contributor

This pull request has merge conflicts that need to be resolved.

@twz123 twz123 force-pushed the encapsulate-debug-flags branch from e90aef1 to f7d165f Compare December 24, 2024 13:35
@twz123 twz123 force-pushed the encapsulate-debug-flags branch from f7d165f to e51ffd1 Compare December 24, 2024 13:54
@twz123 twz123 marked this pull request as ready for review December 24, 2024 14:28
@twz123 twz123 requested review from a team as code owners December 24, 2024 14:28
@twz123 twz123 requested review from ncopa and jnummelin December 24, 2024 14:28
Copy link
Contributor

github-actions bot commented Jan 7, 2025

This pull request has merge conflicts that need to be resolved.

@twz123 twz123 force-pushed the encapsulate-debug-flags branch from e51ffd1 to b5c9e56 Compare January 7, 2025 14:42
@twz123 twz123 force-pushed the encapsulate-debug-flags branch from b5c9e56 to f5c848e Compare January 7, 2025 16:06
Copy link
Contributor

github-actions bot commented Jan 8, 2025

This pull request has merge conflicts that need to be resolved.

Copy link
Contributor

github-actions bot commented Jan 9, 2025

This pull request has merge conflicts that need to be resolved.

twz123 added 2 commits January 9, 2025 11:40
Relative paths are automatically resolved based on the current working
directory. No need to do this manually.

Signed-off-by: Tom Wieczorek <twieczorek@mirantis.com>
These flags are used for shared functionality based on Cobra's
"persistent" functions. In k0s, however, the distinction was never that
clear. Persistent flags were mostly used by accident, sometimes to share
flag definitions between subcommands, even if the persistent functions
didn't use those flags.

Identify most (all?) of these cases and use flags instead of persistent
flags. Deprecate and hide the unused persistent flags, so that they can
eventually be removed.

Signed-off-by: Tom Wieczorek <twieczorek@mirantis.com>
@twz123 twz123 marked this pull request as draft January 9, 2025 11:41
twz123 added 2 commits January 9, 2025 12:41
Introduce internal.DebugFlags to replace debug and verbose logging
flag handling. Move the flag definitions from the "PersistentFlagSet"
to a struct method. Remove the debug flag handling from the root
command and move it to the subcommands. This allows for the removal
of CallPersistentPreRun, since the commands no longer rely on proper
chaining of the PersistentPreRun hooks.

Signed-off-by: Tom Wieczorek <twieczorek@mirantis.com>
@twz123 twz123 force-pushed the encapsulate-debug-flags branch from aeefa47 to 104340e Compare January 9, 2025 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant