fix(cmd): return error when config add flags are partially provided#3826
fix(cmd): return error when config add flags are partially provided#3826Ankitsinghsisodya wants to merge 2 commits into
Conversation
Added validation to ensure that the --name flag cannot be provided without the --value flag, and vice versa, in both environment and label commands. This prevents the creation of invalid configurations. Added corresponding unit tests to verify the expected error behavior when these flags are misused.
Updated error handling in the label command to use errors.New instead of fmt.Errorf for consistency in flag validation messages. This change improves clarity and maintains uniformity in error reporting when required flags are missing.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: Ankitsinghsisodya The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
knative-prow
Bot
added
size/M
|
Hi @Ankitsinghsisodya. Thanks for your PR. I'm waiting for a knative member to verify that this patch is reasonable to test. If it is, they should reply with Tip We noticed you've done this a few times! Consider joining the org to skip this step and gain Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds validation and tests to prevent config envs/labels add from accepting incomplete flag pairs (e.g., --name without --value) which would otherwise write broken config entries.
Changes:
- Add a regression test ensuring
config envs add --namewithout--valuefails and does not save. - Add regression tests for
config labels addwhen--name/--valueare provided without the other. - Add CLI-side validation for
config labels addwhen flags are incomplete.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| cmd/config_test.go | Adds tests for missing --name/--value combinations and a helper to build the labels command. |
| cmd/config_labels.go | Adds validation intended to require --name and --value together. |
| cmd/config_envs.go | Adds validation to require --value when --name is provided for envs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| if np != nil { | ||
| return errors.New("--value is required when --name is provided") | ||
| } | ||
| if vp != nil { |
| // TestLabelsAddNameWithoutValue ensures that providing --name without --value returns an error. | ||
| func TestLabelsAddNameWithoutValue(t *testing.T) { | ||
| mock := common.NewMockLoaderSaver() | ||
| mock.LoadFn = func(path string) (fn.Function, error) { | ||
| return fn.Function{}, nil | ||
| } | ||
| mock.SaveFn = func(f fn.Function) error { | ||
| t.Error("Save must not be called when validation fails") | ||
| return nil | ||
| } |
lkingland
added
ok-to-test
Problem
config envs add --name=KEY(without--value) silently writesfn.Env{Name: &"KEY", Value: nil}tofunc.yaml. This entry is invisible inconfig envs list, renders asKEY=(empty string) at deploy time, and failsValidateEnvsat build time with "env entry #N is missing value field". The OR condition in the non-interactive guard allowed the partial set to bypass the interactive prompt and go straight to Save.config labels add --name=Foo(without--value) silently drops the flag and launches the interactive prompt with no explanation, because the AND condition means the non-interactive block is never entered.Changes
cmd/config_envs.go--nameis provided but--valueis not, return--value is required when --name is providedbefore calling Save.--value='{{ secret:S }}'without--name) is unaffected — the guard only triggers when name is set and value is nil.cmd/config_labels.go--nameor only--valueis provided, return a clear error rather than silently entering interactive mode.Tests
Added to
cmd/config_test.go:TestEnvsAddNameWithoutValue— verifies error is returned and Save is not called.TestLabelsAddNameWithoutValue— verifies error when--nameis given without--value.TestLabelsAddValueWithoutName— verifies error when--valueis given without--name.