fix: apply clientConnection QPS/burst to the manager client #3432
+152
−3
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,6 +27,7 @@ import ( | |
| "github.com/google/go-cmp/cmp/cmpopts" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/runtime" | ||
| "k8s.io/client-go/rest" | ||
| componentconfigv1alpha1 "k8s.io/component-base/config/v1alpha1" | ||
| "k8s.io/utils/ptr" | ||
| ctrl "sigs.k8s.io/controller-runtime" | ||
|
|
@@ -798,6 +799,125 @@ func TestIsCertManagementEnabled(t *testing.T) { | |
| } | ||
| } | ||
|
|
||
| func TestApplyClientConnection(t *testing.T) { | ||
| testcases := map[string]struct { | ||
| cfg configapi.Configuration | ||
| initialQPS float32 | ||
| initialBurst int | ||
| wantQPS float32 | ||
| wantBurst int | ||
| }{ | ||
| "nil ClientConnection keeps rest.Config defaults": { | ||
| cfg: configapi.Configuration{}, | ||
| initialQPS: 5, | ||
| initialBurst: 10, | ||
| wantQPS: 5, | ||
| wantBurst: 10, | ||
| }, | ||
| "default values override client-go defaults": { | ||
| cfg: configapi.Configuration{ | ||
| ClientConnection: &configapi.ClientConnection{ | ||
| QPS: ptr.To[float32](50), | ||
| Burst: ptr.To[int32](100), | ||
| }, | ||
| }, | ||
| initialQPS: 5, | ||
| initialBurst: 10, | ||
| wantQPS: 50, | ||
| wantBurst: 100, | ||
| }, | ||
| "custom values applied": { | ||
| cfg: configapi.Configuration{ | ||
| ClientConnection: &configapi.ClientConnection{ | ||
| QPS: ptr.To[float32](200), | ||
| Burst: ptr.To[int32](400), | ||
| }, | ||
| }, | ||
| wantQPS: 200, | ||
| wantBurst: 400, | ||
| }, | ||
| "only QPS set preserves existing burst": { | ||
| cfg: configapi.Configuration{ | ||
| ClientConnection: &configapi.ClientConnection{ | ||
| QPS: ptr.To[float32](75), | ||
| }, | ||
| }, | ||
| initialBurst: 10, | ||
| wantQPS: 75, | ||
| wantBurst: 10, | ||
| }, | ||
| "only burst set preserves existing QPS": { | ||
| cfg: configapi.Configuration{ | ||
| ClientConnection: &configapi.ClientConnection{ | ||
| Burst: ptr.To[int32](150), | ||
| }, | ||
| }, | ||
| initialQPS: 5, | ||
| wantQPS: 5, | ||
| wantBurst: 150, | ||
| }, | ||
| "zero QPS is valid and applied": { | ||
| cfg: configapi.Configuration{ | ||
| ClientConnection: &configapi.ClientConnection{ | ||
| QPS: ptr.To[float32](0), | ||
| Burst: ptr.To[int32](0), | ||
| }, | ||
| }, | ||
| initialQPS: 5, | ||
| initialBurst: 10, | ||
| wantQPS: 0, | ||
| wantBurst: 0, | ||
| }, | ||
| "empty ClientConnection struct preserves existing values": { | ||
| cfg: configapi.Configuration{ | ||
| ClientConnection: &configapi.ClientConnection{}, | ||
| }, | ||
| initialQPS: 5, | ||
| initialBurst: 10, | ||
| wantQPS: 5, | ||
| wantBurst: 10, | ||
| }, | ||
| } | ||
|
|
||
| for name, tc := range testcases { | ||
| t.Run(name, func(t *testing.T) { | ||
| restCfg := &rest.Config{ | ||
| QPS: tc.initialQPS, | ||
| Burst: tc.initialBurst, | ||
| } | ||
| ApplyClientConnection(restCfg, &tc.cfg) | ||
| if restCfg.QPS != tc.wantQPS { | ||
| t.Errorf("QPS = %v, want %v", restCfg.QPS, tc.wantQPS) | ||
| } | ||
| if restCfg.Burst != tc.wantBurst { | ||
| t.Errorf("Burst = %v, want %v", restCfg.Burst, tc.wantBurst) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestLoadAndApplyClientConnection(t *testing.T) { | ||
|
Contributor
There was a problem hiding this comment. Is this effectively re-testing logic we already cover in TestApplyClientConnection and TestLoad?
Member
Author
There was a problem hiding this comment. Thanks for the review @robert-bell ! Addressed all your feedback ✅
Contributor
There was a problem hiding this comment. Thanks @abhijeet-dhumal. I was more wondering whether this test is needed? |
||
| testScheme := runtime.NewScheme() | ||
| if err := configapi.AddToScheme(testScheme); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| _, cfg, err := Load(testScheme, "", false) | ||
| if err != nil { | ||
| t.Fatalf("Unexpected error: %v", err) | ||
| } | ||
|
|
||
| restCfg := &rest.Config{QPS: 5, Burst: 10} | ||
| ApplyClientConnection(restCfg, &cfg) | ||
|
|
||
| if restCfg.QPS != 50 { | ||
| t.Errorf("QPS = %v, want 50", restCfg.QPS) | ||
| } | ||
| if restCfg.Burst != 100 { | ||
| t.Errorf("Burst = %v, want 100", restCfg.Burst) | ||
| } | ||
| } | ||
|
|
||
| func TestLoadHTTP2(t *testing.T) { | ||
| testScheme := runtime.NewScheme() | ||
| if err := configapi.AddToScheme(testScheme); err != nil { | ||
|
|
||
Oops, something went wrong.
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.
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.
what's the rationale for having a separate function for this rather than doing this as part of
Load?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.
Ah - re-reading this I see the rest config is created in main.go directly. A separate function makes sense.