Refactor DeploymentState to DeploymentPhase

Author: ewoutp

pkg/apis/deployment/v1alpha/deployment_phase.go

@@ -0,0 +1,42 @@
+//
+// DISCLAIMER
+//
+// Copyright 2018 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
+//
+// Author Ewout Prangsma
+//
+
+package v1alpha
+
+// DeploymentPhase is a strongly typed lifetime phase of a deployment
+type DeploymentPhase string
+
+const (
+	// DeploymentPhaseNone indicates that the phase is not set yet
+	DeploymentPhaseNone DeploymentPhase = ""
+	// DeploymentPhaseRunning indicates that the deployment is under control of the
+	// ArangoDeployment operator.
+	DeploymentPhaseRunning DeploymentPhase = "Running"
+	// DeploymentPhaseFailed indicates that a deployment is in a failed state
+	// from which automatic recovery is impossible. Inspect `Reason` for more info.
+	DeploymentPhaseFailed DeploymentPhase = "Failed"
+)
+
+// IsFailed returns true if given state is DeploymentStateFailed
+func (cs DeploymentPhase) IsFailed() bool {
+	return cs == DeploymentPhaseFailed
+}

pkg/apis/deployment/v1alpha/deployment_state_test.go renamed to pkg/apis/deployment/v1alpha/deployment_phase_test.go

@@ -28,11 +28,9 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func TestDeploymentStateIsFailed(t *testing.T) {
-	assert.False(t, DeploymentStateNone.IsFailed())
-	assert.False(t, DeploymentStateCreating.IsFailed())
-	assert.True(t, DeploymentStateFailed.IsFailed())
-	assert.False(t, DeploymentStateRunning.IsFailed())
-	assert.False(t, DeploymentStateScaling.IsFailed())
-	assert.False(t, DeploymentStateUpgrading.IsFailed())
+func TestDeploymentPhaseIsFailed(t *testing.T) {
+	assert.False(t, DeploymentPhaseNone.IsFailed())
+	assert.False(t, DeploymentPhaseCreating.IsFailed())
+	assert.True(t, DeploymentPhaseFailed.IsFailed())
+	assert.False(t, DeploymentPhaseRunning.IsFailed())
 }

pkg/apis/deployment/v1alpha/deployment_state.go

@@ -24,8 +24,8 @@ package v1alpha
 
 // DeploymentStatus contains the status part of a Cluster resource.
 type DeploymentStatus struct {
-	// State holds the current state of the deployment
-	State DeploymentState `json:"state"`
+	// Phase holds the current lifetime phase of the deployment
+	Phase DeploymentPhase `json:"phase"`
 	// Reason contains a human readable reason for reaching the current state (can be empty)
 	Reason string `json:"reason,omitempty"` // Reason for current state
 

pkg/apis/deployment/v1alpha/deployment_status.go

@@ -71,7 +71,7 @@ func (ci *clusterScalingIntegration) ListenForClusterEvents(stopCh <-chan struct
 		delay := time.Second * 2
 
 		// Is deployment in running state
-		if ci.depl.status.State == api.DeploymentStateRunning {
+		if ci.depl.status.Phase == api.DeploymentPhaseRunning {
 			// Update cluster with our state
 			ctx := context.Background()
 			safeToAskCluster, err := ci.updateClusterServerCount(ctx)

pkg/deployment/cluster_scaling_integration.go

@@ -167,7 +167,7 @@ func (d *Deployment) send(ev *deploymentEvent) {
 func (d *Deployment) run() {
 	log := d.deps.Log
 
-	if d.status.State == api.DeploymentStateNone {
+	if d.status.Phase == api.DeploymentPhaseNone {
 		// Create secrets
 		if err := d.resources.EnsureSecrets(); err != nil {
 			d.failOnError(err, "Failed to create secrets")
@@ -198,7 +198,7 @@ func (d *Deployment) run() {
 			return
 		}
 
-		d.status.State = api.DeploymentStateRunning
+		d.status.Phase = api.DeploymentPhaseRunning
 		if err := d.updateCRStatus(); err != nil {
 			log.Warn().Err(err).Msg("update initial CR status failed")
 		}
@@ -402,7 +402,7 @@ func (d *Deployment) reportFailedStatus() {
 	log.Info().Msg("deployment failed. Reporting failed reason...")
 
 	op := func() error {
-		d.status.State = api.DeploymentStateFailed
+		d.status.Phase = api.DeploymentPhaseFailed
 		err := d.updateCRStatus()
 		if err == nil || k8sutil.IsNotFound(err) {
 			// Status has been updated

pkg/deployment/deployment.go

@@ -142,14 +142,9 @@ func (r *Resources) InspectPods() error {
 		return nil
 	})
 
-	// Check overall status update
-	switch status.State {
-	case api.DeploymentStateCreating:
-		if status.Members.AllMembersReady() {
-			status.State = api.DeploymentStateRunning
-		}
-		// TODO handle other State values
-	}
+	// Update overall conditions
+	allMembersReady := status.Members.AllMembersReady()
+	status.Conditions.Update(api.ConditionTypeReady, allMembersReady, "", "")
 
 	// Save status
 	if err := r.context.UpdateStatus(status); err != nil {

pkg/deployment/resources/pod_inspector.go

@@ -136,7 +136,7 @@ func (o *Operator) syncArangoDeployment(apiObject *api.ArangoDeployment) {
 func (o *Operator) handleDeploymentEvent(event *Event) error {
 	apiObject := event.Deployment
 
-	if apiObject.Status.State.IsFailed() {
+	if apiObject.Status.Phase.IsFailed() {
 		deploymentsFailed.Inc()
 		if event.Type == kwatch.Deleted {
 			delete(o.deployments, apiObject.Name)