github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #2009 from smarterclayton/unify_meta

Browse Source 
Unify Accessor for ObjectMeta/TypeMeta/ListMeta
This commit is contained in:
Daniel Smith
2014-10-29 09:58:46 -07:00
parent 3b76b25e7d 66ace4c270
commit 94e736e286
10 changed files with 304 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

158
pkg/api/meta/meta.go
View File

@@ -24,9 +24,13 @@ import (
"github.com/GoogleCloudPlatform/kubernetes/pkg/runtime"
)
// Interface lets you work with object metadata from any of the versioned or
// internal API objects.
// Interface lets you work with object and list metadata from any of the versioned or
// internal API objects. Attempting to set or retrieve a field on an object that does
// not support that field (Name, UID, Namespace on lists) will be a no-op and return
// a default value.
type Interface interface {
Namespace() string
SetNamespace(namespace string)
Name() string
SetName(name string)
UID() string
@@ -45,6 +49,7 @@ type Interface interface {
// obj must be a pointer to an API type. An error is returned if the minimum
// required fields are missing. Fields that are not required return the default
// value and are a no-op if set.
// TODO: add a fast path for *TypeMeta and *ObjectMeta for internal objects
func Accessor(obj interface{}) (Interface, error) {
v, err := conversion.EnforcePtr(obj)
if err != nil {
@@ -62,26 +67,26 @@ func Accessor(obj interface{}) (Interface, error) {
a := &genericAccessor{}
if err := extractFromTypeMeta(typeMeta, a); err != nil {
return nil, fmt.Errorf("unable to find type fields on %#v", typeMeta)
return nil, fmt.Errorf("unable to find type fields on %#v: %v", typeMeta, err)
}
objectMeta := v.FieldByName("ObjectMeta")
if objectMeta.IsValid() {
// look for the ObjectMeta fields
if err := extractFromObjectMeta(objectMeta, a); err != nil {
return nil, fmt.Errorf("unable to find object fields on %#v", objectMeta)
return nil, fmt.Errorf("unable to find object fields on %#v: %v", objectMeta, err)
}
} else {
listMeta := v.FieldByName("ListMeta")
if listMeta.IsValid() {
// look for the ListMeta fields
if err := extractFromListMeta(listMeta, a); err != nil {
return nil, fmt.Errorf("unable to find list fields on %#v", listMeta)
return nil, fmt.Errorf("unable to find list fields on %#v: %v", listMeta, err)
}
} else {
// look for the older TypeMeta with all metadata
if err := extractFromObjectMeta(typeMeta, a); err != nil {
return nil, fmt.Errorf("unable to find object fields on %#v", typeMeta)
return nil, fmt.Errorf("unable to find object fields on %#v: %v", typeMeta, err)
}
}
}
@@ -89,33 +94,92 @@ func Accessor(obj interface{}) (Interface, error) {
return a, nil
}
// NewResourceVersioner returns a ResourceVersioner that can set or
// retrieve ResourceVersion on objects derived from TypeMeta.
func NewResourceVersioner() runtime.ResourceVersioner {
// MetadataAccessor lets you work with object metadata from any of the versioned or
// internal API objects.
type MetadataAccessor interface {
APIVersion(obj runtime.Object) (string, error)
SetAPIVersion(obj runtime.Object, version string) error
Kind(obj runtime.Object) (string, error)
SetKind(obj runtime.Object, kind string) error
Namespace(obj runtime.Object) (string, error)
SetNamespace(obj runtime.Object, namespace string) error
Name(obj runtime.Object) (string, error)
SetName(obj runtime.Object, name string) error
UID(obj runtime.Object) (string, error)
SetUID(obj runtime.Object, uid string) error
SelfLink(obj runtime.Object) (string, error)
SetSelfLink(obj runtime.Object, selfLink string) error
runtime.ResourceVersioner
}
// NewAccessor returns a MetadataAccessor that can retrieve
// or manipulate resource version on objects derived from core API
// metadata concepts.
func NewAccessor() MetadataAccessor {
return resourceAccessor{}
}
// resourceAccessor implements ResourceVersioner and SelfLinker.
type resourceAccessor struct{}
func (v resourceAccessor) ResourceVersion(obj runtime.Object) (string, error) {
func (resourceAccessor) Kind(obj runtime.Object) (string, error) {
accessor, err := Accessor(obj)
if err != nil {
return "", err
}
return accessor.ResourceVersion(), nil
return accessor.Kind(), nil
}
func (v resourceAccessor) SetResourceVersion(obj runtime.Object, version string) error {
func (resourceAccessor) SetKind(obj runtime.Object, kind string) error {
accessor, err := Accessor(obj)
if err != nil {
return err
}
accessor.SetResourceVersion(version)
accessor.SetKind(kind)
return nil
}
func (v resourceAccessor) Name(obj runtime.Object) (string, error) {
func (resourceAccessor) APIVersion(obj runtime.Object) (string, error) {
accessor, err := Accessor(obj)
if err != nil {
return "", err
}
return accessor.APIVersion(), nil
}
func (resourceAccessor) SetAPIVersion(obj runtime.Object, version string) error {
accessor, err := Accessor(obj)
if err != nil {
return err
}
accessor.SetAPIVersion(version)
return nil
}
func (resourceAccessor) Namespace(obj runtime.Object) (string, error) {
accessor, err := Accessor(obj)
if err != nil {
return "", err
}
return accessor.Namespace(), nil
}
func (resourceAccessor) SetNamespace(obj runtime.Object, namespace string) error {
accessor, err := Accessor(obj)
if err != nil {
return err
}
accessor.SetNamespace(namespace)
return nil
}
func (resourceAccessor) Name(obj runtime.Object) (string, error) {
accessor, err := Accessor(obj)
if err != nil {
return "", err
@@ -123,7 +187,33 @@ func (v resourceAccessor) Name(obj runtime.Object) (string, error) {
return accessor.Name(), nil
}
func (v resourceAccessor) SelfLink(obj runtime.Object) (string, error) {
func (resourceAccessor) SetName(obj runtime.Object, name string) error {
accessor, err := Accessor(obj)
if err != nil {
return err
}
accessor.SetName(name)
return nil
}
func (resourceAccessor) UID(obj runtime.Object) (string, error) {
accessor, err := Accessor(obj)
if err != nil {
return "", err
}
return accessor.UID(), nil
}
func (resourceAccessor) SetUID(obj runtime.Object, uid string) error {
accessor, err := Accessor(obj)
if err != nil {
return err
}
accessor.SetUID(uid)
return nil
}
func (resourceAccessor) SelfLink(obj runtime.Object) (string, error) {
accessor, err := Accessor(obj)
if err != nil {
return "", err
@@ -131,7 +221,7 @@ func (v resourceAccessor) SelfLink(obj runtime.Object) (string, error) {
return accessor.SelfLink(), nil
}
func (v resourceAccessor) SetSelfLink(obj runtime.Object, selfLink string) error {
func (resourceAccessor) SetSelfLink(obj runtime.Object, selfLink string) error {
accessor, err := Accessor(obj)
if err != nil {
return err
@@ -140,14 +230,27 @@ func (v resourceAccessor) SetSelfLink(obj runtime.Object, selfLink string) error
return nil
}
// NewSelfLinker returns a SelfLinker that works on all TypeMeta SelfLink fields.
func NewSelfLinker() runtime.SelfLinker {
return resourceAccessor{}
func (resourceAccessor) ResourceVersion(obj runtime.Object) (string, error) {
accessor, err := Accessor(obj)
if err != nil {
return "", err
}
return accessor.ResourceVersion(), nil
}
func (resourceAccessor) SetResourceVersion(obj runtime.Object, version string) error {
accessor, err := Accessor(obj)
if err != nil {
return err
}
accessor.SetResourceVersion(version)
return nil
}
// genericAccessor contains pointers to strings that can modify an arbitrary
// struct and implements the Accessor interface.
type genericAccessor struct {
namespace *string
name *string
uid *string
apiVersion *string
@@ -156,6 +259,20 @@ type genericAccessor struct {
selfLink *string
}
func (a genericAccessor) Namespace() string {
if a.namespace == nil {
return ""
}
return *a.namespace
}
func (a genericAccessor) SetNamespace(namespace string) {
if a.namespace == nil {
return
}
*a.namespace = namespace
}
func (a genericAccessor) Name() string {
if a.name == nil {
return ""
@@ -253,6 +370,9 @@ func extractFromTypeMeta(v reflect.Value, a *genericAccessor) error {
// extractFromObjectMeta extracts pointers to metadata fields from an object
func extractFromObjectMeta(v reflect.Value, a *genericAccessor) error {
if err := fieldPtr(v, "Namespace", &a.namespace); err != nil {
return err
}
if err := fieldPtr(v, "Name", &a.name); err != nil {
return err
}

147
pkg/api/meta/meta_test.go
View File

@@ -26,6 +26,7 @@ import (
func TestGenericTypeMeta(t *testing.T) {
type TypeMeta struct {
Kind string `json:"kind,omitempty" yaml:"kind,omitempty"`
Namespace string `json:"namespace,omitempty" yaml:"namespace,omitempty"`
Name string `json:"name,omitempty" yaml:"name,omitempty"`
UID string `json:"uid,omitempty" yaml:"uid,omitempty"`
CreationTimestamp util.Time `json:"creationTimestamp,omitempty" yaml:"creationTimestamp,omitempty"`
@@ -38,6 +39,7 @@ func TestGenericTypeMeta(t *testing.T) {
}
j := Object{
TypeMeta{
Namespace: "bar",
Name: "foo",
UID: "uid",
APIVersion: "a",
@@ -50,6 +52,9 @@ func TestGenericTypeMeta(t *testing.T) {
if err != nil {
t.Fatalf("new err: %v", err)
}
if e, a := "bar", accessor.Namespace(); e != a {
t.Errorf("expected %v, got %v", e, a)
}
if e, a := "foo", accessor.Name(); e != a {
t.Errorf("expected %v, got %v", e, a)
}
@@ -69,6 +74,7 @@ func TestGenericTypeMeta(t *testing.T) {
t.Errorf("expected %v, got %v", e, a)
}
accessor.SetNamespace("baz")
accessor.SetName("bar")
accessor.SetUID("other")
accessor.SetAPIVersion("c")
@@ -77,6 +83,9 @@ func TestGenericTypeMeta(t *testing.T) {
accessor.SetSelfLink("google.com")
// Prove that accessor changes the original object.
if e, a := "baz", j.Namespace; e != a {
t.Errorf("expected %v, got %v", e, a)
}
if e, a := "bar", j.Name; e != a {
t.Errorf("expected %v, got %v", e, a)
}
@@ -97,12 +106,138 @@ func TestGenericTypeMeta(t *testing.T) {
}
}
type InternalTypeMeta struct {
Kind string `json:"kind,omitempty" yaml:"kind,omitempty"`
Namespace string `json:"namespace,omitempty" yaml:"namespace,omitempty"`
Name string `json:"name,omitempty" yaml:"name,omitempty"`
UID string `json:"uid,omitempty" yaml:"uid,omitempty"`
CreationTimestamp util.Time `json:"creationTimestamp,omitempty" yaml:"creationTimestamp,omitempty"`
SelfLink string `json:"selfLink,omitempty" yaml:"selfLink,omitempty"`
ResourceVersion string `json:"resourceVersion,omitempty" yaml:"resourceVersion,omitempty"`
APIVersion string `json:"apiVersion,omitempty" yaml:"apiVersion,omitempty"`
}
type InternalObject struct {
TypeMeta InternalTypeMeta `json:",inline" yaml:",inline"`
}
func (*InternalObject) IsAnAPIObject() {}
func TestGenericTypeMetaAccessor(t *testing.T) {
j := &InternalObject{
InternalTypeMeta{
Namespace: "bar",
Name: "foo",
UID: "uid",
APIVersion: "a",
Kind: "b",
ResourceVersion: "1",
SelfLink: "some/place/only/we/know",
},
}
accessor := NewAccessor()
namespace, err := accessor.Namespace(j)
if err != nil {
t.Errorf("unexpected error: %v", err)
}
if e, a := "bar", namespace; e != a {
t.Errorf("expected %v, got %v", e, a)
}
name, err := accessor.Name(j)
if err != nil {
t.Errorf("unexpected error: %v", err)
}
if e, a := "foo", name; e != a {
t.Errorf("expected %v, got %v", e, a)
}
uid, err := accessor.UID(j)
if err != nil {
t.Errorf("unexpected error: %v", err)
}
if e, a := "uid", uid; e != a {
t.Errorf("expected %v, got %v", e, a)
}
apiVersion, err := accessor.APIVersion(j)
if err != nil {
t.Errorf("unexpected error: %v", err)
}
if e, a := "a", apiVersion; e != a {
t.Errorf("expected %v, got %v", e, a)
}
kind, err := accessor.Kind(j)
if err != nil {
t.Errorf("unexpected error: %v", err)
}
if e, a := "b", kind; e != a {
t.Errorf("expected %v, got %v", e, a)
}
rv, err := accessor.ResourceVersion(j)
if err != nil {
t.Errorf("unexpected error: %v", err)
}
if e, a := "1", rv; e != a {
t.Errorf("expected %v, got %v", e, a)
}
selfLink, err := accessor.SelfLink(j)
if err != nil {
t.Errorf("unexpected error: %v", err)
}
if e, a := "some/place/only/we/know", selfLink; e != a {
t.Errorf("expected %v, got %v", e, a)
}
if err := accessor.SetNamespace(j, "baz"); err != nil {
t.Errorf("unexpected error: %v", err)
}
if err := accessor.SetName(j, "bar"); err != nil {
t.Errorf("unexpected error: %v", err)
}
if err := accessor.SetUID(j, "other"); err != nil {
t.Errorf("unexpected error: %v", err)
}
if err := accessor.SetAPIVersion(j, "c"); err != nil {
t.Errorf("unexpected error: %v", err)
}
if err := accessor.SetKind(j, "d"); err != nil {
t.Errorf("unexpected error: %v", err)
}
if err := accessor.SetResourceVersion(j, "2"); err != nil {
t.Errorf("unexpected error: %v", err)
}
if err := accessor.SetSelfLink(j, "google.com"); err != nil {
t.Errorf("unexpected error: %v", err)
}
// Prove that accessor changes the original object.
if e, a := "baz", j.TypeMeta.Namespace; e != a {
t.Errorf("expected %v, got %v", e, a)
}
if e, a := "bar", j.TypeMeta.Name; e != a {
t.Errorf("expected %v, got %v", e, a)
}
if e, a := "other", j.TypeMeta.UID; e != a {
t.Errorf("expected %v, got %v", e, a)
}
if e, a := "c", j.TypeMeta.APIVersion; e != a {
t.Errorf("expected %v, got %v", e, a)
}
if e, a := "d", j.TypeMeta.Kind; e != a {
t.Errorf("expected %v, got %v", e, a)
}
if e, a := "2", j.TypeMeta.ResourceVersion; e != a {
t.Errorf("expected %v, got %v", e, a)
}
if e, a := "google.com", j.TypeMeta.SelfLink; e != a {
t.Errorf("expected %v, got %v", e, a)
}
}
func TestGenericObjectMeta(t *testing.T) {
type TypeMeta struct {
Kind string `json:"kind,omitempty" yaml:"kind,omitempty"`
APIVersion string `json:"apiVersion,omitempty" yaml:"apiVersion,omitempty"`
}
type ObjectMeta struct {
Namespace string `json:"namespace,omitempty" yaml:"namespace,omitempty"`
Name string `json:"name,omitempty" yaml:"name,omitempty"`
UID string `json:"uid,omitempty" yaml:"uid,omitempty"`
CreationTimestamp util.Time `json:"creationTimestamp,omitempty" yaml:"creationTimestamp,omitempty"`
@@ -119,6 +254,7 @@ func TestGenericObjectMeta(t *testing.T) {
Kind: "b",
},
ObjectMeta{
Namespace: "bar",
Name: "foo",
UID: "uid",
ResourceVersion: "1",
@@ -129,6 +265,9 @@ func TestGenericObjectMeta(t *testing.T) {
if err != nil {
t.Fatalf("new err: %v", err)
}
if e, a := "bar", accessor.Namespace(); e != a {
t.Errorf("expected %v, got %v", e, a)
}
if e, a := "foo", accessor.Name(); e != a {
t.Errorf("expected %v, got %v", e, a)
}
@@ -148,6 +287,7 @@ func TestGenericObjectMeta(t *testing.T) {
t.Errorf("expected %v, got %v", e, a)
}
accessor.SetNamespace("baz")
accessor.SetName("bar")
accessor.SetUID("other")
accessor.SetAPIVersion("c")
@@ -156,6 +296,9 @@ func TestGenericObjectMeta(t *testing.T) {
accessor.SetSelfLink("google.com")
// Prove that accessor changes the original object.
if e, a := "baz", j.Namespace; e != a {
t.Errorf("expected %v, got %v", e, a)
}
if e, a := "bar", j.Name; e != a {
t.Errorf("expected %v, got %v", e, a)
}
@@ -265,7 +408,7 @@ func TestResourceVersionerOfAPI(t *testing.T) {
"api object with version": {&MyAPIObject{TypeMeta: runtime.TypeMeta{ResourceVersion: "1"}}, "1"},
"pointer to api object with version": {&MyAPIObject{TypeMeta: runtime.TypeMeta{ResourceVersion: "1"}}, "1"},
}
versioning := NewResourceVersioner()
versioning := NewAccessor()
for key, testCase := range testCases {
actual, err := versioning.ResourceVersion(testCase.Object)
if err != nil {
@@ -328,7 +471,7 @@ func TestTypeMetaSelfLinker(t *testing.T) {
},
}
linker := NewSelfLinker()
var linker runtime.SelfLinker = NewAccessor()
for name, item := range table {
got, err := linker.SelfLink(item.obj)
if e, a := item.succeed, err == nil; e != a {