support deleting data volumes while deleting services

api/delete.go

@@ -5,8 +5,10 @@ import (
 )
 
 // DeleteService stops and deletes service serviceID.
-func (a *API) DeleteService(serviceID string) error {
-	return newServiceDeletor(a).Delete(serviceID)
+// when deleteData is enabled, any persistent data that belongs to
+// service and its dependencies also will be deleted.
+func (a *API) DeleteService(serviceID string, deleteData bool) error {
+	return newServiceDeletor(a).Delete(serviceID, deleteData)
 }
 
 // serviceDeletor provides functionalities to delete a MESG service.
@@ -22,7 +24,9 @@ func newServiceDeletor(api *API) *serviceDeletor {
 }
 
 // Delete stops and deletes service serviceID.
-func (d *serviceDeletor) Delete(serviceID string) error {
+// when deleteData is enabled, any persistent data that belongs to
+// service and its dependencies also will be deleted.
+func (d *serviceDeletor) Delete(serviceID string, deleteData bool) error {
 	s, err := d.api.db.Get(serviceID)
 	if err != nil {
 		return err
@@ -34,5 +38,13 @@ func (d *serviceDeletor) Delete(serviceID string) error {
 	if err := s.Stop(); err != nil {
 		return err
 	}
+	// delete volumes first before the service. this way if
+	// deleting volumes fails, process can be retried by the user again
+	// because service still will be in the db.
+	if deleteData {
+		if err := s.DeleteVolumes(); err != nil {
+			return err
+		}
+	}
 	return d.api.db.Delete(serviceID)
 }

api/deploy.go

@@ -139,6 +139,7 @@ func (d *serviceDeployer) deploy(r io.Reader) (*service.Service, *importer.Valid
 	if validationErr != nil {
 		return nil, validationErr, nil
 	}
+
 	return s, nil, d.api.db.Save(s)
 }
 

commands/commands.go

@@ -2,6 +2,7 @@ package commands
 
 import (
 	"io"
+	"io/ioutil"
 
 	"github.com/mesg-foundation/core/commands/provider"
 	"github.com/mesg-foundation/core/container"
@@ -21,8 +22,8 @@ type RootExecutor interface {
 // ServiceExecutor is an interface that handles services commands.
 type ServiceExecutor interface {
 	ServiceByID(id string) (*coreapi.Service, error)
-	ServiceDeleteAll() error
-	ServiceDelete(ids ...string) error
+	ServiceDeleteAll(deleteData bool) error
+	ServiceDelete(deleteData bool, ids ...string) error
 	ServiceDeploy(path string, statuses chan provider.DeployStatus) (id string, validationError, err error)
 	ServiceListenEvents(id, eventFilter string) (chan *coreapi.EventData, chan error, error)
 	ServiceListenResults(id, taskFilter, outputFilter string, tagFilters []string) (chan *coreapi.ResultData, chan error, error)
@@ -65,6 +66,11 @@ func newCommand(c *cobra.Command) *cobra.Command {
 	return c
 }
 
+// discardOutput discards usage and error messages.
+func (c *baseCmd) discardOutput() {
+	c.cmd.SetOutput(ioutil.Discard)
+}
+
 // getFirstOrDefault returns directory if args len is gt 0 or current directory.
 func getFirstOrDefault(args []string) string {
 	if len(args) > 0 {

commands/commands_test.go

@@ -66,6 +66,11 @@ func newMockExecutor() *mocks.Executor {
 	return &mocks.Executor{}
 }
 
+// newMockSurvey returns a Survey mock for testing.
+func newMockSurvey() *mocks.Survey {
+	return &mocks.Survey{}
+}
+
 func TestBaseCommandCmd(t *testing.T) {
 	// NOTE: this test is only to satisfy structcheck
 	// as it doesn't handle embedded structs yet.

commands/provider/service_provider.go

@@ -38,7 +38,7 @@ func (p *ServiceProvider) ServiceByID(id string) (*coreapi.Service, error) {
 }
 
 // ServiceDeleteAll deletes all services.
-func (p *ServiceProvider) ServiceDeleteAll() error {
+func (p *ServiceProvider) ServiceDeleteAll(deleteData bool) error {
 	rep, err := p.client.ListServices(context.Background(), &coreapi.ListServicesRequest{})
 	if err != nil {
 		return err
@@ -51,7 +51,10 @@ func (p *ServiceProvider) ServiceDeleteAll() error {
 	wg.Add(len(rep.Services))
 	for _, s := range rep.Services {
 		go func(id string) {
-			_, err := p.client.DeleteService(context.Background(), &coreapi.DeleteServiceRequest{ServiceID: id})
+			_, err := p.client.DeleteService(context.Background(), &coreapi.DeleteServiceRequest{
+				ServiceID:  id,
+				DeleteData: deleteData,
+			})
 			if err != nil {
 				errs.Append(err)
 			}
@@ -63,11 +66,13 @@ func (p *ServiceProvider) ServiceDeleteAll() error {
 }
 
 // ServiceDelete deletes service with given ids.
-func (p *ServiceProvider) ServiceDelete(ids ...string) error {
+func (p *ServiceProvider) ServiceDelete(deleteData bool, ids ...string) error {
 	var errs xerrors.Errors
 	for _, id := range ids {
-		_, err := p.client.DeleteService(context.Background(), &coreapi.DeleteServiceRequest{ServiceID: id})
-		if err != nil {
+		if _, err := p.client.DeleteService(context.Background(), &coreapi.DeleteServiceRequest{
+			ServiceID:  id,
+			DeleteData: deleteData,
+		}); err != nil {
 			errs = append(errs, err)
 		}
 	}

commands/service_delete.go

@@ -10,11 +10,17 @@ import (
 	survey "gopkg.in/AlecAivazis/survey.v1"
 )
 
+var (
+	errConfirmationNeeded = errors.New("can't continue without confirmation")
+	errNoID               = errors.New("at least one service id must be provided (or run with --all flag)")
+)
+
 type serviceDeleteCmd struct {
 	baseCmd
 
-	all   bool
-	force bool
+	yes      bool
+	all      bool
+	keepData bool
 
 	e ServiceExecutor
 }
@@ -29,39 +35,74 @@ mesg-core service delete --all`,
 		PreRunE: c.preRunE,
 		RunE:    c.runE,
 	})
-
+	c.cmd.Flags().BoolVarP(&c.yes, "yes", "y", c.yes, `Automatic "yes" to all prompts and run non-interactively`)
 	c.cmd.Flags().BoolVar(&c.all, "all", c.all, "Delete all services")
-	c.cmd.Flags().BoolVarP(&c.force, "force", "f", c.force, "Force delete all services")
+	c.cmd.Flags().BoolVar(&c.keepData, "keep-data", c.keepData, "Do not delete services' persistent data")
 	return c
 }
 
 func (c *serviceDeleteCmd) preRunE(cmd *cobra.Command, args []string) error {
 	if len(args) == 0 && !c.all {
-		return errors.New("at least one service id must be provided (or run with --all flag)")
+		return errNoID
 	}
 
-	if !c.all || (c.all && c.force) {
+	if c.yes {
 		return nil
 	}
 
-	if err := survey.AskOne(&survey.Confirm{
-		Message: "Are you sure to delete all services?",
-	}, &c.force, nil); err != nil {
+	if err := c.confirmServiceDelete(); err != nil {
+		return err
+	}
+
+	if !c.keepData {
+		if err := c.confirmDataDelete(); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+// confirmServiceDelete prompts a confirmation dialog for deleting services.
+func (c *serviceDeleteCmd) confirmServiceDelete() error {
+	var (
+		confirmed bool
+		confirm   = &survey.Confirm{
+			Message: "Are you sure to delete service(s)?",
+		}
+	)
+
+	if c.all {
+		confirm.Message = "Are you sure to delete all services?"
+	}
+
+	if err := survey.AskOne(confirm, &confirmed, nil); err != nil {
 		return err
 	}
 
-	// if still no confirm .
-	if !c.force {
-		return errors.New("can't continue without confirmation")
+	if !confirmed {
+		return errConfirmationNeeded
 	}
 	return nil
 }
 
+// confirmServiceDelete prompts a confirmation dialog for deleting services' data.
+func (c *serviceDeleteCmd) confirmDataDelete() error {
+	if err := survey.AskOne(&survey.Confirm{
+		Message: "Are you sure to remove service(s)' persistent data as well?",
+	}, &c.keepData, nil); err != nil {
+		return err
+	}
+
+	c.keepData = !c.keepData
+	return nil
+}
+
 func (c *serviceDeleteCmd) runE(cmd *cobra.Command, args []string) error {
 	var err error
 	if c.all {
 		pretty.Progress("Deleting all services...", func() {
-			err = c.e.ServiceDeleteAll()
+			err = c.e.ServiceDeleteAll(!c.keepData)
 		})
 		if err != nil {
 			return err
@@ -75,7 +116,7 @@ func (c *serviceDeleteCmd) runE(cmd *cobra.Command, args []string) error {
 		// build function to avoid using arg inside progress
 		fn := func(id string) func() {
 			return func() {
-				err = c.e.ServiceDelete(id)
+				err = c.e.ServiceDelete(!c.keepData, id)
 			}
 		}(arg)
 		pretty.Progress(fmt.Sprintf("Deleting service %q...", arg), fn)

commands/service_delete_test.go

@@ -7,14 +7,61 @@ import (
 )
 
 func TestServiceDeleteCmdFlags(t *testing.T) {
-	c := newServiceDeleteCmd(nil)
+	var (
+		c     = newServiceDeleteCmd(nil)
+		flags = c.cmd.Flags()
+	)
+
+	// check defaults.
+	require.False(t, c.yes)
+	require.False(t, c.all)
+	require.False(t, c.keepData)
 
-	flags := c.cmd.Flags()
-	require.Equal(t, flags.ShorthandLookup("f"), flags.Lookup("force"))
+	require.Equal(t, flags.ShorthandLookup("y"), flags.Lookup("yes"))
 
-	flags.Set("force", "true")
-	require.True(t, c.force)
+	flags.Set("yes", "true")
+	require.True(t, c.yes)
 
 	flags.Set("all", "true")
 	require.True(t, c.all)
+
+	flags.Set("keep-data", "true")
+	require.True(t, c.keepData)
+}
+
+func TestServiceDeletePreRunE(t *testing.T) {
+	c := newServiceDeleteCmd(nil)
+	c.discardOutput()
+	require.Equal(t, errNoID, c.preRunE(c.cmd, nil))
+}
+
+func TestServiceDeleteRunE(t *testing.T) {
+	var (
+		m = newMockExecutor()
+		c = newServiceDeleteCmd(m)
+	)
+
+	tests := []struct {
+		all      bool
+		keepData bool
+		arg      string
+	}{
+		{all: false, keepData: false, arg: "0"},
+		{all: false, keepData: true, arg: "0"},
+		{all: true, keepData: false},
+		{all: true, keepData: true},
+	}
+
+	for _, tt := range tests {
+		c.all = tt.all
+		c.keepData = tt.keepData
+
+		if tt.all {
+			m.On("ServiceDeleteAll", !tt.keepData).Once().Return(nil)
+		} else {
+			m.On("ServiceDelete", !tt.keepData, tt.arg).Once().Return(nil)
+		}
+		require.NoError(t, c.runE(c.cmd, []string{tt.arg}))
+	}
+	m.AssertExpectations(t)
 }

commands/service_dev.go

@@ -79,7 +79,7 @@ func (c *serviceDevCmd) runE(cmd *cobra.Command, args []string) error {
 	defer func() {
 		var err error
 		pretty.Progress("Removing the service...", func() {
-			err = c.e.ServiceDelete(id)
+			err = c.e.ServiceDelete(false, id)
 		})
 		if err != nil {
 			fmt.Printf("%s Removing the service completed with an error: %s\n", pretty.FailSign, err)