[Feature] Propagate member conditions (#1382)

Author: ajanikow

docs/generated/actions.md

@@ -41,6 +41,7 @@
 |         MarkToRemoveMember         |    no    |  10m0s  |    no    | Community & Enterprise |               Marks member to be removed. Used when member Pod is annotated with replace annotation                |
 |         MemberPhaseUpdate          |    no    |  10m0s  |    no    | Community & Enterprise |                                                Change member phase                                                 |
 |        ~~MemberRIDUpdate~~         |    no    |  10m0s  |    no    | Community & Enterprise |                                              Update Run ID of member                                               |
+|          MemberStatusSync          |    no    |  10m0s  |    no    | Community & Enterprise |            Sync ArangoMember Status with ArangoDeployment Status, to keep Member information up to date            |
 |             PVCResize              |    no    |  30m0s  |    no    | Community & Enterprise |                               Start the resize procedure. Updates PVC Requests field                               |
 |             PVCResized             |    no    |  15m0s  |    no    | Community & Enterprise |                                        Waits for PVC resize to be completed                                        |
 |            PlaceHolder             |    no    |  10m0s  |    no    | Community & Enterprise |                                              Empty placeholder action                                              |
@@ -133,6 +134,7 @@ spec:
       MarkToRemoveMember: 10m0s
       MemberPhaseUpdate: 10m0s
       MemberRIDUpdate: 10m0s
+      MemberStatusSync: 10m0s
       PVCResize: 30m0s
       PVCResized: 15m0s
       PlaceHolder: 10m0s

internal/actions.yaml

@@ -177,6 +177,10 @@ actions:
     description: Change member phase
     scopes:
       - High
+  MemberStatusSync:
+    description: Sync ArangoMember Status with ArangoDeployment Status, to keep Member information up to date
+    scopes:
+      - High
   SetMemberCondition:
     description: Set member condition
     scopes:

pkg/apis/deployment/v1/actions.generated.go

@@ -134,6 +134,9 @@ const (
 	// ActionMemberRIDUpdateDefaultTimeout define default timeout for action ActionMemberRIDUpdate
 	ActionMemberRIDUpdateDefaultTimeout time.Duration = ActionsDefaultTimeout
 
+	// ActionMemberStatusSyncDefaultTimeout define default timeout for action ActionMemberStatusSync
+	ActionMemberStatusSyncDefaultTimeout time.Duration = ActionsDefaultTimeout
+
 	// ActionPVCResizeDefaultTimeout define default timeout for action ActionPVCResize
 	ActionPVCResizeDefaultTimeout time.Duration = 1800 * time.Second // 30m0s
 
@@ -388,6 +391,9 @@ const (
 	// Deprecated: action is not used anymore
 	ActionTypeMemberRIDUpdate ActionType = "MemberRIDUpdate"
 
+	// ActionTypeMemberStatusSync in scopes High. Sync ArangoMember Status with ArangoDeployment Status, to keep Member information up to date
+	ActionTypeMemberStatusSync ActionType = "MemberStatusSync"
+
 	// ActionTypePVCResize in scopes Normal. Start the resize procedure. Updates PVC Requests field
 	ActionTypePVCResize ActionType = "PVCResize"
 
@@ -605,6 +611,8 @@ func (a ActionType) DefaultTimeout() time.Duration {
 		return ActionMemberPhaseUpdateDefaultTimeout
 	case ActionTypeMemberRIDUpdate:
 		return ActionMemberRIDUpdateDefaultTimeout
+	case ActionTypeMemberStatusSync:
+		return ActionMemberStatusSyncDefaultTimeout
 	case ActionTypePVCResize:
 		return ActionPVCResizeDefaultTimeout
 	case ActionTypePVCResized:
@@ -777,6 +785,8 @@ func (a ActionType) Priority() ActionPriority {
 		return ActionPriorityHigh
 	case ActionTypeMemberRIDUpdate:
 		return ActionPriorityHigh
+	case ActionTypeMemberStatusSync:
+		return ActionPriorityHigh
 	case ActionTypePVCResize:
 		return ActionPriorityNormal
 	case ActionTypePVCResized:
@@ -961,6 +971,8 @@ func (a ActionType) Optional() bool {
 		return false
 	case ActionTypeMemberRIDUpdate:
 		return false
+	case ActionTypeMemberStatusSync:
+		return false
 	case ActionTypePVCResize:
 		return false
 	case ActionTypePVCResized:

pkg/apis/deployment/v1/arango_member_status.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2023 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -25,3 +25,16 @@ type ArangoMemberStatus struct {
 
 	Template *ArangoMemberPodTemplate `json:"template,omitempty"`
 }
+
+func (a ArangoMemberStatus) InSync(status MemberStatus) bool {
+	return status.Conditions.Equal(a.Conditions)
+}
+
+func (a *ArangoMemberStatus) Propagate(status MemberStatus) (changed bool) {
+	if !status.Conditions.Equal(a.Conditions) {
+		changed = true
+		a.Conditions = status.Conditions.DeepCopy()
+	}
+
+	return
+}

pkg/apis/deployment/v1/arango_member_status_test.go

@@ -0,0 +1,70 @@
+//
+// DISCLAIMER
+//
+// Copyright 2023 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License 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.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+
+package v1
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	core "k8s.io/api/core/v1"
+)
+
+func Test_ArangoMemberStatus_Propagate(t *testing.T) {
+	var status ArangoMemberStatus
+
+	t.Run("Add first condition", func(t *testing.T) {
+		var member = MemberStatus{
+			Conditions: ConditionList{
+				{
+					Type:   ConditionTypeScheduled,
+					Status: core.ConditionTrue,
+				},
+			},
+		}
+
+		require.False(t, status.InSync(member))
+		require.True(t, status.Propagate(member))
+		require.True(t, status.InSync(member))
+		require.False(t, status.Propagate(member))
+
+		require.Equal(t, member.Conditions, status.Conditions)
+	})
+
+	t.Run("Update first condition", func(t *testing.T) {
+		var member = MemberStatus{
+			Conditions: ConditionList{
+				{
+					Type:   ConditionTypeScheduled,
+					Status: core.ConditionFalse,
+				},
+			},
+		}
+
+		require.NotEqual(t, member.Conditions, status.Conditions)
+
+		require.False(t, status.InSync(member))
+		require.True(t, status.Propagate(member))
+		require.True(t, status.InSync(member))
+		require.False(t, status.Propagate(member))
+
+		require.Equal(t, member.Conditions, status.Conditions)
+	})
+}