diff --git a/apis/v1alpha1/ack-generate-metadata.yaml b/apis/v1alpha1/ack-generate-metadata.yaml index 91c88cf..4cc7053 100755 --- a/apis/v1alpha1/ack-generate-metadata.yaml +++ b/apis/v1alpha1/ack-generate-metadata.yaml @@ -1,13 +1,13 @@ ack_generate_info: - build_date: "2024-11-15T12:22:33Z" + build_date: "2024-11-15T12:28:35Z" build_hash: 9715a2a715317a76ae83825294ca50cde9afd97b go_version: go1.22.5 version: v0.39.1-4-g9715a2a -api_directory_checksum: 89e6d7c7c3de232b8c908d9fc8a94b31166d61d9 +api_directory_checksum: bec5824e121b02c227862a05ba3ad534a6dd71bf api_version: v1alpha1 aws_sdk_go_version: v1.55.5 generator_config_info: - file_checksum: a6402ac3c8ab9987c5e8cbd62774a6e18d52cca6 + file_checksum: 8509dd7b6855643c5491564f8df855b403d0a9c3 original_file_name: generator.yaml last_modification: reason: API generation diff --git a/apis/v1alpha1/custom_verification_email_template.go b/apis/v1alpha1/custom_verification_email_template.go new file mode 100644 index 0000000..210919e --- /dev/null +++ b/apis/v1alpha1/custom_verification_email_template.go @@ -0,0 +1,89 @@ +// 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" +) + +// CustomVerificationEmailTemplateSpec defines the desired state of CustomVerificationEmailTemplate. +// +// Contains information about a custom verification email template. +type CustomVerificationEmailTemplateSpec struct { + + // The URL that the recipient of the verification email is sent to if his or + // her address is not successfully verified. + // +kubebuilder:validation:Required + FailureRedirectionURL *string `json:"failureRedirectionURL"` + // The email address that the custom verification email is sent from. + // +kubebuilder:validation:Required + FromEmailAddress *string `json:"fromEmailAddress"` + // The URL that the recipient of the verification email is sent to if his or + // her address is successfully verified. + // +kubebuilder:validation:Required + SuccessRedirectionURL *string `json:"successRedirectionURL"` + // The content of the custom verification email. The total size of the email + // must be less than 10 MB. The message body may contain HTML, with some limitations. + // For more information, see Custom Verification Email Frequently Asked Questions + // (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) + // in the Amazon SES Developer Guide. + // +kubebuilder:validation:Required + TemplateContent *string `json:"templateContent"` + // The name of the custom verification email template. + TemplateName *string `json:"templateName,omitempty"` + TemplateRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"templateRef,omitempty"` + // The subject line of the custom verification email. + // +kubebuilder:validation:Required + TemplateSubject *string `json:"templateSubject"` +} + +// CustomVerificationEmailTemplateStatus defines the observed state of CustomVerificationEmailTemplate +type CustomVerificationEmailTemplateStatus 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"` +} + +// CustomVerificationEmailTemplate is the Schema for the CustomVerificationEmailTemplates API +// +kubebuilder:object:root=true +// +kubebuilder:subresource:status +type CustomVerificationEmailTemplate struct { + metav1.TypeMeta `json:",inline"` + metav1.ObjectMeta `json:"metadata,omitempty"` + Spec CustomVerificationEmailTemplateSpec `json:"spec,omitempty"` + Status CustomVerificationEmailTemplateStatus `json:"status,omitempty"` +} + +// CustomVerificationEmailTemplateList contains a list of CustomVerificationEmailTemplate +// +kubebuilder:object:root=true +type CustomVerificationEmailTemplateList struct { + metav1.TypeMeta `json:",inline"` + metav1.ListMeta `json:"metadata,omitempty"` + Items []CustomVerificationEmailTemplate `json:"items"` +} + +func init() { + SchemeBuilder.Register(&CustomVerificationEmailTemplate{}, &CustomVerificationEmailTemplateList{}) +} diff --git a/apis/v1alpha1/generator.yaml b/apis/v1alpha1/generator.yaml index 15c0a8a..5af5564 100644 --- a/apis/v1alpha1/generator.yaml +++ b/apis/v1alpha1/generator.yaml @@ -2,7 +2,7 @@ ignore: resource_names: # - ConfigurationSet # - ConfigurationSetEventDestination - - CustomVerificationEmailTemplate +# - CustomVerificationEmailTemplate # - ReceiptFilter # - ReceiptRule # - ReceiptRuleSet @@ -215,3 +215,21 @@ resources: template_path: hooks/configuration_set_event_destination/sdk_delete_post_build_request.go.tpl sdk_file_end: template_path: hooks/configuration_set_event_destination/sdk_file_end.go.tpl + + CustomVerificationEmailTemplate: + fields: + TemplateName: + is_primary_key: true + is_immutable: true + references: + resource: Template + path: Spec.Name + tags: + ignore: true + exceptions: + terminal_codes: + - CustomVerificationEmailInvalidContent + - CustomVerificationEmailTemplateAlreadyExists + hooks: + sdk_read_one_post_request: + template_path: hooks/custom_verification_email_template/sdk_read_one_post_request.go.tpl diff --git a/apis/v1alpha1/types.go b/apis/v1alpha1/types.go index 0671bd4..66e8bc2 100644 --- a/apis/v1alpha1/types.go +++ b/apis/v1alpha1/types.go @@ -94,8 +94,12 @@ type ConfigurationSet_SDK struct { } // Contains information about a custom verification email template. -type CustomVerificationEmailTemplate struct { - TemplateName *string `json:"templateName,omitempty"` +type CustomVerificationEmailTemplate_SDK struct { + FailureRedirectionURL *string `json:"failureRedirectionURL,omitempty"` + FromEmailAddress *string `json:"fromEmailAddress,omitempty"` + SuccessRedirectionURL *string `json:"successRedirectionURL,omitempty"` + TemplateName *string `json:"templateName,omitempty"` + TemplateSubject *string `json:"templateSubject,omitempty"` } // Specifies whether messages that use the configuration set are required to diff --git a/apis/v1alpha1/zz_generated.deepcopy.go b/apis/v1alpha1/zz_generated.deepcopy.go index b04b79f..70625f4 100644 --- a/apis/v1alpha1/zz_generated.deepcopy.go +++ b/apis/v1alpha1/zz_generated.deepcopy.go @@ -423,19 +423,179 @@ func (in *ConfigurationSet_SDK) DeepCopy() *ConfigurationSet_SDK { // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *CustomVerificationEmailTemplate) DeepCopyInto(out *CustomVerificationEmailTemplate) { *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 CustomVerificationEmailTemplate. +func (in *CustomVerificationEmailTemplate) DeepCopy() *CustomVerificationEmailTemplate { + if in == nil { + return nil + } + out := new(CustomVerificationEmailTemplate) + in.DeepCopyInto(out) + return out +} + +// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. +func (in *CustomVerificationEmailTemplate) 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 *CustomVerificationEmailTemplateList) DeepCopyInto(out *CustomVerificationEmailTemplateList) { + *out = *in + out.TypeMeta = in.TypeMeta + in.ListMeta.DeepCopyInto(&out.ListMeta) + if in.Items != nil { + in, out := &in.Items, &out.Items + *out = make([]CustomVerificationEmailTemplate, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomVerificationEmailTemplateList. +func (in *CustomVerificationEmailTemplateList) DeepCopy() *CustomVerificationEmailTemplateList { + if in == nil { + return nil + } + out := new(CustomVerificationEmailTemplateList) + in.DeepCopyInto(out) + return out +} + +// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. +func (in *CustomVerificationEmailTemplateList) 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 *CustomVerificationEmailTemplateSpec) DeepCopyInto(out *CustomVerificationEmailTemplateSpec) { + *out = *in + if in.FailureRedirectionURL != nil { + in, out := &in.FailureRedirectionURL, &out.FailureRedirectionURL + *out = new(string) + **out = **in + } + if in.FromEmailAddress != nil { + in, out := &in.FromEmailAddress, &out.FromEmailAddress + *out = new(string) + **out = **in + } + if in.SuccessRedirectionURL != nil { + in, out := &in.SuccessRedirectionURL, &out.SuccessRedirectionURL + *out = new(string) + **out = **in + } + if in.TemplateContent != nil { + in, out := &in.TemplateContent, &out.TemplateContent + *out = new(string) + **out = **in + } if in.TemplateName != nil { in, out := &in.TemplateName, &out.TemplateName *out = new(string) **out = **in } + if in.TemplateRef != nil { + in, out := &in.TemplateRef, &out.TemplateRef + *out = new(corev1alpha1.AWSResourceReferenceWrapper) + (*in).DeepCopyInto(*out) + } + if in.TemplateSubject != nil { + in, out := &in.TemplateSubject, &out.TemplateSubject + *out = new(string) + **out = **in + } } -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomVerificationEmailTemplate. -func (in *CustomVerificationEmailTemplate) DeepCopy() *CustomVerificationEmailTemplate { +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomVerificationEmailTemplateSpec. +func (in *CustomVerificationEmailTemplateSpec) DeepCopy() *CustomVerificationEmailTemplateSpec { if in == nil { return nil } - out := new(CustomVerificationEmailTemplate) + out := new(CustomVerificationEmailTemplateSpec) + in.DeepCopyInto(out) + return out +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *CustomVerificationEmailTemplateStatus) DeepCopyInto(out *CustomVerificationEmailTemplateStatus) { + *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) + } + } + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomVerificationEmailTemplateStatus. +func (in *CustomVerificationEmailTemplateStatus) DeepCopy() *CustomVerificationEmailTemplateStatus { + if in == nil { + return nil + } + out := new(CustomVerificationEmailTemplateStatus) + in.DeepCopyInto(out) + return out +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *CustomVerificationEmailTemplate_SDK) DeepCopyInto(out *CustomVerificationEmailTemplate_SDK) { + *out = *in + if in.FailureRedirectionURL != nil { + in, out := &in.FailureRedirectionURL, &out.FailureRedirectionURL + *out = new(string) + **out = **in + } + if in.FromEmailAddress != nil { + in, out := &in.FromEmailAddress, &out.FromEmailAddress + *out = new(string) + **out = **in + } + if in.SuccessRedirectionURL != nil { + in, out := &in.SuccessRedirectionURL, &out.SuccessRedirectionURL + *out = new(string) + **out = **in + } + if in.TemplateName != nil { + in, out := &in.TemplateName, &out.TemplateName + *out = new(string) + **out = **in + } + if in.TemplateSubject != nil { + in, out := &in.TemplateSubject, &out.TemplateSubject + *out = new(string) + **out = **in + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomVerificationEmailTemplate_SDK. +func (in *CustomVerificationEmailTemplate_SDK) DeepCopy() *CustomVerificationEmailTemplate_SDK { + if in == nil { + return nil + } + out := new(CustomVerificationEmailTemplate_SDK) in.DeepCopyInto(out) return out } diff --git a/cmd/controller/main.go b/cmd/controller/main.go index 8fa956a..3dcbf64 100644 --- a/cmd/controller/main.go +++ b/cmd/controller/main.go @@ -42,6 +42,7 @@ import ( _ "github.com/aws-controllers-k8s/ses-controller/pkg/resource/configuration_set" _ "github.com/aws-controllers-k8s/ses-controller/pkg/resource/configuration_set_event_destination" + _ "github.com/aws-controllers-k8s/ses-controller/pkg/resource/custom_verification_email_template" _ "github.com/aws-controllers-k8s/ses-controller/pkg/resource/receipt_filter" _ "github.com/aws-controllers-k8s/ses-controller/pkg/resource/receipt_rule" _ "github.com/aws-controllers-k8s/ses-controller/pkg/resource/receipt_rule_set" diff --git a/config/crd/bases/ses.services.k8s.aws_customverificationemailtemplates.yaml b/config/crd/bases/ses.services.k8s.aws_customverificationemailtemplates.yaml new file mode 100644 index 0000000..f0c6030 --- /dev/null +++ b/config/crd/bases/ses.services.k8s.aws_customverificationemailtemplates.yaml @@ -0,0 +1,171 @@ +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.16.2 + name: customverificationemailtemplates.ses.services.k8s.aws +spec: + group: ses.services.k8s.aws + names: + kind: CustomVerificationEmailTemplate + listKind: CustomVerificationEmailTemplateList + plural: customverificationemailtemplates + singular: customverificationemailtemplate + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: CustomVerificationEmailTemplate is the Schema for the CustomVerificationEmailTemplates + 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: |- + CustomVerificationEmailTemplateSpec defines the desired state of CustomVerificationEmailTemplate. + + Contains information about a custom verification email template. + properties: + failureRedirectionURL: + description: |- + The URL that the recipient of the verification email is sent to if his or + her address is not successfully verified. + type: string + fromEmailAddress: + description: The email address that the custom verification email + is sent from. + type: string + successRedirectionURL: + description: |- + The URL that the recipient of the verification email is sent to if his or + her address is successfully verified. + type: string + templateContent: + description: |- + The content of the custom verification email. The total size of the email + must be less than 10 MB. The message body may contain HTML, with some limitations. + For more information, see Custom Verification Email Frequently Asked Questions + (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) + in the Amazon SES Developer Guide. + type: string + templateName: + description: The name of the custom verification email template. + type: string + templateRef: + description: "AWSResourceReferenceWrapper provides a wrapper around + *AWSResourceReference\ntype to provide more user friendly syntax + for references using 'from' field\nEx:\nAPIIDRef:\n\n\tfrom:\n\t + \ name: my-api" + properties: + from: + description: |- + AWSResourceReference provides all the values necessary to reference another + k8s resource for finding the identifier(Id/ARN/Name) + properties: + name: + type: string + namespace: + type: string + type: object + type: object + templateSubject: + description: The subject line of the custom verification email. + type: string + required: + - failureRedirectionURL + - fromEmailAddress + - successRedirectionURL + - templateContent + - templateSubject + type: object + status: + description: CustomVerificationEmailTemplateStatus defines the observed + state of CustomVerificationEmailTemplate + 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 + type: object + type: object + served: true + storage: true + subresources: + status: {} diff --git a/config/crd/kustomization.yaml b/config/crd/kustomization.yaml index a5cd0a4..16b46f1 100644 --- a/config/crd/kustomization.yaml +++ b/config/crd/kustomization.yaml @@ -4,6 +4,7 @@ resources: - common - bases/ses.services.k8s.aws_configurationsets.yaml - bases/ses.services.k8s.aws_configurationseteventdestinations.yaml + - bases/ses.services.k8s.aws_customverificationemailtemplates.yaml - bases/ses.services.k8s.aws_receiptfilters.yaml - bases/ses.services.k8s.aws_receiptrules.yaml - bases/ses.services.k8s.aws_receiptrulesets.yaml diff --git a/config/rbac/cluster-role-controller.yaml b/config/rbac/cluster-role-controller.yaml index 18d0529..d9e3455 100644 --- a/config/rbac/cluster-role-controller.yaml +++ b/config/rbac/cluster-role-controller.yaml @@ -49,6 +49,7 @@ rules: resources: - configurationseteventdestinations - configurationsets + - customverificationemailtemplates - receiptfilters - receiptrules - receiptrulesets @@ -66,6 +67,7 @@ rules: resources: - configurationseteventdestinations/status - configurationsets/status + - customverificationemailtemplates/status - receiptfilters/status - receiptrules/status - receiptrulesets/status diff --git a/config/rbac/role-reader.yaml b/config/rbac/role-reader.yaml index f803923..8c37ccd 100644 --- a/config/rbac/role-reader.yaml +++ b/config/rbac/role-reader.yaml @@ -11,6 +11,7 @@ rules: resources: - configurationsets - configurationseteventdestinations + - customverificationemailtemplates - receiptfilters - receiptrules - receiptrulesets diff --git a/config/rbac/role-writer.yaml b/config/rbac/role-writer.yaml index 6e89e28..16cb6a4 100644 --- a/config/rbac/role-writer.yaml +++ b/config/rbac/role-writer.yaml @@ -11,6 +11,7 @@ rules: resources: - configurationsets - configurationseteventdestinations + - customverificationemailtemplates - receiptfilters - receiptrules - receiptrulesets @@ -28,6 +29,7 @@ rules: resources: - configurationsets - configurationseteventdestinations + - customverificationemailtemplates - receiptfilters - receiptrules - receiptrulesets diff --git a/generator.yaml b/generator.yaml index 15c0a8a..5af5564 100644 --- a/generator.yaml +++ b/generator.yaml @@ -2,7 +2,7 @@ ignore: resource_names: # - ConfigurationSet # - ConfigurationSetEventDestination - - CustomVerificationEmailTemplate +# - CustomVerificationEmailTemplate # - ReceiptFilter # - ReceiptRule # - ReceiptRuleSet @@ -215,3 +215,21 @@ resources: template_path: hooks/configuration_set_event_destination/sdk_delete_post_build_request.go.tpl sdk_file_end: template_path: hooks/configuration_set_event_destination/sdk_file_end.go.tpl + + CustomVerificationEmailTemplate: + fields: + TemplateName: + is_primary_key: true + is_immutable: true + references: + resource: Template + path: Spec.Name + tags: + ignore: true + exceptions: + terminal_codes: + - CustomVerificationEmailInvalidContent + - CustomVerificationEmailTemplateAlreadyExists + hooks: + sdk_read_one_post_request: + template_path: hooks/custom_verification_email_template/sdk_read_one_post_request.go.tpl diff --git a/helm/crds/ses.services.k8s.aws_customverificationemailtemplates.yaml b/helm/crds/ses.services.k8s.aws_customverificationemailtemplates.yaml new file mode 100644 index 0000000..f0c6030 --- /dev/null +++ b/helm/crds/ses.services.k8s.aws_customverificationemailtemplates.yaml @@ -0,0 +1,171 @@ +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.16.2 + name: customverificationemailtemplates.ses.services.k8s.aws +spec: + group: ses.services.k8s.aws + names: + kind: CustomVerificationEmailTemplate + listKind: CustomVerificationEmailTemplateList + plural: customverificationemailtemplates + singular: customverificationemailtemplate + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: CustomVerificationEmailTemplate is the Schema for the CustomVerificationEmailTemplates + 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: |- + CustomVerificationEmailTemplateSpec defines the desired state of CustomVerificationEmailTemplate. + + Contains information about a custom verification email template. + properties: + failureRedirectionURL: + description: |- + The URL that the recipient of the verification email is sent to if his or + her address is not successfully verified. + type: string + fromEmailAddress: + description: The email address that the custom verification email + is sent from. + type: string + successRedirectionURL: + description: |- + The URL that the recipient of the verification email is sent to if his or + her address is successfully verified. + type: string + templateContent: + description: |- + The content of the custom verification email. The total size of the email + must be less than 10 MB. The message body may contain HTML, with some limitations. + For more information, see Custom Verification Email Frequently Asked Questions + (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) + in the Amazon SES Developer Guide. + type: string + templateName: + description: The name of the custom verification email template. + type: string + templateRef: + description: "AWSResourceReferenceWrapper provides a wrapper around + *AWSResourceReference\ntype to provide more user friendly syntax + for references using 'from' field\nEx:\nAPIIDRef:\n\n\tfrom:\n\t + \ name: my-api" + properties: + from: + description: |- + AWSResourceReference provides all the values necessary to reference another + k8s resource for finding the identifier(Id/ARN/Name) + properties: + name: + type: string + namespace: + type: string + type: object + type: object + templateSubject: + description: The subject line of the custom verification email. + type: string + required: + - failureRedirectionURL + - fromEmailAddress + - successRedirectionURL + - templateContent + - templateSubject + type: object + status: + description: CustomVerificationEmailTemplateStatus defines the observed + state of CustomVerificationEmailTemplate + 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 + type: object + type: object + served: true + storage: true + subresources: + status: {} diff --git a/helm/templates/_helpers.tpl b/helm/templates/_helpers.tpl index 238162d..18d87b3 100644 --- a/helm/templates/_helpers.tpl +++ b/helm/templates/_helpers.tpl @@ -96,6 +96,7 @@ rules: resources: - configurationseteventdestinations - configurationsets + - customverificationemailtemplates - receiptfilters - receiptrules - receiptrulesets @@ -113,6 +114,7 @@ rules: resources: - configurationseteventdestinations/status - configurationsets/status + - customverificationemailtemplates/status - receiptfilters/status - receiptrules/status - receiptrulesets/status diff --git a/helm/templates/role-reader.yaml b/helm/templates/role-reader.yaml index 87d64a9..8633893 100644 --- a/helm/templates/role-reader.yaml +++ b/helm/templates/role-reader.yaml @@ -11,6 +11,7 @@ rules: resources: - configurationsets - configurationseteventdestinations + - customverificationemailtemplates - receiptfilters - receiptrules - receiptrulesets diff --git a/helm/templates/role-writer.yaml b/helm/templates/role-writer.yaml index 43336a5..89dda7c 100644 --- a/helm/templates/role-writer.yaml +++ b/helm/templates/role-writer.yaml @@ -11,6 +11,7 @@ rules: resources: - configurationsets - configurationseteventdestinations + - customverificationemailtemplates - receiptfilters - receiptrules - receiptrulesets @@ -28,6 +29,7 @@ rules: resources: - configurationsets - configurationseteventdestinations + - customverificationemailtemplates - receiptfilters - receiptrules - receiptrulesets diff --git a/pkg/resource/custom_verification_email_template/delta.go b/pkg/resource/custom_verification_email_template/delta.go new file mode 100644 index 0000000..fb45dd1 --- /dev/null +++ b/pkg/resource/custom_verification_email_template/delta.go @@ -0,0 +1,93 @@ +// 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 custom_verification_email_template + +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.FailureRedirectionURL, b.ko.Spec.FailureRedirectionURL) { + delta.Add("Spec.FailureRedirectionURL", a.ko.Spec.FailureRedirectionURL, b.ko.Spec.FailureRedirectionURL) + } else if a.ko.Spec.FailureRedirectionURL != nil && b.ko.Spec.FailureRedirectionURL != nil { + if *a.ko.Spec.FailureRedirectionURL != *b.ko.Spec.FailureRedirectionURL { + delta.Add("Spec.FailureRedirectionURL", a.ko.Spec.FailureRedirectionURL, b.ko.Spec.FailureRedirectionURL) + } + } + if ackcompare.HasNilDifference(a.ko.Spec.FromEmailAddress, b.ko.Spec.FromEmailAddress) { + delta.Add("Spec.FromEmailAddress", a.ko.Spec.FromEmailAddress, b.ko.Spec.FromEmailAddress) + } else if a.ko.Spec.FromEmailAddress != nil && b.ko.Spec.FromEmailAddress != nil { + if *a.ko.Spec.FromEmailAddress != *b.ko.Spec.FromEmailAddress { + delta.Add("Spec.FromEmailAddress", a.ko.Spec.FromEmailAddress, b.ko.Spec.FromEmailAddress) + } + } + if ackcompare.HasNilDifference(a.ko.Spec.SuccessRedirectionURL, b.ko.Spec.SuccessRedirectionURL) { + delta.Add("Spec.SuccessRedirectionURL", a.ko.Spec.SuccessRedirectionURL, b.ko.Spec.SuccessRedirectionURL) + } else if a.ko.Spec.SuccessRedirectionURL != nil && b.ko.Spec.SuccessRedirectionURL != nil { + if *a.ko.Spec.SuccessRedirectionURL != *b.ko.Spec.SuccessRedirectionURL { + delta.Add("Spec.SuccessRedirectionURL", a.ko.Spec.SuccessRedirectionURL, b.ko.Spec.SuccessRedirectionURL) + } + } + if ackcompare.HasNilDifference(a.ko.Spec.TemplateContent, b.ko.Spec.TemplateContent) { + delta.Add("Spec.TemplateContent", a.ko.Spec.TemplateContent, b.ko.Spec.TemplateContent) + } else if a.ko.Spec.TemplateContent != nil && b.ko.Spec.TemplateContent != nil { + if *a.ko.Spec.TemplateContent != *b.ko.Spec.TemplateContent { + delta.Add("Spec.TemplateContent", a.ko.Spec.TemplateContent, b.ko.Spec.TemplateContent) + } + } + if ackcompare.HasNilDifference(a.ko.Spec.TemplateName, b.ko.Spec.TemplateName) { + delta.Add("Spec.TemplateName", a.ko.Spec.TemplateName, b.ko.Spec.TemplateName) + } else if a.ko.Spec.TemplateName != nil && b.ko.Spec.TemplateName != nil { + if *a.ko.Spec.TemplateName != *b.ko.Spec.TemplateName { + delta.Add("Spec.TemplateName", a.ko.Spec.TemplateName, b.ko.Spec.TemplateName) + } + } + if !reflect.DeepEqual(a.ko.Spec.TemplateRef, b.ko.Spec.TemplateRef) { + delta.Add("Spec.TemplateRef", a.ko.Spec.TemplateRef, b.ko.Spec.TemplateRef) + } + if ackcompare.HasNilDifference(a.ko.Spec.TemplateSubject, b.ko.Spec.TemplateSubject) { + delta.Add("Spec.TemplateSubject", a.ko.Spec.TemplateSubject, b.ko.Spec.TemplateSubject) + } else if a.ko.Spec.TemplateSubject != nil && b.ko.Spec.TemplateSubject != nil { + if *a.ko.Spec.TemplateSubject != *b.ko.Spec.TemplateSubject { + delta.Add("Spec.TemplateSubject", a.ko.Spec.TemplateSubject, b.ko.Spec.TemplateSubject) + } + } + + return delta +} diff --git a/pkg/resource/custom_verification_email_template/descriptor.go b/pkg/resource/custom_verification_email_template/descriptor.go new file mode 100644 index 0000000..71503fa --- /dev/null +++ b/pkg/resource/custom_verification_email_template/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 custom_verification_email_template + +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/ses-controller/apis/v1alpha1" +) + +const ( + FinalizerString = "finalizers.ses.services.k8s.aws/CustomVerificationEmailTemplate" +) + +var ( + GroupVersionResource = svcapitypes.GroupVersion.WithResource("customverificationemailtemplates") + GroupKind = metav1.GroupKind{ + Group: "ses.services.k8s.aws", + Kind: "CustomVerificationEmailTemplate", + } +) + +// 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.CustomVerificationEmailTemplate{} +} + +// 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.CustomVerificationEmailTemplate), + } +} + +// 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/custom_verification_email_template/identifiers.go b/pkg/resource/custom_verification_email_template/identifiers.go new file mode 100644 index 0000000..ad73a48 --- /dev/null +++ b/pkg/resource/custom_verification_email_template/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 custom_verification_email_template + +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/custom_verification_email_template/manager.go b/pkg/resource/custom_verification_email_template/manager.go new file mode 100644 index 0000000..cb1a8f8 --- /dev/null +++ b/pkg/resource/custom_verification_email_template/manager.go @@ -0,0 +1,350 @@ +// 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 custom_verification_email_template + +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/aws/session" + svcsdk "github.com/aws/aws-sdk-go/service/ses" + svcsdkapi "github.com/aws/aws-sdk-go/service/ses/sesiface" + "github.com/go-logr/logr" + corev1 "k8s.io/api/core/v1" + + svcapitypes "github.com/aws-controllers-k8s/ses-controller/apis/v1alpha1" +) + +var ( + _ = ackutil.InStrings + _ = acktags.NewTags() + _ = ackrt.MissingImageTagValue + _ = svcapitypes.CustomVerificationEmailTemplate{} +) + +// +kubebuilder:rbac:groups=ses.services.k8s.aws,resources=customverificationemailtemplates,verbs=get;list;watch;create;update;patch;delete +// +kubebuilder:rbac:groups=ses.services.k8s.aws,resources=customverificationemailtemplates/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 + // 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 + // sess is the AWS SDK Session object used to communicate with the backend + // AWS service API + sess *session.Session + // sdk is a pointer to the AWS service API interface exposed by the + // aws-sdk-go/services/{alias}/{alias}iface package. + sdkapi svcsdkapi.SESAPI +} + +// 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) + 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:ses:%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 { + + return nil +} + +// newResourceManager returns a new struct implementing +// acktypes.AWSResourceManager +func newResourceManager( + cfg ackcfg.Config, + log logr.Logger, + metrics *ackmetrics.Metrics, + rr acktypes.Reconciler, + sess *session.Session, + id ackv1alpha1.AWSAccountID, + region ackv1alpha1.AWSRegion, +) (*resourceManager, error) { + return &resourceManager{ + cfg: cfg, + log: log, + metrics: metrics, + rr: rr, + awsAccountID: id, + awsRegion: region, + sess: sess, + sdkapi: svcsdk.New(sess), + }, 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/custom_verification_email_template/manager_factory.go b/pkg/resource/custom_verification_email_template/manager_factory.go new file mode 100644 index 0000000..cb7f343 --- /dev/null +++ b/pkg/resource/custom_verification_email_template/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 custom_verification_email_template + +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/aws/session" + "github.com/go-logr/logr" + + svcresource "github.com/aws-controllers-k8s/ses-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, + log logr.Logger, + metrics *ackmetrics.Metrics, + rr acktypes.Reconciler, + sess *session.Session, + 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, log, metrics, rr, sess, 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/custom_verification_email_template/references.go b/pkg/resource/custom_verification_email_template/references.go new file mode 100644 index 0000000..ed8d6fa --- /dev/null +++ b/pkg/resource/custom_verification_email_template/references.go @@ -0,0 +1,166 @@ +// 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 custom_verification_email_template + +import ( + "context" + "fmt" + + corev1 "k8s.io/api/core/v1" + "k8s.io/apimachinery/pkg/types" + "sigs.k8s.io/controller-runtime/pkg/client" + + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" + ackerr "github.com/aws-controllers-k8s/runtime/pkg/errors" + acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" + + svcapitypes "github.com/aws-controllers-k8s/ses-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() + + if ko.Spec.TemplateRef != nil { + ko.Spec.TemplateName = nil + } + + 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) { + ko := rm.concreteResource(res).ko + + resourceHasReferences := false + err := validateReferenceFields(ko) + if fieldHasReferences, err := rm.resolveReferenceForTemplateName(ctx, apiReader, ko); err != nil { + return &resource{ko}, (resourceHasReferences || fieldHasReferences), err + } else { + resourceHasReferences = resourceHasReferences || fieldHasReferences + } + + return &resource{ko}, resourceHasReferences, err +} + +// validateReferenceFields validates the reference field and corresponding +// identifier field. +func validateReferenceFields(ko *svcapitypes.CustomVerificationEmailTemplate) error { + + if ko.Spec.TemplateRef != nil && ko.Spec.TemplateName != nil { + return ackerr.ResourceReferenceAndIDNotSupportedFor("TemplateName", "TemplateRef") + } + if ko.Spec.TemplateRef == nil && ko.Spec.TemplateName == nil { + return ackerr.ResourceReferenceOrIDRequiredFor("TemplateName", "TemplateRef") + } + return nil +} + +// resolveReferenceForTemplateName reads the resource referenced +// from TemplateRef field and sets the TemplateName +// from referenced resource. Returns a boolean indicating whether a reference +// contains references, or an error +func (rm *resourceManager) resolveReferenceForTemplateName( + ctx context.Context, + apiReader client.Reader, + ko *svcapitypes.CustomVerificationEmailTemplate, +) (hasReferences bool, err error) { + if ko.Spec.TemplateRef != nil && ko.Spec.TemplateRef.From != nil { + hasReferences = true + arr := ko.Spec.TemplateRef.From + if arr.Name == nil || *arr.Name == "" { + return hasReferences, fmt.Errorf("provided resource reference is nil or empty: TemplateRef") + } + namespace := ko.ObjectMeta.GetNamespace() + if arr.Namespace != nil && *arr.Namespace != "" { + namespace = *arr.Namespace + } + obj := &svcapitypes.Template{} + if err := getReferencedResourceState_Template(ctx, apiReader, obj, *arr.Name, namespace); err != nil { + return hasReferences, err + } + ko.Spec.TemplateName = (*string)(obj.Spec.Name) + } + + return hasReferences, nil +} + +// getReferencedResourceState_Template looks up whether a referenced resource +// exists and is in a ACK.ResourceSynced=True state. If the referenced resource does exist and is +// in a Synced state, returns nil, otherwise returns `ackerr.ResourceReferenceTerminalFor` or +// `ResourceReferenceNotSyncedFor` depending on if the resource is in a Terminal state. +func getReferencedResourceState_Template( + ctx context.Context, + apiReader client.Reader, + obj *svcapitypes.Template, + name string, // the Kubernetes name of the referenced resource + namespace string, // the Kubernetes namespace of the referenced resource +) error { + namespacedName := types.NamespacedName{ + Namespace: namespace, + Name: name, + } + err := apiReader.Get(ctx, namespacedName, obj) + if err != nil { + return err + } + var refResourceTerminal bool + for _, cond := range obj.Status.Conditions { + if cond.Type == ackv1alpha1.ConditionTypeTerminal && + cond.Status == corev1.ConditionTrue { + return ackerr.ResourceReferenceTerminalFor( + "Template", + namespace, name) + } + } + if refResourceTerminal { + return ackerr.ResourceReferenceTerminalFor( + "Template", + namespace, name) + } + var refResourceSynced bool + for _, cond := range obj.Status.Conditions { + if cond.Type == ackv1alpha1.ConditionTypeResourceSynced && + cond.Status == corev1.ConditionTrue { + refResourceSynced = true + } + } + if !refResourceSynced { + return ackerr.ResourceReferenceNotSyncedFor( + "Template", + namespace, name) + } + if obj.Spec.Name == nil { + return ackerr.ResourceReferenceMissingTargetFieldFor( + "Template", + namespace, name, + "Spec.Name") + } + return nil +} diff --git a/pkg/resource/custom_verification_email_template/resource.go b/pkg/resource/custom_verification_email_template/resource.go new file mode 100644 index 0000000..42da9e4 --- /dev/null +++ b/pkg/resource/custom_verification_email_template/resource.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 custom_verification_email_template + +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/ses-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.CustomVerificationEmailTemplate +} + +// 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.Spec.TemplateName = &identifier.NameOrID + + 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/custom_verification_email_template/sdk.go b/pkg/resource/custom_verification_email_template/sdk.go new file mode 100644 index 0000000..d9f62dc --- /dev/null +++ b/pkg/resource/custom_verification_email_template/sdk.go @@ -0,0 +1,449 @@ +// 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 custom_verification_email_template + +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/aws" + svcsdk "github.com/aws/aws-sdk-go/service/ses" + corev1 "k8s.io/api/core/v1" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + + svcapitypes "github.com/aws-controllers-k8s/ses-controller/apis/v1alpha1" +) + +// Hack to avoid import errors during build... +var ( + _ = &metav1.Time{} + _ = strings.ToLower("") + _ = &aws.JSONValue{} + _ = &svcsdk.SES{} + _ = &svcapitypes.CustomVerificationEmailTemplate{} + _ = ackv1alpha1.AWSAccountID("") + _ = &ackerr.NotFound + _ = &ackcondition.NotManagedMessage + _ = &reflect.Value{} + _ = fmt.Sprintf("") + _ = &ackrequeue.NoRequeue{} +) + +// 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.GetCustomVerificationEmailTemplateOutput + resp, err = rm.sdkapi.GetCustomVerificationEmailTemplateWithContext(ctx, input) + if err != nil { + if awsErr, ok := ackerr.AWSError(err); ok && awsErr.Code() == svcsdk.ErrCodeCustomVerificationEmailTemplateDoesNotExistException { + rm.metrics.RecordAPICall("READ_ONE", "GetCustomVerificationEmailTemplate", err) + return nil, ackerr.NotFound + } + } + + rm.metrics.RecordAPICall("READ_ONE", "GetCustomVerificationEmailTemplate", err) + if err != nil { + if reqErr, ok := ackerr.AWSRequestFailure(err); ok && reqErr.StatusCode() == 404 { + return nil, ackerr.NotFound + } + if awsErr, ok := ackerr.AWSError(err); ok && awsErr.Code() == "UNKNOWN" { + 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.FailureRedirectionURL != nil { + ko.Spec.FailureRedirectionURL = resp.FailureRedirectionURL + } else { + ko.Spec.FailureRedirectionURL = nil + } + if resp.FromEmailAddress != nil { + ko.Spec.FromEmailAddress = resp.FromEmailAddress + } else { + ko.Spec.FromEmailAddress = nil + } + if resp.SuccessRedirectionURL != nil { + ko.Spec.SuccessRedirectionURL = resp.SuccessRedirectionURL + } else { + ko.Spec.SuccessRedirectionURL = nil + } + if resp.TemplateContent != nil { + ko.Spec.TemplateContent = resp.TemplateContent + } else { + ko.Spec.TemplateContent = nil + } + if resp.TemplateName != nil { + ko.Spec.TemplateName = resp.TemplateName + } else { + ko.Spec.TemplateName = nil + } + if resp.TemplateSubject != nil { + ko.Spec.TemplateSubject = resp.TemplateSubject + } else { + ko.Spec.TemplateSubject = 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.Spec.TemplateName == 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.GetCustomVerificationEmailTemplateInput, error) { + res := &svcsdk.GetCustomVerificationEmailTemplateInput{} + + if r.ko.Spec.TemplateName != nil { + res.SetTemplateName(*r.ko.Spec.TemplateName) + } + + 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.CreateCustomVerificationEmailTemplateOutput + _ = resp + resp, err = rm.sdkapi.CreateCustomVerificationEmailTemplateWithContext(ctx, input) + rm.metrics.RecordAPICall("CREATE", "CreateCustomVerificationEmailTemplate", 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() + + 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.CreateCustomVerificationEmailTemplateInput, error) { + res := &svcsdk.CreateCustomVerificationEmailTemplateInput{} + + if r.ko.Spec.FailureRedirectionURL != nil { + res.SetFailureRedirectionURL(*r.ko.Spec.FailureRedirectionURL) + } + if r.ko.Spec.FromEmailAddress != nil { + res.SetFromEmailAddress(*r.ko.Spec.FromEmailAddress) + } + if r.ko.Spec.SuccessRedirectionURL != nil { + res.SetSuccessRedirectionURL(*r.ko.Spec.SuccessRedirectionURL) + } + if r.ko.Spec.TemplateContent != nil { + res.SetTemplateContent(*r.ko.Spec.TemplateContent) + } + if r.ko.Spec.TemplateName != nil { + res.SetTemplateName(*r.ko.Spec.TemplateName) + } + if r.ko.Spec.TemplateSubject != nil { + res.SetTemplateSubject(*r.ko.Spec.TemplateSubject) + } + + 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) + }() + if immutableFieldChanges := rm.getImmutableFieldChanges(delta); len(immutableFieldChanges) > 0 { + msg := fmt.Sprintf("Immutable Spec fields have been modified: %s", strings.Join(immutableFieldChanges, ",")) + return nil, ackerr.NewTerminalError(fmt.Errorf(msg)) + } + input, err := rm.newUpdateRequestPayload(ctx, desired, delta) + if err != nil { + return nil, err + } + + var resp *svcsdk.UpdateCustomVerificationEmailTemplateOutput + _ = resp + resp, err = rm.sdkapi.UpdateCustomVerificationEmailTemplateWithContext(ctx, input) + rm.metrics.RecordAPICall("UPDATE", "UpdateCustomVerificationEmailTemplate", 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() + + 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.UpdateCustomVerificationEmailTemplateInput, error) { + res := &svcsdk.UpdateCustomVerificationEmailTemplateInput{} + + if r.ko.Spec.FailureRedirectionURL != nil { + res.SetFailureRedirectionURL(*r.ko.Spec.FailureRedirectionURL) + } + if r.ko.Spec.FromEmailAddress != nil { + res.SetFromEmailAddress(*r.ko.Spec.FromEmailAddress) + } + if r.ko.Spec.SuccessRedirectionURL != nil { + res.SetSuccessRedirectionURL(*r.ko.Spec.SuccessRedirectionURL) + } + if r.ko.Spec.TemplateContent != nil { + res.SetTemplateContent(*r.ko.Spec.TemplateContent) + } + if r.ko.Spec.TemplateName != nil { + res.SetTemplateName(*r.ko.Spec.TemplateName) + } + if r.ko.Spec.TemplateSubject != nil { + res.SetTemplateSubject(*r.ko.Spec.TemplateSubject) + } + + 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.DeleteCustomVerificationEmailTemplateOutput + _ = resp + resp, err = rm.sdkapi.DeleteCustomVerificationEmailTemplateWithContext(ctx, input) + rm.metrics.RecordAPICall("DELETE", "DeleteCustomVerificationEmailTemplate", 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.DeleteCustomVerificationEmailTemplateInput, error) { + res := &svcsdk.DeleteCustomVerificationEmailTemplateInput{} + + if r.ko.Spec.TemplateName != nil { + res.SetTemplateName(*r.ko.Spec.TemplateName) + } + + return res, nil +} + +// setStatusDefaults sets default properties into supplied custom resource +func (rm *resourceManager) setStatusDefaults( + ko *svcapitypes.CustomVerificationEmailTemplate, +) { + 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 + } + awsErr, ok := ackerr.AWSError(err) + if !ok { + return false + } + switch awsErr.Code() { + case "CustomVerificationEmailInvalidContent", + "CustomVerificationEmailTemplateAlreadyExists": + return true + default: + return false + } +} + +// getImmutableFieldChanges returns list of immutable fields from the +func (rm *resourceManager) getImmutableFieldChanges( + delta *ackcompare.Delta, +) []string { + var fields []string + if delta.DifferentAt("Spec.TemplateName") { + fields = append(fields, "TemplateName") + } + + return fields +} diff --git a/templates/hooks/custom_verification_email_template/sdk_read_one_post_request.go.tpl b/templates/hooks/custom_verification_email_template/sdk_read_one_post_request.go.tpl new file mode 100644 index 0000000..d829fe3 --- /dev/null +++ b/templates/hooks/custom_verification_email_template/sdk_read_one_post_request.go.tpl @@ -0,0 +1,6 @@ + if err != nil { + if awsErr, ok := ackerr.AWSError(err); ok && awsErr.Code() == svcsdk.ErrCodeCustomVerificationEmailTemplateDoesNotExistException { + rm.metrics.RecordAPICall("READ_ONE", "GetCustomVerificationEmailTemplate", err) + return nil, ackerr.NotFound + } + } diff --git a/test/e2e/resources/custom_verification_email_template_simple.yaml b/test/e2e/resources/custom_verification_email_template_simple.yaml new file mode 100644 index 0000000..f7c5c73 --- /dev/null +++ b/test/e2e/resources/custom_verification_email_template_simple.yaml @@ -0,0 +1,13 @@ +apiVersion: ses.services.k8s.aws/v1alpha1 +kind: CustomVerificationEmailTemplate +metadata: + name: $CUSTOM_VERIFICATION_EMAIL_TEMPLATE_NAME +spec: + templateRef: + from: + name: $TEMPLATE_REF_NAME + templateSubject: template-subject + failureRedirectionURL: https://example.com + fromEmailAddress: todo@todo.com + successRedirectionURL: https://example.com/test + templateContent: "Initial template content" diff --git a/test/e2e/tests/custom_verification_email_template_test.py b/test/e2e/tests/custom_verification_email_template_test.py new file mode 100644 index 0000000..c128c56 --- /dev/null +++ b/test/e2e/tests/custom_verification_email_template_test.py @@ -0,0 +1,123 @@ +# 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 CustomVerificationEmailTemplate resource +""" + +import boto3 +import logging +import time + +import pytest +from functools import partial + +from typing import Dict, Tuple +from acktest.k8s import resource as k8s +from acktest.resources import random_suffix_name +from acktest.k8s import condition +from e2e import service_marker, CRD_GROUP, CRD_VERSION, SERVICE_NAME, load_ses_resource +from e2e.common.waiter import wait_until_deleted, MAX_WAIT_FOR_SYNCED_MINUTES +from e2e.replacement_values import REPLACEMENT_VALUES + +from .template_test import simple_template + + +CUSTOM_VERIFICATION_EMAIL_TEMPLATE_RESOURCE_PLURAL = "customverificationemailtemplates" + +@pytest.fixture(scope='module') +def ses_client(): + return boto3.client(SERVICE_NAME) + +def get_custom_verification_email_template(ses_client, template_name): + try: + return ses_client.get_custom_verification_email_template(TemplateName=template_name) + except ses_client.exceptions.CustomVerificationEmailTemplateDoesNotExistException: + return None + +@pytest.fixture +def simple_custom_verification_email_template(simple_template, ses_client) -> Tuple[k8s.CustomResourceReference, Dict]: + custom_verification_email_template_name = random_suffix_name('simple-verification-template', 32) + + replacements = REPLACEMENT_VALUES.copy() + replacements['CUSTOM_VERIFICATION_EMAIL_TEMPLATE_NAME'] = custom_verification_email_template_name + + (ref, template_cr) = simple_template + replacements['TEMPLATE_REF_NAME'] = template_cr['spec']['name'] + + resource_data = load_ses_resource( + 'custom_verification_email_template_simple', + additional_replacements=replacements, + ) + logging.debug(resource_data) + + ref = k8s.CustomResourceReference( + CRD_GROUP, CRD_VERSION, CUSTOM_VERIFICATION_EMAIL_TEMPLATE_RESOURCE_PLURAL, + custom_verification_email_template_name, namespace='default', + ) + k8s.create_custom_resource(ref, resource_data) + cr = k8s.wait_resource_consumed_by_controller(ref, wait_periods=10) + + assert cr is not None + assert cr['status'] is not None + assert k8s.get_resource_exists(ref) + + yield ref, cr + + _, deleted = k8s.delete_custom_resource(ref, 3, 10) + assert deleted + wait_until_deleted(partial(get_custom_verification_email_template, ses_client, custom_verification_email_template_name)) + + +@service_marker +@pytest.mark.canary +class TestCustomVerificationEmailTemplate: + def test_create_update_custom_verification_email_template(self, simple_custom_verification_email_template, ses_client): + (ref, cr) = simple_custom_verification_email_template + assert k8s.wait_on_condition( + ref, + condition.CONDITION_TYPE_RESOURCE_SYNCED, + 'True', + wait_periods=MAX_WAIT_FOR_SYNCED_MINUTES, + ) + template_name = cr['spec']['templateRef']['from']['name'] + get_current_template = partial(get_custom_verification_email_template, ses_client, template_name) + assert get_current_template() is not None + + updates = { + 'spec': { + 'templateSubject': 'updated-subject', + 'failureRedirectionURL': 'https://example.com/updated', + 'successRedirectionURL': 'https://example.com/updated', + 'templateContent': 'updated template content', + } + } + k8s.patch_custom_resource(ref, updates) + time.sleep(10) + assert k8s.wait_on_condition( + ref, + condition.CONDITION_TYPE_RESOURCE_SYNCED, + 'True', + wait_periods=MAX_WAIT_FOR_SYNCED_MINUTES, + ) + + template = get_current_template() + template.pop('ResponseMetadata', None) + updated_template = updates['spec'] + assert template == { + 'TemplateName': template_name, + 'TemplateSubject': updated_template['templateSubject'], + 'FromEmailAddress': cr['spec']['fromEmailAddress'], + 'FailureRedirectionURL': updated_template['failureRedirectionURL'], + 'SuccessRedirectionURL': updated_template['successRedirectionURL'], + 'TemplateContent': updated_template['templateContent'], + }