Add default values to the comparison checker (#36)

* Add default values to the comparison checker

* Remove hardcoded defaults and assign server side values instead

* Use the IsNil and IsNotNil instead of simple nil checks

* Fix Nil Checks

Author: mbaijal

generator.yaml

@@ -24,6 +24,9 @@ operations:
     resource_name: HyperParameterTuningJob
 resources:
   Model:
+    hooks:
+      delta_pre_compare:
+        code: customSetDefaults(a, b)
     exceptions:
       errors:
         404:
@@ -148,6 +151,8 @@ resources:
         - InvalidAction
         - UnrecognizedClientException
     hooks:
+      delta_pre_compare:
+        code: customSetDefaults(a, b)
       sdk_create_post_set_output:
         code: rm.customSetOutput(r, aws.String(svcsdk.TrainingJobStatusInProgress), ko)
       sdk_delete_pre_build_request:
@@ -197,6 +202,8 @@ resources:
         - InvalidAction
         - UnrecognizedClientException
     hooks:
+      delta_pre_compare:
+        code: customSetDefaults(a, b)
       sdk_delete_pre_build_request:
         template_path: processing_job/sdk_delete_pre_build_request.go.tpl
       sdk_create_post_set_output:
@@ -237,6 +244,8 @@ resources:
         - InvalidAction
         - UnrecognizedClientException
     hooks:
+      delta_pre_compare:
+        code: customSetDefaults(a, b)
       sdk_delete_pre_build_request:
         template_path: transform_job/sdk_delete_pre_build_request.go.tpl
       sdk_create_post_set_output:

pkg/resource/model/custom_delta.go

@@ -0,0 +1,39 @@
+// 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 model
+
+import (
+	ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare"
+	svcapitypes "github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1"
+)
+
+func customSetDefaults(
+	a *resource,
+	b *resource,
+) {
+	// PrimaryContainer is not a required field, so this check is required
+	if ackcompare.IsNil(a.ko.Spec.PrimaryContainer) && ackcompare.IsNotNil(b.ko.Spec.PrimaryContainer) {
+		a.ko.Spec.PrimaryContainer = &svcapitypes.ContainerDefinition{}
+	}
+
+	if ackcompare.IsNotNil(a.ko.Spec.PrimaryContainer) && ackcompare.IsNotNil(b.ko.Spec.PrimaryContainer) {
+		if ackcompare.IsNil(a.ko.Spec.PrimaryContainer.Mode) && ackcompare.IsNotNil(b.ko.Spec.PrimaryContainer.Mode) {
+			a.ko.Spec.PrimaryContainer.Mode = b.ko.Spec.PrimaryContainer.Mode
+		}
+	}
+
+	if ackcompare.IsNil(a.ko.Spec.EnableNetworkIsolation) && ackcompare.IsNotNil(b.ko.Spec.EnableNetworkIsolation) {
+		a.ko.Spec.EnableNetworkIsolation = b.ko.Spec.EnableNetworkIsolation
+	}
+}

pkg/resource/model/delta.go

@@ -0,0 +1,35 @@
+// 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 processing_job
+
+import (
+	ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare"
+	svcapitypes "github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1"
+)
+
+func customSetDefaults(
+	a *resource,
+	b *resource,
+) {
+	// StoppingCondition is not a required field, so first create it
+	if ackcompare.IsNil(a.ko.Spec.StoppingCondition) && ackcompare.IsNotNil(b.ko.Spec.StoppingCondition) {
+		a.ko.Spec.StoppingCondition = &svcapitypes.ProcessingStoppingCondition{}
+	}
+
+	if ackcompare.IsNotNil(a.ko.Spec.StoppingCondition) && ackcompare.IsNotNil(b.ko.Spec.StoppingCondition) {
+		if ackcompare.IsNil(a.ko.Spec.StoppingCondition.MaxRuntimeInSeconds) && ackcompare.IsNotNil(b.ko.Spec.StoppingCondition.MaxRuntimeInSeconds) {
+			a.ko.Spec.StoppingCondition.MaxRuntimeInSeconds = b.ko.Spec.StoppingCondition.MaxRuntimeInSeconds
+		}
+	}
+}

pkg/resource/processing_job/custom_delta.go

@@ -0,0 +1,49 @@
+// 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 training_job
+
+import (
+	ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare"
+)
+
+func customSetDefaults(
+	a *resource,
+	b *resource,
+) {
+	if ackcompare.IsNil(a.ko.Spec.EnableInterContainerTrafficEncryption) && ackcompare.IsNotNil(b.ko.Spec.EnableInterContainerTrafficEncryption) {
+		a.ko.Spec.EnableInterContainerTrafficEncryption = b.ko.Spec.EnableInterContainerTrafficEncryption
+	}
+
+	if ackcompare.IsNil(a.ko.Spec.EnableManagedSpotTraining) && ackcompare.IsNotNil(b.ko.Spec.EnableManagedSpotTraining) {
+		a.ko.Spec.EnableManagedSpotTraining = b.ko.Spec.EnableManagedSpotTraining
+	}
+
+	if ackcompare.IsNil(a.ko.Spec.EnableNetworkIsolation) && ackcompare.IsNotNil(b.ko.Spec.EnableNetworkIsolation) {
+		a.ko.Spec.EnableNetworkIsolation = b.ko.Spec.EnableNetworkIsolation
+	}
+
+	// AlgorithmSpecification is a required field
+	if ackcompare.IsNotNil(a.ko.Spec.AlgorithmSpecification) && ackcompare.IsNotNil(b.ko.Spec.AlgorithmSpecification) {
+		if ackcompare.IsNil(a.ko.Spec.AlgorithmSpecification.EnableSageMakerMetricsTimeSeries) && ackcompare.IsNotNil(b.ko.Spec.AlgorithmSpecification.EnableSageMakerMetricsTimeSeries) {
+			a.ko.Spec.AlgorithmSpecification.EnableSageMakerMetricsTimeSeries = b.ko.Spec.AlgorithmSpecification.EnableSageMakerMetricsTimeSeries
+		}
+	}
+
+	// OutputDataConfig is a required field but the KMS Key is an empty string by default, it cannot be nil.
+	if ackcompare.IsNotNil(a.ko.Spec.OutputDataConfig) && ackcompare.IsNotNil(b.ko.Spec.OutputDataConfig) {
+		if ackcompare.IsNil(a.ko.Spec.OutputDataConfig.KMSKeyID) && ackcompare.IsNotNil(b.ko.Spec.OutputDataConfig.KMSKeyID) {
+			a.ko.Spec.OutputDataConfig.KMSKeyID = b.ko.Spec.OutputDataConfig.KMSKeyID
+		}
+	}
+}

pkg/resource/processing_job/delta.go

@@ -0,0 +1,65 @@
+// 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 transform_job
+
+import (
+	ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare"
+	svcapitypes "github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1"
+)
+
+func customSetDefaults(
+	a *resource,
+	b *resource,
+) {
+	// TransformInput is a required field.
+	if ackcompare.IsNil(a.ko.Spec.TransformInput.CompressionType) && ackcompare.IsNotNil(b.ko.Spec.TransformInput.CompressionType) {
+		a.ko.Spec.TransformInput.CompressionType = b.ko.Spec.TransformInput.CompressionType
+	}
+
+	if ackcompare.IsNil(a.ko.Spec.TransformInput.SplitType) && ackcompare.IsNotNil(b.ko.Spec.TransformInput.SplitType) {
+		a.ko.Spec.TransformInput.SplitType = b.ko.Spec.TransformInput.SplitType
+	}
+
+	// DataProcessing is not a required field, so first create it.
+	if ackcompare.IsNil(a.ko.Spec.DataProcessing) && ackcompare.IsNotNil(b.ko.Spec.DataProcessing) {
+		a.ko.Spec.DataProcessing = &svcapitypes.DataProcessing{}
+	}
+
+	if ackcompare.IsNotNil(a.ko.Spec.DataProcessing) && ackcompare.IsNotNil(b.ko.Spec.DataProcessing) {
+		if ackcompare.IsNil(a.ko.Spec.DataProcessing.InputFilter) && ackcompare.IsNotNil(b.ko.Spec.DataProcessing.InputFilter) {
+			a.ko.Spec.DataProcessing.InputFilter = b.ko.Spec.DataProcessing.InputFilter
+		}
+		if ackcompare.IsNil(a.ko.Spec.DataProcessing.JoinSource) && ackcompare.IsNotNil(b.ko.Spec.DataProcessing.JoinSource) {
+			a.ko.Spec.DataProcessing.JoinSource = b.ko.Spec.DataProcessing.JoinSource
+		}
+		if ackcompare.IsNil(a.ko.Spec.DataProcessing.OutputFilter) && ackcompare.IsNotNil(b.ko.Spec.DataProcessing.OutputFilter) {
+			a.ko.Spec.DataProcessing.OutputFilter = b.ko.Spec.DataProcessing.OutputFilter
+		}
+	}
+
+	// TODO: TransformOutput is a required field, so this check should not be required
+	if ackcompare.IsNil(a.ko.Spec.TransformOutput) && ackcompare.IsNotNil(b.ko.Spec.TransformOutput) {
+		a.ko.Spec.TransformOutput = &svcapitypes.TransformOutput{}
+	}
+
+	if ackcompare.IsNotNil(a.ko.Spec.TransformOutput) && ackcompare.IsNotNil(b.ko.Spec.TransformOutput) {
+		if ackcompare.IsNil(a.ko.Spec.TransformOutput.AssembleWith) && ackcompare.IsNotNil(b.ko.Spec.TransformOutput.AssembleWith) {
+			a.ko.Spec.TransformOutput.AssembleWith = b.ko.Spec.TransformOutput.AssembleWith
+		}
+		if ackcompare.IsNil(a.ko.Spec.TransformOutput.KMSKeyID) && ackcompare.IsNotNil(b.ko.Spec.TransformOutput.KMSKeyID) {
+			a.ko.Spec.TransformOutput.KMSKeyID = b.ko.Spec.TransformOutput.KMSKeyID
+		}
+	}
+
+}