diff --git a/apis/v1alpha1/ack-generate-metadata.yaml b/apis/v1alpha1/ack-generate-metadata.yaml index 4d34dfd..ab50163 100644 --- a/apis/v1alpha1/ack-generate-metadata.yaml +++ b/apis/v1alpha1/ack-generate-metadata.yaml @@ -1,13 +1,13 @@ ack_generate_info: - build_date: "2025-04-08T22:19:16Z" + build_date: "2025-04-10T17:18:37Z" build_hash: 0909e7f0adb8ffe4120a8c20d5d58b991f2539e9 go_version: go1.24.0 version: v0.43.2-14-g0909e7f -api_directory_checksum: 38f3854ec052552b2259dbfdc6e8ceb0932476a3 +api_directory_checksum: 58f6efc74b9a4ba3fae4cec38c981b52409f143a api_version: v1alpha1 aws_sdk_go_version: v1.32.6 generator_config_info: - file_checksum: 312713f8325616b13defaf9078ce1019a5e7a181 + file_checksum: f6718d195d829cee30fea115df5ee64261ec25da original_file_name: generator.yaml last_modification: reason: API generation diff --git a/apis/v1alpha1/api_key.go b/apis/v1alpha1/api_key.go new file mode 100644 index 0000000..ccf6fc9 --- /dev/null +++ b/apis/v1alpha1/api_key.go @@ -0,0 +1,99 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file 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. + +// Code generated by ack-generate. DO NOT EDIT. + +package v1alpha1 + +import ( + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" +) + +// ApiKeySpec defines the desired state of ApiKey. +// +// A resource that can be distributed to callers for executing Method resources +// that require an API key. API keys can be mapped to any Stage on any RestApi, +// which indicates that the callers with the API key can make requests to that +// stage. +type APIKeySpec struct { + + // An Amazon Web Services Marketplace customer identifier, when integrating + // with the Amazon Web Services SaaS Marketplace. + CustomerID *string `json:"customerID,omitempty"` + // The description of the ApiKey. + Description *string `json:"description,omitempty"` + // Specifies whether the ApiKey can be used by callers. + Enabled *bool `json:"enabled,omitempty"` + // Specifies whether (true) or not (false) the key identifier is distinct from + // the created API key value. This parameter is deprecated and should not be + // used. + GenerateDistinctID *bool `json:"generateDistinctID,omitempty"` + // The name of the ApiKey. + // +kubebuilder:validation:Required + Name *string `json:"name"` + // DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key. + StageKeys []*StageKey `json:"stageKeys,omitempty"` + // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. + // The tag key can be up to 128 characters and must not start with aws:. The + // tag value can be up to 256 characters. + Tags map[string]*string `json:"tags,omitempty"` + // Specifies a value of the API key. + Value *ackv1alpha1.SecretKeyReference `json:"value,omitempty"` +} + +// APIKeyStatus defines the observed state of APIKey +type APIKeyStatus struct { + // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member + // that is used to contain resource sync state, account ownership, + // constructed ARN for the resource + // +kubebuilder:validation:Optional + ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` + // All CRs managed by ACK have a common `Status.Conditions` member that + // contains a collection of `ackv1alpha1.Condition` objects that describe + // the various terminal states of the CR and its backend AWS service API + // resource + // +kubebuilder:validation:Optional + Conditions []*ackv1alpha1.Condition `json:"conditions"` + // The timestamp when the API Key was created. + // +kubebuilder:validation:Optional + CreatedDate *metav1.Time `json:"createdDate,omitempty"` + // The identifier of the API Key. + // +kubebuilder:validation:Optional + ID *string `json:"id,omitempty"` + // The timestamp when the API Key was last updated. + // +kubebuilder:validation:Optional + LastUpdatedDate *metav1.Time `json:"lastUpdatedDate,omitempty"` +} + +// APIKey is the Schema for the APIKeys API +// +kubebuilder:object:root=true +// +kubebuilder:subresource:status +type APIKey struct { + metav1.TypeMeta `json:",inline"` + metav1.ObjectMeta `json:"metadata,omitempty"` + Spec APIKeySpec `json:"spec,omitempty"` + Status APIKeyStatus `json:"status,omitempty"` +} + +// APIKeyList contains a list of APIKey +// +kubebuilder:object:root=true +type APIKeyList struct { + metav1.TypeMeta `json:",inline"` + metav1.ListMeta `json:"metadata,omitempty"` + Items []APIKey `json:"items"` +} + +func init() { + SchemeBuilder.Register(&APIKey{}, &APIKeyList{}) +} diff --git a/apis/v1alpha1/generator.yaml b/apis/v1alpha1/generator.yaml index 5cf6155..050a9f9 100644 --- a/apis/v1alpha1/generator.yaml +++ b/apis/v1alpha1/generator.yaml @@ -43,7 +43,7 @@ operations: resource_name: ApiIntegrationResponse ignore: resource_names: - - ApiKey + # - ApiKey - Authorizer - BasePathMapping - Deployment @@ -63,6 +63,14 @@ ignore: field_paths: - Resource.ResourceMethods - CreateResourceOutput.ResourceMethods + - GetApiKeyInput.IncludeValue + - GetApiKeyOutput.Value + - CreateApiKeyOutput.Value + - UpdateApiKeyInput.Value + - UpdateApiKeyOutput.Value + - CreateApiKeyOutput.StageKeys + - UpdateApiKeyOutput.StageKeys + - GetApiKeyOutput.StageKeys resources: VpcLink: fields: @@ -321,4 +329,40 @@ resources: exceptions: terminal_codes: - BadRequestException - - InvalidParameter \ No newline at end of file + - InvalidParameter + ApiKey: + fields: + ID: + is_primary_key: true + Name: + is_required: true + StageKeys: + list_of: StageKey + Value: + is_secret: true + exceptions: + terminal_codes: + - BadRequestException + - InvalidParameter + renames: + operations: + GetApiKey: + input_fields: + ApiKey: Id + UpdateApiKey: + input_fields: + ApiKey: Id + DeleteApiKey: + input_fields: + ApiKey: Id + hooks: + sdk_update_pre_build_request: + template_path: hooks/api_key/sdk_update_pre_build_request.go.tpl + sdk_update_post_build_request: + template_path: hooks/api_key/sdk_update_post_build_request.go.tpl + sdk_read_one_post_request: + template_path: hooks/api_key/sdk_read_one_post_request.go.tpl + sdk_create_post_request: + template_path: hooks/api_key/sdk_update_post_request.go.tpl + sdk_update_post_request: + template_path: hooks/api_key/sdk_update_post_request.go.tpl diff --git a/apis/v1alpha1/types.go b/apis/v1alpha1/types.go index 3123e3d..b9153d3 100644 --- a/apis/v1alpha1/types.go +++ b/apis/v1alpha1/types.go @@ -32,7 +32,7 @@ var ( // that require an API key. API keys can be mapped to any Stage on any RestApi, // which indicates that the callers with the API key can make requests to that // stage. -type APIKey struct { +type APIKey_SDK struct { CreatedDate *metav1.Time `json:"createdDate,omitempty"` CustomerID *string `json:"customerID,omitempty"` Description *string `json:"description,omitempty"` diff --git a/apis/v1alpha1/zz_generated.deepcopy.go b/apis/v1alpha1/zz_generated.deepcopy.go index 30c6a31..53f5227 100644 --- a/apis/v1alpha1/zz_generated.deepcopy.go +++ b/apis/v1alpha1/zz_generated.deepcopy.go @@ -203,6 +203,181 @@ func (in *APIIntegrationResponseStatus) DeepCopy() *APIIntegrationResponseStatus // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *APIKey) DeepCopyInto(out *APIKey) { + *out = *in + out.TypeMeta = in.TypeMeta + in.ObjectMeta.DeepCopyInto(&out.ObjectMeta) + in.Spec.DeepCopyInto(&out.Spec) + in.Status.DeepCopyInto(&out.Status) +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIKey. +func (in *APIKey) DeepCopy() *APIKey { + if in == nil { + return nil + } + out := new(APIKey) + in.DeepCopyInto(out) + return out +} + +// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. +func (in *APIKey) DeepCopyObject() runtime.Object { + if c := in.DeepCopy(); c != nil { + return c + } + return nil +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *APIKeyList) DeepCopyInto(out *APIKeyList) { + *out = *in + out.TypeMeta = in.TypeMeta + in.ListMeta.DeepCopyInto(&out.ListMeta) + if in.Items != nil { + in, out := &in.Items, &out.Items + *out = make([]APIKey, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIKeyList. +func (in *APIKeyList) DeepCopy() *APIKeyList { + if in == nil { + return nil + } + out := new(APIKeyList) + in.DeepCopyInto(out) + return out +} + +// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. +func (in *APIKeyList) DeepCopyObject() runtime.Object { + if c := in.DeepCopy(); c != nil { + return c + } + return nil +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *APIKeySpec) DeepCopyInto(out *APIKeySpec) { + *out = *in + if in.CustomerID != nil { + in, out := &in.CustomerID, &out.CustomerID + *out = new(string) + **out = **in + } + if in.Description != nil { + in, out := &in.Description, &out.Description + *out = new(string) + **out = **in + } + if in.Enabled != nil { + in, out := &in.Enabled, &out.Enabled + *out = new(bool) + **out = **in + } + if in.GenerateDistinctID != nil { + in, out := &in.GenerateDistinctID, &out.GenerateDistinctID + *out = new(bool) + **out = **in + } + if in.Name != nil { + in, out := &in.Name, &out.Name + *out = new(string) + **out = **in + } + if in.StageKeys != nil { + in, out := &in.StageKeys, &out.StageKeys + *out = make([]*StageKey, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(StageKey) + (*in).DeepCopyInto(*out) + } + } + } + if in.Tags != nil { + in, out := &in.Tags, &out.Tags + *out = make(map[string]*string, len(*in)) + for key, val := range *in { + var outVal *string + if val == nil { + (*out)[key] = nil + } else { + inVal := (*in)[key] + in, out := &inVal, &outVal + *out = new(string) + **out = **in + } + (*out)[key] = outVal + } + } + if in.Value != nil { + in, out := &in.Value, &out.Value + *out = new(corev1alpha1.SecretKeyReference) + **out = **in + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIKeySpec. +func (in *APIKeySpec) DeepCopy() *APIKeySpec { + if in == nil { + return nil + } + out := new(APIKeySpec) + in.DeepCopyInto(out) + return out +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *APIKeyStatus) DeepCopyInto(out *APIKeyStatus) { + *out = *in + if in.ACKResourceMetadata != nil { + in, out := &in.ACKResourceMetadata, &out.ACKResourceMetadata + *out = new(corev1alpha1.ResourceMetadata) + (*in).DeepCopyInto(*out) + } + if in.Conditions != nil { + in, out := &in.Conditions, &out.Conditions + *out = make([]*corev1alpha1.Condition, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(corev1alpha1.Condition) + (*in).DeepCopyInto(*out) + } + } + } + if in.CreatedDate != nil { + in, out := &in.CreatedDate, &out.CreatedDate + *out = (*in).DeepCopy() + } + if in.ID != nil { + in, out := &in.ID, &out.ID + *out = new(string) + **out = **in + } + if in.LastUpdatedDate != nil { + in, out := &in.LastUpdatedDate, &out.LastUpdatedDate + *out = (*in).DeepCopy() + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIKeyStatus. +func (in *APIKeyStatus) DeepCopy() *APIKeyStatus { + if in == nil { + return nil + } + out := new(APIKeyStatus) + in.DeepCopyInto(out) + return out +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *APIKey_SDK) DeepCopyInto(out *APIKey_SDK) { *out = *in if in.CreatedDate != nil { in, out := &in.CreatedDate, &out.CreatedDate @@ -271,12 +446,12 @@ func (in *APIKey) DeepCopyInto(out *APIKey) { } } -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIKey. -func (in *APIKey) DeepCopy() *APIKey { +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIKey_SDK. +func (in *APIKey_SDK) DeepCopy() *APIKey_SDK { if in == nil { return nil } - out := new(APIKey) + out := new(APIKey_SDK) in.DeepCopyInto(out) return out } diff --git a/cmd/controller/main.go b/cmd/controller/main.go index 1039a6e..47385d9 100644 --- a/cmd/controller/main.go +++ b/cmd/controller/main.go @@ -41,6 +41,7 @@ import ( svcresource "github.com/aws-controllers-k8s/apigateway-controller/pkg/resource" _ "github.com/aws-controllers-k8s/apigateway-controller/pkg/resource/api_integration_response" + _ "github.com/aws-controllers-k8s/apigateway-controller/pkg/resource/api_key" _ "github.com/aws-controllers-k8s/apigateway-controller/pkg/resource/api_method_response" _ "github.com/aws-controllers-k8s/apigateway-controller/pkg/resource/integration" _ "github.com/aws-controllers-k8s/apigateway-controller/pkg/resource/method" diff --git a/config/crd/bases/apigateway.services.k8s.aws_apikeys.yaml b/config/crd/bases/apigateway.services.k8s.aws_apikeys.yaml new file mode 100644 index 0000000..8b3d61c --- /dev/null +++ b/config/crd/bases/apigateway.services.k8s.aws_apikeys.yaml @@ -0,0 +1,193 @@ +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.16.2 + name: apikeys.apigateway.services.k8s.aws +spec: + group: apigateway.services.k8s.aws + names: + kind: APIKey + listKind: APIKeyList + plural: apikeys + singular: apikey + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: APIKey is the Schema for the APIKeys API + properties: + apiVersion: + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + type: string + kind: + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + type: string + metadata: + type: object + spec: + description: |- + ApiKeySpec defines the desired state of ApiKey. + + A resource that can be distributed to callers for executing Method resources + that require an API key. API keys can be mapped to any Stage on any RestApi, + which indicates that the callers with the API key can make requests to that + stage. + properties: + customerID: + description: |- + An Amazon Web Services Marketplace customer identifier, when integrating + with the Amazon Web Services SaaS Marketplace. + type: string + description: + description: The description of the ApiKey. + type: string + enabled: + description: Specifies whether the ApiKey can be used by callers. + type: boolean + generateDistinctID: + description: |- + Specifies whether (true) or not (false) the key identifier is distinct from + the created API key value. This parameter is deprecated and should not be + used. + type: boolean + name: + description: The name of the ApiKey. + type: string + stageKeys: + description: DEPRECATED FOR USAGE PLANS - Specifies stages associated + with the API key. + items: + description: A reference to a unique stage identified in the format + {restApiId}/{stage}. + properties: + restAPIID: + type: string + stageName: + type: string + type: object + type: array + tags: + additionalProperties: + type: string + description: |- + The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. + The tag key can be up to 128 characters and must not start with aws:. The + tag value can be up to 256 characters. + type: object + value: + description: Specifies a value of the API key. + properties: + key: + description: Key is the key within the secret + type: string + name: + description: name is unique within a namespace to reference a + secret resource. + type: string + namespace: + description: namespace defines the space within which the secret + name must be unique. + type: string + required: + - key + type: object + x-kubernetes-map-type: atomic + required: + - name + type: object + status: + description: APIKeyStatus defines the observed state of APIKey + properties: + ackResourceMetadata: + description: |- + All CRs managed by ACK have a common `Status.ACKResourceMetadata` member + that is used to contain resource sync state, account ownership, + constructed ARN for the resource + properties: + arn: + description: |- + ARN is the Amazon Resource Name for the resource. This is a + globally-unique identifier and is set only by the ACK service controller + once the controller has orchestrated the creation of the resource OR + when it has verified that an "adopted" resource (a resource where the + ARN annotation was set by the Kubernetes user on the CR) exists and + matches the supplied CR's Spec field values. + https://github.com/aws/aws-controllers-k8s/issues/270 + type: string + ownerAccountID: + description: |- + OwnerAccountID is the AWS Account ID of the account that owns the + backend AWS service API resource. + type: string + region: + description: Region is the AWS region in which the resource exists + or will exist. + type: string + required: + - ownerAccountID + - region + type: object + conditions: + description: |- + All CRs managed by ACK have a common `Status.Conditions` member that + contains a collection of `ackv1alpha1.Condition` objects that describe + the various terminal states of the CR and its backend AWS service API + resource + items: + description: |- + Condition is the common struct used by all CRDs managed by ACK service + controllers to indicate terminal states of the CR and its backend AWS + service API resource + properties: + lastTransitionTime: + description: Last time the condition transitioned from one status + to another. + format: date-time + type: string + message: + description: A human readable message indicating details about + the transition. + type: string + reason: + description: The reason for the condition's last transition. + type: string + status: + description: Status of the condition, one of True, False, Unknown. + type: string + type: + description: Type is the type of the Condition + type: string + required: + - status + - type + type: object + type: array + createdDate: + description: The timestamp when the API Key was created. + format: date-time + type: string + id: + description: The identifier of the API Key. + type: string + lastUpdatedDate: + description: The timestamp when the API Key was last updated. + format: date-time + type: string + type: object + type: object + served: true + storage: true + subresources: + status: {} diff --git a/config/crd/kustomization.yaml b/config/crd/kustomization.yaml index a68a6cd..daeb5b6 100644 --- a/config/crd/kustomization.yaml +++ b/config/crd/kustomization.yaml @@ -3,6 +3,7 @@ kind: Kustomization resources: - common - bases/apigateway.services.k8s.aws_apiintegrationresponses.yaml + - bases/apigateway.services.k8s.aws_apikeys.yaml - bases/apigateway.services.k8s.aws_apimethodresponses.yaml - bases/apigateway.services.k8s.aws_integrations.yaml - bases/apigateway.services.k8s.aws_methods.yaml diff --git a/config/rbac/cluster-role-controller.yaml b/config/rbac/cluster-role-controller.yaml index 65e52a8..095542e 100644 --- a/config/rbac/cluster-role-controller.yaml +++ b/config/rbac/cluster-role-controller.yaml @@ -26,6 +26,7 @@ rules: - apigateway.services.k8s.aws resources: - apiintegrationresponses + - apikeys - apimethodresponses - integrations - methods @@ -45,6 +46,7 @@ rules: - apigateway.services.k8s.aws resources: - apiintegrationresponses/status + - apikeys/status - apimethodresponses/status - integrations/status - methods/status diff --git a/config/rbac/role-reader.yaml b/config/rbac/role-reader.yaml index 3083e54..67b01d9 100644 --- a/config/rbac/role-reader.yaml +++ b/config/rbac/role-reader.yaml @@ -10,6 +10,7 @@ rules: - apigateway.services.k8s.aws resources: - apiintegrationresponses + - apikeys - apimethodresponses - integrations - methods diff --git a/config/rbac/role-writer.yaml b/config/rbac/role-writer.yaml index 38d1788..4bd6925 100644 --- a/config/rbac/role-writer.yaml +++ b/config/rbac/role-writer.yaml @@ -10,6 +10,7 @@ rules: - apigateway.services.k8s.aws resources: - apiintegrationresponses + - apikeys - apimethodresponses - integrations - methods @@ -29,6 +30,7 @@ rules: - apigateway.services.k8s.aws resources: - apiintegrationresponses + - apikeys - apimethodresponses - integrations - methods diff --git a/generator.yaml b/generator.yaml index 5cf6155..050a9f9 100644 --- a/generator.yaml +++ b/generator.yaml @@ -43,7 +43,7 @@ operations: resource_name: ApiIntegrationResponse ignore: resource_names: - - ApiKey + # - ApiKey - Authorizer - BasePathMapping - Deployment @@ -63,6 +63,14 @@ ignore: field_paths: - Resource.ResourceMethods - CreateResourceOutput.ResourceMethods + - GetApiKeyInput.IncludeValue + - GetApiKeyOutput.Value + - CreateApiKeyOutput.Value + - UpdateApiKeyInput.Value + - UpdateApiKeyOutput.Value + - CreateApiKeyOutput.StageKeys + - UpdateApiKeyOutput.StageKeys + - GetApiKeyOutput.StageKeys resources: VpcLink: fields: @@ -321,4 +329,40 @@ resources: exceptions: terminal_codes: - BadRequestException - - InvalidParameter \ No newline at end of file + - InvalidParameter + ApiKey: + fields: + ID: + is_primary_key: true + Name: + is_required: true + StageKeys: + list_of: StageKey + Value: + is_secret: true + exceptions: + terminal_codes: + - BadRequestException + - InvalidParameter + renames: + operations: + GetApiKey: + input_fields: + ApiKey: Id + UpdateApiKey: + input_fields: + ApiKey: Id + DeleteApiKey: + input_fields: + ApiKey: Id + hooks: + sdk_update_pre_build_request: + template_path: hooks/api_key/sdk_update_pre_build_request.go.tpl + sdk_update_post_build_request: + template_path: hooks/api_key/sdk_update_post_build_request.go.tpl + sdk_read_one_post_request: + template_path: hooks/api_key/sdk_read_one_post_request.go.tpl + sdk_create_post_request: + template_path: hooks/api_key/sdk_update_post_request.go.tpl + sdk_update_post_request: + template_path: hooks/api_key/sdk_update_post_request.go.tpl diff --git a/helm/crds/apigateway.services.k8s.aws_apikeys.yaml b/helm/crds/apigateway.services.k8s.aws_apikeys.yaml new file mode 100644 index 0000000..8b3d61c --- /dev/null +++ b/helm/crds/apigateway.services.k8s.aws_apikeys.yaml @@ -0,0 +1,193 @@ +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.16.2 + name: apikeys.apigateway.services.k8s.aws +spec: + group: apigateway.services.k8s.aws + names: + kind: APIKey + listKind: APIKeyList + plural: apikeys + singular: apikey + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: APIKey is the Schema for the APIKeys API + properties: + apiVersion: + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + type: string + kind: + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + type: string + metadata: + type: object + spec: + description: |- + ApiKeySpec defines the desired state of ApiKey. + + A resource that can be distributed to callers for executing Method resources + that require an API key. API keys can be mapped to any Stage on any RestApi, + which indicates that the callers with the API key can make requests to that + stage. + properties: + customerID: + description: |- + An Amazon Web Services Marketplace customer identifier, when integrating + with the Amazon Web Services SaaS Marketplace. + type: string + description: + description: The description of the ApiKey. + type: string + enabled: + description: Specifies whether the ApiKey can be used by callers. + type: boolean + generateDistinctID: + description: |- + Specifies whether (true) or not (false) the key identifier is distinct from + the created API key value. This parameter is deprecated and should not be + used. + type: boolean + name: + description: The name of the ApiKey. + type: string + stageKeys: + description: DEPRECATED FOR USAGE PLANS - Specifies stages associated + with the API key. + items: + description: A reference to a unique stage identified in the format + {restApiId}/{stage}. + properties: + restAPIID: + type: string + stageName: + type: string + type: object + type: array + tags: + additionalProperties: + type: string + description: |- + The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. + The tag key can be up to 128 characters and must not start with aws:. The + tag value can be up to 256 characters. + type: object + value: + description: Specifies a value of the API key. + properties: + key: + description: Key is the key within the secret + type: string + name: + description: name is unique within a namespace to reference a + secret resource. + type: string + namespace: + description: namespace defines the space within which the secret + name must be unique. + type: string + required: + - key + type: object + x-kubernetes-map-type: atomic + required: + - name + type: object + status: + description: APIKeyStatus defines the observed state of APIKey + properties: + ackResourceMetadata: + description: |- + All CRs managed by ACK have a common `Status.ACKResourceMetadata` member + that is used to contain resource sync state, account ownership, + constructed ARN for the resource + properties: + arn: + description: |- + ARN is the Amazon Resource Name for the resource. This is a + globally-unique identifier and is set only by the ACK service controller + once the controller has orchestrated the creation of the resource OR + when it has verified that an "adopted" resource (a resource where the + ARN annotation was set by the Kubernetes user on the CR) exists and + matches the supplied CR's Spec field values. + https://github.com/aws/aws-controllers-k8s/issues/270 + type: string + ownerAccountID: + description: |- + OwnerAccountID is the AWS Account ID of the account that owns the + backend AWS service API resource. + type: string + region: + description: Region is the AWS region in which the resource exists + or will exist. + type: string + required: + - ownerAccountID + - region + type: object + conditions: + description: |- + All CRs managed by ACK have a common `Status.Conditions` member that + contains a collection of `ackv1alpha1.Condition` objects that describe + the various terminal states of the CR and its backend AWS service API + resource + items: + description: |- + Condition is the common struct used by all CRDs managed by ACK service + controllers to indicate terminal states of the CR and its backend AWS + service API resource + properties: + lastTransitionTime: + description: Last time the condition transitioned from one status + to another. + format: date-time + type: string + message: + description: A human readable message indicating details about + the transition. + type: string + reason: + description: The reason for the condition's last transition. + type: string + status: + description: Status of the condition, one of True, False, Unknown. + type: string + type: + description: Type is the type of the Condition + type: string + required: + - status + - type + type: object + type: array + createdDate: + description: The timestamp when the API Key was created. + format: date-time + type: string + id: + description: The identifier of the API Key. + type: string + lastUpdatedDate: + description: The timestamp when the API Key was last updated. + format: date-time + type: string + type: object + type: object + served: true + storage: true + subresources: + status: {} diff --git a/helm/templates/_helpers.tpl b/helm/templates/_helpers.tpl index 1b06e71..0c66477 100644 --- a/helm/templates/_helpers.tpl +++ b/helm/templates/_helpers.tpl @@ -73,6 +73,7 @@ rules: - apigateway.services.k8s.aws resources: - apiintegrationresponses + - apikeys - apimethodresponses - integrations - methods @@ -92,6 +93,7 @@ rules: - apigateway.services.k8s.aws resources: - apiintegrationresponses/status + - apikeys/status - apimethodresponses/status - integrations/status - methods/status diff --git a/helm/templates/role-reader.yaml b/helm/templates/role-reader.yaml index 97ef9f5..314cdf2 100644 --- a/helm/templates/role-reader.yaml +++ b/helm/templates/role-reader.yaml @@ -10,6 +10,7 @@ rules: - apigateway.services.k8s.aws resources: - apiintegrationresponses + - apikeys - apimethodresponses - integrations - methods diff --git a/helm/templates/role-writer.yaml b/helm/templates/role-writer.yaml index 32a3c0a..c8280a4 100644 --- a/helm/templates/role-writer.yaml +++ b/helm/templates/role-writer.yaml @@ -10,6 +10,7 @@ rules: - apigateway.services.k8s.aws resources: - apiintegrationresponses + - apikeys - apimethodresponses - integrations - methods @@ -29,6 +30,7 @@ rules: - apigateway.services.k8s.aws resources: - apiintegrationresponses + - apikeys - apimethodresponses - integrations - methods diff --git a/pkg/resource/api_key/delta.go b/pkg/resource/api_key/delta.go new file mode 100644 index 0000000..ba42517 --- /dev/null +++ b/pkg/resource/api_key/delta.go @@ -0,0 +1,102 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file 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. + +// Code generated by ack-generate. DO NOT EDIT. + +package api_key + +import ( + "bytes" + "reflect" + + ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare" + acktags "github.com/aws-controllers-k8s/runtime/pkg/tags" +) + +// Hack to avoid import errors during build... +var ( + _ = &bytes.Buffer{} + _ = &reflect.Method{} + _ = &acktags.Tags{} +) + +// newResourceDelta returns a new `ackcompare.Delta` used to compare two +// resources +func newResourceDelta( + a *resource, + b *resource, +) *ackcompare.Delta { + delta := ackcompare.NewDelta() + if (a == nil && b != nil) || + (a != nil && b == nil) { + delta.Add("", a, b) + return delta + } + + if ackcompare.HasNilDifference(a.ko.Spec.CustomerID, b.ko.Spec.CustomerID) { + delta.Add("Spec.CustomerID", a.ko.Spec.CustomerID, b.ko.Spec.CustomerID) + } else if a.ko.Spec.CustomerID != nil && b.ko.Spec.CustomerID != nil { + if *a.ko.Spec.CustomerID != *b.ko.Spec.CustomerID { + delta.Add("Spec.CustomerID", a.ko.Spec.CustomerID, b.ko.Spec.CustomerID) + } + } + if ackcompare.HasNilDifference(a.ko.Spec.Description, b.ko.Spec.Description) { + delta.Add("Spec.Description", a.ko.Spec.Description, b.ko.Spec.Description) + } else if a.ko.Spec.Description != nil && b.ko.Spec.Description != nil { + if *a.ko.Spec.Description != *b.ko.Spec.Description { + delta.Add("Spec.Description", a.ko.Spec.Description, b.ko.Spec.Description) + } + } + if ackcompare.HasNilDifference(a.ko.Spec.Enabled, b.ko.Spec.Enabled) { + delta.Add("Spec.Enabled", a.ko.Spec.Enabled, b.ko.Spec.Enabled) + } else if a.ko.Spec.Enabled != nil && b.ko.Spec.Enabled != nil { + if *a.ko.Spec.Enabled != *b.ko.Spec.Enabled { + delta.Add("Spec.Enabled", a.ko.Spec.Enabled, b.ko.Spec.Enabled) + } + } + if ackcompare.HasNilDifference(a.ko.Spec.GenerateDistinctID, b.ko.Spec.GenerateDistinctID) { + delta.Add("Spec.GenerateDistinctID", a.ko.Spec.GenerateDistinctID, b.ko.Spec.GenerateDistinctID) + } else if a.ko.Spec.GenerateDistinctID != nil && b.ko.Spec.GenerateDistinctID != nil { + if *a.ko.Spec.GenerateDistinctID != *b.ko.Spec.GenerateDistinctID { + delta.Add("Spec.GenerateDistinctID", a.ko.Spec.GenerateDistinctID, b.ko.Spec.GenerateDistinctID) + } + } + if ackcompare.HasNilDifference(a.ko.Spec.Name, b.ko.Spec.Name) { + delta.Add("Spec.Name", a.ko.Spec.Name, b.ko.Spec.Name) + } else if a.ko.Spec.Name != nil && b.ko.Spec.Name != nil { + if *a.ko.Spec.Name != *b.ko.Spec.Name { + delta.Add("Spec.Name", a.ko.Spec.Name, b.ko.Spec.Name) + } + } + if len(a.ko.Spec.StageKeys) != len(b.ko.Spec.StageKeys) { + delta.Add("Spec.StageKeys", a.ko.Spec.StageKeys, b.ko.Spec.StageKeys) + } else if len(a.ko.Spec.StageKeys) > 0 { + if !reflect.DeepEqual(a.ko.Spec.StageKeys, b.ko.Spec.StageKeys) { + delta.Add("Spec.StageKeys", a.ko.Spec.StageKeys, b.ko.Spec.StageKeys) + } + } + desiredACKTags, _ := convertToOrderedACKTags(a.ko.Spec.Tags) + latestACKTags, _ := convertToOrderedACKTags(b.ko.Spec.Tags) + if !ackcompare.MapStringStringEqual(desiredACKTags, latestACKTags) { + delta.Add("Spec.Tags", a.ko.Spec.Tags, b.ko.Spec.Tags) + } + if ackcompare.HasNilDifference(a.ko.Spec.Value, b.ko.Spec.Value) { + delta.Add("Spec.Value", a.ko.Spec.Value, b.ko.Spec.Value) + } else if a.ko.Spec.Value != nil && b.ko.Spec.Value != nil { + if *a.ko.Spec.Value != *b.ko.Spec.Value { + delta.Add("Spec.Value", a.ko.Spec.Value, b.ko.Spec.Value) + } + } + + return delta +} diff --git a/pkg/resource/api_key/descriptor.go b/pkg/resource/api_key/descriptor.go new file mode 100644 index 0000000..1615f81 --- /dev/null +++ b/pkg/resource/api_key/descriptor.go @@ -0,0 +1,155 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file 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. + +// Code generated by ack-generate. DO NOT EDIT. + +package api_key + +import ( + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" + ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare" + acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + "k8s.io/apimachinery/pkg/runtime/schema" + rtclient "sigs.k8s.io/controller-runtime/pkg/client" + k8sctrlutil "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil" + + svcapitypes "github.com/aws-controllers-k8s/apigateway-controller/apis/v1alpha1" +) + +const ( + FinalizerString = "finalizers.apigateway.services.k8s.aws/APIKey" +) + +var ( + GroupVersionResource = svcapitypes.GroupVersion.WithResource("apikeys") + GroupKind = metav1.GroupKind{ + Group: "apigateway.services.k8s.aws", + Kind: "APIKey", + } +) + +// resourceDescriptor implements the +// `aws-service-operator-k8s/pkg/types.AWSResourceDescriptor` interface +type resourceDescriptor struct { +} + +// GroupVersionKind returns a Kubernetes schema.GroupVersionKind struct that +// describes the API Group, Version and Kind of CRs described by the descriptor +func (d *resourceDescriptor) GroupVersionKind() schema.GroupVersionKind { + return svcapitypes.GroupVersion.WithKind(GroupKind.Kind) +} + +// EmptyRuntimeObject returns an empty object prototype that may be used in +// apimachinery and k8s client operations +func (d *resourceDescriptor) EmptyRuntimeObject() rtclient.Object { + return &svcapitypes.APIKey{} +} + +// ResourceFromRuntimeObject returns an AWSResource that has been initialized +// with the supplied runtime.Object +func (d *resourceDescriptor) ResourceFromRuntimeObject( + obj rtclient.Object, +) acktypes.AWSResource { + return &resource{ + ko: obj.(*svcapitypes.APIKey), + } +} + +// Delta returns an `ackcompare.Delta` object containing the difference between +// one `AWSResource` and another. +func (d *resourceDescriptor) Delta(a, b acktypes.AWSResource) *ackcompare.Delta { + return newResourceDelta(a.(*resource), b.(*resource)) +} + +// IsManaged returns true if the supplied AWSResource is under the management +// of an ACK service controller. What this means in practice is that the +// underlying custom resource (CR) in the AWSResource has had a +// resource-specific finalizer associated with it. +func (d *resourceDescriptor) IsManaged( + res acktypes.AWSResource, +) bool { + obj := res.RuntimeObject() + if obj == nil { + // Should not happen. If it does, there is a bug in the code + panic("nil RuntimeMetaObject in AWSResource") + } + // Remove use of custom code once + // https://github.com/kubernetes-sigs/controller-runtime/issues/994 is + // fixed. This should be able to be: + // + // return k8sctrlutil.ContainsFinalizer(obj, FinalizerString) + return containsFinalizer(obj, FinalizerString) +} + +// Remove once https://github.com/kubernetes-sigs/controller-runtime/issues/994 +// is fixed. +func containsFinalizer(obj rtclient.Object, finalizer string) bool { + f := obj.GetFinalizers() + for _, e := range f { + if e == finalizer { + return true + } + } + return false +} + +// MarkManaged places the supplied resource under the management of ACK. What +// this typically means is that the resource manager will decorate the +// underlying custom resource (CR) with a finalizer that indicates ACK is +// managing the resource and the underlying CR may not be deleted until ACK is +// finished cleaning up any backend AWS service resources associated with the +// CR. +func (d *resourceDescriptor) MarkManaged( + res acktypes.AWSResource, +) { + obj := res.RuntimeObject() + if obj == nil { + // Should not happen. If it does, there is a bug in the code + panic("nil RuntimeMetaObject in AWSResource") + } + k8sctrlutil.AddFinalizer(obj, FinalizerString) +} + +// MarkUnmanaged removes the supplied resource from management by ACK. What +// this typically means is that the resource manager will remove a finalizer +// underlying custom resource (CR) that indicates ACK is managing the resource. +// This will allow the Kubernetes API server to delete the underlying CR. +func (d *resourceDescriptor) MarkUnmanaged( + res acktypes.AWSResource, +) { + obj := res.RuntimeObject() + if obj == nil { + // Should not happen. If it does, there is a bug in the code + panic("nil RuntimeMetaObject in AWSResource") + } + k8sctrlutil.RemoveFinalizer(obj, FinalizerString) +} + +// MarkAdopted places descriptors on the custom resource that indicate the +// resource was not created from within ACK. +func (d *resourceDescriptor) MarkAdopted( + res acktypes.AWSResource, +) { + obj := res.RuntimeObject() + if obj == nil { + // Should not happen. If it does, there is a bug in the code + panic("nil RuntimeObject in AWSResource") + } + curr := obj.GetAnnotations() + if curr == nil { + curr = make(map[string]string) + } + curr[ackv1alpha1.AnnotationAdopted] = "true" + obj.SetAnnotations(curr) +} diff --git a/pkg/resource/api_key/hooks.go b/pkg/resource/api_key/hooks.go new file mode 100644 index 0000000..27dee21 --- /dev/null +++ b/pkg/resource/api_key/hooks.go @@ -0,0 +1,132 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file 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 api_key + +import ( + "context" + "fmt" + "strings" + + ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare" + "github.com/aws/aws-sdk-go-v2/aws" + svcsdk "github.com/aws/aws-sdk-go-v2/service/apigateway" + + svcapitypes "github.com/aws-controllers-k8s/apigateway-controller/apis/v1alpha1" + "github.com/aws-controllers-k8s/apigateway-controller/pkg/tags" + "github.com/aws-controllers-k8s/apigateway-controller/pkg/util/patch" +) + +func updateApiKeyInput(desired *resource, input *svcsdk.UpdateApiKeyInput, delta *ackcompare.Delta) { + desiredSpec := desired.ko.Spec + var patchSet patch.Set + + if delta.DifferentAt("Spec.Name") { + patchSet.Replace("/name", desiredSpec.Name) + } + if delta.DifferentAt("Spec.Description") { + patchSet.Replace("/description", desiredSpec.Description) + } + if delta.DifferentAt("Spec.Enabled") { + patchSet.Replace("/enabled", aws.String(fmt.Sprintf("%t", *desiredSpec.Enabled))) + } + if delta.DifferentAt("Spec.CustomerID") { + patchSet.Replace("/customerId", desiredSpec.CustomerID) + } + + // Handle StageKeys with add/remove operations + if delta.DifferentAt("Spec.StageKeys") && desiredSpec.StageKeys != nil { + updateStageKeyPatches(&patchSet, desiredSpec.StageKeys, desiredSpec.StageKeys) + } + + input.PatchOperations = patchSet.GetPatchOperations() +} + +// updateStageKeyPatches adds patch operations for stage keys, handling both additions and removals. +// Each StageKey represents a REST API stage in the format "restApiId/stageName". +// The path needs to be JSON Pointer encoded (RFC 6901) where "/" becomes "~1" +// to avoid conflicts with path separators. +// +// Example: +// +// StageKey{RestAPIID: "abc123", StageName: "prod"} becomes "/stages/abc123~1prod" +func updateStageKeyPatches(patchSet *patch.Set, latest, desired []*svcapitypes.StageKey) { + latestMap := make(map[string]bool) + desiredMap := make(map[string]bool) + + // Build desired stage keys map + for _, sk := range desired { + if sk.RestAPIID != nil && sk.StageName != nil { + key := fmt.Sprintf("%s/%s", *sk.RestAPIID, *sk.StageName) + desiredMap[key] = true + } + } + + // Build latest stage keys map (only for those that are still desired) + for _, sk := range latest { + if sk.RestAPIID != nil && sk.StageName != nil { + key := fmt.Sprintf("%s/%s", *sk.RestAPIID, *sk.StageName) + if desiredMap[key] { + latestMap[key] = true + } + } + } + + // Add new stage keys + for key := range desiredMap { + if !latestMap[key] { + encodedKey := strings.Replace(key, "/", "~1", -1) + patchSet.Add(fmt.Sprintf("/stages/%s", encodedKey), aws.String("")) + } + } + + // Remove stage keys that are no longer desired + for _, sk := range latest { + if sk.RestAPIID != nil && sk.StageName != nil { + key := fmt.Sprintf("%s/%s", *sk.RestAPIID, *sk.StageName) + if !desiredMap[key] { + encodedKey := strings.Replace(key, "/", "~1", -1) + patchSet.Remove(fmt.Sprintf("/stages/%s", encodedKey)) + } + } + } +} + +// syncApiKeyTags synchronizes tags between desired and latest resources +func updateTags( + ctx context.Context, + rm *resourceManager, + desired *resource, + latest *resource, +) error { + resourceARN := fmt.Sprintf( + "arn:aws:apigateway:%s::/apikeys/%s", + *desired.ko.Status.ACKResourceMetadata.Region, + *desired.ko.Status.ID, + ) + return tags.SyncTags(ctx, rm.sdkapi, rm.metrics, resourceARN, desired.ko.Spec.Tags, latest.ko.Spec.Tags) +} + +// getStageKeysFromStrings converts a slice of stage key strings in the format "restAPIID/stageName" +// to a slice of StageKey objects +func getStageKeysFromStrings(stageKeyStrings []string) []*svcapitypes.StageKey { + stageKeys := make([]*svcapitypes.StageKey, 0, len(stageKeyStrings)) + for _, stageKeyStr := range stageKeyStrings { + parts := strings.Split(stageKeyStr, "/") + stageKeys = append(stageKeys, &svcapitypes.StageKey{ + RestAPIID: &parts[0], + StageName: &parts[1], + }) + } + return stageKeys +} diff --git a/pkg/resource/api_key/identifiers.go b/pkg/resource/api_key/identifiers.go new file mode 100644 index 0000000..3a0a5b7 --- /dev/null +++ b/pkg/resource/api_key/identifiers.go @@ -0,0 +1,55 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file 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. + +// Code generated by ack-generate. DO NOT EDIT. + +package api_key + +import ( + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" +) + +// resourceIdentifiers implements the +// `aws-service-operator-k8s/pkg/types.AWSResourceIdentifiers` interface +type resourceIdentifiers struct { + meta *ackv1alpha1.ResourceMetadata +} + +// ARN returns the AWS Resource Name for the backend AWS resource. If nil, +// this means the resource has not yet been created in the backend AWS +// service. +func (ri *resourceIdentifiers) ARN() *ackv1alpha1.AWSResourceName { + if ri.meta != nil { + return ri.meta.ARN + } + return nil +} + +// OwnerAccountID returns the AWS account identifier in which the +// backend AWS resource resides, or nil if this information is not known +// for the resource +func (ri *resourceIdentifiers) OwnerAccountID() *ackv1alpha1.AWSAccountID { + if ri.meta != nil { + return ri.meta.OwnerAccountID + } + return nil +} + +// Region returns the AWS region in which the resource exists, or +// nil if this information is not known. +func (ri *resourceIdentifiers) Region() *ackv1alpha1.AWSRegion { + if ri.meta != nil { + return ri.meta.Region + } + return nil +} diff --git a/pkg/resource/api_key/manager.go b/pkg/resource/api_key/manager.go new file mode 100644 index 0000000..e50b5d5 --- /dev/null +++ b/pkg/resource/api_key/manager.go @@ -0,0 +1,404 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file 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. + +// Code generated by ack-generate. DO NOT EDIT. + +package api_key + +import ( + "context" + "fmt" + "time" + + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" + ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare" + ackcondition "github.com/aws-controllers-k8s/runtime/pkg/condition" + ackcfg "github.com/aws-controllers-k8s/runtime/pkg/config" + ackerr "github.com/aws-controllers-k8s/runtime/pkg/errors" + ackmetrics "github.com/aws-controllers-k8s/runtime/pkg/metrics" + ackrequeue "github.com/aws-controllers-k8s/runtime/pkg/requeue" + ackrt "github.com/aws-controllers-k8s/runtime/pkg/runtime" + ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log" + acktags "github.com/aws-controllers-k8s/runtime/pkg/tags" + acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" + ackutil "github.com/aws-controllers-k8s/runtime/pkg/util" + "github.com/aws/aws-sdk-go-v2/aws" + svcsdk "github.com/aws/aws-sdk-go-v2/service/apigateway" + "github.com/go-logr/logr" + corev1 "k8s.io/api/core/v1" + + svcapitypes "github.com/aws-controllers-k8s/apigateway-controller/apis/v1alpha1" +) + +var ( + _ = ackutil.InStrings + _ = acktags.NewTags() + _ = ackrt.MissingImageTagValue + _ = svcapitypes.APIKey{} +) + +// +kubebuilder:rbac:groups=apigateway.services.k8s.aws,resources=apikeys,verbs=get;list;watch;create;update;patch;delete +// +kubebuilder:rbac:groups=apigateway.services.k8s.aws,resources=apikeys/status,verbs=get;update;patch + +var lateInitializeFieldNames = []string{} + +// resourceManager is responsible for providing a consistent way to perform +// CRUD operations in a backend AWS service API for Book custom resources. +type resourceManager struct { + // cfg is a copy of the ackcfg.Config object passed on start of the service + // controller + cfg ackcfg.Config + // clientcfg is a copy of the client configuration passed on start of the + // service controller + clientcfg aws.Config + // log refers to the logr.Logger object handling logging for the service + // controller + log logr.Logger + // metrics contains a collection of Prometheus metric objects that the + // service controller and its reconcilers track + metrics *ackmetrics.Metrics + // rr is the Reconciler which can be used for various utility + // functions such as querying for Secret values given a SecretReference + rr acktypes.Reconciler + // awsAccountID is the AWS account identifier that contains the resources + // managed by this resource manager + awsAccountID ackv1alpha1.AWSAccountID + // The AWS Region that this resource manager targets + awsRegion ackv1alpha1.AWSRegion + // sdk is a pointer to the AWS service API client exposed by the + // aws-sdk-go-v2/services/{alias} package. + sdkapi *svcsdk.Client +} + +// concreteResource returns a pointer to a resource from the supplied +// generic AWSResource interface +func (rm *resourceManager) concreteResource( + res acktypes.AWSResource, +) *resource { + // cast the generic interface into a pointer type specific to the concrete + // implementing resource type managed by this resource manager + return res.(*resource) +} + +// ReadOne returns the currently-observed state of the supplied AWSResource in +// the backend AWS service API. +func (rm *resourceManager) ReadOne( + ctx context.Context, + res acktypes.AWSResource, +) (acktypes.AWSResource, error) { + r := rm.concreteResource(res) + if r.ko == nil { + // Should never happen... if it does, it's buggy code. + panic("resource manager's ReadOne() method received resource with nil CR object") + } + observed, err := rm.sdkFind(ctx, r) + mirrorAWSTags(r, observed) + if err != nil { + if observed != nil { + return rm.onError(observed, err) + } + return rm.onError(r, err) + } + return rm.onSuccess(observed) +} + +// Create attempts to create the supplied AWSResource in the backend AWS +// service API, returning an AWSResource representing the newly-created +// resource +func (rm *resourceManager) Create( + ctx context.Context, + res acktypes.AWSResource, +) (acktypes.AWSResource, error) { + r := rm.concreteResource(res) + if r.ko == nil { + // Should never happen... if it does, it's buggy code. + panic("resource manager's Create() method received resource with nil CR object") + } + created, err := rm.sdkCreate(ctx, r) + if err != nil { + if created != nil { + return rm.onError(created, err) + } + return rm.onError(r, err) + } + return rm.onSuccess(created) +} + +// Update attempts to mutate the supplied desired AWSResource in the backend AWS +// service API, returning an AWSResource representing the newly-mutated +// resource. +// Note for specialized logic implementers can check to see how the latest +// observed resource differs from the supplied desired state. The +// higher-level reonciler determines whether or not the desired differs +// from the latest observed and decides whether to call the resource +// manager's Update method +func (rm *resourceManager) Update( + ctx context.Context, + resDesired acktypes.AWSResource, + resLatest acktypes.AWSResource, + delta *ackcompare.Delta, +) (acktypes.AWSResource, error) { + desired := rm.concreteResource(resDesired) + latest := rm.concreteResource(resLatest) + if desired.ko == nil || latest.ko == nil { + // Should never happen... if it does, it's buggy code. + panic("resource manager's Update() method received resource with nil CR object") + } + updated, err := rm.sdkUpdate(ctx, desired, latest, delta) + if err != nil { + if updated != nil { + return rm.onError(updated, err) + } + return rm.onError(latest, err) + } + return rm.onSuccess(updated) +} + +// Delete attempts to destroy the supplied AWSResource in the backend AWS +// service API, returning an AWSResource representing the +// resource being deleted (if delete is asynchronous and takes time) +func (rm *resourceManager) Delete( + ctx context.Context, + res acktypes.AWSResource, +) (acktypes.AWSResource, error) { + r := rm.concreteResource(res) + if r.ko == nil { + // Should never happen... if it does, it's buggy code. + panic("resource manager's Update() method received resource with nil CR object") + } + observed, err := rm.sdkDelete(ctx, r) + if err != nil { + if observed != nil { + return rm.onError(observed, err) + } + return rm.onError(r, err) + } + + return rm.onSuccess(observed) +} + +// ARNFromName returns an AWS Resource Name from a given string name. This +// is useful for constructing ARNs for APIs that require ARNs in their +// GetAttributes operations but all we have (for new CRs at least) is a +// name for the resource +func (rm *resourceManager) ARNFromName(name string) string { + return fmt.Sprintf( + "arn:aws:apigateway:%s:%s:%s", + rm.awsRegion, + rm.awsAccountID, + name, + ) +} + +// LateInitialize returns an acktypes.AWSResource after setting the late initialized +// fields from the readOne call. This method will initialize the optional fields +// which were not provided by the k8s user but were defaulted by the AWS service. +// If there are no such fields to be initialized, the returned object is similar to +// object passed in the parameter. +func (rm *resourceManager) LateInitialize( + ctx context.Context, + latest acktypes.AWSResource, +) (acktypes.AWSResource, error) { + rlog := ackrtlog.FromContext(ctx) + // If there are no fields to late initialize, do nothing + if len(lateInitializeFieldNames) == 0 { + rlog.Debug("no late initialization required.") + return latest, nil + } + latestCopy := latest.DeepCopy() + lateInitConditionReason := "" + lateInitConditionMessage := "" + observed, err := rm.ReadOne(ctx, latestCopy) + if err != nil { + lateInitConditionMessage = "Unable to complete Read operation required for late initialization" + lateInitConditionReason = "Late Initialization Failure" + ackcondition.SetLateInitialized(latestCopy, corev1.ConditionFalse, &lateInitConditionMessage, &lateInitConditionReason) + ackcondition.SetSynced(latestCopy, corev1.ConditionFalse, nil, nil) + return latestCopy, err + } + lateInitializedRes := rm.lateInitializeFromReadOneOutput(observed, latestCopy) + incompleteInitialization := rm.incompleteLateInitialization(lateInitializedRes) + if incompleteInitialization { + // Add the condition with LateInitialized=False + lateInitConditionMessage = "Late initialization did not complete, requeuing with delay of 5 seconds" + lateInitConditionReason = "Delayed Late Initialization" + ackcondition.SetLateInitialized(lateInitializedRes, corev1.ConditionFalse, &lateInitConditionMessage, &lateInitConditionReason) + ackcondition.SetSynced(lateInitializedRes, corev1.ConditionFalse, nil, nil) + return lateInitializedRes, ackrequeue.NeededAfter(nil, time.Duration(5)*time.Second) + } + // Set LateInitialized condition to True + lateInitConditionMessage = "Late initialization successful" + lateInitConditionReason = "Late initialization successful" + ackcondition.SetLateInitialized(lateInitializedRes, corev1.ConditionTrue, &lateInitConditionMessage, &lateInitConditionReason) + return lateInitializedRes, nil +} + +// incompleteLateInitialization return true if there are fields which were supposed to be +// late initialized but are not. If all the fields are late initialized, false is returned +func (rm *resourceManager) incompleteLateInitialization( + res acktypes.AWSResource, +) bool { + return false +} + +// lateInitializeFromReadOneOutput late initializes the 'latest' resource from the 'observed' +// resource and returns 'latest' resource +func (rm *resourceManager) lateInitializeFromReadOneOutput( + observed acktypes.AWSResource, + latest acktypes.AWSResource, +) acktypes.AWSResource { + return latest +} + +// IsSynced returns true if the resource is synced. +func (rm *resourceManager) IsSynced(ctx context.Context, res acktypes.AWSResource) (bool, error) { + r := rm.concreteResource(res) + if r.ko == nil { + // Should never happen... if it does, it's buggy code. + panic("resource manager's IsSynced() method received resource with nil CR object") + } + + return true, nil +} + +// EnsureTags ensures that tags are present inside the AWSResource. +// If the AWSResource does not have any existing resource tags, the 'tags' +// field is initialized and the controller tags are added. +// If the AWSResource has existing resource tags, then controller tags are +// added to the existing resource tags without overriding them. +// If the AWSResource does not support tags, only then the controller tags +// will not be added to the AWSResource. +func (rm *resourceManager) EnsureTags( + ctx context.Context, + res acktypes.AWSResource, + md acktypes.ServiceControllerMetadata, +) error { + r := rm.concreteResource(res) + if r.ko == nil { + // Should never happen... if it does, it's buggy code. + panic("resource manager's EnsureTags method received resource with nil CR object") + } + defaultTags := ackrt.GetDefaultTags(&rm.cfg, r.ko, md) + var existingTags map[string]*string + existingTags = r.ko.Spec.Tags + resourceTags, keyOrder := convertToOrderedACKTags(existingTags) + tags := acktags.Merge(resourceTags, defaultTags) + r.ko.Spec.Tags = fromACKTags(tags, keyOrder) + return nil +} + +// FilterAWSTags ignores tags that have keys that start with "aws:" +// is needed to ensure the controller does not attempt to remove +// tags set by AWS. This function needs to be called after each Read +// operation. +// Eg. resources created with cloudformation have tags that cannot be +// removed by an ACK controller +func (rm *resourceManager) FilterSystemTags(res acktypes.AWSResource) { + r := rm.concreteResource(res) + if r == nil || r.ko == nil { + return + } + var existingTags map[string]*string + existingTags = r.ko.Spec.Tags + resourceTags, tagKeyOrder := convertToOrderedACKTags(existingTags) + ignoreSystemTags(resourceTags) + r.ko.Spec.Tags = fromACKTags(resourceTags, tagKeyOrder) +} + +// mirrorAWSTags ensures that AWS tags are included in the desired resource +// if they are present in the latest resource. This will ensure that the +// aws tags are not present in a diff. The logic of the controller will +// ensure these tags aren't patched to the resource in the cluster, and +// will only be present to make sure we don't try to remove these tags. +// +// Although there are a lot of similarities between this function and +// EnsureTags, they are very much different. +// While EnsureTags tries to make sure the resource contains the controller +// tags, mirrowAWSTags tries to make sure tags injected by AWS are mirrored +// from the latest resoruce to the desired resource. +func mirrorAWSTags(a *resource, b *resource) { + if a == nil || a.ko == nil || b == nil || b.ko == nil { + return + } + var existingLatestTags map[string]*string + var existingDesiredTags map[string]*string + existingDesiredTags = a.ko.Spec.Tags + existingLatestTags = b.ko.Spec.Tags + desiredTags, desiredTagKeyOrder := convertToOrderedACKTags(existingDesiredTags) + latestTags, _ := convertToOrderedACKTags(existingLatestTags) + syncAWSTags(desiredTags, latestTags) + a.ko.Spec.Tags = fromACKTags(desiredTags, desiredTagKeyOrder) +} + +// newResourceManager returns a new struct implementing +// acktypes.AWSResourceManager +// This is for AWS-SDK-GO-V2 - Created newResourceManager With AWS sdk-Go-ClientV2 +func newResourceManager( + cfg ackcfg.Config, + clientcfg aws.Config, + log logr.Logger, + metrics *ackmetrics.Metrics, + rr acktypes.Reconciler, + id ackv1alpha1.AWSAccountID, + region ackv1alpha1.AWSRegion, +) (*resourceManager, error) { + return &resourceManager{ + cfg: cfg, + clientcfg: clientcfg, + log: log, + metrics: metrics, + rr: rr, + awsAccountID: id, + awsRegion: region, + sdkapi: svcsdk.NewFromConfig(clientcfg), + }, nil +} + +// onError updates resource conditions and returns updated resource +// it returns nil if no condition is updated. +func (rm *resourceManager) onError( + r *resource, + err error, +) (acktypes.AWSResource, error) { + if r == nil { + return nil, err + } + r1, updated := rm.updateConditions(r, false, err) + if !updated { + return r, err + } + for _, condition := range r1.Conditions() { + if condition.Type == ackv1alpha1.ConditionTypeTerminal && + condition.Status == corev1.ConditionTrue { + // resource is in Terminal condition + // return Terminal error + return r1, ackerr.Terminal + } + } + return r1, err +} + +// onSuccess updates resource conditions and returns updated resource +// it returns the supplied resource if no condition is updated. +func (rm *resourceManager) onSuccess( + r *resource, +) (acktypes.AWSResource, error) { + if r == nil { + return nil, nil + } + r1, updated := rm.updateConditions(r, true, nil) + if !updated { + return r, nil + } + return r1, nil +} diff --git a/pkg/resource/api_key/manager_factory.go b/pkg/resource/api_key/manager_factory.go new file mode 100644 index 0000000..094c6e4 --- /dev/null +++ b/pkg/resource/api_key/manager_factory.go @@ -0,0 +1,100 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file 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. + +// Code generated by ack-generate. DO NOT EDIT. + +package api_key + +import ( + "fmt" + "sync" + + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" + ackcfg "github.com/aws-controllers-k8s/runtime/pkg/config" + ackmetrics "github.com/aws-controllers-k8s/runtime/pkg/metrics" + acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/go-logr/logr" + + svcresource "github.com/aws-controllers-k8s/apigateway-controller/pkg/resource" +) + +// resourceManagerFactory produces resourceManager objects. It implements the +// `types.AWSResourceManagerFactory` interface. +type resourceManagerFactory struct { + sync.RWMutex + // rmCache contains resource managers for a particular AWS account ID + rmCache map[string]*resourceManager +} + +// ResourcePrototype returns an AWSResource that resource managers produced by +// this factory will handle +func (f *resourceManagerFactory) ResourceDescriptor() acktypes.AWSResourceDescriptor { + return &resourceDescriptor{} +} + +// ManagerFor returns a resource manager object that can manage resources for a +// supplied AWS account +func (f *resourceManagerFactory) ManagerFor( + cfg ackcfg.Config, + clientcfg aws.Config, + log logr.Logger, + metrics *ackmetrics.Metrics, + rr acktypes.Reconciler, + id ackv1alpha1.AWSAccountID, + region ackv1alpha1.AWSRegion, + roleARN ackv1alpha1.AWSResourceName, +) (acktypes.AWSResourceManager, error) { + // We use the account ID, region, and role ARN to uniquely identify a + // resource manager. This helps us to avoid creating multiple resource + // managers for the same account/region/roleARN combination. + rmId := fmt.Sprintf("%s/%s/%s", id, region, roleARN) + f.RLock() + rm, found := f.rmCache[rmId] + f.RUnlock() + + if found { + return rm, nil + } + + f.Lock() + defer f.Unlock() + + rm, err := newResourceManager(cfg, clientcfg, log, metrics, rr, id, region) + if err != nil { + return nil, err + } + f.rmCache[rmId] = rm + return rm, nil +} + +// IsAdoptable returns true if the resource is able to be adopted +func (f *resourceManagerFactory) IsAdoptable() bool { + return true +} + +// RequeueOnSuccessSeconds returns true if the resource should be requeued after specified seconds +// Default is false which means resource will not be requeued after success. +func (f *resourceManagerFactory) RequeueOnSuccessSeconds() int { + return 0 +} + +func newResourceManagerFactory() *resourceManagerFactory { + return &resourceManagerFactory{ + rmCache: map[string]*resourceManager{}, + } +} + +func init() { + svcresource.RegisterManagerFactory(newResourceManagerFactory()) +} diff --git a/pkg/resource/api_key/references.go b/pkg/resource/api_key/references.go new file mode 100644 index 0000000..9a0d147 --- /dev/null +++ b/pkg/resource/api_key/references.go @@ -0,0 +1,57 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file 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. + +// Code generated by ack-generate. DO NOT EDIT. + +package api_key + +import ( + "context" + + "sigs.k8s.io/controller-runtime/pkg/client" + + acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" + + svcapitypes "github.com/aws-controllers-k8s/apigateway-controller/apis/v1alpha1" +) + +// ClearResolvedReferences removes any reference values that were made +// concrete in the spec. It returns a copy of the input AWSResource which +// contains the original *Ref values, but none of their respective concrete +// values. +func (rm *resourceManager) ClearResolvedReferences(res acktypes.AWSResource) acktypes.AWSResource { + ko := rm.concreteResource(res).ko.DeepCopy() + + return &resource{ko} +} + +// ResolveReferences finds if there are any Reference field(s) present +// inside AWSResource passed in the parameter and attempts to resolve those +// reference field(s) into their respective target field(s). It returns a +// copy of the input AWSResource with resolved reference(s), a boolean which +// is set to true if the resource contains any references (regardless of if +// they are resolved successfully) and an error if the passed AWSResource's +// reference field(s) could not be resolved. +func (rm *resourceManager) ResolveReferences( + ctx context.Context, + apiReader client.Reader, + res acktypes.AWSResource, +) (acktypes.AWSResource, bool, error) { + return res, false, nil +} + +// validateReferenceFields validates the reference field and corresponding +// identifier field. +func validateReferenceFields(ko *svcapitypes.APIKey) error { + return nil +} diff --git a/pkg/resource/api_key/resource.go b/pkg/resource/api_key/resource.go new file mode 100644 index 0000000..5634e59 --- /dev/null +++ b/pkg/resource/api_key/resource.go @@ -0,0 +1,111 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file 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. + +// Code generated by ack-generate. DO NOT EDIT. + +package api_key + +import ( + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" + ackerrors "github.com/aws-controllers-k8s/runtime/pkg/errors" + acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + rtclient "sigs.k8s.io/controller-runtime/pkg/client" + + svcapitypes "github.com/aws-controllers-k8s/apigateway-controller/apis/v1alpha1" +) + +// Hack to avoid import errors during build... +var ( + _ = &ackerrors.MissingNameIdentifier +) + +// resource implements the `aws-controller-k8s/runtime/pkg/types.AWSResource` +// interface +type resource struct { + // The Kubernetes-native CR representing the resource + ko *svcapitypes.APIKey +} + +// Identifiers returns an AWSResourceIdentifiers object containing various +// identifying information, including the AWS account ID that owns the +// resource, the resource's AWS Resource Name (ARN) +func (r *resource) Identifiers() acktypes.AWSResourceIdentifiers { + return &resourceIdentifiers{r.ko.Status.ACKResourceMetadata} +} + +// IsBeingDeleted returns true if the Kubernetes resource has a non-zero +// deletion timestamp +func (r *resource) IsBeingDeleted() bool { + return !r.ko.DeletionTimestamp.IsZero() +} + +// RuntimeObject returns the Kubernetes apimachinery/runtime representation of +// the AWSResource +func (r *resource) RuntimeObject() rtclient.Object { + return r.ko +} + +// MetaObject returns the Kubernetes apimachinery/apis/meta/v1.Object +// representation of the AWSResource +func (r *resource) MetaObject() metav1.Object { + return r.ko.GetObjectMeta() +} + +// Conditions returns the ACK Conditions collection for the AWSResource +func (r *resource) Conditions() []*ackv1alpha1.Condition { + return r.ko.Status.Conditions +} + +// ReplaceConditions sets the Conditions status field for the resource +func (r *resource) ReplaceConditions(conditions []*ackv1alpha1.Condition) { + r.ko.Status.Conditions = conditions +} + +// SetObjectMeta sets the ObjectMeta field for the resource +func (r *resource) SetObjectMeta(meta metav1.ObjectMeta) { + r.ko.ObjectMeta = meta +} + +// SetStatus will set the Status field for the resource +func (r *resource) SetStatus(desired acktypes.AWSResource) { + r.ko.Status = desired.(*resource).ko.Status +} + +// SetIdentifiers sets the Spec or Status field that is referenced as the unique +// resource identifier +func (r *resource) SetIdentifiers(identifier *ackv1alpha1.AWSIdentifiers) error { + if identifier.NameOrID == "" { + return ackerrors.MissingNameIdentifier + } + r.ko.Status.ID = &identifier.NameOrID + + return nil +} + +// PopulateResourceFromAnnotation populates the fields passed from adoption annotation +func (r *resource) PopulateResourceFromAnnotation(fields map[string]string) error { + tmp, ok := fields["id"] + if !ok { + return ackerrors.MissingNameIdentifier + } + r.ko.Status.ID = &tmp + + return nil +} + +// DeepCopy will return a copy of the resource +func (r *resource) DeepCopy() acktypes.AWSResource { + koCopy := r.ko.DeepCopy() + return &resource{koCopy} +} diff --git a/pkg/resource/api_key/sdk.go b/pkg/resource/api_key/sdk.go new file mode 100644 index 0000000..848ab58 --- /dev/null +++ b/pkg/resource/api_key/sdk.go @@ -0,0 +1,550 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file 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. + +// Code generated by ack-generate. DO NOT EDIT. + +package api_key + +import ( + "context" + "errors" + "fmt" + "reflect" + "strings" + + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" + ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare" + ackcondition "github.com/aws-controllers-k8s/runtime/pkg/condition" + ackerr "github.com/aws-controllers-k8s/runtime/pkg/errors" + ackrequeue "github.com/aws-controllers-k8s/runtime/pkg/requeue" + ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log" + "github.com/aws/aws-sdk-go-v2/aws" + svcsdk "github.com/aws/aws-sdk-go-v2/service/apigateway" + svcsdktypes "github.com/aws/aws-sdk-go-v2/service/apigateway/types" + smithy "github.com/aws/smithy-go" + corev1 "k8s.io/api/core/v1" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + + svcapitypes "github.com/aws-controllers-k8s/apigateway-controller/apis/v1alpha1" +) + +// Hack to avoid import errors during build... +var ( + _ = &metav1.Time{} + _ = strings.ToLower("") + _ = &svcsdk.Client{} + _ = &svcapitypes.APIKey{} + _ = ackv1alpha1.AWSAccountID("") + _ = &ackerr.NotFound + _ = &ackcondition.NotManagedMessage + _ = &reflect.Value{} + _ = fmt.Sprintf("") + _ = &ackrequeue.NoRequeue{} + _ = &aws.Config{} +) + +// sdkFind returns SDK-specific information about a supplied resource +func (rm *resourceManager) sdkFind( + ctx context.Context, + r *resource, +) (latest *resource, err error) { + rlog := ackrtlog.FromContext(ctx) + exit := rlog.Trace("rm.sdkFind") + defer func() { + exit(err) + }() + // If any required fields in the input shape are missing, AWS resource is + // not created yet. Return NotFound here to indicate to callers that the + // resource isn't yet created. + if rm.requiredFieldsMissingFromReadOneInput(r) { + return nil, ackerr.NotFound + } + + input, err := rm.newDescribeRequestPayload(r) + if err != nil { + return nil, err + } + + var resp *svcsdk.GetApiKeyOutput + resp, err = rm.sdkapi.GetApiKey(ctx, input) + + if resp.StageKeys != nil { + r.ko.Spec.StageKeys = getStageKeysFromStrings(resp.StageKeys) + } else { + r.ko.Spec.StageKeys = nil + } + + rm.metrics.RecordAPICall("READ_ONE", "GetApiKey", err) + if err != nil { + var awsErr smithy.APIError + if errors.As(err, &awsErr) && awsErr.ErrorCode() == "NotFoundException" { + return nil, ackerr.NotFound + } + return nil, err + } + + // Merge in the information we read from the API call above to the copy of + // the original Kubernetes object we passed to the function + ko := r.ko.DeepCopy() + + if resp.CreatedDate != nil { + ko.Status.CreatedDate = &metav1.Time{*resp.CreatedDate} + } else { + ko.Status.CreatedDate = nil + } + if resp.CustomerId != nil { + ko.Spec.CustomerID = resp.CustomerId + } else { + ko.Spec.CustomerID = nil + } + if resp.Description != nil { + ko.Spec.Description = resp.Description + } else { + ko.Spec.Description = nil + } + ko.Spec.Enabled = &resp.Enabled + if resp.Id != nil { + ko.Status.ID = resp.Id + } else { + ko.Status.ID = nil + } + if resp.LastUpdatedDate != nil { + ko.Status.LastUpdatedDate = &metav1.Time{*resp.LastUpdatedDate} + } else { + ko.Status.LastUpdatedDate = nil + } + if resp.Name != nil { + ko.Spec.Name = resp.Name + } else { + ko.Spec.Name = nil + } + if resp.Tags != nil { + ko.Spec.Tags = aws.StringMap(resp.Tags) + } else { + ko.Spec.Tags = nil + } + + rm.setStatusDefaults(ko) + return &resource{ko}, nil +} + +// requiredFieldsMissingFromReadOneInput returns true if there are any fields +// for the ReadOne Input shape that are required but not present in the +// resource's Spec or Status +func (rm *resourceManager) requiredFieldsMissingFromReadOneInput( + r *resource, +) bool { + return r.ko.Status.ID == nil + +} + +// newDescribeRequestPayload returns SDK-specific struct for the HTTP request +// payload of the Describe API call for the resource +func (rm *resourceManager) newDescribeRequestPayload( + r *resource, +) (*svcsdk.GetApiKeyInput, error) { + res := &svcsdk.GetApiKeyInput{} + + if r.ko.Status.ID != nil { + res.ApiKey = r.ko.Status.ID + } + + return res, nil +} + +// sdkCreate creates the supplied resource in the backend AWS service API and +// returns a copy of the resource with resource fields (in both Spec and +// Status) filled in with values from the CREATE API operation's Output shape. +func (rm *resourceManager) sdkCreate( + ctx context.Context, + desired *resource, +) (created *resource, err error) { + rlog := ackrtlog.FromContext(ctx) + exit := rlog.Trace("rm.sdkCreate") + defer func() { + exit(err) + }() + input, err := rm.newCreateRequestPayload(ctx, desired) + if err != nil { + return nil, err + } + + var resp *svcsdk.CreateApiKeyOutput + _ = resp + resp, err = rm.sdkapi.CreateApiKey(ctx, input) + + if resp.StageKeys != nil { + desired.ko.Spec.StageKeys = getStageKeysFromStrings(resp.StageKeys) + } else { + desired.ko.Spec.StageKeys = nil + } + + rm.metrics.RecordAPICall("CREATE", "CreateApiKey", err) + if err != nil { + return nil, err + } + // Merge in the information we read from the API call above to the copy of + // the original Kubernetes object we passed to the function + ko := desired.ko.DeepCopy() + + if resp.CreatedDate != nil { + ko.Status.CreatedDate = &metav1.Time{*resp.CreatedDate} + } else { + ko.Status.CreatedDate = nil + } + if resp.CustomerId != nil { + ko.Spec.CustomerID = resp.CustomerId + } else { + ko.Spec.CustomerID = nil + } + if resp.Description != nil { + ko.Spec.Description = resp.Description + } else { + ko.Spec.Description = nil + } + ko.Spec.Enabled = &resp.Enabled + if resp.Id != nil { + ko.Status.ID = resp.Id + } else { + ko.Status.ID = nil + } + if resp.LastUpdatedDate != nil { + ko.Status.LastUpdatedDate = &metav1.Time{*resp.LastUpdatedDate} + } else { + ko.Status.LastUpdatedDate = nil + } + if resp.Name != nil { + ko.Spec.Name = resp.Name + } else { + ko.Spec.Name = nil + } + if resp.Tags != nil { + ko.Spec.Tags = aws.StringMap(resp.Tags) + } else { + ko.Spec.Tags = nil + } + + rm.setStatusDefaults(ko) + return &resource{ko}, nil +} + +// newCreateRequestPayload returns an SDK-specific struct for the HTTP request +// payload of the Create API call for the resource +func (rm *resourceManager) newCreateRequestPayload( + ctx context.Context, + r *resource, +) (*svcsdk.CreateApiKeyInput, error) { + res := &svcsdk.CreateApiKeyInput{} + + if r.ko.Spec.CustomerID != nil { + res.CustomerId = r.ko.Spec.CustomerID + } + if r.ko.Spec.Description != nil { + res.Description = r.ko.Spec.Description + } + if r.ko.Spec.Enabled != nil { + res.Enabled = *r.ko.Spec.Enabled + } + if r.ko.Spec.GenerateDistinctID != nil { + res.GenerateDistinctId = *r.ko.Spec.GenerateDistinctID + } + if r.ko.Spec.Name != nil { + res.Name = r.ko.Spec.Name + } + if r.ko.Spec.StageKeys != nil { + f5 := []svcsdktypes.StageKey{} + for _, f5iter := range r.ko.Spec.StageKeys { + f5elem := &svcsdktypes.StageKey{} + if f5iter.RestAPIID != nil { + f5elem.RestApiId = f5iter.RestAPIID + } + if f5iter.StageName != nil { + f5elem.StageName = f5iter.StageName + } + f5 = append(f5, *f5elem) + } + res.StageKeys = f5 + } + if r.ko.Spec.Tags != nil { + res.Tags = aws.ToStringMap(r.ko.Spec.Tags) + } + if r.ko.Spec.Value != nil { + tmpSecret, err := rm.rr.SecretValueFromReference(ctx, r.ko.Spec.Value) + if err != nil { + return nil, ackrequeue.Needed(err) + } + if tmpSecret != "" { + res.Value = aws.String(tmpSecret) + } + } + + return res, nil +} + +// sdkUpdate patches the supplied resource in the backend AWS service API and +// returns a new resource with updated fields. +func (rm *resourceManager) sdkUpdate( + ctx context.Context, + desired *resource, + latest *resource, + delta *ackcompare.Delta, +) (updated *resource, err error) { + rlog := ackrtlog.FromContext(ctx) + exit := rlog.Trace("rm.sdkUpdate") + defer func() { + exit(err) + }() + + // Handle tag updates separately through TagResource/UntagResource APIs + if delta.DifferentAt("Spec.Tags") { + if err := updateTags(ctx, rm, desired, latest); err != nil { + return nil, err + } + } + + if !delta.DifferentExcept("Spec.Tags") { + return desired, nil + } + + input, err := rm.newUpdateRequestPayload(ctx, desired, delta) + if err != nil { + return nil, err + } + + updateApiKeyInput(desired, input, delta) + + var resp *svcsdk.UpdateApiKeyOutput + _ = resp + resp, err = rm.sdkapi.UpdateApiKey(ctx, input) + + if resp.StageKeys != nil { + desired.ko.Spec.StageKeys = getStageKeysFromStrings(resp.StageKeys) + } else { + desired.ko.Spec.StageKeys = nil + } + + rm.metrics.RecordAPICall("UPDATE", "UpdateApiKey", err) + if err != nil { + return nil, err + } + // Merge in the information we read from the API call above to the copy of + // the original Kubernetes object we passed to the function + ko := desired.ko.DeepCopy() + + if resp.CreatedDate != nil { + ko.Status.CreatedDate = &metav1.Time{*resp.CreatedDate} + } else { + ko.Status.CreatedDate = nil + } + if resp.CustomerId != nil { + ko.Spec.CustomerID = resp.CustomerId + } else { + ko.Spec.CustomerID = nil + } + if resp.Description != nil { + ko.Spec.Description = resp.Description + } else { + ko.Spec.Description = nil + } + ko.Spec.Enabled = &resp.Enabled + if resp.Id != nil { + ko.Status.ID = resp.Id + } else { + ko.Status.ID = nil + } + if resp.LastUpdatedDate != nil { + ko.Status.LastUpdatedDate = &metav1.Time{*resp.LastUpdatedDate} + } else { + ko.Status.LastUpdatedDate = nil + } + if resp.Name != nil { + ko.Spec.Name = resp.Name + } else { + ko.Spec.Name = nil + } + if resp.Tags != nil { + ko.Spec.Tags = aws.StringMap(resp.Tags) + } else { + ko.Spec.Tags = nil + } + + rm.setStatusDefaults(ko) + return &resource{ko}, nil +} + +// newUpdateRequestPayload returns an SDK-specific struct for the HTTP request +// payload of the Update API call for the resource +func (rm *resourceManager) newUpdateRequestPayload( + ctx context.Context, + r *resource, + delta *ackcompare.Delta, +) (*svcsdk.UpdateApiKeyInput, error) { + res := &svcsdk.UpdateApiKeyInput{} + + if r.ko.Status.ID != nil { + res.ApiKey = r.ko.Status.ID + } + + return res, nil +} + +// sdkDelete deletes the supplied resource in the backend AWS service API +func (rm *resourceManager) sdkDelete( + ctx context.Context, + r *resource, +) (latest *resource, err error) { + rlog := ackrtlog.FromContext(ctx) + exit := rlog.Trace("rm.sdkDelete") + defer func() { + exit(err) + }() + input, err := rm.newDeleteRequestPayload(r) + if err != nil { + return nil, err + } + var resp *svcsdk.DeleteApiKeyOutput + _ = resp + resp, err = rm.sdkapi.DeleteApiKey(ctx, input) + rm.metrics.RecordAPICall("DELETE", "DeleteApiKey", err) + return nil, err +} + +// newDeleteRequestPayload returns an SDK-specific struct for the HTTP request +// payload of the Delete API call for the resource +func (rm *resourceManager) newDeleteRequestPayload( + r *resource, +) (*svcsdk.DeleteApiKeyInput, error) { + res := &svcsdk.DeleteApiKeyInput{} + + if r.ko.Status.ID != nil { + res.ApiKey = r.ko.Status.ID + } + + return res, nil +} + +// setStatusDefaults sets default properties into supplied custom resource +func (rm *resourceManager) setStatusDefaults( + ko *svcapitypes.APIKey, +) { + if ko.Status.ACKResourceMetadata == nil { + ko.Status.ACKResourceMetadata = &ackv1alpha1.ResourceMetadata{} + } + if ko.Status.ACKResourceMetadata.Region == nil { + ko.Status.ACKResourceMetadata.Region = &rm.awsRegion + } + if ko.Status.ACKResourceMetadata.OwnerAccountID == nil { + ko.Status.ACKResourceMetadata.OwnerAccountID = &rm.awsAccountID + } + if ko.Status.Conditions == nil { + ko.Status.Conditions = []*ackv1alpha1.Condition{} + } +} + +// updateConditions returns updated resource, true; if conditions were updated +// else it returns nil, false +func (rm *resourceManager) updateConditions( + r *resource, + onSuccess bool, + err error, +) (*resource, bool) { + ko := r.ko.DeepCopy() + rm.setStatusDefaults(ko) + + // Terminal condition + var terminalCondition *ackv1alpha1.Condition = nil + var recoverableCondition *ackv1alpha1.Condition = nil + var syncCondition *ackv1alpha1.Condition = nil + for _, condition := range ko.Status.Conditions { + if condition.Type == ackv1alpha1.ConditionTypeTerminal { + terminalCondition = condition + } + if condition.Type == ackv1alpha1.ConditionTypeRecoverable { + recoverableCondition = condition + } + if condition.Type == ackv1alpha1.ConditionTypeResourceSynced { + syncCondition = condition + } + } + var termError *ackerr.TerminalError + if rm.terminalAWSError(err) || err == ackerr.SecretTypeNotSupported || err == ackerr.SecretNotFound || errors.As(err, &termError) { + if terminalCondition == nil { + terminalCondition = &ackv1alpha1.Condition{ + Type: ackv1alpha1.ConditionTypeTerminal, + } + ko.Status.Conditions = append(ko.Status.Conditions, terminalCondition) + } + var errorMessage = "" + if err == ackerr.SecretTypeNotSupported || err == ackerr.SecretNotFound || errors.As(err, &termError) { + errorMessage = err.Error() + } else { + awsErr, _ := ackerr.AWSError(err) + errorMessage = awsErr.Error() + } + terminalCondition.Status = corev1.ConditionTrue + terminalCondition.Message = &errorMessage + } else { + // Clear the terminal condition if no longer present + if terminalCondition != nil { + terminalCondition.Status = corev1.ConditionFalse + terminalCondition.Message = nil + } + // Handling Recoverable Conditions + if err != nil { + if recoverableCondition == nil { + // Add a new Condition containing a non-terminal error + recoverableCondition = &ackv1alpha1.Condition{ + Type: ackv1alpha1.ConditionTypeRecoverable, + } + ko.Status.Conditions = append(ko.Status.Conditions, recoverableCondition) + } + recoverableCondition.Status = corev1.ConditionTrue + awsErr, _ := ackerr.AWSError(err) + errorMessage := err.Error() + if awsErr != nil { + errorMessage = awsErr.Error() + } + recoverableCondition.Message = &errorMessage + } else if recoverableCondition != nil { + recoverableCondition.Status = corev1.ConditionFalse + recoverableCondition.Message = nil + } + } + // Required to avoid the "declared but not used" error in the default case + _ = syncCondition + if terminalCondition != nil || recoverableCondition != nil || syncCondition != nil { + return &resource{ko}, true // updated + } + return nil, false // not updated +} + +// terminalAWSError returns awserr, true; if the supplied error is an aws Error type +// and if the exception indicates that it is a Terminal exception +// 'Terminal' exception are specified in generator configuration +func (rm *resourceManager) terminalAWSError(err error) bool { + if err == nil { + return false + } + + var terminalErr smithy.APIError + if !errors.As(err, &terminalErr) { + return false + } + switch terminalErr.ErrorCode() { + case "BadRequestException", + "InvalidParameter": + return true + default: + return false + } +} diff --git a/pkg/resource/api_key/tags.go b/pkg/resource/api_key/tags.go new file mode 100644 index 0000000..91a3436 --- /dev/null +++ b/pkg/resource/api_key/tags.go @@ -0,0 +1,108 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file 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. + +// Code generated by ack-generate. DO NOT EDIT. + +package api_key + +import ( + "slices" + "strings" + + acktags "github.com/aws-controllers-k8s/runtime/pkg/tags" + + svcapitypes "github.com/aws-controllers-k8s/apigateway-controller/apis/v1alpha1" +) + +var ( + _ = svcapitypes.APIKey{} + _ = acktags.NewTags() + ACKSystemTags = []string{"services.k8s.aws/namespace", "services.k8s.aws/controller-version"} +) + +// convertToOrderedACKTags converts the tags parameter into 'acktags.Tags' shape. +// This method helps in creating the hub(acktags.Tags) for merging +// default controller tags with existing resource tags. It also returns a slice +// of keys maintaining the original key Order when the tags are a list +func convertToOrderedACKTags(tags map[string]*string) (acktags.Tags, []string) { + result := acktags.NewTags() + keyOrder := []string{} + + if len(tags) == 0 { + return result, keyOrder + } + for k, v := range tags { + if v == nil { + result[k] = "" + } else { + result[k] = *v + } + } + + return result, keyOrder +} + +// fromACKTags converts the tags parameter into map[string]*string shape. +// This method helps in setting the tags back inside AWSResource after merging +// default controller tags with existing resource tags. When a list, +// it maintains the order from original +func fromACKTags(tags acktags.Tags, keyOrder []string) map[string]*string { + result := map[string]*string{} + + _ = keyOrder + for k, v := range tags { + result[k] = &v + } + + return result +} + +// ignoreSystemTags ignores tags that have keys that start with "aws:" +// and ACKSystemTags, to avoid patching them to the resourceSpec. +// Eg. resources created with cloudformation have tags that cannot be +// removed by an ACK controller +func ignoreSystemTags(tags acktags.Tags) { + for k := range tags { + if strings.HasPrefix(k, "aws:") || + slices.Contains(ACKSystemTags, k) { + delete(tags, k) + } + } +} + +// syncAWSTags ensures AWS-managed tags (prefixed with "aws:") from the latest resource state +// are preserved in the desired state. This prevents the controller from attempting to +// modify AWS-managed tags, which would result in an error. +// +// AWS-managed tags are automatically added by AWS services (e.g., CloudFormation, Service Catalog) +// and cannot be modified or deleted through normal tag operations. Common examples include: +// - aws:cloudformation:stack-name +// - aws:servicecatalog:productArn +// +// Parameters: +// - a: The target Tags map to be updated (typically desired state) +// - b: The source Tags map containing AWS-managed tags (typically latest state) +// +// Example: +// +// latest := Tags{"aws:cloudformation:stack-name": "my-stack", "environment": "prod"} +// desired := Tags{"environment": "dev"} +// SyncAWSTags(desired, latest) +// desired now contains {"aws:cloudformation:stack-name": "my-stack", "environment": "dev"} +func syncAWSTags(a acktags.Tags, b acktags.Tags) { + for k := range b { + if strings.HasPrefix(k, "aws:") { + a[k] = b[k] + } + } +} diff --git a/templates/hooks/api_key/sdk_read_one_post_request.go.tpl b/templates/hooks/api_key/sdk_read_one_post_request.go.tpl new file mode 100644 index 0000000..13710f5 --- /dev/null +++ b/templates/hooks/api_key/sdk_read_one_post_request.go.tpl @@ -0,0 +1,6 @@ + + if resp.StageKeys != nil { + r.ko.Spec.StageKeys = getStageKeysFromStrings(resp.StageKeys) + } else { + r.ko.Spec.StageKeys = nil + } diff --git a/templates/hooks/api_key/sdk_update_post_build_request.go.tpl b/templates/hooks/api_key/sdk_update_post_build_request.go.tpl new file mode 100644 index 0000000..587e456 --- /dev/null +++ b/templates/hooks/api_key/sdk_update_post_build_request.go.tpl @@ -0,0 +1,2 @@ + + updateApiKeyInput(desired, input, delta) diff --git a/templates/hooks/api_key/sdk_update_post_request.go.tpl b/templates/hooks/api_key/sdk_update_post_request.go.tpl new file mode 100644 index 0000000..f6a6e60 --- /dev/null +++ b/templates/hooks/api_key/sdk_update_post_request.go.tpl @@ -0,0 +1,7 @@ + + if resp.StageKeys != nil { + desired.ko.Spec.StageKeys = getStageKeysFromStrings(resp.StageKeys) + } else { + desired.ko.Spec.StageKeys = nil + } + \ No newline at end of file diff --git a/templates/hooks/api_key/sdk_update_pre_build_request.go.tpl b/templates/hooks/api_key/sdk_update_pre_build_request.go.tpl new file mode 100644 index 0000000..24beeb0 --- /dev/null +++ b/templates/hooks/api_key/sdk_update_pre_build_request.go.tpl @@ -0,0 +1,11 @@ + + // Handle tag updates separately through TagResource/UntagResource APIs + if delta.DifferentAt("Spec.Tags") { + if err := updateTags(ctx, rm, desired, latest); err != nil { + return nil, err + } + } + + if !delta.DifferentExcept("Spec.Tags") { + return desired, nil + } diff --git a/test/e2e/resources/api_key_simple.yaml b/test/e2e/resources/api_key_simple.yaml new file mode 100644 index 0000000..2409268 --- /dev/null +++ b/test/e2e/resources/api_key_simple.yaml @@ -0,0 +1,14 @@ +apiVersion: apigateway.services.k8s.aws/v1alpha1 +kind: APIKey +metadata: + name: $API_KEY_NAME +spec: + name: $API_KEY_NAME + description: API Key for testing + enabled: true + stageKeys: + - restAPIID: $REST_API_ID + stageName: $STAGE_NAME + tags: + k1: v1 + k2: v2 \ No newline at end of file diff --git a/test/e2e/tests/api_key_test.py b/test/e2e/tests/api_key_test.py new file mode 100644 index 0000000..69456d1 --- /dev/null +++ b/test/e2e/tests/api_key_test.py @@ -0,0 +1,133 @@ +# Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"). You may +# not use this file except in compliance with the License. A copy of the +# License is located at +# +# http://aws.amazon.com/apache2.0/ +# +# or in the "license" file accompanying this file. This file 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. + +"""Integration tests for the API Key resource +""" + +import pytest +import logging +import time +from typing import Dict, Tuple + +from acktest.k8s import resource as k8s +from acktest.resources import random_suffix_name +from acktest import tags +from e2e import service_marker, CRD_GROUP, CRD_VERSION, load_apigateway_resource +from e2e.replacement_values import REPLACEMENT_VALUES +from e2e.bootstrap_resources import get_bootstrap_resources +from .rest_api_test import simple_rest_api +from .resource_test import simple_resource +from .integration_test import simple_integration +from .stage_test import simple_stage + +API_KEY_RESOURCE_PLURAL = "apikeys" +MODIFY_WAIT_AFTER_SECONDS = 60 + + +@pytest.fixture(scope='module') +def simple_api_key(simple_stage, simple_rest_api, apigateway_client) -> Tuple[k8s.CustomResourceReference, Dict]: + api_key_name = random_suffix_name("simple-api-key", 32) + + replacements = REPLACEMENT_VALUES.copy() + replacements["API_KEY_NAME"] = api_key_name + + (stage_ref, stage_cr, rest_api_id) = simple_stage + (rest_api_ref, rest_api_cr) = simple_rest_api + + replacements["REST_API_ID"] = rest_api_cr["status"]["id"] + replacements["STAGE_NAME"] = stage_cr["spec"]["stageName"] + + resource_data = load_apigateway_resource( + "api_key_simple", + additional_replacements=replacements, + ) + + ref = k8s.CustomResourceReference( + CRD_GROUP, + CRD_VERSION, + API_KEY_RESOURCE_PLURAL, + api_key_name, + namespace="default", + ) + k8s.create_custom_resource(ref, resource_data) + cr = k8s.wait_resource_consumed_by_controller(ref) + + assert cr is not None + assert k8s.get_resource_exists(ref) + + cr = k8s.get_resource(ref) + yield ref, cr + + # Delete the API key + _, deleted = k8s.delete_custom_resource(ref, 3, 10) + assert deleted + + +@service_marker +@pytest.mark.canary +class TestAPIKey: + def test_create_update_api_key(self, simple_api_key, apigateway_client): + (ref, cr) = simple_api_key + + api_key_id = cr["status"]["id"] + assert api_key_id is not None + + aws_api_key = apigateway_client.get_api_key( + apiKey=api_key_id, + includeValue=True + ) + + assert aws_api_key["name"] == cr["spec"]["name"] + assert aws_api_key["description"] == "API Key for testing" + assert aws_api_key["enabled"] == True + + # Validate tags + latest_tags = aws_api_key["tags"] + tags.assert_ack_system_tags( + tags=latest_tags, + ) + + assert 'tags' in cr['spec'] + user_tags = cr["spec"]["tags"] + tags.assert_equal_without_ack_tags( + expected=user_tags, + actual=latest_tags, + ) + + update_tags = {"k1": "updated-v1", "k3": "v3"} + + cr["spec"]["tags"] = update_tags + cr["spec"]["enabled"] = False + + k8s.patch_custom_resource(ref, cr) + updated_cr = k8s.wait_resource_consumed_by_controller(ref) + + time.sleep(MODIFY_WAIT_AFTER_SECONDS) + updated_aws_api_key = apigateway_client.get_api_key( + apiKey=api_key_id, + includeValue=True + ) + + # Validate updated tags + latest_tags = updated_aws_api_key["tags"] + tags.assert_ack_system_tags( + tags=latest_tags, + ) + + user_tags = updated_cr["spec"]["tags"] + tags.assert_equal_without_ack_tags( + expected=user_tags, + actual=latest_tags, + ) + + assert updated_aws_api_key["enabled"] == False diff --git a/test/e2e/tests/resource_test.py b/test/e2e/tests/resource_test.py index 4e5f7cd..ea9e826 100644 --- a/test/e2e/tests/resource_test.py +++ b/test/e2e/tests/resource_test.py @@ -64,7 +64,6 @@ def simple_resource(simple_rest_api, apigateway_client) -> Tuple[k8s.CustomResou k8s.create_custom_resource(ref, resource_data) cr = k8s.wait_resource_consumed_by_controller(ref, wait_periods=30) - assert cr is not None assert cr['status']['id'] is not None assert k8s.get_resource_exists(ref) @@ -83,7 +82,8 @@ def simple_resource(simple_rest_api, apigateway_client) -> Tuple[k8s.CustomResou _, deleted = k8s.delete_custom_resource(ref, 10, 60) assert deleted - wait_until_deleted(partial(apigateway_client.get_resource, **resource_query)) + wait_until_deleted( + partial(apigateway_client.get_resource, **resource_query)) @service_marker @@ -91,7 +91,8 @@ def simple_resource(simple_rest_api, apigateway_client) -> Tuple[k8s.CustomResou class TestResource: def test_create_update_resource(self, simple_resource, apigateway_client): (ref, cr, _, resource_query) = simple_resource - assert safe_get(partial(apigateway_client.get_resource, **resource_query)) is not None + assert safe_get(partial(apigateway_client.get_resource, + **resource_query)) is not None updates = { 'spec': { diff --git a/test/e2e/tests/stage_test.py b/test/e2e/tests/stage_test.py index e9f100e..b0b2ad9 100644 --- a/test/e2e/tests/stage_test.py +++ b/test/e2e/tests/stage_test.py @@ -43,7 +43,7 @@ def apigateway_client(): return boto3.client(SERVICE_NAME) -@pytest.fixture +@pytest.fixture(scope='module') def simple_stage(simple_integration, apigateway_client) -> Tuple[k8s.CustomResourceReference, Dict, str]: stage_name = random_suffix_name('simple-stage', 32) (ref, cr, resource_query) = simple_integration