ensure Synced condition on Domain resources (#4)

Adds custom code to generic hook templates that places a
ConditionTypeResourceSynced on Domain resources with a status of False
when the Status.Processing field of the Domain is True and a status of
True otherwise.

Refactors the e2e tests to match the style of the RDS controller and
adds assertions for the ResourceSynced condition.

Signed-off-by: Jay Pipes <[email protected]>

By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license.

Author: jaypipes

apis/v1alpha1/ack-generate-metadata.yaml

@@ -1,13 +1,13 @@
 ack_generate_info:
-  build_date: "2021-10-15T18:16:23Z"
-  build_hash: f4166ae9942034b0552f244685515eef5a92dc25
-  go_version: go1.17.1
+  build_date: "2021-11-04T22:37:28Z"
+  build_hash: 0a8fc32cdf2d33693e919e4a59da05599b9f916e
+  go_version: go1.17
   version: v0.15.1
 api_directory_checksum: 550c87ef2158e5b3d58bc5a8ff5d3367c192b04a
 api_version: v1alpha1
 aws_sdk_go_version: v1.40.51
 generator_config_info:
-  file_checksum: 829c0e98be7f1960e999ed9df55b722a2b697921
+  file_checksum: 1aa3cbb5df5c91de25b9935978e30138af9b696d
   original_file_name: generator.yaml
 last_modification:
   reason: API generation

apis/v1alpha1/generator.yaml

@@ -15,3 +15,12 @@ resources:
           code: ResourceNotFoundException
       terminal_codes:
         - ValidationException
+    hooks:
+      sdk_create_post_set_output:
+        template_path: hooks/domain/sdk_create_post_set_output.go.tpl
+      sdk_read_one_post_set_output:
+        template_path: hooks/domain/sdk_read_one_post_set_output.go.tpl
+      sdk_update_pre_build_request:
+        template_path: hooks/domain/sdk_update_pre_build_request.go.tpl
+      sdk_delete_pre_build_request:
+        template_path: hooks/domain/sdk_delete_pre_build_request.go.tpl

config/crd/bases/opensearch.services.k8s.aws_domains.yaml

@@ -15,3 +15,12 @@ resources:
           code: ResourceNotFoundException
       terminal_codes:
         - ValidationException
+    hooks:
+      sdk_create_post_set_output:
+        template_path: hooks/domain/sdk_create_post_set_output.go.tpl
+      sdk_read_one_post_set_output:
+        template_path: hooks/domain/sdk_read_one_post_set_output.go.tpl
+      sdk_update_pre_build_request:
+        template_path: hooks/domain/sdk_update_pre_build_request.go.tpl
+      sdk_delete_pre_build_request:
+        template_path: hooks/domain/sdk_delete_pre_build_request.go.tpl

config/crd/bases/opensearch.services.k8s.aws_outboundconnections.yaml

@@ -0,0 +1,102 @@
+// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"). You may
+// not use this file except in compliance with the License. A copy of the
+// License is located at
+//
+//     http://aws.amazon.com/apache2.0/
+//
+// or in the "license" file accompanying this file. This file is distributed
+// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+// express or implied. See the License for the specific language governing
+// permissions and limitations under the License.
+
+package domain
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1"
+)
+
+// getSyncedCondition returns the Condition in the resource's Conditions
+// collection that is of type ConditionTypeResourceSynced. If no such condition
+// is found, returns nil.
+//
+// TODO(jaypipes): Move to ACK code-gen templates.
+func getSyncedCondition(r *resource) *ackv1alpha1.Condition {
+	return getConditionOfType(r, ackv1alpha1.ConditionTypeResourceSynced)
+}
+
+// getTerminalCondition returns the Condition in the resource's Conditions
+// collection that is of type ConditionTypeTerminal. If no such condition is
+// found, returns nil.
+//
+// TODO(jaypipes): Move to ACK code-gen templates.
+func getTerminalCondition(r *resource) *ackv1alpha1.Condition {
+	return getConditionOfType(r, ackv1alpha1.ConditionTypeTerminal)
+}
+
+// getConditionOfType returns the Condition in the resource's Conditions
+// collection of the supplied type. If no such condition is found, returns nil.
+//
+// TODO(jaypipes): Move to ACK code-gen templates.
+func getConditionOfType(
+	r *resource,
+	condType ackv1alpha1.ConditionType,
+) *ackv1alpha1.Condition {
+	for _, condition := range r.ko.Status.Conditions {
+		if condition.Type == condType {
+			return condition
+		}
+	}
+	return nil
+}
+
+// setSyncedCondition sets the resource's Condition of type
+// ConditionTypeResourceSynced to the supplied status, optional message and
+// reason.
+//
+// TODO(jaypipes): Move to ACK code-gen templates.
+func setSyncedCondition(
+	r *resource,
+	status corev1.ConditionStatus,
+	message *string,
+	reason *string,
+) {
+	c := getSyncedCondition(r)
+	if c == nil {
+		c = &ackv1alpha1.Condition{
+			Type: ackv1alpha1.ConditionTypeResourceSynced,
+		}
+		r.ko.Status.Conditions = append(r.ko.Status.Conditions, c)
+	}
+	now := metav1.Now()
+	c.LastTransitionTime = &now
+	c.Status = status
+}
+
+// setTerminalCondition sets the resource's Condition of type
+// ConditionTypeTerminal to the supplied status, optional message and reason.
+//
+// TODO(jaypipes): Move to ACK code-gen templates.
+func setTerminalCondition(
+	r *resource,
+	status corev1.ConditionStatus,
+	message *string,
+	reason *string,
+) {
+	c := getTerminalCondition(r)
+	if c == nil {
+		c = &ackv1alpha1.Condition{
+			Type: ackv1alpha1.ConditionTypeTerminal,
+		}
+		r.ko.Status.Conditions = append(r.ko.Status.Conditions, c)
+	}
+	now := metav1.Now()
+	c.LastTransitionTime = &now
+	c.Status = status
+	c.Message = message
+	c.Reason = reason
+}

generator.yaml

@@ -0,0 +1,36 @@
+// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"). You may
+// not use this file except in compliance with the License. A copy of the
+// License is located at
+//
+//     http://aws.amazon.com/apache2.0/
+//
+// or in the "license" file accompanying this file. This file is distributed
+// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+// express or implied. See the License for the specific language governing
+// permissions and limitations under the License.
+
+package domain
+
+import (
+	"errors"
+
+	ackrequeue "github.com/aws-controllers-k8s/runtime/pkg/requeue"
+)
+
+var (
+	requeueWaitWhileProcessing = ackrequeue.NeededAfter(
+		errors.New("domain is currently processing changes, cannot be modified or deleted."),
+		ackrequeue.DefaultRequeueAfterDuration,
+	)
+)
+
+// domainProcessing returns true if the supplied domain is in a state of
+// processing
+func domainProcessing(r *resource) bool {
+	if r.ko.Status.Processing == nil {
+		return false
+	}
+	return *r.ko.Status.Processing
+}

pkg/resource/domain/conditions.go

@@ -0,0 +1,6 @@
+	if domainProcessing(&resource{ko}) {
+		// Setting resource synced condition to false will trigger a requeue of
+		// the resource. No need to return a requeue error here.
+		setSyncedCondition(&resource{ko}, corev1.ConditionFalse, nil, nil)
+		return &resource{ko}, nil
+	}