Merge pull request #490 from mesg-foundation/feature/refactor-deploy-…

…statuses refactor service deploy statuses flags, closes #487
mesg-foundation · Sep 24, 2018 · 97c2599 · 97c2599
2 parents 3dbd069 + c00faa2
commit 97c2599
Show file tree

Hide file tree

Showing 10 changed files with 292 additions and 272 deletions.
diff --git a/api/deploy.go b/api/deploy.go
@@ -1,13 +1,11 @@
 package api
 
 import (
-	"fmt"
 	"io"
 	"io/ioutil"
 	"os"
 	"path/filepath"
 
-	"github.com/logrusorgru/aurora"
 	"github.com/mesg-foundation/core/database/services"
 	"github.com/mesg-foundation/core/service"
 	"github.com/mesg-foundation/core/service/importer"
@@ -55,11 +53,14 @@ type StatusType int
 const (
 	_ StatusType = iota // skip zero value.
 
-	// RUNNING indicates that status message belongs to an active state.
-	RUNNING
+	// Running indicates that status message belongs to a continuous state.
+	Running
 
-	// DONE indicates that status message belongs to completed state.
-	DONE
+	// DonePositive indicates that status message belongs to a positive noncontinuous state.
+	DonePositive
+
+	// DoneNegative indicates that status message belongs to a negative noncontinuous state.
+	DoneNegative
 )
 
 // DeployStatus represents the deployment status.
@@ -81,7 +82,7 @@ func newServiceDeployer(api *API, options ...DeployServiceOption) *serviceDeploy
 
 // FromGitURL deploys a service hosted at a Git url.
 func (d *serviceDeployer) FromGitURL(url string) (*service.Service, *importer.ValidationError, error) {
-	d.sendStatus("Downloading service...", RUNNING)
+	d.sendStatus("Downloading service...", Running)
 	path, err := d.createTempDir()
 	if err != nil {
 		return nil, nil, err
@@ -97,7 +98,7 @@ func (d *serviceDeployer) FromGitURL(url string) (*service.Service, *importer.Va
 		return nil, nil, err
 	}
 
-	d.sendStatus(fmt.Sprintf("%s Service downloaded with success.", aurora.Green("✔")), DONE)
+	d.sendStatus("Service downloaded with success.", DonePositive)
 	r, err := xarchive.GzippedTar(path)
 	if err != nil {
 		return nil, nil, err
@@ -148,10 +149,12 @@ func (d *serviceDeployer) forwardDeployStatuses(statuses chan service.DeployStat
 	for status := range statuses {
 		var t StatusType
 		switch status.Type {
-		case service.DRUNNING:
-			t = RUNNING
-		case service.DDONE:
-			t = DONE
+		case service.DRunning:
+			t = Running
+		case service.DDonePositive:
+			t = DonePositive
+		case service.DDoneNegative:
+			t = DoneNegative
 		}
 		d.sendStatus(status.Message, t)
 	}

diff --git a/api/deploy_test.go b/api/deploy_test.go
@@ -1,15 +1,13 @@
 package api
 
 import (
-	"fmt"
 	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strings"
 	"sync"
 	"testing"
 
-	"github.com/logrusorgru/aurora"
 	"github.com/mesg-foundation/core/service/importer"
 	"github.com/mesg-foundation/core/x/xdocker/xarchive"
 	"github.com/stretchr/testify/require"
@@ -39,32 +37,32 @@ func TestDeployService(t *testing.T) {
 
 	require.Equal(t, DeployStatus{
 		Message: "Receiving service context...",
-		Type:    RUNNING,
+		Type:    Running,
 	}, <-statuses)
 
 	require.Equal(t, DeployStatus{
-		Message: fmt.Sprintf("%s Service context received with success.", aurora.Green("✔")),
-		Type:    DONE,
+		Message: "Service context received with success.",
+		Type:    DonePositive,
 	}, <-statuses)
 
 	require.Equal(t, DeployStatus{
-		Message: fmt.Sprintf("%s [DEPRECATED] Please use .dockerignore instead of .mesgignore", aurora.Red("⨯")),
-		Type:    DONE,
+		Message: "[DEPRECATED] Please use .dockerignore instead of .mesgignore",
+		Type:    DoneNegative,
 	}, <-statuses)
 
 	require.Equal(t, DeployStatus{
 		Message: "Building Docker image...",
-		Type:    RUNNING,
+		Type:    Running,
 	}, <-statuses)
 
 	require.Equal(t, DeployStatus{
-		Message: fmt.Sprintf("%s Image built with success.", aurora.Green("✔")),
-		Type:    DONE,
+		Message: "Image built with success.",
+		Type:    DonePositive,
 	}, <-statuses)
 
 	require.Equal(t, DeployStatus{
-		Message: fmt.Sprintf("%s Service deployed.", aurora.Green("✔")),
-		Type:    DONE,
+		Message: "Service deployed.",
+		Type:    DonePositive,
 	}, <-statuses)
 
 	wg.Wait()
@@ -94,12 +92,12 @@ func TestDeployInvalidService(t *testing.T) {
 
 	require.Equal(t, DeployStatus{
 		Message: "Receiving service context...",
-		Type:    RUNNING,
+		Type:    Running,
 	}, <-statuses)
 
 	require.Equal(t, DeployStatus{
-		Message: fmt.Sprintf("%s Service context received with success.", aurora.Green("✔")),
-		Type:    DONE,
+		Message: "Service context received with success.",
+		Type:    DonePositive,
 	}, <-statuses)
 
 	select {
@@ -131,37 +129,37 @@ func TestDeployServiceFromURL(t *testing.T) {
 
 	require.Equal(t, DeployStatus{
 		Message: "Downloading service...",
-		Type:    RUNNING,
+		Type:    Running,
 	}, <-statuses)
 
 	require.Equal(t, DeployStatus{
-		Message: fmt.Sprintf("%s Service downloaded with success.", aurora.Green("✔")),
-		Type:    DONE,
+		Message: "Service downloaded with success.",
+		Type:    DonePositive,
 	}, <-statuses)
 
 	require.Equal(t, DeployStatus{
 		Message: "Receiving service context...",
-		Type:    RUNNING,
+		Type:    Running,
 	}, <-statuses)
 
 	require.Equal(t, DeployStatus{
-		Message: fmt.Sprintf("%s Service context received with success.", aurora.Green("✔")),
-		Type:    DONE,
+		Message: "Service context received with success.",
+		Type:    DonePositive,
 	}, <-statuses)
 
 	require.Equal(t, DeployStatus{
 		Message: "Building Docker image...",
-		Type:    RUNNING,
+		Type:    Running,
 	}, <-statuses)
 
 	require.Equal(t, DeployStatus{
-		Message: fmt.Sprintf("%s Image built with success.", aurora.Green("✔")),
-		Type:    DONE,
+		Message: "Image built with success.",
+		Type:    DonePositive,
 	}, <-statuses)
 
 	require.Equal(t, DeployStatus{
-		Message: fmt.Sprintf("%s Service deployed.", aurora.Green("✔")),
-		Type:    DONE,
+		Message: "Service deployed.",
+		Type:    DonePositive,
 	}, <-statuses)
 
 	wg.Wait()

diff --git a/commands/provider/service_deployer.go b/commands/provider/service_deployer.go
@@ -16,11 +16,14 @@ type StatusType int
 const (
 	_ StatusType = iota // skip zero value.
 
-	// RUNNING indicates that status message belongs to an active state.
-	RUNNING
+	// Running indicates that status message belongs to a continuous state.
+	Running
 
-	// DONE indicates that status message belongs to completed state.
-	DONE
+	// DonePositive indicates that status message belongs to a positive noncontinuous state.
+	DonePositive
+
+	// DoneNegative indicates that status message belongs to a negative noncontinuous state.
+	DoneNegative
 )
 
 // DeployStatus represents the deployment status.
@@ -116,20 +119,21 @@ func readDeployReply(stream coreapi.Core_DeployServiceClient, deployment chan de
 
 		switch {
 		case status != nil:
+			s := DeployStatus{
+				Message: status.Message,
+			}
+
 			switch status.Type {
 			case coreapi.DeployServiceReply_Status_RUNNING:
-				statuses <- DeployStatus{
-					Message: status.Message,
-					Type:    RUNNING,
-				}
-
-			case coreapi.DeployServiceReply_Status_DONE:
-				statuses <- DeployStatus{
-					Message: status.Message,
-					Type:    DONE,
-				}
+				s.Type = Running
+			case coreapi.DeployServiceReply_Status_DONE_POSITIVE:
+				s.Type = DonePositive
+			case coreapi.DeployServiceReply_Status_DONE_NEGATIVE:
+				s.Type = DoneNegative
 			}
 
+			statuses <- s
+
 		case serviceID != "":
 			result.serviceID = serviceID
 			deployment <- result

diff --git a/commands/service_deploy.go b/commands/service_deploy.go
@@ -61,11 +61,18 @@ func (c *serviceDeployCmd) runE(cmd *cobra.Command, args []string) error {
 func printDeployStatuses(statuses chan provider.DeployStatus) {
 	for status := range statuses {
 		switch status.Type {
-		case provider.RUNNING:
+		case provider.Running:
 			pretty.UseSpinner(status.Message)
-		case provider.DONE:
+		default:
+			var sign string
+			switch status.Type {
+			case provider.DonePositive:
+				sign = pretty.SuccessSign
+			case provider.DoneNegative:
+				sign = pretty.FailSign
+			}
 			pretty.DestroySpinner()
-			fmt.Println(status.Message)
+			fmt.Printf("%s %s\n", sign, status.Message)
 		}
 	}
 }
diff --git a/interface/grpc/core/deploy.go b/interface/grpc/core/deploy.go
@@ -48,10 +48,12 @@ func sendDeployStatus(statuses chan api.DeployStatus, stream coreapi.Core_Deploy
 	for status := range statuses {
 		var typ coreapi.DeployServiceReply_Status_Type
 		switch status.Type {
-		case api.RUNNING:
+		case api.Running:
 			typ = coreapi.DeployServiceReply_Status_RUNNING
-		case api.DONE:
-			typ = coreapi.DeployServiceReply_Status_DONE
+		case api.DonePositive:
+			typ = coreapi.DeployServiceReply_Status_DONE_POSITIVE
+		case api.DoneNegative:
+			typ = coreapi.DeployServiceReply_Status_DONE_NEGATIVE
 		}
 
 		stream.Send(&coreapi.DeployServiceReply{

diff --git a/interface/grpc/core/deploy_test.go b/interface/grpc/core/deploy_test.go
@@ -1,12 +1,10 @@
 package core
 
 import (
-	"fmt"
 	"io/ioutil"
 	"strings"
 	"testing"
 
-	"github.com/logrusorgru/aurora"
 	"github.com/mesg-foundation/core/api"
 	"github.com/mesg-foundation/core/protobuf/coreapi"
 	"github.com/stretchr/testify/require"
@@ -24,8 +22,8 @@ func TestDeployService(t *testing.T) {
 	require.Len(t, stream.serviceID, 40)
 
 	require.Contains(t, stream.statuses, api.DeployStatus{
-		Message: fmt.Sprintf("%s Service deployed.", aurora.Green("✔")),
-		Type:    api.DONE,
+		Message: "Service deployed.",
+		Type:    api.DonePositive,
 	})
 }
 
@@ -50,9 +48,11 @@ func (s *testDeployStream) Send(m *coreapi.DeployServiceReply) error {
 		var typ api.StatusType
 		switch status.Type {
 		case coreapi.DeployServiceReply_Status_RUNNING:
-			typ = api.RUNNING
-		case coreapi.DeployServiceReply_Status_DONE:
-			typ = api.DONE
+			typ = api.Running
+		case coreapi.DeployServiceReply_Status_DONE_POSITIVE:
+			typ = api.DonePositive
+		case coreapi.DeployServiceReply_Status_DONE_NEGATIVE:
+			typ = api.DoneNegative
 		}
 		s.statuses = append(s.statuses, api.DeployStatus{
 			Message: status.Message,