-
Notifications
You must be signed in to change notification settings - Fork 176
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Adds validation - Improve code documentation and add tests
- Loading branch information
1 parent
af23382
commit 3debc97
Showing
4 changed files
with
177 additions
and
32 deletions.
There are no files selected for viewing
This file contains 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 |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| *.swp | ||
| *~ | ||
| _output | ||
| apiserver.local.config/ | ||
| .idea/ |
This file contains 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 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 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 |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| /* | ||
| Copyright 2022 The Kubernetes 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 options | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/spf13/pflag" | ||
| "github.com/stretchr/testify/assert" | ||
|
|
||
| utilerrors "k8s.io/apimachinery/pkg/util/errors" | ||
| genericapiserver "k8s.io/apiserver/pkg/server" | ||
|
|
||
| "sigs.k8s.io/custom-metrics-apiserver/pkg/apiserver" | ||
| ) | ||
|
|
||
| func TestValidate(t *testing.T) { | ||
| cases := []struct { | ||
| testName string | ||
| args []string | ||
| shouldErr bool | ||
| }{ | ||
| { | ||
| testName: "only-secure-port", | ||
| args: []string{"--secure-port=6443"}, // default is 443, which requires privileges | ||
| shouldErr: false, | ||
| }, | ||
| { | ||
| testName: "secure-port-0", | ||
| args: []string{"--secure-port=0"}, // means: "don't serve HTTPS at all" | ||
| shouldErr: false, | ||
| }, | ||
| { | ||
| testName: "invalid-secure-port", | ||
| args: []string{"--secure-port=-1"}, | ||
| shouldErr: true, | ||
| }, | ||
| { | ||
| testName: "empty-header", | ||
| args: []string{"--secure-port=6443", "--requestheader-username-headers=\" \""}, | ||
| shouldErr: true, | ||
| }, | ||
| { | ||
| testName: "invalid-audit-log-format", | ||
| args: []string{"--secure-port=6443", "--audit-log-path=file", "--audit-log-format=txt"}, | ||
| shouldErr: true, | ||
| }, | ||
| } | ||
|
|
||
| for _, c := range cases { | ||
| t.Run(c.testName, func(t *testing.T) { | ||
| o := NewCustomMetricsAdapterServerOptions() | ||
|
|
||
| flagSet := pflag.NewFlagSet("", pflag.PanicOnError) | ||
| o.AddFlags(flagSet) | ||
| err := flagSet.Parse(c.args) | ||
| assert.NoErrorf(t, err, "Error while parsing flags") | ||
|
|
||
| errList := o.Validate() | ||
| err = utilerrors.NewAggregate(errList) | ||
| if c.shouldErr { | ||
| assert.Errorf(t, err, "Expected error while validating options") | ||
| } else { | ||
| assert.NoErrorf(t, err, "Error while validating options") | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestApplyTo(t *testing.T) { | ||
| cases := []struct { | ||
| testName string | ||
| args []string | ||
| shouldErr bool | ||
| }{ | ||
| { | ||
| testName: "only-secure-port", | ||
| args: []string{"--secure-port=6443"}, // default is 443, which requires privileges | ||
| }, | ||
| { | ||
| testName: "secure-port-0", | ||
| args: []string{"--secure-port=0"}, // means: "don't serve HTTPS at all" | ||
| shouldErr: false, | ||
| }, | ||
| } | ||
|
|
||
| for _, c := range cases { | ||
| t.Run(c.testName, func(t *testing.T) { | ||
| o := NewCustomMetricsAdapterServerOptions() | ||
|
|
||
| // Unit tests have no Kubernetes cluster access | ||
| o.Authentication.RemoteKubeConfigFileOptional = true | ||
| o.Authorization.RemoteKubeConfigFileOptional = true | ||
|
|
||
| flagSet := pflag.NewFlagSet("", pflag.PanicOnError) | ||
| o.AddFlags(flagSet) | ||
| err := flagSet.Parse(c.args) | ||
| assert.NoErrorf(t, err, "Error while parsing flags") | ||
|
|
||
| serverConfig := genericapiserver.NewConfig(apiserver.Codecs) | ||
| err = o.ApplyTo(serverConfig) | ||
|
|
||
| defer func() { | ||
| // Close the listener, if any | ||
| if serverConfig.SecureServing != nil && serverConfig.SecureServing.Listener != nil { | ||
| err := serverConfig.SecureServing.Listener.Close() | ||
| assert.NoError(t, err) | ||
| } | ||
| }() | ||
|
|
||
| assert.NoErrorf(t, err, "Error while applying options") | ||
| }) | ||
| } | ||
| } |