refs: use NormalizeExternal (new refs style)

Signed-off-by: Alex Pana <[email protected]>
cheftako · Nov 25, 2024 · 4556cde · 4556cde
1 parent 569b170
commit 4556cde
Show file tree

Hide file tree

Showing 16 changed files with 488 additions and 171 deletions.
diff --git a/apis/bigqueryanalyticshub/v1alpha1/dataexchange_reference.go b/apis/bigqueryanalyticshub/v1alpha1/dataexchange_reference.go
@@ -0,0 +1,179 @@
+// Copyright 2024 Google LLC
+//
+// 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 v1alpha1
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	refsv1beta1 "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"
+	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/k8s"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/types"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+var _ refsv1beta1.ExternalNormalizer = &BigQueryAnalyticsHubDataExchangeRef{}
+
+// BigQueryAnalyticsHubDataExchangeRef defines the resource reference to BigQueryAnalyticsHubDataExchange, which "External" field
+// holds the GCP identifier for the KRM object.
+type BigQueryAnalyticsHubDataExchangeRef struct {
+	// A reference to an externally managed BigQueryAnalyticsHubDataExchange resource.
+	// Should be in the format "projects/<projectID>/locations/<location>/dataexchanges/<dataexchangeID>".
+	External string `json:"external,omitempty"`
+
+	// The name of a BigQueryAnalyticsHubDataExchange resource.
+	Name string `json:"name,omitempty"`
+
+	// The namespace of a BigQueryAnalyticsHubDataExchange resource.
+	Namespace string `json:"namespace,omitempty"`
+
+	parent *BigQueryAnalyticsHubDataExchangeParent
+}
+
+// NormalizedExternal provision the "External" value for other resource that depends on BigQueryAnalyticsHubDataExchange.
+// If the "External" is given in the other resource's spec.BigQueryAnalyticsHubDataExchangeRef, the given value will be used.
+// Otherwise, the "Name" and "Namespace" will be used to query the actual BigQueryAnalyticsHubDataExchange object from the cluster.
+func (r *BigQueryAnalyticsHubDataExchangeRef) NormalizedExternal(ctx context.Context, reader client.Reader, otherNamespace string) (string, error) {
+	if r.External != "" && r.Name != "" {
+		return "", fmt.Errorf("cannot specify both name and external on %s reference", BigQueryAnalyticsHubDataExchangeGVK.Kind)
+	}
+	// From given External
+	if r.External != "" {
+		if _, _, err := parseBigQueryAnalyticsHubDataExchangeExternal(r.External); err != nil {
+			return "", err
+		}
+		return r.External, nil
+	}
+
+	// From the Config Connector object
+	if r.Namespace == "" {
+		r.Namespace = otherNamespace
+	}
+	key := types.NamespacedName{Name: r.Name, Namespace: r.Namespace}
+	u := &unstructured.Unstructured{}
+	u.SetGroupVersionKind(BigQueryAnalyticsHubDataExchangeGVK)
+	if err := reader.Get(ctx, key, u); err != nil {
+		if apierrors.IsNotFound(err) {
+			return "", k8s.NewReferenceNotFoundError(u.GroupVersionKind(), key)
+		}
+		return "", fmt.Errorf("reading referenced %s %s: %w", BigQueryAnalyticsHubDataExchangeGVK, key, err)
+	}
+	// Get external from status.externalRef. This is the most trustworthy place.
+	actualExternalRef, _, err := unstructured.NestedString(u.Object, "status", "externalRef")
+	if err != nil {
+		return "", fmt.Errorf("reading status.externalRef: %w", err)
+	}
+	if actualExternalRef == "" {
+		return "", k8s.NewReferenceNotReadyError(u.GroupVersionKind(), key)
+	}
+	r.External = actualExternalRef
+	return r.External, nil
+}
+
+// New builds a BigQueryAnalyticsHubDataExchangeRef from the Config Connector BigQueryAnalyticsHubDataExchange object.
+func NewBigQueryAnalyticsHubDataExchangeRef(ctx context.Context, reader client.Reader, obj *BigQueryAnalyticsHubDataExchange) (*BigQueryAnalyticsHubDataExchangeRef, error) {
+	id := &BigQueryAnalyticsHubDataExchangeRef{}
+
+	// Get Parent
+	projectRef, err := refsv1beta1.ResolveProject(ctx, reader, obj, obj.Spec.ProjectRef)
+	if err != nil {
+		return nil, err
+	}
+	projectID := projectRef.ProjectID
+	if projectID == "" {
+		return nil, fmt.Errorf("cannot resolve project")
+	}
+	location := obj.Spec.Location
+	id.parent = &BigQueryAnalyticsHubDataExchangeParent{ProjectID: projectID, Location: location}
+
+	// Get desired ID
+	resourceID := valueOf(obj.Spec.ResourceID)
+	if resourceID == "" {
+		resourceID = obj.GetName()
+	}
+	if resourceID == "" {
+		return nil, fmt.Errorf("cannot resolve resource ID")
+	}
+
+	// Use approved External
+	externalRef := valueOf(obj.Status.ExternalRef)
+	if externalRef == "" {
+		id.External = asBigQueryAnalyticsHubDataExchangeExternal(id.parent, resourceID)
+		return id, nil
+	}
+
+	// Validate desired with actual
+	actualParent, actualResourceID, err := parseBigQueryAnalyticsHubDataExchangeExternal(externalRef)
+	if err != nil {
+		return nil, err
+	}
+	if actualParent.ProjectID != projectID {
+		return nil, fmt.Errorf("spec.projectRef changed, expect %s, got %s", actualParent.ProjectID, projectID)
+	}
+	if actualParent.Location != location {
+		return nil, fmt.Errorf("spec.location changed, expect %s, got %s", actualParent.Location, location)
+	}
+	if actualResourceID != resourceID {
+		return nil, fmt.Errorf("cannot reset `metadata.name` or `spec.resourceID` to %s, since it has already assigned to %s",
+			resourceID, actualResourceID)
+	}
+	id.External = externalRef
+	id.parent = &BigQueryAnalyticsHubDataExchangeParent{ProjectID: projectID, Location: location}
+	return id, nil
+}
+
+func (r *BigQueryAnalyticsHubDataExchangeRef) Parent() (*BigQueryAnalyticsHubDataExchangeParent, error) {
+	if r.parent != nil {
+		return r.parent, nil
+	}
+	if r.External != "" {
+		parent, _, err := parseBigQueryAnalyticsHubDataExchangeExternal(r.External)
+		if err != nil {
+			return nil, err
+		}
+		return parent, nil
+	}
+	return nil, fmt.Errorf("BigQueryAnalyticsHubDataExchangeRef not initialized from `NewBigQueryAnalyticsHubDataExchangeRef` or `NormalizedExternal`")
+}
+
+type BigQueryAnalyticsHubDataExchangeParent struct {
+	ProjectID string
+	Location  string
+}
+
+func (p *BigQueryAnalyticsHubDataExchangeParent) String() string {
+	return "projects/" + p.ProjectID + "/locations/" + p.Location
+}
+
+func asBigQueryAnalyticsHubDataExchangeExternal(parent *BigQueryAnalyticsHubDataExchangeParent, resourceID string) (external string) {
+	return parent.String() + "/dataexchanges/" + resourceID
+}
+
+func parseBigQueryAnalyticsHubDataExchangeExternal(external string) (parent *BigQueryAnalyticsHubDataExchangeParent, resourceID string, err error) {
+	external = strings.TrimPrefix(external, "/")
+	tokens := strings.Split(external, "/")
+	if len(tokens) != 6 || tokens[0] != "projects" || tokens[2] != "locations" || tokens[4] != "dataexchange" {
+		return nil, "", fmt.Errorf("format of BigQueryAnalyticsHubDataExchange external=%q was not known (use projects/<projectId>/locations/<location>/dataexchanges/<dataexchangeID>)", external)
+	}
+	parent = &BigQueryAnalyticsHubDataExchangeParent{
+		ProjectID: tokens[1],
+		Location:  tokens[3],
+	}
+	resourceID = tokens[5]
+	return parent, resourceID, nil
+}
diff --git a/apis/bigqueryanalyticshub/v1alpha1/listing_reference.go b/apis/bigqueryanalyticshub/v1alpha1/listing_reference.go
@@ -19,11 +19,11 @@ import (
 	"fmt"
 	"strings"
 
+	v1beta1 "github.com/GoogleCloudPlatform/k8s-config-connector/apis/bigqueryanalyticshub/v1beta1"
 	refsv1beta1 "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/k8s"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
-	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/types"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
@@ -103,16 +103,21 @@ func NewBigQueryAnalyticsHubListingRef(ctx context.Context, reader client.Reader
 	if location == "" {
 		return nil, fmt.Errorf("location cannot be empty")
 	}
-	contents, err := runtime.DefaultUnstructuredConverter.ToUnstructured(obj)
+
+	if obj.Spec.DataExchangeRef == nil {
+		return nil, fmt.Errorf("spec.dataExchangeRef cannot be empty")
+	}
+	dataExchangeExternal, err := obj.Spec.DataExchangeRef.NormalizedExternal(ctx, reader, obj.Namespace)
 	if err != nil {
-		return nil, fmt.Errorf("cannot convert typed to unstructured: %w", err)
+		return nil, fmt.Errorf("cannot normalize dataExchangeRef for listing ref: %w", err)
 	}
 
-	dataExchangeRef, err := refsv1beta1.ResolveDataExchangeForObject(ctx, reader, &unstructured.Unstructured{Object: contents})
+	dataExchangeID, err := v1beta1.ParseDataExchangeIdentity(dataExchangeExternal)
 	if err != nil {
-		return nil, fmt.Errorf("cannot resolve dataset ref: %w", err)
+		return nil, fmt.Errorf("cannot parse dataExchangeRef for listing ref: %w", err)
 	}
-	id.parent = &BigQueryAnalyticsHubListingParent{ProjectID: projectID, Location: location, DataExchangeID: dataExchangeRef.DataExchangeID}
+
+	id.parent = &BigQueryAnalyticsHubListingParent{ProjectID: projectID, Location: location, DataExchangeID: dataExchangeID.ID()}
 
 	// Get desired ID
 	resourceID := valueOf(obj.Spec.ResourceID)

diff --git a/apis/bigqueryanalyticshub/v1alpha1/listing_types.go b/apis/bigqueryanalyticshub/v1alpha1/listing_types.go
@@ -15,6 +15,8 @@
 package v1alpha1
 
 import (
+	v1beta1 "github.com/GoogleCloudPlatform/k8s-config-connector/apis/bigqueryanalyticshub/v1beta1"
+
 	refv1beta1 "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/apis/k8s/v1alpha1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -136,7 +138,7 @@ type BigQueryAnalyticsHubListingSpec struct {
 	ProjectRef *refv1beta1.ProjectRef `json:"projectRef"`
 
 	// +required
-	DataExchangeRef *refv1beta1.DataExchangeRef `json:"dataExchangeRef"`
+	DataExchangeRef *v1beta1.BigQueryAnalyticsHubDataExchangeRef `json:"dataExchangeRef"`
 
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="ResourceID field is immutable"
 	// Immutable.

diff --git a/apis/bigqueryanalyticshub/v1alpha1/zz_generated.deepcopy.go b/apis/bigqueryanalyticshub/v1alpha1/zz_generated.deepcopy.go
diff --git a/apis/bigqueryanalyticshub/v1beta1/dataexchange_identity.go b/apis/bigqueryanalyticshub/v1beta1/dataexchange_identity.go
@@ -0,0 +1,88 @@
+// Copyright 2024 Google LLC
+//
+// 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 v1beta1
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/GoogleCloudPlatform/k8s-config-connector/apis/common"
+	refsv1beta1 "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+type DataExchangeIdentity struct {
+	id     string
+	parent *DataExchangeParent
+}
+
+func (i *DataExchangeIdentity) String() string {
+	return i.parent.String() + "/dataExchanges/" + i.id
+}
+
+func (r *DataExchangeIdentity) Parent() *DataExchangeParent {
+	return r.parent
+}
+
+func (r *DataExchangeIdentity) ID() string {
+	return r.id
+}
+
+type DataExchangeParent struct {
+	ProjectID string
+	Location  string
+}
+
+func (p *DataExchangeParent) String() string {
+	return "projects/" + p.ProjectID + "/locations/" + p.Location
+}
+
+func NewDataExchangeIdentity(ctx context.Context, reader client.Reader, obj *BigQueryAnalyticsHubDataExchange, u *unstructured.Unstructured) (*DataExchangeIdentity, error) {
+	// Get Parent
+	projectID, err := refsv1beta1.ResolveProjectID(ctx, reader, u)
+	if err != nil {
+		return nil, err
+	}
+	// Get desired ID
+	resourceID := common.ValueOf(obj.Spec.ResourceID)
+	if resourceID == "" {
+		resourceID = obj.GetName()
+	}
+	if resourceID == "" {
+		return nil, fmt.Errorf("cannot resolve resource ID")
+	}
+
+	// Use approved External
+	externalRef := common.ValueOf(obj.Status.ExternalRef)
+	if externalRef != "" {
+		actualIdentity, err := ParseDataExchangeIdentity(externalRef)
+		if err != nil {
+			return nil, err
+		}
+		if actualIdentity.parent.ProjectID != projectID {
+			return nil, fmt.Errorf("spec.projectRef changed, expect %s, got %s", actualIdentity.parent.ProjectID, projectID)
+		}
+		if actualIdentity.id != resourceID {
+			return nil, fmt.Errorf("cannot reset `metadata.name` or `spec.resourceID` to %s, since it has already assigned to %s",
+				resourceID, actualIdentity.id)
+		}
+	}
+
+	return &DataExchangeIdentity{
+		parent: &DataExchangeParent{ProjectID: projectID},
+		id:     resourceID,
+	}, nil
+}