feat: add a helper to know automation reached goal state (#120)

Author: gssbzn

Makefile

@@ -36,8 +36,8 @@ lint: ## Run linter
 .PHONY: check
 check: test lint ## Run tests and linters
 
-.PHONY: addcopy
-addcopy:
+.PHONY: addlicense
+addlicense:
 	find . -name '*.go' | while read -r file; do addlicense -c "MongoDB Inc" "$$file"; done
 
 .PHONY: list

atmcfg/atmcfg.go

@@ -642,3 +642,12 @@ func reclaimByShardNameAndProcesses(out *opsmngr.AutomationConfig, processesMap
 		// compact doesn't run on mongoses
 	}
 }
+
+func IsGoalState(s *opsmngr.AutomationStatus) bool {
+	for _, p := range s.Processes {
+		if p.LastGoalVersionAchieved != s.GoalVersion {
+			return false
+		}
+	}
+	return true
+}

atmcfg/atmcfg_test.go

@@ -753,3 +753,52 @@ func isLastCompactEmpty(t *testing.T, process *opsmngr.Process, hostname string,
 		t.Errorf("ReclaimFreeSpace\n got=%#v", process.LastRestart)
 	}
 }
+
+func TestIsGoalState(t *testing.T) {
+	tests := []struct {
+		name string
+		s    *opsmngr.AutomationStatus
+		want bool
+	}{
+		{
+			name: "reached goal",
+			s: &opsmngr.AutomationStatus{
+				Processes: []opsmngr.ProcessStatus{
+					{
+						LastGoalVersionAchieved: 0,
+						Name:                    "test",
+						Hostname:                "test",
+					},
+				},
+				GoalVersion: 0,
+			},
+			want: true,
+		},
+		{
+			name: "pending goal",
+			s: &opsmngr.AutomationStatus{
+				Processes: []opsmngr.ProcessStatus{
+					{
+						LastGoalVersionAchieved: 0,
+						Name:                    "test",
+						Hostname:                "test",
+					},
+				},
+				GoalVersion: 1,
+			},
+			want: false,
+		},
+		{
+			name: "empty",
+			s:    &opsmngr.AutomationStatus{},
+			want: true,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := IsGoalState(tt.s); got != tt.want {
+				t.Errorf("IsGoalState() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}

atmcfg/fixtures.go

@@ -1,3 +1,17 @@
+// Copyright 2021 MongoDB Inc
+//
+// 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.
+
 package atmcfg
 
 import "go.mongodb.org/ops-manager/opsmngr"

go.sum

@@ -27,7 +27,6 @@ go.mongodb.org/atlas v0.11.1-0.20210811161401-47f8a8c02572/go.mod h1:MMWDsc2akjT
 golang.org/x/text v0.3.5 h1:i6eZZ+zk0SOf0xgBpEpPD18qWcJda6q1sxt3S0kzyUQ=
 golang.org/x/text v0.3.5/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
-golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU=

opsmngr/automation_status.go

@@ -57,8 +57,12 @@ type AutomationStatus struct {
 }
 
 type ProcessStatus struct {
-	Plan                    []string `json:"plan"`
+	ErrorCode               *int     `json:"errorCode,omitempty"`
+	ErrorCodeDescription    *string  `json:"errorCodeDescription,omitempty"`
+	ErrorCodeHumanReadable  *string  `json:"errorCodeHumanReadable,omitempty"`
+	ErrorString             *string  `json:"errorString,omitempty"`
+	Hostname                string   `json:"hostname"`
 	LastGoalVersionAchieved int      `json:"lastGoalVersionAchieved"`
 	Name                    string   `json:"name"`
-	Hostname                string   `json:"hostname"`
+	Plan                    []string `json:"plan"`
 }

opsmngr/organization_invitations.go

@@ -1,3 +1,17 @@
+// Copyright 2021 MongoDB Inc
+//
+// 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.
+
 package opsmngr
 
 import (