Add ObservedGeneration to ACK Status Conditions

Observed Generation is a kubernetes standard that persists the latest
reconciled generation (metadata.generation) in the resource status
condition

Author: michaelhtm

apis/core/v1alpha1/conditions.go

@@ -72,6 +72,11 @@ type Condition struct {
 	Type ConditionType `json:"type"`
 	// Status of the condition, one of True, False, Unknown.
 	Status corev1.ConditionStatus `json:"status"`
+	// observedGeneration represents the .metadata.generation that the condition was set based upon.
+	// For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration 
+	// is 9, the condition is out of date with respect to the current state of the instance.
+	// +optional
+	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 	// Last time the condition transitioned from one status to another.
 	// +optional
 	LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty"`

pkg/condition/condition.go

@@ -105,7 +105,7 @@ func AllOfType(
 // SetSynced sets the resource's Condition of type ConditionTypeResourceSynced
 // to the supplied status, optional message and reason.
 func SetSynced(
-	subject acktypes.ConditionManager,
+	subject acktypes.AWSResource,
 	status corev1.ConditionStatus,
 	message *string,
 	reason *string,
@@ -121,6 +121,7 @@ func SetSynced(
 	now := metav1.Now()
 	c.LastTransitionTime = &now
 	c.Status = status
+	c.ObservedGeneration = subject.MetaObject().GetGeneration()
 	c.Message = message
 	c.Reason = reason
 	subject.ReplaceConditions(allConds)
@@ -129,7 +130,7 @@ func SetSynced(
 // SetTerminal sets the resource's Condition of type ConditionTypeTerminal to
 // the supplied status, optional message and reason.
 func SetTerminal(
-	subject acktypes.ConditionManager,
+	subject acktypes.AWSResource,
 	status corev1.ConditionStatus,
 	message *string,
 	reason *string,
@@ -145,6 +146,7 @@ func SetTerminal(
 	now := metav1.Now()
 	c.LastTransitionTime = &now
 	c.Status = status
+	c.ObservedGeneration = subject.MetaObject().GetGeneration()
 	c.Message = message
 	c.Reason = reason
 	subject.ReplaceConditions(allConds)
@@ -153,7 +155,7 @@ func SetTerminal(
 // SetRecoverable sets the resource's Condition of type ConditionTypeRecoverable
 // to the supplied status, optional message and reason.
 func SetRecoverable(
-	subject acktypes.ConditionManager,
+	subject acktypes.AWSResource,
 	status corev1.ConditionStatus,
 	message *string,
 	reason *string,
@@ -169,6 +171,7 @@ func SetRecoverable(
 	now := metav1.Now()
 	c.LastTransitionTime = &now
 	c.Status = status
+	c.ObservedGeneration = subject.MetaObject().GetGeneration()
 	c.Message = message
 	c.Reason = reason
 	subject.ReplaceConditions(allConds)
@@ -177,7 +180,7 @@ func SetRecoverable(
 // SetLateInitialized sets the resource's Condition of type ConditionTypeLateInitialized to
 // the supplied status, optional message and reason.
 func SetLateInitialized(
-	subject acktypes.ConditionManager,
+	subject acktypes.AWSResource,
 	status corev1.ConditionStatus,
 	message *string,
 	reason *string,
@@ -193,6 +196,7 @@ func SetLateInitialized(
 	now := metav1.Now()
 	c.LastTransitionTime = &now
 	c.Status = status
+	c.ObservedGeneration = subject.MetaObject().GetGeneration()
 	c.Message = message
 	c.Reason = reason
 	subject.ReplaceConditions(allConds)
@@ -201,7 +205,7 @@ func SetLateInitialized(
 // SetReferencesResolved sets the resource's Condition of type ConditionTypeReferencesResolved
 // to the supplied status, optional message and reason.
 func SetReferencesResolved(
-	subject acktypes.ConditionManager,
+	subject acktypes.AWSResource,
 	status corev1.ConditionStatus,
 	message *string,
 	reason *string,
@@ -217,6 +221,7 @@ func SetReferencesResolved(
 	now := metav1.Now()
 	c.LastTransitionTime = &now
 	c.Status = status
+	c.ObservedGeneration = subject.MetaObject().GetGeneration()
 	c.Message = message
 	c.Reason = reason
 	subject.ReplaceConditions(allConds)

pkg/condition/condition_test.go

@@ -25,6 +25,7 @@ import (
 	ackerr "github.com/aws-controllers-k8s/runtime/pkg/errors"
 	corev1 "k8s.io/api/core/v1"
 
+	metav1mocks "github.com/aws-controllers-k8s/runtime/mocks/apimachinery/pkg/apis/meta/v1"
 	ackmocks "github.com/aws-controllers-k8s/runtime/mocks/pkg/types"
 )
 
@@ -111,7 +112,10 @@ func TestConditionGetters(t *testing.T) {
 func TestConditionSetters(t *testing.T) {
 	r := &ackmocks.AWSResource{}
 	r.On("Conditions").Return([]*ackv1alpha1.Condition{})
-
+	metaObject := &metav1mocks.Object{}
+	var observedGeneration int64 = 1
+	r.On("MetaObject").Return(metaObject)
+	metaObject.On("GetGeneration").Return(observedGeneration)
 	// Ensure that if there is no synced condition, it gets added...
 	r.On(
 		"ReplaceConditions",
@@ -132,6 +136,8 @@ func TestConditionSetters(t *testing.T) {
 
 	// Ensure that SetSynced doesn't overwrite any other conditions...
 	r = &ackmocks.AWSResource{}
+	r.On("MetaObject").Return(metaObject)
+	metaObject.On("GetGeneration").Return(observedGeneration)
 	r.On("Conditions").Return(
 		[]*ackv1alpha1.Condition{
 			&ackv1alpha1.Condition{
@@ -157,6 +163,8 @@ func TestConditionSetters(t *testing.T) {
 
 	// Ensure that SetSynced overwrites an existing synced condition...
 	r = &ackmocks.AWSResource{}
+	r.On("MetaObject").Return(metaObject)
+	metaObject.On("GetGeneration").Return(observedGeneration)
 	r.On("Conditions").Return(
 		[]*ackv1alpha1.Condition{
 			&ackv1alpha1.Condition{
@@ -183,6 +191,8 @@ func TestConditionSetters(t *testing.T) {
 
 	// Ensure that if there is no terminal condition, it gets added...
 	r = &ackmocks.AWSResource{}
+	r.On("MetaObject").Return(metaObject)
+	metaObject.On("GetGeneration").Return(observedGeneration)
 	r.On("Conditions").Return([]*ackv1alpha1.Condition{})
 	r.On(
 		"ReplaceConditions",
@@ -204,6 +214,8 @@ func TestConditionSetters(t *testing.T) {
 	// ReferencesResolved condition
 	// SetReferencesResolved
 	r = &ackmocks.AWSResource{}
+	r.On("MetaObject").Return(metaObject)
+	metaObject.On("GetGeneration").Return(observedGeneration)
 	r.On("Conditions").Return([]*ackv1alpha1.Condition{})
 	r.On(
 		"ReplaceConditions",
@@ -219,6 +231,8 @@ func TestConditionSetters(t *testing.T) {
 
 	//RemoveReferencesResolved
 	r = &ackmocks.AWSResource{}
+	r.On("MetaObject").Return(metaObject)
+	metaObject.On("GetGeneration").Return(observedGeneration)
 	r.On("Conditions").Return(
 		[]*ackv1alpha1.Condition{
 			&ackv1alpha1.Condition{
@@ -246,6 +260,8 @@ func TestConditionSetters(t *testing.T) {
 	//WithReferencesResolvedCondition
 	// Without Error
 	r = &ackmocks.AWSResource{}
+	r.On("MetaObject").Return(metaObject)
+	metaObject.On("GetGeneration").Return(observedGeneration)
 	r.On("DeepCopy").Return(r)
 	r.On("Conditions").Return([]*ackv1alpha1.Condition{})
 	r.On(
@@ -263,6 +279,8 @@ func TestConditionSetters(t *testing.T) {
 	errorMsg := "error message"
 	err := errors.New(errorMsg)
 	r = &ackmocks.AWSResource{}
+	r.On("MetaObject").Return(metaObject)
+	metaObject.On("GetGeneration").Return(observedGeneration)
 	r.On("DeepCopy").Return(r)
 	r.On("Conditions").Return([]*ackv1alpha1.Condition{})
 	r.On(
@@ -280,6 +298,8 @@ func TestConditionSetters(t *testing.T) {
 	// With Terminal Error
 	terminalError := ackerr.ResourceReferenceTerminal
 	r = &ackmocks.AWSResource{}
+	r.On("MetaObject").Return(metaObject)
+	metaObject.On("GetGeneration").Return(observedGeneration)
 	r.On("DeepCopy").Return(r)
 	r.On("Conditions").Return([]*ackv1alpha1.Condition{})
 	r.On(