From 55d45867e6a8b6336be0c56da0b4843dd552b1b0 Mon Sep 17 00:00:00 2001 From: Baasbank Date: Fri, 3 May 2019 23:10:40 +0100 Subject: [PATCH] fixes golint error in staging/src/k8s.io/sample-controller/pkg/apis/samplecontroller/v1alpha1 fixes golint error in staging/src/k8s.io/sample-controller/pkg/apis/samplecontroller fixes golint errors in staging/src/k8s.io/sample-apiserver/pkg/cmd/server fixex golint errors in staging/src/k8s.io/sample-apiserver/pkg/apiserver --- hack/.golint_failures | 4 ---- .../src/k8s.io/sample-apiserver/pkg/apiserver/apiserver.go | 7 ++++++- .../src/k8s.io/sample-apiserver/pkg/cmd/server/start.go | 6 ++++++ .../pkg/apis/samplecontroller/register.go | 1 + .../pkg/apis/samplecontroller/v1alpha1/register.go | 4 +++- 5 files changed, 16 insertions(+), 6 deletions(-) diff --git a/hack/.golint_failures b/hack/.golint_failures index 064c109f162..d0902d4beaf 100644 --- a/hack/.golint_failures +++ b/hack/.golint_failures @@ -593,12 +593,8 @@ staging/src/k8s.io/sample-apiserver/pkg/admission/plugin/banflunder staging/src/k8s.io/sample-apiserver/pkg/admission/wardleinitializer staging/src/k8s.io/sample-apiserver/pkg/apis/wardle staging/src/k8s.io/sample-apiserver/pkg/apis/wardle/v1alpha1 -staging/src/k8s.io/sample-apiserver/pkg/apiserver -staging/src/k8s.io/sample-apiserver/pkg/cmd/server staging/src/k8s.io/sample-apiserver/pkg/registry/wardle/fischer staging/src/k8s.io/sample-apiserver/pkg/registry/wardle/flunder -staging/src/k8s.io/sample-controller/pkg/apis/samplecontroller -staging/src/k8s.io/sample-controller/pkg/apis/samplecontroller/v1alpha1 test/e2e test/e2e/auth test/e2e/autoscaling diff --git a/staging/src/k8s.io/sample-apiserver/pkg/apiserver/apiserver.go b/staging/src/k8s.io/sample-apiserver/pkg/apiserver/apiserver.go index e93f1fa213a..384c46d4ae3 100644 --- a/staging/src/k8s.io/sample-apiserver/pkg/apiserver/apiserver.go +++ b/staging/src/k8s.io/sample-apiserver/pkg/apiserver/apiserver.go @@ -33,7 +33,10 @@ import ( ) var ( + // Scheme defines methods for serializing and deserializing API objects. Scheme = runtime.NewScheme() + // Codecs provides methods for retrieving codecs and serializers for specific + // versions and content types. Codecs = serializer.NewCodecFactory(Scheme) ) @@ -55,10 +58,12 @@ func init() { ) } +// ExtraConfig holds custom apiserver config type ExtraConfig struct { // Place you custom config here. } +// Config defines the config for the apiserver type Config struct { GenericConfig *genericapiserver.RecommendedConfig ExtraConfig ExtraConfig @@ -74,8 +79,8 @@ type completedConfig struct { ExtraConfig *ExtraConfig } +// CompletedConfig embeds a private pointer that cannot be instantiated outside of this package. type CompletedConfig struct { - // Embed a private pointer that cannot be instantiated outside of this package. *completedConfig } diff --git a/staging/src/k8s.io/sample-apiserver/pkg/cmd/server/start.go b/staging/src/k8s.io/sample-apiserver/pkg/cmd/server/start.go index 4f17e82ba3e..fd3d365898b 100644 --- a/staging/src/k8s.io/sample-apiserver/pkg/cmd/server/start.go +++ b/staging/src/k8s.io/sample-apiserver/pkg/cmd/server/start.go @@ -41,6 +41,7 @@ import ( const defaultEtcdPathPrefix = "/registry/wardle.kubernetes.io" +// WardleServerOptions contains state for master/api server type WardleServerOptions struct { RecommendedOptions *genericoptions.RecommendedOptions @@ -49,6 +50,7 @@ type WardleServerOptions struct { StdErr io.Writer } +// NewWardleServerOptions returns a new WardleServerOptions func NewWardleServerOptions(out, errOut io.Writer) *WardleServerOptions { o := &WardleServerOptions{ RecommendedOptions: genericoptions.NewRecommendedOptions( @@ -92,12 +94,14 @@ func NewCommandStartWardleServer(defaults *WardleServerOptions, stopCh <-chan st return cmd } +// Validate validates WardleServerOptions func (o WardleServerOptions) Validate(args []string) error { errors := []error{} errors = append(errors, o.RecommendedOptions.Validate()...) return utilerrors.NewAggregate(errors) } +// Complete fills in fields required to have valid data func (o *WardleServerOptions) Complete() error { // register admission plugins banflunder.Register(o.RecommendedOptions.Admission.Plugins) @@ -108,6 +112,7 @@ func (o *WardleServerOptions) Complete() error { return nil } +// Config returns config for the api server given WardleServerOptions func (o *WardleServerOptions) Config() (*apiserver.Config, error) { // TODO have a "real" external address if err := o.RecommendedOptions.SecureServing.MaybeDefaultWithSelfSignedCerts("localhost", nil, []net.IP{net.ParseIP("127.0.0.1")}); err != nil { @@ -138,6 +143,7 @@ func (o *WardleServerOptions) Config() (*apiserver.Config, error) { return config, nil } +// RunWardleServer starts a new WardleServer given WardleServerOptions func (o WardleServerOptions) RunWardleServer(stopCh <-chan struct{}) error { config, err := o.Config() if err != nil { diff --git a/staging/src/k8s.io/sample-controller/pkg/apis/samplecontroller/register.go b/staging/src/k8s.io/sample-controller/pkg/apis/samplecontroller/register.go index 394f7967e2b..fd5a7888d75 100644 --- a/staging/src/k8s.io/sample-controller/pkg/apis/samplecontroller/register.go +++ b/staging/src/k8s.io/sample-controller/pkg/apis/samplecontroller/register.go @@ -16,6 +16,7 @@ limitations under the License. package samplecontroller +// GroupName is the group name used in this package const ( GroupName = "samplecontroller.k8s.io" ) diff --git a/staging/src/k8s.io/sample-controller/pkg/apis/samplecontroller/v1alpha1/register.go b/staging/src/k8s.io/sample-controller/pkg/apis/samplecontroller/v1alpha1/register.go index df5695eb092..e8e0a28efaa 100644 --- a/staging/src/k8s.io/sample-controller/pkg/apis/samplecontroller/v1alpha1/register.go +++ b/staging/src/k8s.io/sample-controller/pkg/apis/samplecontroller/v1alpha1/register.go @@ -38,8 +38,10 @@ func Resource(resource string) schema.GroupResource { } var ( + // SchemeBuilder initializes a scheme builder SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) - AddToScheme = SchemeBuilder.AddToScheme + // AddToScheme is a global function that registers this API group & version to a scheme + AddToScheme = SchemeBuilder.AddToScheme ) // Adds the list of known types to Scheme.