Merge pull request #786 from turkenh/fix-unknown-fields

turkenh · web-flow · commit 19d95a69cc03 · 2024-11-05T10:14:56.000+03:00
Fix unknown fields warnings and possibility to suppress finalizer ones
diff --git a/pkg/resource/fake/mocks.go b/pkg/resource/fake/mocks.go
@@ -35,7 +35,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/manager"
 
 	xpv1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
-	"github.com/crossplane/crossplane-runtime/pkg/resource/unstructured/claim"
+	"github.com/crossplane/crossplane-runtime/pkg/resource/unstructured/reference"
 )
 
 // Conditioned is a mock that implements Conditioned interface.
@@ -50,13 +50,13 @@ func (m *Conditioned) GetCondition(ct xpv1.ConditionType) xpv1.Condition {
 }
 
 // ClaimReferencer is a mock that implements ClaimReferencer interface.
-type ClaimReferencer struct{ Ref *claim.Reference }
+type ClaimReferencer struct{ Ref *reference.Claim }
 
 // SetClaimReference sets the ClaimReference.
-func (m *ClaimReferencer) SetClaimReference(r *claim.Reference) { m.Ref = r }
+func (m *ClaimReferencer) SetClaimReference(r *reference.Claim) { m.Ref = r }
 
 // GetClaimReference gets the ClaimReference.
-func (m *ClaimReferencer) GetClaimReference() *claim.Reference { return m.Ref }
+func (m *ClaimReferencer) GetClaimReference() *reference.Claim { return m.Ref }
 
 // ManagedResourceReferencer is a mock that implements ManagedResourceReferencer interface.
 type ManagedResourceReferencer struct{ Ref *corev1.ObjectReference }
