sdk.go

// 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 resolver_rule

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/route53resolver"
	corev1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

	svcapitypes "github.com/aws-controllers-k8s/route53resolver-controller/apis/v1alpha1"
)

// Hack to avoid import errors during build...
var (
	_ = &metav1.Time{}
	_ = strings.ToLower("")
	_ = &aws.JSONValue{}
	_ = &svcsdk.Route53Resolver{}
	_ = &svcapitypes.ResolverRule{}
	_ = 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.GetResolverRuleOutput
	resp, err = rm.sdkapi.GetResolverRuleWithContext(ctx, input)
	rm.metrics.RecordAPICall("READ_ONE", "GetResolverRule", err)
	if err != nil {
		if reqErr, ok := ackerr.AWSRequestFailure(err); ok && reqErr.StatusCode() == 404 {
			return nil, ackerr.NotFound
		}
		if awsErr, ok := ackerr.AWSError(err); ok && awsErr.Code() == "UNKNOWN" {
			return nil, ackerr.NotFound
		}
		return nil, err
	}

	// Merge in the information we read from the API call above to the copy of
	// the original Kubernetes object we passed to the function
	ko := r.ko.DeepCopy()

	if ko.Status.ACKResourceMetadata == nil {
		ko.Status.ACKResourceMetadata = &ackv1alpha1.ResourceMetadata{}
	}
	if resp.ResolverRule.Arn != nil {
		arn := ackv1alpha1.AWSResourceName(*resp.ResolverRule.Arn)
		ko.Status.ACKResourceMetadata.ARN = &arn
	}
	if resp.ResolverRule.CreationTime != nil {
		ko.Status.CreationTime = resp.ResolverRule.CreationTime
	} else {
		ko.Status.CreationTime = nil
	}
	if resp.ResolverRule.CreatorRequestId != nil {
		ko.Status.CreatorRequestID = resp.ResolverRule.CreatorRequestId
	} else {
		ko.Status.CreatorRequestID = nil
	}
	if resp.ResolverRule.DomainName != nil {
		ko.Spec.DomainName = resp.ResolverRule.DomainName
	} else {
		ko.Spec.DomainName = nil
	}
	if resp.ResolverRule.Id != nil {
		ko.Status.ID = resp.ResolverRule.Id
	} else {
		ko.Status.ID = nil
	}
	if resp.ResolverRule.ModificationTime != nil {
		ko.Status.ModificationTime = resp.ResolverRule.ModificationTime
	} else {
		ko.Status.ModificationTime = nil
	}
	if resp.ResolverRule.Name != nil {
		ko.Spec.Name = resp.ResolverRule.Name
	} else {
		ko.Spec.Name = nil
	}
	if resp.ResolverRule.OwnerId != nil {
		ko.Status.OwnerID = resp.ResolverRule.OwnerId
	} else {
		ko.Status.OwnerID = nil
	}
	if resp.ResolverRule.ResolverEndpointId != nil {
		ko.Spec.ResolverEndpointID = resp.ResolverRule.ResolverEndpointId
	} else {
		ko.Spec.ResolverEndpointID = nil
	}
	if resp.ResolverRule.RuleType != nil {
		ko.Spec.RuleType = resp.ResolverRule.RuleType
	} else {
		ko.Spec.RuleType = nil
	}
	if resp.ResolverRule.ShareStatus != nil {
		ko.Status.ShareStatus = resp.ResolverRule.ShareStatus
	} else {
		ko.Status.ShareStatus = nil
	}
	if resp.ResolverRule.Status != nil {
		ko.Status.Status = resp.ResolverRule.Status
	} else {
		ko.Status.Status = nil
	}
	if resp.ResolverRule.StatusMessage != nil {
		ko.Status.StatusMessage = resp.ResolverRule.StatusMessage
	} else {
		ko.Status.StatusMessage = nil
	}
	if resp.ResolverRule.TargetIps != nil {
		f13 := []*svcapitypes.TargetAddress{}
		for _, f13iter := range resp.ResolverRule.TargetIps {
			f13elem := &svcapitypes.TargetAddress{}
			if f13iter.Ip != nil {
				f13elem.IP = f13iter.Ip
			}
			if f13iter.Ipv6 != nil {
				f13elem.IPv6 = f13iter.Ipv6
			}
			if f13iter.Port != nil {
				f13elem.Port = f13iter.Port
			}
			f13 = append(f13, f13elem)
		}
		ko.Spec.TargetIPs = f13
	} else {
		ko.Spec.TargetIPs = nil
	}

	rm.setStatusDefaults(ko)
	ko.Spec.Associations, err = rm.getAttachedVPC(ctx, &resource{ko})
	if err != nil {
		return nil, err
	}

	return &resource{ko}, nil
}

