From 177da683a3814864e93f96b13ef17f18b392436b Mon Sep 17 00:00:00 2001 From: cpu1 Date: Fri, 15 Nov 2024 16:27:47 +0530 Subject: [PATCH] Implement resource ReceiptRuleSet Signed-off-by: cpu1 --- apis/v1alpha1/ack-generate-metadata.yaml | 6 +- apis/v1alpha1/generator.yaml | 18 +- apis/v1alpha1/receipt_rule_set.go | 74 ++++ apis/v1alpha1/types.go | 155 +++++++- apis/v1alpha1/zz_generated.deepcopy.go | 344 +++++++++++++++++ cmd/controller/main.go | 1 + .../ses.services.k8s.aws_receiptrulesets.yaml | 128 +++++++ config/crd/kustomization.yaml | 1 + config/rbac/cluster-role-controller.yaml | 2 + config/rbac/role-reader.yaml | 1 + config/rbac/role-writer.yaml | 2 + generator.yaml | 18 +- .../ses.services.k8s.aws_receiptrulesets.yaml | 128 +++++++ helm/templates/_helpers.tpl | 2 + helm/templates/role-reader.yaml | 1 + helm/templates/role-writer.yaml | 2 + pkg/resource/receipt_rule_set/delta.go | 55 +++ pkg/resource/receipt_rule_set/descriptor.go | 155 ++++++++ pkg/resource/receipt_rule_set/hooks.go | 18 + pkg/resource/receipt_rule_set/identifiers.go | 55 +++ pkg/resource/receipt_rule_set/manager.go | 350 ++++++++++++++++++ .../receipt_rule_set/manager_factory.go | 100 +++++ pkg/resource/receipt_rule_set/references.go | 56 +++ pkg/resource/receipt_rule_set/resource.go | 100 +++++ pkg/resource/receipt_rule_set/sdk.go | 346 +++++++++++++++++ .../sdk_read_one_post_request.go.tpl | 7 + .../resources/receipt_rule_set_simple.yaml | 6 + test/e2e/tests/receipt_rule_set_test.py | 84 +++++ 28 files changed, 2202 insertions(+), 13 deletions(-) create mode 100644 apis/v1alpha1/receipt_rule_set.go create mode 100644 config/crd/bases/ses.services.k8s.aws_receiptrulesets.yaml create mode 100644 helm/crds/ses.services.k8s.aws_receiptrulesets.yaml create mode 100644 pkg/resource/receipt_rule_set/delta.go create mode 100644 pkg/resource/receipt_rule_set/descriptor.go create mode 100644 pkg/resource/receipt_rule_set/hooks.go create mode 100644 pkg/resource/receipt_rule_set/identifiers.go create mode 100644 pkg/resource/receipt_rule_set/manager.go create mode 100644 pkg/resource/receipt_rule_set/manager_factory.go create mode 100644 pkg/resource/receipt_rule_set/references.go create mode 100644 pkg/resource/receipt_rule_set/resource.go create mode 100644 pkg/resource/receipt_rule_set/sdk.go create mode 100644 templates/hooks/receipt_rule_set/sdk_read_one_post_request.go.tpl create mode 100644 test/e2e/resources/receipt_rule_set_simple.yaml create mode 100644 test/e2e/tests/receipt_rule_set_test.py diff --git a/apis/v1alpha1/ack-generate-metadata.yaml b/apis/v1alpha1/ack-generate-metadata.yaml index 62c5491..05c6bed 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-15T10:21:56Z" + build_date: "2024-11-15T10:41:37Z" build_hash: 9715a2a715317a76ae83825294ca50cde9afd97b go_version: go1.22.5 version: v0.39.1-4-g9715a2a -api_directory_checksum: 3d3ca082ed59a9e43ed3f0e3ca4462c926d548fc +api_directory_checksum: 321ba64ffa258789823c7b8cc23a8d9d75c1080c api_version: v1alpha1 aws_sdk_go_version: v1.55.5 generator_config_info: - file_checksum: 0178bde0d5f5a62790ad9c1802857661f7bcc078 + file_checksum: aa1c1fc94f2d60cd59b79690003ca0ac3f82b120 original_file_name: generator.yaml last_modification: reason: API generation diff --git a/apis/v1alpha1/generator.yaml b/apis/v1alpha1/generator.yaml index e35bd89..d1a3b34 100644 --- a/apis/v1alpha1/generator.yaml +++ b/apis/v1alpha1/generator.yaml @@ -5,7 +5,7 @@ ignore: - CustomVerificationEmailTemplate - ReceiptFilter - ReceiptRule - - ReceiptRuleSet +# - ReceiptRuleSet - Template field_paths: @@ -40,3 +40,19 @@ resources: template_path: hooks/configuration_set/sdk_create_post_build_request.go.tpl sdk_read_one_post_request: template_path: hooks/configuration_set/sdk_read_one_post_request.go.tpl + + ReceiptRuleSet: + fields: + RuleSetName: + is_primary_key: true + is_immutable: true + update_operation: + custom_method_name: customUpdate + tags: + ignore: true + exceptions: + terminal_codes: + - AlreadyExists + hooks: + sdk_read_one_post_request: + template_path: hooks/receipt_rule_set/sdk_read_one_post_request.go.tpl diff --git a/apis/v1alpha1/receipt_rule_set.go b/apis/v1alpha1/receipt_rule_set.go new file mode 100644 index 0000000..bf95942 --- /dev/null +++ b/apis/v1alpha1/receipt_rule_set.go @@ -0,0 +1,74 @@ +// 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" +) + +// ReceiptRuleSetSpec defines the desired state of ReceiptRuleSet. +type ReceiptRuleSetSpec struct { + + // The name of the rule set to create. The name must meet the following requirements: + // + // - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), + // or dashes (-). + // + // - Start and end with a letter or number. + // + // - Contain 64 characters or fewer. + // + // +kubebuilder:validation:Required + RuleSetName *string `json:"ruleSetName"` +} + +// ReceiptRuleSetStatus defines the observed state of ReceiptRuleSet +type ReceiptRuleSetStatus 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"` +} + +// ReceiptRuleSet is the Schema for the ReceiptRuleSets API +// +kubebuilder:object:root=true +// +kubebuilder:subresource:status +type ReceiptRuleSet struct { + metav1.TypeMeta `json:",inline"` + metav1.ObjectMeta `json:"metadata,omitempty"` + Spec ReceiptRuleSetSpec `json:"spec,omitempty"` + Status ReceiptRuleSetStatus `json:"status,omitempty"` +} + +// ReceiptRuleSetList contains a list of ReceiptRuleSet +// +kubebuilder:object:root=true +type ReceiptRuleSetList struct { + metav1.TypeMeta `json:",inline"` + metav1.ListMeta `json:"metadata,omitempty"` + Items []ReceiptRuleSet `json:"items"` +} + +func init() { + SchemeBuilder.Register(&ReceiptRuleSet{}, &ReceiptRuleSetList{}) +} diff --git a/apis/v1alpha1/types.go b/apis/v1alpha1/types.go index 1da28bc..def7af6 100644 --- a/apis/v1alpha1/types.go +++ b/apis/v1alpha1/types.go @@ -28,6 +28,16 @@ var ( _ = ackv1alpha1.AWSAccountID("") ) +// When included in a receipt rule, this action adds a header to the received +// email. +// +// For information about adding a header using a receipt rule, see the Amazon +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-add-header.html). +type AddHeaderAction struct { + HeaderName *string `json:"headerName,omitempty"` + HeaderValue *string `json:"headerValue,omitempty"` +} + // When included in a receipt rule, this action rejects the received email by // returning a bounce response to the sender and, optionally, publishes a notification // to Amazon Simple Notification Service (Amazon SNS). @@ -35,7 +45,11 @@ var ( // For information about sending a bounce message in response to a received // email, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-bounce.html). type BounceAction struct { - TopicARN *string `json:"topicARN,omitempty"` + Message *string `json:"message,omitempty"` + Sender *string `json:"sender,omitempty"` + SmtpReplyCode *string `json:"smtpReplyCode,omitempty"` + StatusCode *string `json:"statusCode,omitempty"` + TopicARN *string `json:"topicARN,omitempty"` } // Recipient-related information to include in the Delivery Status Notification @@ -44,6 +58,7 @@ type BounceAction struct { // For information about receiving email through Amazon SES, see the Amazon // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html). type BouncedRecipientInfo struct { + Recipient *string `json:"recipient,omitempty"` RecipientARN *string `json:"recipientARN,omitempty"` } @@ -162,8 +177,93 @@ type KinesisFirehoseDestination struct { // For information about using Amazon Web Services Lambda actions in receipt // rules, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-lambda.html). type LambdaAction struct { - FunctionARN *string `json:"functionARN,omitempty"` - TopicARN *string `json:"topicARN,omitempty"` + FunctionARN *string `json:"functionARN,omitempty"` + InvocationType *string `json:"invocationType,omitempty"` + TopicARN *string `json:"topicARN,omitempty"` +} + +// An action that Amazon SES can take when it receives an email on behalf of +// one or more email addresses or domains that you own. An instance of this +// data type can represent only one action. +// +// For information about setting up receipt rules, see the Amazon SES Developer +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html). +type ReceiptAction struct { + // When included in a receipt rule, this action adds a header to the received + // email. + // + // For information about adding a header using a receipt rule, see the Amazon + // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-add-header.html). + AddHeaderAction *AddHeaderAction `json:"addHeaderAction,omitempty"` + // When included in a receipt rule, this action rejects the received email by + // returning a bounce response to the sender and, optionally, publishes a notification + // to Amazon Simple Notification Service (Amazon SNS). + // + // For information about sending a bounce message in response to a received + // email, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-bounce.html). + BounceAction *BounceAction `json:"bounceAction,omitempty"` + // When included in a receipt rule, this action calls an Amazon Web Services + // Lambda function and, optionally, publishes a notification to Amazon Simple + // Notification Service (Amazon SNS). + // + // To enable Amazon SES to call your Amazon Web Services Lambda function or + // to publish to an Amazon SNS topic of another account, Amazon SES must have + // permission to access those resources. For information about giving permissions, + // see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html). + // + // For information about using Amazon Web Services Lambda actions in receipt + // rules, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-lambda.html). + LambdaAction *LambdaAction `json:"lambdaAction,omitempty"` + // When included in a receipt rule, this action saves the received message to + // an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes + // a notification to Amazon Simple Notification Service (Amazon SNS). + // + // To enable Amazon SES to write emails to your Amazon S3 bucket, use an Amazon + // Web Services KMS key to encrypt your emails, or publish to an Amazon SNS + // topic of another account, Amazon SES must have permission to access those + // resources. For information about granting permissions, see the Amazon SES + // Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html). + // + // When you save your emails to an Amazon S3 bucket, the maximum email size + // (including headers) is 40 MB. Emails larger than that bounces. + // + // For information about specifying Amazon S3 actions in receipt rules, see + // the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-s3.html). + S3Action *S3Action `json:"s3Action,omitempty"` + // When included in a receipt rule, this action publishes a notification to + // Amazon Simple Notification Service (Amazon SNS). This action includes a complete + // copy of the email content in the Amazon SNS notifications. Amazon SNS notifications + // for all other actions simply provide information about the email. They do + // not include the email content itself. + // + // If you own the Amazon SNS topic, you don't need to do anything to give Amazon + // SES permission to publish emails to it. However, if you don't own the Amazon + // SNS topic, you need to attach a policy to the topic to give Amazon SES permissions + // to access it. For information about giving permissions, see the Amazon SES + // Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html). + // + // You can only publish emails that are 150 KB or less (including the header) + // to Amazon SNS. Larger emails bounce. If you anticipate emails larger than + // 150 KB, use the S3 action instead. + // + // For information about using a receipt rule to publish an Amazon SNS notification, + // see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-sns.html). + SNSAction *SNSAction `json:"snsAction,omitempty"` + // When included in a receipt rule, this action terminates the evaluation of + // the receipt rule set and, optionally, publishes a notification to Amazon + // Simple Notification Service (Amazon SNS). + // + // For information about setting a stop action in a receipt rule, see the Amazon + // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-stop.html). + StopAction *StopAction `json:"stopAction,omitempty"` + // When included in a receipt rule, this action calls Amazon WorkMail and, optionally, + // publishes a notification to Amazon Simple Notification Service (Amazon SNS). + // It usually isn't necessary to set this up manually, because Amazon WorkMail + // adds the rule automatically during its setup procedure. + // + // For information using a receipt rule to call Amazon WorkMail, see the Amazon + // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-workmail.html). + WorkmailAction *WorkmailAction `json:"workmailAction,omitempty"` } // Receipt rules enable you to specify which actions Amazon SES should take @@ -178,9 +278,33 @@ type LambdaAction struct { // For information about setting up receipt rules, see the Amazon SES Developer // Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html). type ReceiptRule struct { - Enabled *bool `json:"enabled,omitempty"` - ScanEnabled *bool `json:"scanEnabled,omitempty"` - TLSPolicy *string `json:"tlsPolicy,omitempty"` + Actions []*ReceiptAction `json:"actions,omitempty"` + Enabled *bool `json:"enabled,omitempty"` + Name *string `json:"name,omitempty"` + Recipients []*string `json:"recipients,omitempty"` + ScanEnabled *bool `json:"scanEnabled,omitempty"` + TLSPolicy *string `json:"tlsPolicy,omitempty"` +} + +// Information about a receipt rule set. +// +// A receipt rule set is a collection of rules that specify what Amazon SES +// should do with mail it receives on behalf of your account's verified domains. +// +// For information about setting up receipt rule sets, see the Amazon SES Developer +// Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html#receiving-email-concepts-rules). +type ReceiptRuleSetMetadata struct { + CreatedTimestamp *metav1.Time `json:"createdTimestamp,omitempty"` + Name *string `json:"name,omitempty"` +} + +// Recipient-related information to include in the Delivery Status Notification +// (DSN) when an email that Amazon SES receives on your behalf bounces. +// +// For information about receiving email through Amazon SES, see the Amazon +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html). +type RecipientDsnFields struct { + FinalRecipient *string `json:"finalRecipient,omitempty"` } // Contains information about the reputation settings for a configuration set. @@ -206,8 +330,10 @@ type ReputationOptions struct { // For information about specifying Amazon S3 actions in receipt rules, see // the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-s3.html). type S3Action struct { - KMSKeyARN *string `json:"kmsKeyARN,omitempty"` - TopicARN *string `json:"topicARN,omitempty"` + BucketName *string `json:"bucketName,omitempty"` + KMSKeyARN *string `json:"kmsKeyARN,omitempty"` + ObjectKeyPrefix *string `json:"objectKeyPrefix,omitempty"` + TopicARN *string `json:"topicARN,omitempty"` } // When included in a receipt rule, this action publishes a notification to @@ -229,6 +355,7 @@ type S3Action struct { // For information about using a receipt rule to publish an Amazon SNS notification, // see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-sns.html). type SNSAction struct { + Encoding *string `json:"encoding,omitempty"` TopicARN *string `json:"topicARN,omitempty"` } @@ -242,6 +369,12 @@ type SNSDestination struct { TopicARN *string `json:"topicARN,omitempty"` } +// Represents sending statistics data. Each SendDataPoint contains statistics +// for a 15-minute period of sending activity. +type SendDataPoint struct { + Timestamp *metav1.Time `json:"timestamp,omitempty"` +} + // When included in a receipt rule, this action terminates the evaluation of // the receipt rule set and, optionally, publishes a notification to Amazon // Simple Notification Service (Amazon SNS). @@ -249,9 +382,15 @@ type SNSDestination struct { // For information about setting a stop action in a receipt rule, see the Amazon // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-stop.html). type StopAction struct { + Scope *string `json:"scope,omitempty"` TopicARN *string `json:"topicARN,omitempty"` } +// Contains information about an email template. +type TemplateMetadata struct { + CreatedTimestamp *metav1.Time `json:"createdTimestamp,omitempty"` +} + // A domain that is used to redirect email recipients to an Amazon SES-operated // domain. This domain captures open and click events generated by Amazon SES // emails. diff --git a/apis/v1alpha1/zz_generated.deepcopy.go b/apis/v1alpha1/zz_generated.deepcopy.go index fbd54bb..90b827b 100644 --- a/apis/v1alpha1/zz_generated.deepcopy.go +++ b/apis/v1alpha1/zz_generated.deepcopy.go @@ -24,9 +24,54 @@ import ( runtime "k8s.io/apimachinery/pkg/runtime" ) +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *AddHeaderAction) DeepCopyInto(out *AddHeaderAction) { + *out = *in + if in.HeaderName != nil { + in, out := &in.HeaderName, &out.HeaderName + *out = new(string) + **out = **in + } + if in.HeaderValue != nil { + in, out := &in.HeaderValue, &out.HeaderValue + *out = new(string) + **out = **in + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AddHeaderAction. +func (in *AddHeaderAction) DeepCopy() *AddHeaderAction { + if in == nil { + return nil + } + out := new(AddHeaderAction) + in.DeepCopyInto(out) + return out +} + // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *BounceAction) DeepCopyInto(out *BounceAction) { *out = *in + if in.Message != nil { + in, out := &in.Message, &out.Message + *out = new(string) + **out = **in + } + if in.Sender != nil { + in, out := &in.Sender, &out.Sender + *out = new(string) + **out = **in + } + if in.SmtpReplyCode != nil { + in, out := &in.SmtpReplyCode, &out.SmtpReplyCode + *out = new(string) + **out = **in + } + if in.StatusCode != nil { + in, out := &in.StatusCode, &out.StatusCode + *out = new(string) + **out = **in + } if in.TopicARN != nil { in, out := &in.TopicARN, &out.TopicARN *out = new(string) @@ -47,6 +92,11 @@ func (in *BounceAction) DeepCopy() *BounceAction { // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *BouncedRecipientInfo) DeepCopyInto(out *BouncedRecipientInfo) { *out = *in + if in.Recipient != nil { + in, out := &in.Recipient, &out.Recipient + *out = new(string) + **out = **in + } if in.RecipientARN != nil { in, out := &in.RecipientARN, &out.RecipientARN *out = new(string) @@ -409,6 +459,11 @@ func (in *LambdaAction) DeepCopyInto(out *LambdaAction) { *out = new(string) **out = **in } + if in.InvocationType != nil { + in, out := &in.InvocationType, &out.InvocationType + *out = new(string) + **out = **in + } if in.TopicARN != nil { in, out := &in.TopicARN, &out.TopicARN *out = new(string) @@ -426,14 +481,91 @@ func (in *LambdaAction) DeepCopy() *LambdaAction { return out } +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *ReceiptAction) DeepCopyInto(out *ReceiptAction) { + *out = *in + if in.AddHeaderAction != nil { + in, out := &in.AddHeaderAction, &out.AddHeaderAction + *out = new(AddHeaderAction) + (*in).DeepCopyInto(*out) + } + if in.BounceAction != nil { + in, out := &in.BounceAction, &out.BounceAction + *out = new(BounceAction) + (*in).DeepCopyInto(*out) + } + if in.LambdaAction != nil { + in, out := &in.LambdaAction, &out.LambdaAction + *out = new(LambdaAction) + (*in).DeepCopyInto(*out) + } + if in.S3Action != nil { + in, out := &in.S3Action, &out.S3Action + *out = new(S3Action) + (*in).DeepCopyInto(*out) + } + if in.SNSAction != nil { + in, out := &in.SNSAction, &out.SNSAction + *out = new(SNSAction) + (*in).DeepCopyInto(*out) + } + if in.StopAction != nil { + in, out := &in.StopAction, &out.StopAction + *out = new(StopAction) + (*in).DeepCopyInto(*out) + } + if in.WorkmailAction != nil { + in, out := &in.WorkmailAction, &out.WorkmailAction + *out = new(WorkmailAction) + (*in).DeepCopyInto(*out) + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReceiptAction. +func (in *ReceiptAction) DeepCopy() *ReceiptAction { + if in == nil { + return nil + } + out := new(ReceiptAction) + in.DeepCopyInto(out) + return out +} + // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *ReceiptRule) DeepCopyInto(out *ReceiptRule) { *out = *in + if in.Actions != nil { + in, out := &in.Actions, &out.Actions + *out = make([]*ReceiptAction, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(ReceiptAction) + (*in).DeepCopyInto(*out) + } + } + } if in.Enabled != nil { in, out := &in.Enabled, &out.Enabled *out = new(bool) **out = **in } + if in.Name != nil { + in, out := &in.Name, &out.Name + *out = new(string) + **out = **in + } + if in.Recipients != nil { + in, out := &in.Recipients, &out.Recipients + *out = make([]*string, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(string) + **out = **in + } + } + } if in.ScanEnabled != nil { in, out := &in.ScanEnabled, &out.ScanEnabled *out = new(bool) @@ -456,6 +588,160 @@ func (in *ReceiptRule) DeepCopy() *ReceiptRule { return out } +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *ReceiptRuleSet) DeepCopyInto(out *ReceiptRuleSet) { + *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 ReceiptRuleSet. +func (in *ReceiptRuleSet) DeepCopy() *ReceiptRuleSet { + if in == nil { + return nil + } + out := new(ReceiptRuleSet) + in.DeepCopyInto(out) + return out +} + +// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. +func (in *ReceiptRuleSet) 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 *ReceiptRuleSetList) DeepCopyInto(out *ReceiptRuleSetList) { + *out = *in + out.TypeMeta = in.TypeMeta + in.ListMeta.DeepCopyInto(&out.ListMeta) + if in.Items != nil { + in, out := &in.Items, &out.Items + *out = make([]ReceiptRuleSet, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReceiptRuleSetList. +func (in *ReceiptRuleSetList) DeepCopy() *ReceiptRuleSetList { + if in == nil { + return nil + } + out := new(ReceiptRuleSetList) + in.DeepCopyInto(out) + return out +} + +// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. +func (in *ReceiptRuleSetList) 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 *ReceiptRuleSetMetadata) DeepCopyInto(out *ReceiptRuleSetMetadata) { + *out = *in + if in.CreatedTimestamp != nil { + in, out := &in.CreatedTimestamp, &out.CreatedTimestamp + *out = (*in).DeepCopy() + } + if in.Name != nil { + in, out := &in.Name, &out.Name + *out = new(string) + **out = **in + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReceiptRuleSetMetadata. +func (in *ReceiptRuleSetMetadata) DeepCopy() *ReceiptRuleSetMetadata { + if in == nil { + return nil + } + out := new(ReceiptRuleSetMetadata) + in.DeepCopyInto(out) + return out +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *ReceiptRuleSetSpec) DeepCopyInto(out *ReceiptRuleSetSpec) { + *out = *in + if in.RuleSetName != nil { + in, out := &in.RuleSetName, &out.RuleSetName + *out = new(string) + **out = **in + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReceiptRuleSetSpec. +func (in *ReceiptRuleSetSpec) DeepCopy() *ReceiptRuleSetSpec { + if in == nil { + return nil + } + out := new(ReceiptRuleSetSpec) + in.DeepCopyInto(out) + return out +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *ReceiptRuleSetStatus) DeepCopyInto(out *ReceiptRuleSetStatus) { + *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 ReceiptRuleSetStatus. +func (in *ReceiptRuleSetStatus) DeepCopy() *ReceiptRuleSetStatus { + if in == nil { + return nil + } + out := new(ReceiptRuleSetStatus) + in.DeepCopyInto(out) + return out +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *RecipientDsnFields) DeepCopyInto(out *RecipientDsnFields) { + *out = *in + if in.FinalRecipient != nil { + in, out := &in.FinalRecipient, &out.FinalRecipient + *out = new(string) + **out = **in + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RecipientDsnFields. +func (in *RecipientDsnFields) DeepCopy() *RecipientDsnFields { + if in == nil { + return nil + } + out := new(RecipientDsnFields) + in.DeepCopyInto(out) + return out +} + // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *ReputationOptions) DeepCopyInto(out *ReputationOptions) { *out = *in @@ -488,11 +774,21 @@ func (in *ReputationOptions) DeepCopy() *ReputationOptions { // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *S3Action) DeepCopyInto(out *S3Action) { *out = *in + if in.BucketName != nil { + in, out := &in.BucketName, &out.BucketName + *out = new(string) + **out = **in + } if in.KMSKeyARN != nil { in, out := &in.KMSKeyARN, &out.KMSKeyARN *out = new(string) **out = **in } + if in.ObjectKeyPrefix != nil { + in, out := &in.ObjectKeyPrefix, &out.ObjectKeyPrefix + *out = new(string) + **out = **in + } if in.TopicARN != nil { in, out := &in.TopicARN, &out.TopicARN *out = new(string) @@ -513,6 +809,11 @@ func (in *S3Action) DeepCopy() *S3Action { // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *SNSAction) DeepCopyInto(out *SNSAction) { *out = *in + if in.Encoding != nil { + in, out := &in.Encoding, &out.Encoding + *out = new(string) + **out = **in + } if in.TopicARN != nil { in, out := &in.TopicARN, &out.TopicARN *out = new(string) @@ -550,9 +851,33 @@ func (in *SNSDestination) DeepCopy() *SNSDestination { return out } +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *SendDataPoint) DeepCopyInto(out *SendDataPoint) { + *out = *in + if in.Timestamp != nil { + in, out := &in.Timestamp, &out.Timestamp + *out = (*in).DeepCopy() + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SendDataPoint. +func (in *SendDataPoint) DeepCopy() *SendDataPoint { + if in == nil { + return nil + } + out := new(SendDataPoint) + in.DeepCopyInto(out) + return out +} + // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *StopAction) DeepCopyInto(out *StopAction) { *out = *in + if in.Scope != nil { + in, out := &in.Scope, &out.Scope + *out = new(string) + **out = **in + } if in.TopicARN != nil { in, out := &in.TopicARN, &out.TopicARN *out = new(string) @@ -570,6 +895,25 @@ func (in *StopAction) DeepCopy() *StopAction { return out } +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *TemplateMetadata) DeepCopyInto(out *TemplateMetadata) { + *out = *in + if in.CreatedTimestamp != nil { + in, out := &in.CreatedTimestamp, &out.CreatedTimestamp + *out = (*in).DeepCopy() + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateMetadata. +func (in *TemplateMetadata) DeepCopy() *TemplateMetadata { + if in == nil { + return nil + } + out := new(TemplateMetadata) + in.DeepCopyInto(out) + return out +} + // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *TrackingOptions) DeepCopyInto(out *TrackingOptions) { *out = *in diff --git a/cmd/controller/main.go b/cmd/controller/main.go index 25aef11..f17dd84 100644 --- a/cmd/controller/main.go +++ b/cmd/controller/main.go @@ -40,6 +40,7 @@ import ( svcsdk "github.com/aws/aws-sdk-go/service/ses" _ "github.com/aws-controllers-k8s/ses-controller/pkg/resource/configuration_set" + _ "github.com/aws-controllers-k8s/ses-controller/pkg/resource/receipt_rule_set" "github.com/aws-controllers-k8s/ses-controller/pkg/version" ) diff --git a/config/crd/bases/ses.services.k8s.aws_receiptrulesets.yaml b/config/crd/bases/ses.services.k8s.aws_receiptrulesets.yaml new file mode 100644 index 0000000..352662b --- /dev/null +++ b/config/crd/bases/ses.services.k8s.aws_receiptrulesets.yaml @@ -0,0 +1,128 @@ +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.16.2 + name: receiptrulesets.ses.services.k8s.aws +spec: + group: ses.services.k8s.aws + names: + kind: ReceiptRuleSet + listKind: ReceiptRuleSetList + plural: receiptrulesets + singular: receiptruleset + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: ReceiptRuleSet is the Schema for the ReceiptRuleSets 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: ReceiptRuleSetSpec defines the desired state of ReceiptRuleSet. + properties: + ruleSetName: + description: |- + The name of the rule set to create. The name must meet the following requirements: + + * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), + or dashes (-). + + * Start and end with a letter or number. + + * Contain 64 characters or fewer. + type: string + required: + - ruleSetName + type: object + status: + description: ReceiptRuleSetStatus defines the observed state of ReceiptRuleSet + 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 4f0bdf4..e9ca230 100644 --- a/config/crd/kustomization.yaml +++ b/config/crd/kustomization.yaml @@ -3,3 +3,4 @@ kind: Kustomization resources: - common - bases/ses.services.k8s.aws_configurationsets.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 7713476..e6875ae 100644 --- a/config/rbac/cluster-role-controller.yaml +++ b/config/rbac/cluster-role-controller.yaml @@ -48,6 +48,7 @@ rules: - ses.services.k8s.aws resources: - configurationsets + - receiptrulesets verbs: - create - delete @@ -60,6 +61,7 @@ rules: - ses.services.k8s.aws resources: - configurationsets/status + - receiptrulesets/status verbs: - get - patch diff --git a/config/rbac/role-reader.yaml b/config/rbac/role-reader.yaml index 647c91e..9b2b843 100644 --- a/config/rbac/role-reader.yaml +++ b/config/rbac/role-reader.yaml @@ -10,6 +10,7 @@ rules: - ses.services.k8s.aws resources: - configurationsets + - receiptrulesets verbs: - get - list diff --git a/config/rbac/role-writer.yaml b/config/rbac/role-writer.yaml index 208ad4e..9a952d7 100644 --- a/config/rbac/role-writer.yaml +++ b/config/rbac/role-writer.yaml @@ -10,6 +10,7 @@ rules: - ses.services.k8s.aws resources: - configurationsets + - receiptrulesets verbs: - create - delete @@ -22,6 +23,7 @@ rules: - ses.services.k8s.aws resources: - configurationsets + - receiptrulesets verbs: - get - patch diff --git a/generator.yaml b/generator.yaml index e35bd89..d1a3b34 100644 --- a/generator.yaml +++ b/generator.yaml @@ -5,7 +5,7 @@ ignore: - CustomVerificationEmailTemplate - ReceiptFilter - ReceiptRule - - ReceiptRuleSet +# - ReceiptRuleSet - Template field_paths: @@ -40,3 +40,19 @@ resources: template_path: hooks/configuration_set/sdk_create_post_build_request.go.tpl sdk_read_one_post_request: template_path: hooks/configuration_set/sdk_read_one_post_request.go.tpl + + ReceiptRuleSet: + fields: + RuleSetName: + is_primary_key: true + is_immutable: true + update_operation: + custom_method_name: customUpdate + tags: + ignore: true + exceptions: + terminal_codes: + - AlreadyExists + hooks: + sdk_read_one_post_request: + template_path: hooks/receipt_rule_set/sdk_read_one_post_request.go.tpl diff --git a/helm/crds/ses.services.k8s.aws_receiptrulesets.yaml b/helm/crds/ses.services.k8s.aws_receiptrulesets.yaml new file mode 100644 index 0000000..00bb779 --- /dev/null +++ b/helm/crds/ses.services.k8s.aws_receiptrulesets.yaml @@ -0,0 +1,128 @@ +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.16.2 + name: receiptrulesets.ses.services.k8s.aws +spec: + group: ses.services.k8s.aws + names: + kind: ReceiptRuleSet + listKind: ReceiptRuleSetList + plural: receiptrulesets + singular: receiptruleset + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: ReceiptRuleSet is the Schema for the ReceiptRuleSets 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: ReceiptRuleSetSpec defines the desired state of ReceiptRuleSet. + properties: + ruleSetName: + description: |- + The name of the rule set to create. The name must meet the following requirements: + + - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), + or dashes (-). + + - Start and end with a letter or number. + + - Contain 64 characters or fewer. + type: string + required: + - ruleSetName + type: object + status: + description: ReceiptRuleSetStatus defines the observed state of ReceiptRuleSet + 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 38b53ab..f27153b 100644 --- a/helm/templates/_helpers.tpl +++ b/helm/templates/_helpers.tpl @@ -95,6 +95,7 @@ rules: - ses.services.k8s.aws resources: - configurationsets + - receiptrulesets verbs: - create - delete @@ -107,6 +108,7 @@ rules: - ses.services.k8s.aws resources: - configurationsets/status + - receiptrulesets/status verbs: - get - patch diff --git a/helm/templates/role-reader.yaml b/helm/templates/role-reader.yaml index 7062c7e..0385c05 100644 --- a/helm/templates/role-reader.yaml +++ b/helm/templates/role-reader.yaml @@ -10,6 +10,7 @@ rules: - ses.services.k8s.aws resources: - configurationsets + - receiptrulesets verbs: - get - list diff --git a/helm/templates/role-writer.yaml b/helm/templates/role-writer.yaml index bc0bf42..b507bbd 100644 --- a/helm/templates/role-writer.yaml +++ b/helm/templates/role-writer.yaml @@ -10,6 +10,7 @@ rules: - ses.services.k8s.aws resources: - configurationsets + - receiptrulesets verbs: - create - delete @@ -22,6 +23,7 @@ rules: - ses.services.k8s.aws resources: - configurationsets + - receiptrulesets verbs: - get - patch diff --git a/pkg/resource/receipt_rule_set/delta.go b/pkg/resource/receipt_rule_set/delta.go new file mode 100644 index 0000000..615ceac --- /dev/null +++ b/pkg/resource/receipt_rule_set/delta.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 receipt_rule_set + +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.RuleSetName, b.ko.Spec.RuleSetName) { + delta.Add("Spec.RuleSetName", a.ko.Spec.RuleSetName, b.ko.Spec.RuleSetName) + } else if a.ko.Spec.RuleSetName != nil && b.ko.Spec.RuleSetName != nil { + if *a.ko.Spec.RuleSetName != *b.ko.Spec.RuleSetName { + delta.Add("Spec.RuleSetName", a.ko.Spec.RuleSetName, b.ko.Spec.RuleSetName) + } + } + + return delta +} diff --git a/pkg/resource/receipt_rule_set/descriptor.go b/pkg/resource/receipt_rule_set/descriptor.go new file mode 100644 index 0000000..2440348 --- /dev/null +++ b/pkg/resource/receipt_rule_set/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 receipt_rule_set + +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/ReceiptRuleSet" +) + +var ( + GroupVersionResource = svcapitypes.GroupVersion.WithResource("receiptrulesets") + GroupKind = metav1.GroupKind{ + Group: "ses.services.k8s.aws", + Kind: "ReceiptRuleSet", + } +) + +// 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.ReceiptRuleSet{} +} + +// 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.ReceiptRuleSet), + } +} + +// 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/receipt_rule_set/hooks.go b/pkg/resource/receipt_rule_set/hooks.go new file mode 100644 index 0000000..91ca461 --- /dev/null +++ b/pkg/resource/receipt_rule_set/hooks.go @@ -0,0 +1,18 @@ +package receipt_rule_set + +import ( + "context" + + ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare" + + "github.com/aws-controllers-k8s/ses-controller/pkg/util" +) + +func (rm *resourceManager) customUpdate( + ctx context.Context, + desired *resource, + _ *resource, + delta *ackcompare.Delta, +) (updated *resource, err error) { + return util.ValidateImmutableResource(ctx, rm.getImmutableFieldChanges(delta), desired) +} diff --git a/pkg/resource/receipt_rule_set/identifiers.go b/pkg/resource/receipt_rule_set/identifiers.go new file mode 100644 index 0000000..2f4f59a --- /dev/null +++ b/pkg/resource/receipt_rule_set/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 receipt_rule_set + +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/receipt_rule_set/manager.go b/pkg/resource/receipt_rule_set/manager.go new file mode 100644 index 0000000..501a326 --- /dev/null +++ b/pkg/resource/receipt_rule_set/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 receipt_rule_set + +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.ReceiptRuleSet{} +) + +// +kubebuilder:rbac:groups=ses.services.k8s.aws,resources=receiptrulesets,verbs=get;list;watch;create;update;patch;delete +// +kubebuilder:rbac:groups=ses.services.k8s.aws,resources=receiptrulesets/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/receipt_rule_set/manager_factory.go b/pkg/resource/receipt_rule_set/manager_factory.go new file mode 100644 index 0000000..af81fc5 --- /dev/null +++ b/pkg/resource/receipt_rule_set/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 receipt_rule_set + +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/receipt_rule_set/references.go b/pkg/resource/receipt_rule_set/references.go new file mode 100644 index 0000000..97f5f5d --- /dev/null +++ b/pkg/resource/receipt_rule_set/references.go @@ -0,0 +1,56 @@ +// 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 receipt_rule_set + +import ( + "context" + "sigs.k8s.io/controller-runtime/pkg/client" + + 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() + + 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.ReceiptRuleSet) error { + return nil +} diff --git a/pkg/resource/receipt_rule_set/resource.go b/pkg/resource/receipt_rule_set/resource.go new file mode 100644 index 0000000..46a9b2c --- /dev/null +++ b/pkg/resource/receipt_rule_set/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 receipt_rule_set + +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.ReceiptRuleSet +} + +// 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.RuleSetName = &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/receipt_rule_set/sdk.go b/pkg/resource/receipt_rule_set/sdk.go new file mode 100644 index 0000000..45aba52 --- /dev/null +++ b/pkg/resource/receipt_rule_set/sdk.go @@ -0,0 +1,346 @@ +// 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 receipt_rule_set + +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.ReceiptRuleSet{} + _ = 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.DescribeReceiptRuleSetOutput + resp, err = rm.sdkapi.DescribeReceiptRuleSetWithContext(ctx, input) + _ = resp + if err != nil { + if awsErr, ok := ackerr.AWSError(err); ok && awsErr.Code() == svcsdk.ErrCodeRuleSetDoesNotExistException { + rm.metrics.RecordAPICall("READ_ONE", "DescribeReceiptRuleSet", err) + return nil, ackerr.NotFound + } + } + + rm.metrics.RecordAPICall("READ_ONE", "DescribeReceiptRuleSet", 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() + + 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.RuleSetName == 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.DescribeReceiptRuleSetInput, error) { + res := &svcsdk.DescribeReceiptRuleSetInput{} + + if r.ko.Spec.RuleSetName != nil { + res.SetRuleSetName(*r.ko.Spec.RuleSetName) + } + + 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.CreateReceiptRuleSetOutput + _ = resp + resp, err = rm.sdkapi.CreateReceiptRuleSetWithContext(ctx, input) + rm.metrics.RecordAPICall("CREATE", "CreateReceiptRuleSet", 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.CreateReceiptRuleSetInput, error) { + res := &svcsdk.CreateReceiptRuleSetInput{} + + if r.ko.Spec.RuleSetName != nil { + res.SetRuleSetName(*r.ko.Spec.RuleSetName) + } + + 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, +) (*resource, error) { + return rm.customUpdate(ctx, desired, latest, delta) +} + +// 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.DeleteReceiptRuleSetOutput + _ = resp + resp, err = rm.sdkapi.DeleteReceiptRuleSetWithContext(ctx, input) + rm.metrics.RecordAPICall("DELETE", "DeleteReceiptRuleSet", 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.DeleteReceiptRuleSetInput, error) { + res := &svcsdk.DeleteReceiptRuleSetInput{} + + if r.ko.Spec.RuleSetName != nil { + res.SetRuleSetName(*r.ko.Spec.RuleSetName) + } + + return res, nil +} + +// setStatusDefaults sets default properties into supplied custom resource +func (rm *resourceManager) setStatusDefaults( + ko *svcapitypes.ReceiptRuleSet, +) { + 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 "AlreadyExists": + 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.RuleSetName") { + fields = append(fields, "RuleSetName") + } + + return fields +} diff --git a/templates/hooks/receipt_rule_set/sdk_read_one_post_request.go.tpl b/templates/hooks/receipt_rule_set/sdk_read_one_post_request.go.tpl new file mode 100644 index 0000000..1ec8b03 --- /dev/null +++ b/templates/hooks/receipt_rule_set/sdk_read_one_post_request.go.tpl @@ -0,0 +1,7 @@ + _ = resp + if err != nil { + if awsErr, ok := ackerr.AWSError(err); ok && awsErr.Code() == svcsdk.ErrCodeRuleSetDoesNotExistException { + rm.metrics.RecordAPICall("READ_ONE", "DescribeReceiptRuleSet", err) + return nil, ackerr.NotFound + } + } diff --git a/test/e2e/resources/receipt_rule_set_simple.yaml b/test/e2e/resources/receipt_rule_set_simple.yaml new file mode 100644 index 0000000..489126f --- /dev/null +++ b/test/e2e/resources/receipt_rule_set_simple.yaml @@ -0,0 +1,6 @@ +apiVersion: ses.services.k8s.aws/v1alpha1 +kind: ReceiptRuleSet +metadata: + name: $RECEIPT_RULE_SET_NAME +spec: + ruleSetName: $RECEIPT_RULE_SET_NAME diff --git a/test/e2e/tests/receipt_rule_set_test.py b/test/e2e/tests/receipt_rule_set_test.py new file mode 100644 index 0000000..1cf0ccf --- /dev/null +++ b/test/e2e/tests/receipt_rule_set_test.py @@ -0,0 +1,84 @@ +# 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 ReceiptRuleSet resource +""" + +import boto3 +import logging + +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 + + +RECEIPT_RULE_SET_RESOURCE_PLURAL = "receiptrulesets" + +@pytest.fixture(scope='module') +def ses_client(): + return boto3.client(SERVICE_NAME) + +def get_receipt_rule_set(ses_client, receipt_rule_set_name): + receipt_rule_sets = [rule_set for rule_set in ses_client.list_receipt_rule_sets()['RuleSets'] if rule_set['Name'] == receipt_rule_set_name] + return receipt_rule_sets[0] if receipt_rule_sets else None + +@pytest.fixture +def simple_receipt_rule_set(ses_client) -> Tuple[k8s.CustomResourceReference, Dict]: + receipt_rule_set_name = random_suffix_name('simple-receipt-rule-set', 32) + + replacements = REPLACEMENT_VALUES.copy() + replacements['RECEIPT_RULE_SET_NAME'] = receipt_rule_set_name + + resource_data = load_ses_resource( + 'receipt_rule_set_simple', + additional_replacements=replacements, + ) + logging.debug(resource_data) + + ref = k8s.CustomResourceReference( + CRD_GROUP, CRD_VERSION, RECEIPT_RULE_SET_RESOURCE_PLURAL, + receipt_rule_set_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_receipt_rule_set, ses_client, receipt_rule_set_name)) + + +@service_marker +@pytest.mark.canary +class TestReceiptRuleSet: + def test_create_receipt_rule_set(self, simple_receipt_rule_set, ses_client): + (ref, cr) = simple_receipt_rule_set + assert k8s.wait_on_condition( + ref, + condition.CONDITION_TYPE_RESOURCE_SYNCED, + 'True', + wait_periods=MAX_WAIT_FOR_SYNCED_MINUTES, + ) + assert get_receipt_rule_set(ses_client, cr['spec']['ruleSetName']) is not None