requeue until Stopped for job style resources (#88)

Description of changes:
- requeue until Stopped for job style resources
  - integ test changes for the same
- Reduce terminal codes to only those which can be fixed by a change in spec. Reason being the latest runtime 0.13+ ignores metadata and status updates leaving customer with no way to get the controller reconcile if the terminal code is not related to spec field change. I will make this change for other resources in a separate PR
- consolidate hook related code to one file and refractor to use common pkg to reduce code duplication
  - removed post `sdk_create_post_set_output` hook because runtime does a readone and paches the status post create

TODO:
During testing, I found that if there is an error during delete it is not reflected in the resource conditions. Will put a PR to codegen and create a new PR with those changes

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

Author: surajkota

apis/v1alpha1/ack-generate-metadata.yaml

@@ -1,14 +1,14 @@
 ack_generate_info:
-  build_date: "2021-08-25T04:12:22Z"
+  build_date: "2021-08-30T20:10:42Z"
   build_hash: c77aa9c75d944952dee198029ba9822691cd82b0
   go_version: go1.16.4 linux/amd64
   version: v0.6.0
-api_directory_checksum: f7275158658c496010e6e3d2d24b3aba37e2e1f4
+api_directory_checksum: dd5cd5b0cfebeb75eae65c53ab3195a9935a4b87
 api_version: v1alpha1
 aws_sdk_go_version: v1.38.11
 generator_config_info:
-  file_checksum: 39823b712f9bd1035dc1c5ff1323a91930ce3db0
+  file_checksum: 84ebf8b8fb4e8a73f6c7fbaab033e3a75436e08e
   original_file_name: generator.yaml
 last_modification:
   reason: API generation
-  timestamp: 2021-08-25 04:12:25.649196147 +0000 UTC
+  timestamp: 2021-08-30 20:10:45.71009265 +0000 UTC

apis/v1alpha1/generator.yaml

@@ -150,28 +150,20 @@ resources:
             code: ValidationException
             message_prefix: Requested resource not found
       terminal_codes:
-        - ResourceLimitExceeded
         - ResourceNotFound
         - ResourceInUse
-        - OptInRequired
         - InvalidParameterCombination
         - InvalidParameterValue
         - MissingParameter
-        - MissingAction
-        - InvalidClientTokenId
-        - InvalidQueryParameter
-        - MalformedQueryString
-        - InvalidAction
-        - UnrecognizedClientException
     hooks:
       delta_pre_compare:
         code: customSetDefaults(a, b)
-      sdk_create_post_set_output:
-        code: rm.customCreateTrainingJobSetOutput(&resource{ko})
       sdk_read_one_post_set_output:
-        code: rm.customDescribeTrainingJobSetOutput(&resource{ko})
+        code: rm.customSetOutput(&resource{ko})
       sdk_delete_pre_build_request:
         template_path: training_job/sdk_delete_pre_build_request.go.tpl
+      sdk_delete_post_request:
+        template_path: common/sdk_delete_post_request.go.tpl
     fields:
       TrainingJobStatus:
         is_read_only: true
@@ -217,28 +209,20 @@ resources:
             code: ValidationException
             message_prefix: Could not find requested job
       terminal_codes:
-        - ResourceLimitExceeded
         - ResourceNotFound
         - ResourceInUse
-        - OptInRequired
         - InvalidParameterCombination
         - InvalidParameterValue
         - MissingParameter
-        - MissingAction
-        - InvalidClientTokenId
-        - InvalidQueryParameter
-        - MalformedQueryString
-        - InvalidAction
-        - UnrecognizedClientException
     hooks:
       delta_pre_compare:
         code: customSetDefaults(a, b)
+      sdk_read_one_post_set_output:
+        code: rm.customSetOutput(&resource{ko})
       sdk_delete_pre_build_request:
         template_path: processing_job/sdk_delete_pre_build_request.go.tpl
-      sdk_create_post_set_output:
-        code: rm.customSetOutput(desired, aws.String(svcsdk.ProcessingJobStatusInProgress), ko)
-      sdk_read_one_post_set_output:
-        code: rm.customSetOutput(r, resp.ProcessingJobStatus, ko)
+      sdk_delete_post_request:
+        template_path: common/sdk_delete_post_request.go.tpl
     fields:
       ProcessingJobStatus:
         is_read_only: true
@@ -262,28 +246,20 @@ resources:
             code: ValidationException
             message_prefix: Could not find requested job with name
       terminal_codes:
-        - ResourceLimitExceeded
         - ResourceNotFound
         - ResourceInUse
-        - OptInRequired
         - InvalidParameterCombination
         - InvalidParameterValue
         - MissingParameter
-        - MissingAction
-        - InvalidClientTokenId
-        - InvalidQueryParameter
-        - MalformedQueryString
-        - InvalidAction
-        - UnrecognizedClientException
     hooks:
       delta_pre_compare:
         code: customSetDefaults(a, b)
+      sdk_read_one_post_set_output:
+        code: rm.customSetOutput(&resource{ko})
       sdk_delete_pre_build_request:
         template_path: transform_job/sdk_delete_pre_build_request.go.tpl
-      sdk_create_post_set_output:
-        code: rm.customSetOutput(desired, aws.String(svcsdk.TransformJobStatusInProgress), ko)
-      sdk_read_one_post_set_output:
-        code: rm.customSetOutput(r, resp.TransformJobStatus, ko)
+      sdk_delete_post_request:
+        template_path: common/sdk_delete_post_request.go.tpl
     fields:
       TransformJobStatus:
         is_read_only: true
@@ -306,28 +282,20 @@ resources:
           404:
             code: ResourceNotFound
       terminal_codes:
-        - ResourceLimitExceeded
         - ResourceNotFound
         - ResourceInUse
-        - OptInRequired
         - InvalidParameterCombination
         - InvalidParameterValue
         - MissingParameter
-        - MissingAction
-        - InvalidClientTokenId
-        - InvalidQueryParameter
-        - MalformedQueryString
-        - InvalidAction
-        - UnrecognizedClientException
     hooks:
       delta_pre_compare:
         code: customSetDefaults(a, b)
+      sdk_read_one_post_set_output:
+        code: rm.customSetOutput(&resource{ko})
       sdk_delete_pre_build_request:
         template_path: hyper_parameter_tuning_job/sdk_delete_pre_build_request.go.tpl
-      sdk_create_post_set_output:
-        code: rm.customSetOutput(desired, aws.String(svcsdk.HyperParameterTuningJobStatusInProgress), ko)
-      sdk_read_one_post_set_output:
-        code: rm.customSetOutput(r, resp.HyperParameterTuningJobStatus, ko)
+      sdk_delete_post_request:
+        template_path: common/sdk_delete_post_request.go.tpl
     fields:
       HyperParameterTuningJobStatus:
         is_read_only: true

generator.yaml

@@ -150,28 +150,20 @@ resources:
             code: ValidationException
             message_prefix: Requested resource not found
       terminal_codes:
-        - ResourceLimitExceeded
         - ResourceNotFound
         - ResourceInUse
-        - OptInRequired
         - InvalidParameterCombination
         - InvalidParameterValue
         - MissingParameter
-        - MissingAction
-        - InvalidClientTokenId
-        - InvalidQueryParameter
-        - MalformedQueryString
-        - InvalidAction
-        - UnrecognizedClientException
     hooks:
       delta_pre_compare:
         code: customSetDefaults(a, b)
-      sdk_create_post_set_output:
-        code: rm.customCreateTrainingJobSetOutput(&resource{ko})
       sdk_read_one_post_set_output:
-        code: rm.customDescribeTrainingJobSetOutput(&resource{ko})
+        code: rm.customSetOutput(&resource{ko})
       sdk_delete_pre_build_request:
         template_path: training_job/sdk_delete_pre_build_request.go.tpl
+      sdk_delete_post_request:
+        template_path: common/sdk_delete_post_request.go.tpl
     fields:
       TrainingJobStatus:
         is_read_only: true
@@ -217,28 +209,20 @@ resources:
             code: ValidationException
             message_prefix: Could not find requested job
       terminal_codes:
-        - ResourceLimitExceeded
         - ResourceNotFound
         - ResourceInUse
-        - OptInRequired
         - InvalidParameterCombination
         - InvalidParameterValue
         - MissingParameter
-        - MissingAction
-        - InvalidClientTokenId
-        - InvalidQueryParameter
-        - MalformedQueryString
-        - InvalidAction
-        - UnrecognizedClientException
     hooks:
       delta_pre_compare:
         code: customSetDefaults(a, b)
+      sdk_read_one_post_set_output:
+        code: rm.customSetOutput(&resource{ko})
       sdk_delete_pre_build_request:
         template_path: processing_job/sdk_delete_pre_build_request.go.tpl
-      sdk_create_post_set_output:
-        code: rm.customSetOutput(desired, aws.String(svcsdk.ProcessingJobStatusInProgress), ko)
-      sdk_read_one_post_set_output:
-        code: rm.customSetOutput(r, resp.ProcessingJobStatus, ko)
+      sdk_delete_post_request:
+        template_path: common/sdk_delete_post_request.go.tpl
     fields:
       ProcessingJobStatus:
         is_read_only: true
@@ -262,28 +246,20 @@ resources:
             code: ValidationException
             message_prefix: Could not find requested job with name
       terminal_codes:
-        - ResourceLimitExceeded
         - ResourceNotFound
         - ResourceInUse
-        - OptInRequired
         - InvalidParameterCombination
         - InvalidParameterValue
         - MissingParameter
-        - MissingAction
-        - InvalidClientTokenId
-        - InvalidQueryParameter
-        - MalformedQueryString
-        - InvalidAction
-        - UnrecognizedClientException
     hooks:
       delta_pre_compare:
         code: customSetDefaults(a, b)
+      sdk_read_one_post_set_output:
+        code: rm.customSetOutput(&resource{ko})
       sdk_delete_pre_build_request:
         template_path: transform_job/sdk_delete_pre_build_request.go.tpl
-      sdk_create_post_set_output:
-        code: rm.customSetOutput(desired, aws.String(svcsdk.TransformJobStatusInProgress), ko)
-      sdk_read_one_post_set_output:
-        code: rm.customSetOutput(r, resp.TransformJobStatus, ko)
+      sdk_delete_post_request:
+        template_path: common/sdk_delete_post_request.go.tpl
     fields:
       TransformJobStatus:
         is_read_only: true
@@ -306,28 +282,20 @@ resources:
           404:
             code: ResourceNotFound
       terminal_codes:
-        - ResourceLimitExceeded
         - ResourceNotFound
         - ResourceInUse
-        - OptInRequired
         - InvalidParameterCombination
         - InvalidParameterValue
         - MissingParameter
-        - MissingAction
-        - InvalidClientTokenId
-        - InvalidQueryParameter
-        - MalformedQueryString
-        - InvalidAction
-        - UnrecognizedClientException
     hooks:
       delta_pre_compare:
         code: customSetDefaults(a, b)
+      sdk_read_one_post_set_output:
+        code: rm.customSetOutput(&resource{ko})
       sdk_delete_pre_build_request:
         template_path: hyper_parameter_tuning_job/sdk_delete_pre_build_request.go.tpl
-      sdk_create_post_set_output:
-        code: rm.customSetOutput(desired, aws.String(svcsdk.HyperParameterTuningJobStatusInProgress), ko)
-      sdk_read_one_post_set_output:
-        code: rm.customSetOutput(r, resp.HyperParameterTuningJobStatus, ko)
+      sdk_delete_post_request:
+        template_path: common/sdk_delete_post_request.go.tpl
     fields:
       HyperParameterTuningJobStatus:
         is_read_only: true

pkg/resource/hyper_parameter_tuning_job/custom_set_output.go

@@ -0,0 +1,43 @@
+// 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 hyper_parameter_tuning_job
+
+import (
+	"errors"
+
+	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"
+)
+
+var (
+	modifyingStatuses = []string{
+		svcsdk.HyperParameterTuningJobStatusInProgress,
+		svcsdk.HyperParameterTuningJobStatusStopping,
+	}
+	resourceName = resourceGK.Kind
+
+	requeueWaitWhileDeleting = ackrequeue.NeededAfter(
+		errors.New(resourceName+" is Stopping."),
+		ackrequeue.DefaultRequeueAfterDuration,
+	)
+)
+
+// customSetOutput sets ConditionTypeResourceSynced condition to True or False
+// based on the hyperParameterTuningJobStatus on AWS so the reconciler can determine if a
+// requeue is needed
+func (rm *resourceManager) customSetOutput(r *resource) {
+	jobStatus := r.ko.Status.HyperParameterTuningJobStatus
+	svccommon.SetSyncedCondition(r, jobStatus, &resourceName, &modifyingStatuses)
+}