Add Table resource custom hooks, terminalCodes and e2e tests (#3)

Part of aws-controllers-k8s/community#803

Description of changes
- Add custom hooks, terminalCodes, printcomns to `Table` resource in `generator.yaml`
- Add e2e tests for `Table` create and delete operations

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

Author: a-hilaly

generator.yaml

@@ -4,6 +4,17 @@ resources:
       errors:
         404:
           code: ResourceNotFoundException
+      terminal_codes:
+        - InternalServerError
+        - LimitExceededException
+        - ResourceInUseException
+    hooks:
+      sdk_read_one_post_set_output:
+        template_path: hooks/table/sdk_read_one_post_set_output.go.tpl
+      sdk_update_pre_build_request:
+        template_path: hooks/table/sdk_update_pre_build_request.go.tpl
+      sdk_delete_pre_build_request:
+        template_path: hooks/table/sdk_delete_pre_build_request.go.tpl
   GlobalTable:
     exceptions:
       errors:

pkg/resource/table/conditions.go

@@ -0,0 +1,102 @@
+// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"). You may
+// not use this file except in compliance with the License. A copy of the
+// License is located at
+//
+//     http://aws.amazon.com/apache2.0/
+//
+// or in the "license" file accompanying this file. This file is distributed
+// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+// express or implied. See the License for the specific language governing
+// permissions and limitations under the License.
+
+package table
+
+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
+}

pkg/resource/table/hooks.go

@@ -0,0 +1,97 @@
+// 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 table
+
+import (
+	"errors"
+	"time"
+
+	"github.com/aws-controllers-k8s/dynamodb-controller/apis/v1alpha1"
+	ackrequeue "github.com/aws-controllers-k8s/runtime/pkg/requeue"
+)
+
+var (
+	ErrTableDeleting = errors.New("Table in 'DELETING' state, cannot be modified or deleted")
+	ErrTableCreating = errors.New("Table in 'CREATING' state, cannot be modified or deleted")
+	ErrTableUpdating = errors.New("Table in 'UPDATING' state, cannot be modified or deleted")
+)
+
+var (
+	// TerminalStatuses are the status strings that are terminal states for a
+	// DynamoDB table
+	TerminalStatuses = []v1alpha1.TableStatus_SDK{
+		v1alpha1.TableStatus_SDK_ARCHIVING,
+		v1alpha1.TableStatus_SDK_DELETING,
+	}
+)
+
+var (
+	requeueWaitWhileDeleting = ackrequeue.NeededAfter(
+		ErrTableDeleting,
+		5*time.Second,
+	)
+	requeueWaitWhileCreating = ackrequeue.NeededAfter(
+		ErrTableDeleting,
+		5*time.Second,
+	)
+	requeueWaitWhileUpdating = ackrequeue.NeededAfter(
+		ErrTableUpdating,
+		5*time.Second,
+	)
+)
+
+// tableHasTerminalStatus returns whether the supplied Dynamodb table is in a
+// terminal state
+func tableHasTerminalStatus(r *resource) bool {
+	if r.ko.Status.TableStatus == nil {
+		return false
+	}
+	ts := *r.ko.Status.TableStatus
+	for _, s := range TerminalStatuses {
+		if ts == string(s) {
+			return true
+		}
+	}
+	return false
+}
+
+// isTableCreating returns true if the supplied DynamodbDB table is in the process
+// of being created
+func isTableCreating(r *resource) bool {
+	if r.ko.Status.TableStatus == nil {
+		return false
+	}
+	dbis := *r.ko.Status.TableStatus
+	return dbis == string(v1alpha1.TableStatus_SDK_CREATING)
+}
+
+// isTableDeleting returns true if the supplied DynamodbDB table is in the process
+// of being deleted
+func isTableDeleting(r *resource) bool {
+	if r.ko.Status.TableStatus == nil {
+		return false
+	}
+	dbis := *r.ko.Status.TableStatus
+	return dbis == string(v1alpha1.TableStatus_SDK_DELETING)
+}
+
+// isTableUpdating returns true if the supplied DynamodbDB table is in the process
+// of being deleted
+func isTableUpdating(r *resource) bool {
+	if r.ko.Status.TableStatus == nil {
+		return false
+	}
+	dbis := *r.ko.Status.TableStatus
+	return dbis == string(v1alpha1.TableStatus_SDK_UPDATING)
+}

pkg/resource/table/sdk.go

@@ -0,0 +1,6 @@
+	if isTableDeleting(r) {
+		return requeueWaitWhileDeleting
+	}
+	if isTableUpdating(r) {
+		return requeueWaitWhileUpdating
+	}

templates/hooks/table/sdk_delete_pre_build_request.go.tpl

@@ -0,0 +1,6 @@
+	if isTableCreating(&resource{ko}) {
+		return &resource{ko}, requeueWaitWhileCreating
+	}
+	if isTableUpdating(&resource{ko}) {
+		return &resource{ko}, requeueWaitWhileUpdating
+	}

templates/hooks/table/sdk_read_one_post_set_output.go.tpl

@@ -0,0 +1,21 @@
+	if isTableDeleting(latest) {
+		msg := "table is currently being deleted"
+		setSyncedCondition(desired, corev1.ConditionFalse, &msg, nil)
+		return desired, requeueWaitWhileDeleting
+	}
+	if isTableCreating(latest) {
+		msg := "table is currently being created"
+		setSyncedCondition(desired, corev1.ConditionFalse, &msg, nil)
+		return desired, requeueWaitWhileCreating
+	}
+	if isTableUpdating(latest) {
+		msg := "table is currently being updated"
+		setSyncedCondition(desired, corev1.ConditionFalse, &msg, nil)
+		return desired, requeueWaitWhileUpdating
+	}
+	if tableHasTerminalStatus(latest) {
+		msg := "table is in '"+*latest.ko.Status.TableStatus+"' status"
+		setTerminalCondition(desired, corev1.ConditionTrue, &msg, nil)
+		setSyncedCondition(desired, corev1.ConditionTrue, nil, nil)
+		return desired, nil
+	}

templates/hooks/table/sdk_update_pre_build_request.go.tpl

@@ -0,0 +1,3 @@
+__pycache__/
+*.py[cod]
+**/bootstrap.yaml