-
Notifications
You must be signed in to change notification settings - Fork 200
fix(preheat): handle nil payload during policy update #1022
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| // Copyright Project Harbor Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package policy | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "testing" | ||
|
|
||
| "github.com/goharbor/go-client/pkg/sdk/v2.0/client/preheat" | ||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestUpdatePolicyCommand_NilPolicy(t *testing.T) { | ||
| originalGetPreheatPolicy := getPreheatPolicyFunc | ||
| t.Cleanup(func() { | ||
| getPreheatPolicyFunc = originalGetPreheatPolicy | ||
| }) | ||
|
|
||
| getPreheatPolicyFunc = func(projectName, policyName string) (*preheat.GetPolicyOK, error) { | ||
| return nil, nil | ||
| } | ||
|
|
||
| cmd := UpdatePolicyCommand() | ||
| var buf bytes.Buffer | ||
| cmd.SetOut(&buf) | ||
| cmd.SetErr(&buf) | ||
| cmd.SetArgs([]string{"my-project", "my-policy"}) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There is a test helper function, in /pkg/testutil/testutil.go This takes the cmd & the flags, and just outputs the error (if any)
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks for the feedback! I've updated the tests to use the existing pkg/testutil.TestCmd helper and aligned them with the Harbor CLI testing conventions. I also verified that the test suite passes after the changes. Please let me know if there's anything else I should adjust. |
||
|
|
||
| err := cmd.Execute() | ||
| assert.Error(t, err) | ||
| assert.Contains(t, err.Error(), "payload is empty") | ||
| } | ||
|
|
||
| func TestUpdatePolicyCommand_NilPayload(t *testing.T) { | ||
| originalGetPreheatPolicy := getPreheatPolicyFunc | ||
| t.Cleanup(func() { | ||
| getPreheatPolicyFunc = originalGetPreheatPolicy | ||
| }) | ||
|
|
||
| getPreheatPolicyFunc = func(projectName, policyName string) (*preheat.GetPolicyOK, error) { | ||
| return &preheat.GetPolicyOK{Payload: nil}, nil | ||
| } | ||
|
|
||
| cmd := UpdatePolicyCommand() | ||
| var buf bytes.Buffer | ||
| cmd.SetOut(&buf) | ||
| cmd.SetErr(&buf) | ||
| cmd.SetArgs([]string{"my-project", "my-policy"}) | ||
|
|
||
| err := cmd.Execute() | ||
| assert.Error(t, err) | ||
| assert.Contains(t, err.Error(), "payload is empty") | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we generally discourage this method of testing since it makes it kinda complicated to understand.
Our method for testing is to just test the command failures, which is wrong flags, malformed input etc
The full command testing is TBD in the e2e tests which are in-dev by a support feature that @bupd i think is making.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can just remove this now, and the relevant things in tests, cause we dont use it