Implement Kopia core flag handling data structures and flag testing suite #2649
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change Overview
This PR is the first in the series of PRs that will add a new way to build Kopia CLI commands.
The functionality of this PR provides the foundation for subsequent PRs and introduces a implementation of Kopia parameters handling in the CLI using the safecli package.
The Kopia flags can be represented in three ways:
/restore/dir
or01234566789abcdef
.--flag=value
, where the value can be a sensitive field for log output.--readonly
, where the flag is present without any value.To support this behavior, this PR introduces two primary data structures:
pkg/kopia/cli/internal/flag/stringFlag
andpkg/kopia/cli/internal/flag/boolFlag
structs provide a structured approach to managing flags, encapsulating their properties and behaviors.stringFlag
ensures that sensitive information is managed safely.Functions such as
pkg/kopia/cli/internal/flag/NewStringFlag
,pkg/kopia/cli/internal/flag/NewBoolFlag
, etc will be utilized in upcoming PRs for creating Kopia CLI commands.pkg/kopia/cli/internal/flag/test/FlagTest
struct and related methods provide a framework for defining and executing flag tests (seepkg/kopia/cli/internal/flag/flag_test.go
).pkg/kopia/cli/errors.go
will serve as a centralized location for error definitions.Looking forward for any feedback/suggestions!
Pull request type
Please check the type of change your PR introduces:
Test Plan