Create Failed terminal condition Feature Group Creating requeue (#51)

Summary:
Set terminal condition for feature group in "Create Failed" state. Also factored out common custom_update_conditions code between feature group, monitoring schedule, and endpoint. Secondly, added requeue on Creating functionality for feature group in order to allow for the feature group status to be updated to Created.

Files Added:
- pkg/common/custom_set_terminal_state.go - Contains functionality of custom_update_conditions.go from previous endpoint / monitoring files (that is also reused with feature group).
- pkg/common/custom_set_synced_condition.go - Contains general functionality of customSetOutput from previous model package group hooks.go (that is also reused with feature group).
- pkg/common/custom_utilities.go - Contains helper function IsModifyingStatus that is used for both this PR and [PR #52](#52). Derived from previous model package group hooks.go.
- pkg/resource/feature_group/custom_update_conditions.go - added call to custom_set_terminal_state.go to set the terminal condition if the feature group "Create Failed" state is reached.
- pkg/resource/feature_group/hooks.go - Contains helper function isCreating, and ackrequeue variable requeueWaitWhileCreating which are referenced from (also new) resource manager customSetOutput function that is called post read One.

Files Edited:
- generator.yaml - Added custom update for featuregroup and updated captalization for custom update functions for endpoint and monitoring schedule to be consistent. Also included sdk_read_one_post_set_output hook calling to customSetOutput function.
- pkg/resource/endpoint/custom_update_conditions.go - factored out common code into custom_set_terminal_state.go
- pkg/resource/monitoring_schedule/custom_update_conditions.go - factored out common code into custom_set_terminal_state.go. Also replaced hardcoded string with library defined reference.
- pkg/resource/model_package_group/hooks.go - factored out common code into custom_set_synced_condition.go.

Author: BriannaRoskind

apis/v1alpha1/ack-generate-metadata.yaml

@@ -1,14 +1,14 @@
 ack_generate_info:
-  build_date: "2021-07-22T20:36:39Z"
+  build_date: "2021-07-23T02:02:51Z"
   build_hash: 6911f924191f5315747c8e81fbcbf29b4edc8cb1
   go_version: go1.16.4 linux/amd64
   version: v0.3.1
 api_directory_checksum: 4906740ff8ff6ebfffbaea971f7e8aa5a858edd8
 api_version: v1alpha1
 aws_sdk_go_version: v1.38.11
 generator_config_info:
-  file_checksum: c05fa636159c1f79ab353fd790587a5b36f8b95b
+  file_checksum: 8e1b7e085d2ff8673e0d239e05e0a1403825c355
   original_file_name: generator.yaml
 last_modification:
   reason: API generation
-  timestamp: 2021-07-22 20:36:41.771709478 +0000 UTC
+  timestamp: 2021-07-23 02:02:53.613950676 +0000 UTC

generator.yaml

@@ -69,7 +69,7 @@ resources:
   Endpoint:
     reconcile: 
       requeue_on_success_seconds: 30
-    update_conditions_custom_method_name: customUpdateConditions
+    update_conditions_custom_method_name: CustomUpdateConditions
     exceptions:
       errors:
         404:
@@ -429,7 +429,7 @@ resources:
   MonitoringSchedule:
     reconcile: 
       requeue_on_success_seconds: 30
-    update_conditions_custom_method_name: customUpdateConditions
+    update_conditions_custom_method_name: CustomUpdateConditions
     exceptions:
       errors:
           404:
@@ -490,6 +490,7 @@ resources:
           operation: DescribeMonitoringSchedule
           path: LastMonitoringExecutionSummary
   FeatureGroup:
+    update_conditions_custom_method_name: CustomUpdateConditions
     exceptions:
       errors:
           404:
@@ -514,6 +515,8 @@ resources:
         template_path: common/sdk_delete_pre_build_request.go.tpl
       sdk_delete_post_request:
         template_path: common/sdk_delete_post_request.go.tpl
+      sdk_read_one_post_set_output:
+        code: rm.customSetOutput(&resource{ko})
     fields:
       FailureReason:
         is_read_only: true

pkg/common/custom_conditions.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.
+
+// Use this file if conditions need to be updated based on the latest status
+// of endpoint which is not evident from API response
+
+package common
+
+import (
+	ackcondition "github.com/aws-controllers-k8s/runtime/pkg/condition"
+	acktypes "github.com/aws-controllers-k8s/runtime/pkg/types"
+	corev1 "k8s.io/api/core/v1"
+)
+
+// SetSyncedCondition sets the ACK Synced Condition
+// status to true if the resource status exists but
+// is not in one of the given modifying statuses,
+// or false if the resource status is one of the
+// given modifying statuses.
+func SetSyncedCondition(
+	r acktypes.AWSResource,
+	latestStatus *string,
+	resourceName *string,
+	modifyingStatuses *[]string,
+) {
+	if latestStatus == nil {
+		return
+	}
+
+	msg := *resourceName + " is in " + *latestStatus + " status."
+	conditionStatus := corev1.ConditionTrue
+	if IsModifyingStatus(latestStatus, modifyingStatuses) {
+		conditionStatus = corev1.ConditionFalse
+	}
+
+	ackcondition.SetSynced(r, conditionStatus, &msg, nil)
+}
+
+// SetTerminalState sets conditions (terminal) on
+// a resource's supplied status conditions if the
+// latest status matches the terminal status.
+// It returns true if conditions are updated.
+func SetTerminalState(
+	r acktypes.AWSResource,
+	latestStatus *string,
+	resourceName *string,
+	terminalStatus string,
+) bool {
+	if latestStatus == nil || *latestStatus != terminalStatus {
+		return false
+	}
+
+	terminalCondition := ackcondition.Terminal(r)
+	if terminalCondition != nil && terminalCondition.Status == corev1.ConditionTrue {
+		// some other exception already put the resource in terminal condition
+		return false
+	}
+
+	// setting terminal condition since controller can no longer recover by retrying
+	terminalMessage := *resourceName + " status reached terminal state: " + terminalStatus + ". Check the FailureReason."
+	ackcondition.SetTerminal(r, corev1.ConditionTrue, &terminalMessage, nil)
+
+	return true
+}

pkg/resource/endpoint/custom_update_conditions.go

@@ -17,48 +17,24 @@
 package endpoint
 
 import (
-	ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1"
 	svcapitypes "github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1"
-	"github.com/aws/aws-sdk-go/aws"
+	svccommon "github.com/aws-controllers-k8s/sagemaker-controller/pkg/common"
 	svcsdk "github.com/aws/aws-sdk-go/service/sagemaker"
-	corev1 "k8s.io/api/core/v1"
 )
 
-// CustomUpdateConditions sets conditions (terminal) on supplied endpoint
+// CustomUpdateConditions sets conditions (terminal) on supplied endpoint.
 // it examines supplied resource to determine conditions.
-// It returns true if conditions are updated
-func (rm *resourceManager) customUpdateConditions(
+// It returns true if conditions are updated.
+func (rm *resourceManager) CustomUpdateConditions(
 	ko *svcapitypes.Endpoint,
 	r *resource,
 	err error,
 ) bool {
 	latestStatus := r.ko.Status.EndpointStatus
-
-	if latestStatus == nil || *latestStatus != svcsdk.EndpointStatusFailed {
-		return false
-	}
-	var terminalCondition *ackv1alpha1.Condition = nil
-
-	for _, condition := range ko.Status.Conditions {
-		if condition.Type == ackv1alpha1.ConditionTypeTerminal {
-			terminalCondition = condition
-			break
-		}
-	}
-	if terminalCondition != nil && terminalCondition.Status == corev1.ConditionTrue {
-		// some other exception already put the resource in terminal condition
-		return false
-	}
-
-	// setting terminal condition since controller can no longer recover by retrying
-	if terminalCondition == nil {
-		terminalCondition = &ackv1alpha1.Condition{
-			Type: ackv1alpha1.ConditionTypeTerminal,
-		}
-		ko.Status.Conditions = append(ko.Status.Conditions, terminalCondition)
-	}
-	terminalCondition.Status = corev1.ConditionTrue
-	terminalCondition.Message = aws.String("endpoint status: Failed. check FailureReason")
-
-	return true
+	terminalStatus := svcsdk.EndpointStatusFailed
+	conditionManager := &resource{ko}
+	resourceName := resourceGK.Kind
+	// If the latestStatus == terminalStatus we will set
+	// the terminal condition and terminal message.
+	return svccommon.SetTerminalState(conditionManager, latestStatus, &resourceName, terminalStatus)
 }

pkg/resource/endpoint/sdk.go

@@ -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 feature_group
+
+import (
+	svcapitypes "github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1"
+	svccommon "github.com/aws-controllers-k8s/sagemaker-controller/pkg/common"
+	svcsdk "github.com/aws/aws-sdk-go/service/sagemaker"
+)
+
+// CustomUpdateConditions sets conditions (terminal) on supplied feature group.
+// it examines supplied resource to determine conditions.
+// It returns true if conditions are updated.
+func (rm *resourceManager) CustomUpdateConditions(
+	ko *svcapitypes.FeatureGroup,
+	r *resource,
+	err error,
+) bool {
+	latestStatus := r.ko.Status.FeatureGroupStatus
+	terminalStatus := svcsdk.FeatureGroupStatusCreateFailed
+	conditionManager := &resource{ko}
+	// If the latestStatus == terminalStatus we will set
+	// the terminal condition and terminal message.
+	return svccommon.SetTerminalState(conditionManager, latestStatus, &resourceName, terminalStatus)
+}

pkg/resource/feature_group/custom_update_conditions.go

@@ -43,3 +43,11 @@ func (rm *resourceManager) requeueUntilCanModify(
 	latestStatus := r.ko.Status.FeatureGroupStatus
 	return svccommon.RequeueIfModifying(latestStatus, &resourceName, &modifyingStatuses)
 }
+
+// customSetOutput sets the ack syncedCondition depending on
+// whether the latest status of the resource is one of the
+// defined modifyingStatuses.
+func (rm *resourceManager) customSetOutput(r *resource) {
+	latestStatus := r.ko.Status.FeatureGroupStatus
+	svccommon.SetSyncedCondition(r, latestStatus, &resourceName, &modifyingStatuses)
+}

pkg/resource/feature_group/hooks.go

@@ -17,11 +17,9 @@ import (
 	"context"
 	"errors"
 
-	ackcondition "github.com/aws-controllers-k8s/runtime/pkg/condition"
 	ackrequeue "github.com/aws-controllers-k8s/runtime/pkg/requeue"
 	svccommon "github.com/aws-controllers-k8s/sagemaker-controller/pkg/common"
 	svcsdk "github.com/aws/aws-sdk-go/service/sagemaker"
-	corev1 "k8s.io/api/core/v1"
 )
 
 var (
@@ -38,16 +36,8 @@ var (
 )
 
 func (rm *resourceManager) customSetOutput(r *resource) {
-	if r.ko.Status.ModelPackageGroupStatus == nil {
-		return
-	}
-	ModelPackageGroupStatus := *r.ko.Status.ModelPackageGroupStatus
-	msg := "ModelPackageGroup is in" + ModelPackageGroupStatus + "status"
-	if !svccommon.IsModifyingStatus(&ModelPackageGroupStatus, &modifyingStatuses) {
-		ackcondition.SetSynced(r, corev1.ConditionTrue, &msg, nil)
-	} else {
-		ackcondition.SetSynced(r, corev1.ConditionFalse, &msg, nil)
-	}
+	latestStatus := r.ko.Status.ModelPackageGroupStatus
+	svccommon.SetSyncedCondition(r, latestStatus, &resourceName, &modifyingStatuses)
 }
 
 // requeueUntilCanModify creates and returns an

pkg/resource/feature_group/sdk.go

@@ -17,46 +17,24 @@
 package monitoring_schedule
 
 import (
-	ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1"
 	svcapitypes "github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1"
-	"github.com/aws/aws-sdk-go/aws"
-	corev1 "k8s.io/api/core/v1"
+	svccommon "github.com/aws-controllers-k8s/sagemaker-controller/pkg/common"
+	svcsdk "github.com/aws/aws-sdk-go/service/sagemaker"
 )
 
-// CustomUpdateConditions sets conditions (terminal) on supplied resource
+// CustomUpdateConditions sets conditions (terminal) on supplied monitoring schedule.
 // it examines supplied resource to determine conditions.
-// It returns true if conditions are updated
-func (rm *resourceManager) customUpdateConditions(
+// It returns true if conditions are updated.
+func (rm *resourceManager) CustomUpdateConditions(
 	ko *svcapitypes.MonitoringSchedule,
 	r *resource,
 	err error,
 ) bool {
 	latestStatus := r.ko.Status.MonitoringScheduleStatus
-
-	if latestStatus == nil || *latestStatus != "Failed" {
-		return false
-	}
-
-	var terminalCondition *ackv1alpha1.Condition = nil
-	for _, condition := range ko.Status.Conditions {
-		if condition.Type == ackv1alpha1.ConditionTypeTerminal {
-			terminalCondition = condition
-			break
-		}
-	}
-	if terminalCondition != nil && terminalCondition.Status == corev1.ConditionTrue {
-		// some other exception already put the resource in terminal condition
-		return false
-	}
-
-	if terminalCondition == nil {
-		terminalCondition = &ackv1alpha1.Condition{
-			Type: ackv1alpha1.ConditionTypeTerminal,
-		}
-		ko.Status.Conditions = append(ko.Status.Conditions, terminalCondition)
-	}
-	terminalCondition.Status = corev1.ConditionTrue
-	terminalCondition.Message = aws.String("MonitoringScheduleStatus Failed. Check FailureReason")
-
-	return true
+	terminalStatus := svcsdk.ScheduleStatusFailed
+	conditionManager := &resource{ko}
+	resourceName := resourceGK.Kind
+	// If the latestStatus == terminalStatus we will set
+	// the terminal condition and terminal message.
+	return svccommon.SetTerminalState(conditionManager, latestStatus, &resourceName, terminalStatus)
 }