github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-23 19:56:01 +00:00
Code Issues Projects Releases Wiki Activity

Remove dependency on internal types from pkg/kubectl/resource.

Browse Source 
Updates the Result.Object function to take an argument.
This commit is contained in:
Phillip Wittrock 2017-10-17 18:46:38 -07:00
parent e3e2e24cc5
commit 72d672c3d5
12 changed files with 113 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
pkg/kubectl/BUILD
View File

@ -196,6 +196,7 @@ filegroup(
"//pkg/kubectl/apps:all-srcs",
"//pkg/kubectl/cmd:all-srcs",
"//pkg/kubectl/explain:all-srcs",
"//pkg/kubectl/internaldeps:all-srcs",
"//pkg/kubectl/metricsutil:all-srcs",
"//pkg/kubectl/plugins:all-srcs",
"//pkg/kubectl/proxy:all-srcs",

1
pkg/kubectl/cmd/BUILD
View File

@ -86,6 +86,7 @@ go_library(
"//pkg/kubectl/cmd/util/editor:go_default_library",
"//pkg/kubectl/cmd/util/openapi:go_default_library",
"//pkg/kubectl/explain:go_default_library",
"//pkg/kubectl/internaldeps:go_default_library",
"//pkg/kubectl/metricsutil:go_default_library",
"//pkg/kubectl/plugins:go_default_library",
"//pkg/kubectl/proxy:go_default_library",

3
pkg/kubectl/cmd/attach.go
View File

@ -34,6 +34,7 @@ import (
coreclient "k8s.io/kubernetes/pkg/client/clientset_generated/internalclientset/typed/core/internalversion"
"k8s.io/kubernetes/pkg/kubectl/cmd/templates"
cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
"k8s.io/kubernetes/pkg/kubectl/internaldeps"
"k8s.io/kubernetes/pkg/kubectl/util/i18n"
)
@ -152,7 +153,7 @@ func (p *AttachOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, argsIn [
builder.ResourceNames(argsIn[0], argsIn[1])
}
obj, err := builder.Do().Object()
obj, err := builder.Do().Object(internaldeps.ToInternalList)
if err != nil {
return err
}

3
pkg/kubectl/cmd/get.go
View File

@ -38,6 +38,7 @@ import (
"k8s.io/kubernetes/pkg/kubectl/cmd/templates"
cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
"k8s.io/kubernetes/pkg/kubectl/cmd/util/openapi"
"k8s.io/kubernetes/pkg/kubectl/internaldeps"
"k8s.io/kubernetes/pkg/kubectl/resource"
"k8s.io/kubernetes/pkg/kubectl/util/i18n"
"k8s.io/kubernetes/pkg/printers"
@ -248,7 +249,7 @@ func RunGet(f cmdutil.Factory, out, errOut io.Writer, cmd *cobra.Command, args [
if err != nil {
return err
}
obj, err := r.Object()
obj, err := r.Object(internaldeps.ToInternalList)
if err != nil {
return err
}

3
pkg/kubectl/cmd/rollingupdate.go
View File

@ -35,6 +35,7 @@ import (
"k8s.io/kubernetes/pkg/kubectl"
"k8s.io/kubernetes/pkg/kubectl/cmd/templates"
cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
"k8s.io/kubernetes/pkg/kubectl/internaldeps"
"k8s.io/kubernetes/pkg/kubectl/resource"
"k8s.io/kubernetes/pkg/kubectl/util"
"k8s.io/kubernetes/pkg/kubectl/util/i18n"
@ -204,7 +205,7 @@ func RunRollingUpdate(f cmdutil.Factory, out io.Writer, cmd *cobra.Command, args
NamespaceParam(cmdNamespace).DefaultNamespace().
FilenameParam(enforceNamespace, &resource.FilenameOptions{Recursive: false, Filenames: []string{filename}}).
Do()
obj, err := request.Object()
obj, err := request.Object(internaldeps.ToInternalList)
if err != nil {
return err
}

1
pkg/kubectl/cmd/rollout/BUILD
View File

@ -22,6 +22,7 @@ go_library(
"//pkg/kubectl/cmd/set:go_default_library",
"//pkg/kubectl/cmd/templates:go_default_library",
"//pkg/kubectl/cmd/util:go_default_library",
"//pkg/kubectl/internaldeps:go_default_library",
"//pkg/kubectl/resource:go_default_library",
"//pkg/kubectl/util/i18n:go_default_library",
"//pkg/util/interrupt:go_default_library",

3
pkg/kubectl/cmd/rollout/rollout_status.go
View File

@ -24,6 +24,7 @@ import (
"k8s.io/kubernetes/pkg/kubectl"
"k8s.io/kubernetes/pkg/kubectl/cmd/templates"
cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
"k8s.io/kubernetes/pkg/kubectl/internaldeps"
"k8s.io/kubernetes/pkg/kubectl/resource"
"k8s.io/kubernetes/pkg/kubectl/util/i18n"
"k8s.io/kubernetes/pkg/util/interrupt"
@ -104,7 +105,7 @@ func RunStatus(f cmdutil.Factory, cmd *cobra.Command, out io.Writer, args []stri
info := infos[0]
mapping := info.ResourceMapping()
obj, err := r.Object()
obj, err := r.Object(internaldeps.ToInternalList)
if err != nil {
return err
}

27
pkg/kubectl/internaldeps/BUILD Normal file
View File

@ -0,0 +1,27 @@
load("@io_bazel_rules_go//go:def.bzl", "go_library")
go_library(
name = "go_default_library",
srcs = ["result.go"],
importpath = "k8s.io/kubernetes/pkg/kubectl/internaldeps",
visibility = ["//visibility:public"],
deps = [
"//pkg/api:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/apis/meta/v1:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/runtime:go_default_library",
],
)
filegroup(
name = "package-srcs",
srcs = glob(["**"]),
tags = ["automanaged"],
visibility = ["//visibility:private"],
)
filegroup(
name = "all-srcs",
srcs = [":package-srcs"],
tags = ["automanaged"],
visibility = ["//visibility:public"],
)

35
pkg/kubectl/internaldeps/result.go Normal file
View File

@ -0,0 +1,35 @@
/*
Copyright 2016 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 internaldeps
import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/kubernetes/pkg/api"
)
// ToInternalList implements resource.ToList and is used by callers of
// Result.Object to convert multiple returned Objects into an internal
// List containing the objects.
func ToInternalList(objects []runtime.Object, version string) runtime.Object {
return &api.List{
ListMeta: metav1.ListMeta{
ResourceVersion: version,
},
Items: objects,
}
}

3
pkg/kubectl/resource/BUILD
View File

@ -22,10 +22,10 @@ go_library(
"//build/visible_to:pkg_kubectl_resource_CONSUMERS",
],
deps = [
"//pkg/api:go_default_library",
"//pkg/kubectl/validation:go_default_library",
"//vendor/golang.org/x/text/encoding/unicode:go_default_library",
"//vendor/golang.org/x/text/transform:go_default_library",
"//vendor/k8s.io/api/core/v1:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/api/errors:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/api/meta:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/apis/meta/v1:go_default_library",
@ -62,6 +62,7 @@ go_test(
"//pkg/api:go_default_library",
"//pkg/api/testapi:go_default_library",
"//pkg/api/testing:go_default_library",
"//pkg/kubectl/internaldeps:go_default_library",
"//vendor/github.com/ghodss/yaml:go_default_library",
"//vendor/github.com/googleapis/gnostic/OpenAPIv2:go_default_library",
"//vendor/github.com/stretchr/testify/assert:go_default_library",

11
pkg/kubectl/resource/builder_test.go
View File

@ -46,6 +46,7 @@ import (
"k8s.io/kubernetes/pkg/api"
"k8s.io/kubernetes/pkg/api/testapi"
apitesting "k8s.io/kubernetes/pkg/api/testing"
"k8s.io/kubernetes/pkg/kubectl/internaldeps"
)
func stringBody(body string) io.ReadCloser {
@ -893,7 +894,7 @@ func TestMultipleObject(t *testing.T) {
r, pods, svc := streamTestData()
obj, err := NewBuilder(testapi.Default.RESTMapper(), LegacyCategoryExpander, api.Scheme, fakeClient(), testapi.Default.Codec()).
NamespaceParam("test").Stream(r, "STDIN").Flatten().
Do().Object()
Do().Object(internaldeps.ToInternalList)
if err != nil {
t.Fatalf("unexpected error: %v", err)
@ -946,7 +947,7 @@ func TestSingleItemImpliedObject(t *testing.T) {
NamespaceParam("test").DefaultNamespace().
FilenameParam(false, &FilenameOptions{Recursive: false, Filenames: []string{"../../../examples/guestbook/legacy/redis-master-controller.yaml"}}).
Flatten().
Do().Object()
Do().Object(internaldeps.ToInternalList)
if err != nil {
t.Fatalf("unexpected error: %v", err)
@ -966,7 +967,7 @@ func TestSingleItemImpliedObjectNoExtension(t *testing.T) {
NamespaceParam("test").DefaultNamespace().
FilenameParam(false, &FilenameOptions{Recursive: false, Filenames: []string{"../../../examples/pod"}}).
Flatten().
Do().Object()
Do().Object(internaldeps.ToInternalList)
if err != nil {
t.Fatalf("unexpected error: %v", err)
@ -1017,7 +1018,7 @@ func TestListObject(t *testing.T) {
ResourceTypeOrNameArgs(true, "pods").
Flatten()
obj, err := b.Do().Object()
obj, err := b.Do().Object(internaldeps.ToInternalList)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
@ -1050,7 +1051,7 @@ func TestListObjectWithDifferentVersions(t *testing.T) {
NamespaceParam("test").
ResourceTypeOrNameArgs(true, "pods,services").
Flatten().
Do().Object()
Do().Object(internaldeps.ToInternalList)
if err != nil {
t.Fatalf("unexpected error: %v", err)

41
pkg/kubectl/resource/result.go
View File

@ -20,13 +20,13 @@ import (
"fmt"
"reflect"
"k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
utilerrors "k8s.io/apimachinery/pkg/util/errors"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/apimachinery/pkg/watch"
"k8s.io/kubernetes/pkg/api"
)
// ErrMatchFunc can be used to filter errors that may not be true failures.
@ -125,13 +125,37 @@ func (r *Result) Infos() ([]*Info, error) {
return infos, err
}
// ToList is a function that converts a slice of Objects into a single
// List Object. It allows callers to control whether an internal
// or external List is returned.
type ToList func([]runtime.Object, string) runtime.Object
// Compile time check to enforce that list implements the necessary interface
var _ metav1.ListInterface = &v1.List{}
var _ metav1.ListMetaAccessor = &v1.List{}
// ToV1List takes a slice of Objects + their version, and returns
// a v1.List Object containing the objects as Items
func ToV1List(objects []runtime.Object, version string) runtime.Object {
raw := []runtime.RawExtension{}
for _, o := range objects {
raw = append(raw, runtime.RawExtension{Object: o})
}
return &v1.List{
ListMeta: metav1.ListMeta{
ResourceVersion: version,
},
Items: raw,
}
}
// Object returns a single object representing the output of a single visit to all
// found resources. If the Builder was a singular context (expected to return a
// single resource by user input) and only a single resource was found, the resource
// will be returned as is. Otherwise, the returned resources will be part of an
// api.List. The ResourceVersion of the api.List will be set only if it is identical
// v1.List. The ResourceVersion of the v1.List will be set only if it is identical
// across all infos returned.
func (r *Result) Object() (runtime.Object, error) {
func (r *Result) Object(toList ToList) (runtime.Object, error) {
infos, err := r.Infos()
if err != nil {
return nil, err
@ -160,12 +184,11 @@ func (r *Result) Object() (runtime.Object, error) {
if len(versions) == 1 {
version = versions.List()[0]
}
return &api.List{
ListMeta: metav1.ListMeta{
ResourceVersion: version,
},
Items: objects,
}, err
if toList == nil {
toList = ToV1List
}
return toList(objects, version), err
}
// ResourceMapping returns a single meta.RESTMapping representing the