// requiredFieldsMissingFromReadOneInput returns true if there are any fields
// for the ReadOne Input shape that are required but not present in the
// resource's Spec or Status
func (rm *resourceManager) requiredFieldsMissingFromReadOneInput(
	r *resource,
) bool {
	return r.ko.Status.ID == nil

}

// newDescribeRequestPayload returns SDK-specific struct for the HTTP request
// payload of the Describe API call for the resource
func (rm *resourceManager) newDescribeRequestPayload(
	r *resource,
) (*svcsdk.GetResolverRuleInput, error) {
	res := &svcsdk.GetResolverRuleInput{}

	if r.ko.Status.ID != nil {
		res.SetResolverRuleId(*r.ko.Status.ID)
	}

	return res, nil
}

// sdkCreate creates the supplied resource in the backend AWS service API and
// returns a copy of the resource with resource fields (in both Spec and
// Status) filled in with values from the CREATE API operation's Output shape.
func (rm *resourceManager) sdkCreate(
	ctx context.Context,
	desired *resource,
) (created *resource, err error) {
	rlog := ackrtlog.FromContext(ctx)
	exit := rlog.Trace("rm.sdkCreate")
	defer func() {
		exit(err)
	}()
	input, err := rm.newCreateRequestPayload(ctx, desired)
	if err != nil {
		return nil, err
	}
	// A unique string that identifies the request and that allows failed requests to be
	// retried without the risk of running the operation twice.
	// CreatorRequestId can be any unique string, for example, a date/time stamp.
	// TODO: Name is not sufficient, since a failed request cannot be retried.
	// We might need to import the `time` package into `sdk.go`
	input.SetCreatorRequestId(getCreatorRequestId(desired.ko))

	var resp *svcsdk.CreateResolverRuleOutput
	_ = resp
	resp, err = rm.sdkapi.CreateResolverRuleWithContext(ctx, input)
	rm.metrics.RecordAPICall("CREATE", "CreateResolverRule", err)
	if err != nil {
		return nil, err
	}
	// Merge in the information we read from the API call above to the copy of
	// the original Kubernetes object we passed to the function
	ko := desired.ko.DeepCopy()

	if ko.Status.ACKResourceMetadata == nil {
		ko.Status.ACKResourceMetadata = &ackv1alpha1.ResourceMetadata{}
	}
	if resp.ResolverRule.Arn != nil {
		arn := ackv1alpha1.AWSResourceName(*resp.ResolverRule.Arn)
		ko.Status.ACKResourceMetadata.ARN = &arn
	}
	if resp.ResolverRule.CreationTime != nil {
		ko.Status.CreationTime = resp.ResolverRule.CreationTime
	} else {
		ko.Status.CreationTime = nil
	}
	if resp.ResolverRule.CreatorRequestId != nil {
		ko.Status.CreatorRequestID = resp.ResolverRule.CreatorRequestId
	} else {
		ko.Status.CreatorRequestID = nil
	}
	if resp.ResolverRule.DomainName != nil {
		ko.Spec.DomainName = resp.ResolverRule.DomainName
	} else {
		ko.Spec.DomainName = nil
	}
	if resp.ResolverRule.Id != nil {
		ko.Status.ID = resp.ResolverRule.Id
	} else {
		ko.Status.ID = nil
	}
	if resp.ResolverRule.ModificationTime != nil {
		ko.Status.ModificationTime = resp.ResolverRule.ModificationTime
	} else {
		ko.Status.ModificationTime = nil
	}
	if resp.ResolverRule.Name != nil {
		ko.Spec.Name = resp.ResolverRule.Name
	} else {
		ko.Spec.Name = nil
	}
	if resp.ResolverRule.OwnerId != nil {
		ko.Status.OwnerID = resp.ResolverRule.OwnerId
	} else {
		ko.Status.OwnerID = nil
	}
	if resp.ResolverRule.ResolverEndpointId != nil {
		ko.Spec.ResolverEndpointID = resp.ResolverRule.ResolverEndpointId
	} else {
		ko.Spec.ResolverEndpointID = nil
	}
	if resp.ResolverRule.RuleType != nil {
		ko.Spec.RuleType = resp.ResolverRule.RuleType
	} else {
		ko.Spec.RuleType = nil
	}
	if resp.ResolverRule.ShareStatus != nil {
		ko.Status.ShareStatus = resp.ResolverRule.ShareStatus
	} else {
		ko.Status.ShareStatus = nil
	}
	if resp.ResolverRule.Status != nil {
		ko.Status.Status = resp.ResolverRule.Status
	} else {
		ko.Status.Status = nil
	}
	if resp.ResolverRule.StatusMessage != nil {
		ko.Status.StatusMessage = resp.ResolverRule.StatusMessage
	} else {
		ko.Status.StatusMessage = nil
	}
	if resp.ResolverRule.TargetIps != nil {
		f13 := []*svcapitypes.TargetAddress{}
		for _, f13iter := range resp.ResolverRule.TargetIps {
			f13elem := &svcapitypes.TargetAddress{}
			if f13iter.Ip != nil {
				f13elem.IP = f13iter.Ip
			}
			if f13iter.Ipv6 != nil {
				f13elem.IPv6 = f13iter.Ipv6
			}
			if f13iter.Port != nil {
				f13elem.Port = f13iter.Port
			}
			f13 = append(f13, f13elem)
		}
		ko.Spec.TargetIPs = f13
	} else {
		ko.Spec.TargetIPs = nil
	}

	rm.setStatusDefaults(ko)
	if len(desired.ko.Spec.Associations) > 0 {
		ko.Spec.Associations = desired.ko.Spec.Associations
		if err := rm.createAssociation(ctx, &resource{ko}); err != nil {
			rlog.Debug("Error while syncing Association", err)
		}
	}
	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.CreateResolverRuleInput, error) {
	res := &svcsdk.CreateResolverRuleInput{}

	if r.ko.Spec.DomainName != nil {
		res.SetDomainName(*r.ko.Spec.DomainName)
	}
	if r.ko.Spec.Name != nil {
		res.SetName(*r.ko.Spec.Name)
	}
	if r.ko.Spec.ResolverEndpointID != nil {
		res.SetResolverEndpointId(*r.ko.Spec.ResolverEndpointID)
	}
	if r.ko.Spec.RuleType != nil {
		res.SetRuleType(*r.ko.Spec.RuleType)
	}
	if r.ko.Spec.Tags != nil {
		f4 := []*svcsdk.Tag{}
		for _, f4iter := range r.ko.Spec.Tags {
			f4elem := &svcsdk.Tag{}
			if f4iter.Key != nil {
				f4elem.SetKey(*f4iter.Key)
			}
			if f4iter.Value != nil {
				f4elem.SetValue(*f4iter.Value)
			}
			f4 = append(f4, f4elem)
		}
		res.SetTags(f4)
	}
	if r.ko.Spec.TargetIPs != nil {
		f5 := []*svcsdk.TargetAddress{}
		for _, f5iter := range r.ko.Spec.TargetIPs {
			f5elem := &svcsdk.TargetAddress{}
			if f5iter.IP != nil {
				f5elem.SetIp(*f5iter.IP)
			}
			if f5iter.IPv6 != nil {
				f5elem.SetIpv6(*f5iter.IPv6)
			}
			if f5iter.Port != nil {
				f5elem.SetPort(*f5iter.Port)
			}
			f5 = append(f5, f5elem)
		}
		res.SetTargetIps(f5)
	}

	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.customUpdateResolverRule(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)
	}()
	if r.ko.Spec.Associations != nil && r.ko.Status.ID != nil {
		desired := rm.concreteResource(r.DeepCopy())
		desired.ko.Spec.Associations = nil
		if err = rm.syncAssociation(ctx, desired, r); err != nil {
			return nil, err
		}
	}
	input, err := rm.newDeleteRequestPayload(r)
	if err != nil {
		return nil, err
	}
	var resp *svcsdk.DeleteResolverRuleOutput
	_ = resp
	resp, err = rm.sdkapi.DeleteResolverRuleWithContext(ctx, input)
	rm.metrics.RecordAPICall("DELETE", "DeleteResolverRule", 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.DeleteResolverRuleInput, error) {
	res := &svcsdk.DeleteResolverRuleInput{}

	if r.ko.Status.ID != nil {
		res.SetResolverRuleId(*r.ko.Status.ID)
	}

	return res, nil
}

// setStatusDefaults sets default properties into supplied custom resource
func (rm *resourceManager) setStatusDefaults(
	ko *svcapitypes.ResolverRule,
) {
	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 {
	// No terminal_errors specified for this resource in generator config
	return false
}