@@ -184,15 +184,15 @@ func (m *CompositionSelector) SetCompositionSelector(s *metav1.LabelSelector) {
 func (m *CompositionSelector) GetCompositionSelector() *metav1.LabelSelector { return m.Sel }
 
 // CompositionRevisionReferencer is a mock that implements CompositionRevisionReferencer interface.
-type CompositionRevisionReferencer struct{ Ref *corev1.ObjectReference }
+type CompositionRevisionReferencer struct{ Ref *corev1.LocalObjectReference }
 
 // SetCompositionRevisionReference sets the CompositionRevisionReference.
-func (m *CompositionRevisionReferencer) SetCompositionRevisionReference(r *corev1.ObjectReference) {
+func (m *CompositionRevisionReferencer) SetCompositionRevisionReference(r *corev1.LocalObjectReference) {
 	m.Ref = r
 }
 
 // GetCompositionRevisionReference gets the CompositionRevisionReference.
-func (m *CompositionRevisionReferencer) GetCompositionRevisionReference() *corev1.ObjectReference {
+func (m *CompositionRevisionReferencer) GetCompositionRevisionReference() *corev1.LocalObjectReference {
 	return m.Ref
 }
 
@@ -236,13 +236,13 @@ func (m *CompositeResourceDeleter) GetCompositeDeletePolicy() *xpv1.CompositeDel
 }
 
 // CompositeResourceReferencer is a mock that implements CompositeResourceReferencer interface.
-type CompositeResourceReferencer struct{ Ref *corev1.ObjectReference }
+type CompositeResourceReferencer struct{ Ref *reference.Composite }
 
 // SetResourceReference sets the composite resource reference.
-func (m *CompositeResourceReferencer) SetResourceReference(p *corev1.ObjectReference) { m.Ref = p }
+func (m *CompositeResourceReferencer) SetResourceReference(p *reference.Composite) { m.Ref = p }
 
 // GetResourceReference gets the composite resource reference.
-func (m *CompositeResourceReferencer) GetResourceReference() *corev1.ObjectReference { return m.Ref }
+func (m *CompositeResourceReferencer) GetResourceReference() *reference.Composite { return m.Ref }
 
 // ComposedResourcesReferencer is a mock that implements ComposedResourcesReferencer interface.
 type ComposedResourcesReferencer struct{ Refs []corev1.ObjectReference }
diff --git a/pkg/resource/interfaces.go b/pkg/resource/interfaces.go
@@ -25,7 +25,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	xpv1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
-	"github.com/crossplane/crossplane-runtime/pkg/resource/unstructured/claim"
+	"github.com/crossplane/crossplane-runtime/pkg/resource/unstructured/reference"
 )
 
 // A Conditioned may have conditions set or retrieved. Conditions are typically
@@ -37,8 +37,8 @@ type Conditioned interface {
 
 // A ClaimReferencer may reference a resource claim.
 type ClaimReferencer interface {
-	SetClaimReference(r *claim.Reference)
-	GetClaimReference() *claim.Reference
+	SetClaimReference(r *reference.Claim)
+	GetClaimReference() *reference.Claim
 }
 
 // A ManagedResourceReferencer may reference a concrete managed resource.
@@ -120,8 +120,8 @@ type CompositionReferencer interface {
 // A CompositionRevisionReferencer may reference a specific revision of a
 // composition of resources.
 type CompositionRevisionReferencer interface {
-	SetCompositionRevisionReference(ref *corev1.ObjectReference)
-	GetCompositionRevisionReference() *corev1.ObjectReference
+	SetCompositionRevisionReference(ref *corev1.LocalObjectReference)
+	GetCompositionRevisionReference() *corev1.LocalObjectReference
 }
 
 // A CompositionRevisionSelector may reference a set of
@@ -153,8 +153,8 @@ type ComposedResourcesReferencer interface {
 
 // A CompositeResourceReferencer can reference a composite resource.
 type CompositeResourceReferencer interface {
-	SetResourceReference(r *corev1.ObjectReference)
-	GetResourceReference() *corev1.ObjectReference
+	SetResourceReference(r *reference.Composite)
+	GetResourceReference() *reference.Composite
 }
 
 // An EnvironmentConfigReferencer references a list of EnvironmentConfigs.
diff --git a/pkg/resource/unstructured/claim/claim.go b/pkg/resource/unstructured/claim/claim.go
@@ -25,6 +25,7 @@ import (
 
 	xpv1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
 	"github.com/crossplane/crossplane-runtime/pkg/fieldpath"
+	"github.com/crossplane/crossplane-runtime/pkg/resource/unstructured/reference"
 )
 
 // An Option modifies an unstructured composite resource claim.
@@ -63,21 +64,6 @@ type Unstructured struct {
 	unstructured.Unstructured
 }
 
-// Reference to a claim.
-type Reference struct {
-	// APIVersion of the referenced claim.
-	APIVersion string `json:"apiVersion"`
-
-	// Kind of the referenced claim.
-	Kind string `json:"kind"`
-
-	// Name of the referenced claim.
-	Name string `json:"name"`
-
-	// Namespace of the referenced claim.
-	Namespace string `json:"namespace"`
-}
-
 // GetUnstructured returns the underlying *unstructured.Unstructured.
 func (c *Unstructured) GetUnstructured() *unstructured.Unstructured {
 	return &c.Unstructured
@@ -112,16 +98,16 @@ func (c *Unstructured) SetCompositionReference(ref *corev1.ObjectReference) {
 }
 
 // GetCompositionRevisionReference of this resource claim.
-func (c *Unstructured) GetCompositionRevisionReference() *corev1.ObjectReference {
-	out := &corev1.ObjectReference{}
+func (c *Unstructured) GetCompositionRevisionReference() *corev1.LocalObjectReference {
+	out := &corev1.LocalObjectReference{}
 	if err := fieldpath.Pave(c.Object).GetValueInto("spec.compositionRevisionRef", out); err != nil {
 		return nil
 	}
 	return out
 }
 
 // SetCompositionRevisionReference of this resource claim.
-func (c *Unstructured) SetCompositionRevisionReference(ref *corev1.ObjectReference) {
+func (c *Unstructured) SetCompositionRevisionReference(ref *corev1.LocalObjectReference) {
 	_ = fieldpath.Pave(c.Object).SetValue("spec.compositionRevisionRef", ref)
 }
 
@@ -170,22 +156,22 @@ func (c *Unstructured) GetCompositeDeletePolicy() *xpv1.CompositeDeletePolicy {
 }
 
 // GetResourceReference of this composite resource claim.
-func (c *Unstructured) GetResourceReference() *corev1.ObjectReference {
-	out := &corev1.ObjectReference{}
+func (c *Unstructured) GetResourceReference() *reference.Composite {
+	out := &reference.Composite{}
 	if err := fieldpath.Pave(c.Object).GetValueInto("spec.resourceRef", out); err != nil {
 		return nil
 	}
 	return out
 }
 
 // SetResourceReference of this composite resource claim.
-func (c *Unstructured) SetResourceReference(ref *corev1.ObjectReference) {
+func (c *Unstructured) SetResourceReference(ref *reference.Composite) {
 	_ = fieldpath.Pave(c.Object).SetValue("spec.resourceRef", ref)
 }
 
 // GetReference returns reference to this claim.
-func (c *Unstructured) GetReference() *Reference {
-	return &Reference{
+func (c *Unstructured) GetReference() *reference.Claim {
+	return &reference.Claim{
 		APIVersion: c.GetAPIVersion(),
 		Kind:       c.GetKind(),
 		Name:       c.GetName(),
diff --git a/pkg/resource/unstructured/claim/claim_test.go b/pkg/resource/unstructured/claim/claim_test.go
@@ -29,6 +29,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	xpv1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
+	"github.com/crossplane/crossplane-runtime/pkg/resource/unstructured/reference"
 )
 
 var _ client.Object = &Unstructured{}
@@ -172,11 +173,11 @@ func TestCompositionReference(t *testing.T) {
 }
 
 func TestCompositionRevisionReference(t *testing.T) {
-	ref := &corev1.ObjectReference{Namespace: "ns", Name: "cool"}
+	ref := &corev1.LocalObjectReference{Name: "cool"}
 	cases := map[string]struct {
 		u    *Unstructured
-		set  *corev1.ObjectReference
-		want *corev1.ObjectReference
+		set  *corev1.LocalObjectReference
+		want *corev1.LocalObjectReference
 	}{
 		"NewRef": {
 			u:    New(),
@@ -272,11 +273,11 @@ func TestCompositeDeletePolicy(t *testing.T) {
 }
 
 func TestResourceReference(t *testing.T) {
-	ref := &corev1.ObjectReference{Namespace: "ns", Name: "cool"}
+	ref := &reference.Composite{Name: "cool"}
 	cases := map[string]struct {
 		u    *Unstructured
-		set  *corev1.ObjectReference
-		want *corev1.ObjectReference
+		set  *reference.Composite
+		want *reference.Composite
 	}{
 		"NewRef": {
 			u:    New(),
@@ -297,7 +298,7 @@ func TestResourceReference(t *testing.T) {
 }
 
 func TestClaimReference(t *testing.T) {
-	ref := &Reference{Namespace: "ns", Name: "cool", APIVersion: "foo.com/v1", Kind: "Foo"}
+	ref := &reference.Claim{Namespace: "ns", Name: "cool", APIVersion: "foo.com/v1", Kind: "Foo"}
 	u := &Unstructured{}
 	u.SetName(ref.Name)
 	u.SetNamespace(ref.Namespace)
diff --git a/pkg/resource/unstructured/composite/composite.go b/pkg/resource/unstructured/composite/composite.go
@@ -26,7 +26,7 @@ import (
 	xpv1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
 	"github.com/crossplane/crossplane-runtime/pkg/errors"
 	"github.com/crossplane/crossplane-runtime/pkg/fieldpath"
-	"github.com/crossplane/crossplane-runtime/pkg/resource/unstructured/claim"
+	"github.com/crossplane/crossplane-runtime/pkg/resource/unstructured/reference"
 )
 
 // An Option modifies an unstructured composite resource.
@@ -99,16 +99,16 @@ func (c *Unstructured) SetCompositionReference(ref *corev1.ObjectReference) {
 }
 
 // GetCompositionRevisionReference of this Composite resource.
-func (c *Unstructured) GetCompositionRevisionReference() *corev1.ObjectReference {
-	out := &corev1.ObjectReference{}
+func (c *Unstructured) GetCompositionRevisionReference() *corev1.LocalObjectReference {
+	out := &corev1.LocalObjectReference{}
 	if err := fieldpath.Pave(c.Object).GetValueInto("spec.compositionRevisionRef", out); err != nil {
 		return nil
 	}
 	return out
 }
 
 // SetCompositionRevisionReference of this Composite resource.
-func (c *Unstructured) SetCompositionRevisionReference(ref *corev1.ObjectReference) {
+func (c *Unstructured) SetCompositionRevisionReference(ref *corev1.LocalObjectReference) {
 	_ = fieldpath.Pave(c.Object).SetValue("spec.compositionRevisionRef", ref)
 }
 
@@ -142,16 +142,16 @@ func (c *Unstructured) GetCompositionUpdatePolicy() *xpv1.UpdatePolicy {
 }
 
 // GetClaimReference of this Composite resource.
-func (c *Unstructured) GetClaimReference() *claim.Reference {
-	out := &claim.Reference{}
+func (c *Unstructured) GetClaimReference() *reference.Claim {
+	out := &reference.Claim{}
 	if err := fieldpath.Pave(c.Object).GetValueInto("spec.claimRef", out); err != nil {
 		return nil
 	}
 	return out
 }
 
 // SetClaimReference of this Composite resource.
-func (c *Unstructured) SetClaimReference(ref *claim.Reference) {
+func (c *Unstructured) SetClaimReference(ref *reference.Claim) {
 	_ = fieldpath.Pave(c.Object).SetValue("spec.claimRef", ref)
 }
 
@@ -177,6 +177,15 @@ func (c *Unstructured) SetResourceReferences(refs []corev1.ObjectReference) {
 	_ = fieldpath.Pave(c.Object).SetValue("spec.resourceRefs", filtered)
 }
 
+// GetReference returns reference to this composite.
+func (c *Unstructured) GetReference() *reference.Composite {
+	return &reference.Composite{
+		APIVersion: c.GetAPIVersion(),
+		Kind:       c.GetKind(),
+		Name:       c.GetName(),
+	}
+}
+
 // GetWriteConnectionSecretToReference of this Composite resource.
 func (c *Unstructured) GetWriteConnectionSecretToReference() *xpv1.SecretReference {
 	out := &xpv1.SecretReference{}
diff --git a/pkg/resource/unstructured/composite/composite_test.go b/pkg/resource/unstructured/composite/composite_test.go
@@ -30,7 +30,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	xpv1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
-	"github.com/crossplane/crossplane-runtime/pkg/resource/unstructured/claim"
+	"github.com/crossplane/crossplane-runtime/pkg/resource/unstructured/reference"
 	"github.com/crossplane/crossplane-runtime/pkg/test"
 )
 
@@ -259,11 +259,11 @@ func TestCompositionReference(t *testing.T) {
 }
 
 func TestCompositionRevisionReference(t *testing.T) {
-	ref := &corev1.ObjectReference{Namespace: "ns", Name: "cool"}
+	ref := &corev1.LocalObjectReference{Name: "cool"}
 	cases := map[string]struct {
 		u    *Unstructured
-		set  *corev1.ObjectReference
-		want *corev1.ObjectReference
+		set  *corev1.LocalObjectReference
+		want *corev1.LocalObjectReference
 	}{
 		"NewRef": {
 			u:    New(),
@@ -334,11 +334,11 @@ func TestCompositionUpdatePolicy(t *testing.T) {
 }
 
 func TestClaimReference(t *testing.T) {
-	ref := &claim.Reference{Namespace: "ns", Name: "cool", APIVersion: "acme.com/v1", Kind: "Foo"}
+	ref := &reference.Claim{Namespace: "ns", Name: "cool", APIVersion: "acme.com/v1", Kind: "Foo"}
 	cases := map[string]struct {
 		u    *Unstructured
-		set  *claim.Reference
-		want *claim.Reference
+		set  *reference.Claim
+		want *reference.Claim
 	}{
 		"NewRef": {
 			u:    New(),
diff --git a/pkg/resource/unstructured/reference/reference.go b/pkg/resource/unstructured/reference/reference.go
@@ -0,0 +1,59 @@
+/*
+Copyright 2024 The Crossplane 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 reference contains references to resources.
+package reference
+
+import (
+	"k8s.io/apimachinery/pkg/runtime/schema"
+)
+
+// A Claim is a reference to a claim.
+type Claim struct {
+	// APIVersion of the referenced claim.
+	APIVersion string `json:"apiVersion"`
+
+	// Kind of the referenced claim.
+	Kind string `json:"kind"`
+
+	// Name of the referenced claim.
+	Name string `json:"name"`
+
+	// Namespace of the referenced claim.
+	Namespace string `json:"namespace"`
+}
+
+// A Composite is a reference to a composite.
+type Composite struct {
+	// APIVersion of the referenced composite.
+	APIVersion string `json:"apiVersion"`
+
+	// Kind of the referenced composite.
+	Kind string `json:"kind"`
+
+	// Name of the referenced composite.
+	Name string `json:"name"`
+}
+
+// GroupVersionKind returns the GroupVersionKind of the claim reference.
+func (c *Claim) GroupVersionKind() schema.GroupVersionKind {
+	return schema.FromAPIVersionAndKind(c.APIVersion, c.Kind)
+}
+
+// GroupVersionKind returns the GroupVersionKind of the composite reference.
+func (c *Composite) GroupVersionKind() schema.GroupVersionKind {
+	return schema.FromAPIVersionAndKind(c.APIVersion, c.Kind)
+}

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ import (`
`26`	`26`	`xpv1 "github.com/crossplane/crossplane-runtime/apis/common/v1"`
`27`	`27`	`"github.com/crossplane/crossplane-runtime/pkg/errors"`
`28`	`28`	`"github.com/crossplane/crossplane-runtime/pkg/fieldpath"`
`29`		`- "github.com/crossplane/crossplane-runtime/pkg/resource/unstructured/claim"`
	`29`	`+ "github.com/crossplane/crossplane-runtime/pkg/resource/unstructured/reference"`
`30`	`30`	`)`
`31`	`31`
`32`	`32`	`// An Option modifies an unstructured composite resource.`
`@@ -99,16 +99,16 @@ func (c Unstructured) SetCompositionReference(ref corev1.ObjectReference) {`
`99`	`99`	`}`
`100`	`100`
`101`	`101`	`// GetCompositionRevisionReference of this Composite resource.`
`102`		`-func (c Unstructured) GetCompositionRevisionReference() corev1.ObjectReference {`
`103`		`- out := &corev1.ObjectReference{}`
	`102`	`+func (c Unstructured) GetCompositionRevisionReference() corev1.LocalObjectReference {`
	`103`	`+ out := &corev1.LocalObjectReference{}`
`104`	`104`	`if err := fieldpath.Pave(c.Object).GetValueInto("spec.compositionRevisionRef", out); err != nil {`
`105`	`105`	`return nil`
`106`	`106`	`}`
`107`	`107`	`return out`
`108`	`108`	`}`
`109`	`109`
`110`	`110`	`// SetCompositionRevisionReference of this Composite resource.`
`111`		`-func (c Unstructured) SetCompositionRevisionReference(ref corev1.ObjectReference) {`
	`111`	`+func (c Unstructured) SetCompositionRevisionReference(ref corev1.LocalObjectReference) {`
`112`	`112`	`_ = fieldpath.Pave(c.Object).SetValue("spec.compositionRevisionRef", ref)`
`113`	`113`	`}`
`114`	`114`
`@@ -142,16 +142,16 @@ func (c Unstructured) GetCompositionUpdatePolicy() xpv1.UpdatePolicy {`
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`// GetClaimReference of this Composite resource.`
`145`		`-func (c Unstructured) GetClaimReference() claim.Reference {`
`146`		`- out := &claim.Reference{}`
	`145`	`+func (c Unstructured) GetClaimReference() reference.Claim {`
	`146`	`+ out := &reference.Claim{}`
`147`	`147`	`if err := fieldpath.Pave(c.Object).GetValueInto("spec.claimRef", out); err != nil {`
`148`	`148`	`return nil`
`149`	`149`	`}`
`150`	`150`	`return out`
`151`	`151`	`}`
`152`	`152`
`153`	`153`	`// SetClaimReference of this Composite resource.`
`154`		`-func (c Unstructured) SetClaimReference(ref claim.Reference) {`
	`154`	`+func (c Unstructured) SetClaimReference(ref reference.Claim) {`
`155`	`155`	`_ = fieldpath.Pave(c.Object).SetValue("spec.claimRef", ref)`
`156`	`156`	`}`
`157`	`157`
`@@ -177,6 +177,15 @@ func (c *Unstructured) SetResourceReferences(refs []corev1.ObjectReference) {`
`177`	`177`	`_ = fieldpath.Pave(c.Object).SetValue("spec.resourceRefs", filtered)`
`178`	`178`	`}`
`179`	`179`
	`180`	`+// GetReference returns reference to this composite.`
	`181`	`+func (c Unstructured) GetReference() reference.Composite {`
	`182`	`+ return &reference.Composite{`
	`183`	`+ APIVersion: c.GetAPIVersion(),`
	`184`	`+ Kind: c.GetKind(),`
	`185`	`+ Name: c.GetName(),`
	`186`	`+ }`
	`187`	`+}`
	`188`	`+`
`180`	`189`	`// GetWriteConnectionSecretToReference of this Composite resource.`
`181`	`190`	`func (c Unstructured) GetWriteConnectionSecretToReference() xpv1.SecretReference {`
`182`	`191`	`out := &xpv1.SecretReference{}`