-
Notifications
You must be signed in to change notification settings - Fork 242
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add fuzz test, promote ApigeeInstance to v1beta1
- Loading branch information
1 parent
44aceab
commit 43a5bde
Showing
33 changed files
with
1,584 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| // 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" | ||
| "strings" | ||
|
|
||
| "github.com/GoogleCloudPlatform/k8s-config-connector/apis/common" | ||
| refs "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| ) | ||
|
|
||
| // InstanceIdentity defines the resource reference to ApigeeInstance, which "External" field | ||
| // holds the GCP identifier for the KRM object. | ||
| type InstanceIdentity struct { | ||
| parent *InstanceParent | ||
| id string | ||
| } | ||
|
|
||
| func (i *InstanceIdentity) String() string { | ||
| return i.parent.String() + "/instances/" + i.id | ||
| } | ||
|
|
||
| func (i *InstanceIdentity) ID() string { | ||
| return i.id | ||
| } | ||
|
|
||
| func (i *InstanceIdentity) Parent() *InstanceParent { | ||
| return i.parent | ||
| } | ||
|
|
||
| type InstanceParent struct { | ||
| OrganizationID string | ||
| } | ||
|
|
||
| func (p *InstanceParent) String() string { | ||
| return "organizations/" + p.OrganizationID | ||
| } | ||
|
|
||
| // New builds a InstanceIdentity from the Config Connector Instance object. | ||
| func NewApigeeInstanceIdentity(ctx context.Context, reader client.Reader, obj *ApigeeInstance) (*InstanceIdentity, error) { | ||
|
|
||
| // Get Parent | ||
| orgExternal, err := obj.Spec.OrganizationRef.NormalizedExternal(ctx, reader, obj.GetNamespace()) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if orgExternal == "" { | ||
| return nil, fmt.Errorf("cannot resolve organization") | ||
| } | ||
| orgID, err := refs.ParseApigeeOrganizationExternal(orgExternal) | ||
| 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 != "" { | ||
| // Validate desired with actual | ||
| actualParent, actualResourceID, err := ParseInstanceExternal(externalRef) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if actualParent.OrganizationID != orgID { | ||
| return nil, fmt.Errorf("spec.organizationRef changed, expect %s, got %s", actualParent.OrganizationID, orgID) | ||
| } | ||
| 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) | ||
| } | ||
| } | ||
| return &InstanceIdentity{ | ||
| parent: &InstanceParent{ | ||
| OrganizationID: orgID, | ||
| }, | ||
| id: resourceID, | ||
| }, nil | ||
| } | ||
|
|
||
| func ParseInstanceExternal(external string) (parent *InstanceParent, resourceID string, err error) { | ||
| tokens := strings.Split(external, "/") | ||
| if len(tokens) != 4 || tokens[0] != "organizations" || tokens[2] != "instances" { | ||
| return nil, "", fmt.Errorf("format of ApigeeInstance external=%q was not known (use organizations/{{organizationID}}/instances/{{instanceID}})", external) | ||
| } | ||
| parent = &InstanceParent{ | ||
| OrganizationID: tokens[1], | ||
| } | ||
| resourceID = tokens[3] | ||
| return parent, resourceID, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| // 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" | ||
|
|
||
| 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 = &InstanceRef{} | ||
|
|
||
| // InstanceRef defines the resource reference to ApigeeInstance, which "External" field | ||
| // holds the GCP identifier for the KRM object. | ||
| type InstanceRef struct { | ||
| // A reference to an externally managed ApigeeInstance resource. | ||
| // Should be in the format "organizations/{{organizationID}}/instances/{{instanceID}}". | ||
| External string `json:"external,omitempty"` | ||
|
|
||
| // The name of a ApigeeInstance resource. | ||
| Name string `json:"name,omitempty"` | ||
|
|
||
| // The namespace of a ApigeeInstance resource. | ||
| Namespace string `json:"namespace,omitempty"` | ||
| } | ||
|
|
||
| // NormalizedExternal provision the "External" value for other resource that depends on ApigeeInstance. | ||
| // If the "External" is given in the other resource's spec.ApigeeInstanceRef, the given value will be used. | ||
| // Otherwise, the "Name" and "Namespace" will be used to query the actual ApigeeInstance object from the cluster. | ||
| func (r *InstanceRef) 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", ApigeeInstanceGVK.Kind) | ||
| } | ||
| // From given External | ||
| if r.External != "" { | ||
| if _, _, err := ParseInstanceExternal(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(ApigeeInstanceGVK) | ||
| 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", ApigeeInstanceGVK, 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 | ||
| } |
Oops, something went wrong.