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

@@ -21,8 +21,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)

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

@@ -13,8 +13,9 @@ import (
 type serviceDeleteCmd struct {
 	baseCmd
 
-	all   bool
-	force bool
+	all        bool
+	force      bool
+	deleteData bool
 
 	e ServiceExecutor
 }
@@ -32,6 +33,7 @@ mesg-core service delete --all`,
 
 	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().BoolVarP(&c.deleteData, "delete-data", "d", c.force, "Delete services' persistent data along the way")
 	return c
 }
 
@@ -41,7 +43,7 @@ func (c *serviceDeleteCmd) preRunE(cmd *cobra.Command, args []string) error {
 	}
 
 	if !c.all || (c.all && c.force) {
-		return nil
+		return c.askDeleteData()
 	}
 
 	if err := survey.AskOne(&survey.Confirm{
@@ -54,14 +56,27 @@ func (c *serviceDeleteCmd) preRunE(cmd *cobra.Command, args []string) error {
 	if !c.force {
 		return errors.New("can't continue without confirmation")
 	}
+
+	return c.askDeleteData()
+}
+
+func (c *serviceDeleteCmd) askDeleteData() error {
+	if !c.deleteData {
+		if err := survey.AskOne(&survey.Confirm{
+			Message: "Do you want to remove service(s)' persistent data as well?",
+			Default: true,
+		}, &c.deleteData, nil); err != nil {
+			return err
+		}
+	}
 	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.deleteData)
 		})
 		if err != nil {
 			return err
@@ -75,7 +90,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.deleteData, id)
 			}
 		}(arg)
 		pretty.Progress(fmt.Sprintf("Deleting service %q...", arg), fn)

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)

container/container.go

@@ -29,6 +29,7 @@ type Container interface {
 	Status(namespace []string) (StatusType, error)
 	StopService(namespace []string) (err error)
 	TasksError(namespace []string) ([]string, error)
+	DeleteVolume(name string) error
 }
 
 // DockerContainer provides high level interactions with Docker API for MESG.

container/volume.go

@@ -0,0 +1,12 @@
+package container
+
+import (
+	"context"
+)
+
+// DeleteVolume deletes a Docker Volume by name.
+func (c *DockerContainer) DeleteVolume(name string) error {
+	ctx, cancel := context.WithTimeout(context.Background(), c.callTimeout)
+	defer cancel()
+	return c.client.VolumeRemove(ctx, name, false)
+}

container/volume_test.go

@@ -0,0 +1,20 @@
+package container
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/require"
+)
+
+func TestDeleteVolume(t *testing.T) {
+	var (
+		c, m = newTesting(t)
+		name = "1"
+	)
+
+	m.On("VolumeRemove", mock.Anything, name, false).Once().Return(nil)
+	require.NoError(t, c.DeleteVolume(name))
+
+	m.AssertExpectations(t)
+}

docs/api/core.md

@@ -1162,6 +1162,7 @@ Request's data of the `DeleteService` API.
 | Field | Type | Description |
 | ----- | ---- | ----------- |
 | serviceID | [string](#string) | The Service ID. Generated when using the [`DeployService` API](#deployservice). |
+| deleteData | [bool](#bool) | When enabled, any persistent data that belongs to service and its dependencies will be also deleted. |
 
 
 

interface/grpc/core/delete.go

@@ -8,5 +8,5 @@ import (
 
 // DeleteService stops and deletes service serviceID.
 func (s *Server) DeleteService(ctx context.Context, request *coreapi.DeleteServiceRequest) (*coreapi.DeleteServiceReply, error) {
-	return &coreapi.DeleteServiceReply{}, s.api.DeleteService(request.ServiceID)
+	return &coreapi.DeleteServiceReply{}, s.api.DeleteService(request.ServiceID, request.DeleteData)
 }

interface/grpc/core/deploy_integration_test.go

@@ -17,7 +17,7 @@ func TestIntegrationDeployService(t *testing.T) {
 	stream := newTestDeployStream(url)
 
 	require.Nil(t, server.DeployService(stream))
-	defer server.api.DeleteService(stream.serviceID)
+	defer server.api.DeleteService(stream.serviceID, false)
 
 	require.Len(t, stream.serviceID, 40)
 	require.Contains(t, stream.statuses, api.DeployStatus{

interface/grpc/core/execute_test.go

@@ -21,7 +21,7 @@ func TestExecute(t *testing.T) {
 	s, validationErr, err := server.api.DeployService(serviceTar(t, taskServicePath))
 	require.Zero(t, validationErr)
 	require.NoError(t, err)
-	defer server.api.DeleteService(s.ID)
+	defer server.api.DeleteService(s.ID, false)
 
 	require.NoError(t, server.api.StartService(s.ID))
 	defer server.api.StopService(s.ID)
@@ -42,7 +42,7 @@ func TestExecuteWithInvalidJSON(t *testing.T) {
 	s, validationErr, err := server.api.DeployService(serviceTar(t, taskServicePath))
 	require.Zero(t, validationErr)
 	require.NoError(t, err)
-	defer server.api.DeleteService(s.ID)
+	defer server.api.DeleteService(s.ID, false)
 
 	_, err = server.ExecuteTask(context.Background(), &coreapi.ExecuteTaskRequest{
 		ServiceID: s.ID,
@@ -63,7 +63,7 @@ func TestExecuteWithInvalidTask(t *testing.T) {
 	s, validationErr, err := server.api.DeployService(serviceTar(t, taskServicePath))
 	require.Zero(t, validationErr)
 	require.NoError(t, err)
-	defer server.api.DeleteService(s.ID)
+	defer server.api.DeleteService(s.ID, false)
 
 	require.NoError(t, server.api.StartService(s.ID))
 	defer server.api.StopService(s.ID)
@@ -91,7 +91,7 @@ func TestExecuteWithInvalidTaskInput(t *testing.T) {
 	s, validationErr, err := server.api.DeployService(serviceTar(t, taskServicePath))
 	require.Zero(t, validationErr)
 	require.NoError(t, err)
-	defer server.api.DeleteService(s.ID)
+	defer server.api.DeleteService(s.ID, false)
 
 	require.NoError(t, server.api.StartService(s.ID))
 	defer server.api.StopService(s.ID)
@@ -115,7 +115,7 @@ func TestExecuteWithNonRunningService(t *testing.T) {
 	s, validationErr, err := server.api.DeployService(serviceTar(t, taskServicePath))
 	require.Zero(t, validationErr)
 	require.NoError(t, err)
-	defer server.api.DeleteService(s.ID)
+	defer server.api.DeleteService(s.ID, false)
 
 	_, err = server.ExecuteTask(context.Background(), &coreapi.ExecuteTaskRequest{
 		ServiceID: s.ID,

interface/grpc/core/get_service_test.go

@@ -15,7 +15,7 @@ func TestGetService(t *testing.T) {
 	s, validationErr, err := server.api.DeployService(serviceTar(t, taskServicePath))
 	require.Zero(t, validationErr)
 	require.NoError(t, err)
-	defer server.api.DeleteService(s.ID)
+	defer server.api.DeleteService(s.ID, false)
 
 	reply, err := server.GetService(context.Background(), &coreapi.GetServiceRequest{
 		ServiceID: s.ID,

interface/grpc/core/list_services_test.go

@@ -15,7 +15,7 @@ func TestListServices(t *testing.T) {
 
 	stream := newTestDeployStream(url)
 	require.NoError(t, server.DeployService(stream))
-	defer server.api.DeleteService(stream.serviceID)
+	defer server.api.DeleteService(stream.serviceID, false)
 
 	reply, err := server.ListServices(context.Background(), &coreapi.ListServicesRequest{})
 	require.NoError(t, err)

interface/grpc/core/start_test.go

@@ -19,7 +19,7 @@ func TestStartService(t *testing.T) {
 	s, validationErr, err := server.api.DeployService(serviceTar(t, eventServicePath))
 	require.Zero(t, validationErr)
 	require.NoError(t, err)
-	defer server.api.DeleteService(s.ID)
+	defer server.api.DeleteService(s.ID, false)
 
 	_, err = server.StartService(context.Background(), &coreapi.StartServiceRequest{
 		ServiceID: s.ID,

interface/grpc/core/stop_test.go

@@ -19,7 +19,7 @@ func TestStopService(t *testing.T) {
 	s, validationErr, err := server.api.DeployService(serviceTar(t, eventServicePath))
 	require.Zero(t, validationErr)
 	require.NoError(t, err)
-	defer server.api.DeleteService(s.ID)
+	defer server.api.DeleteService(s.ID, false)
 
 	require.NoError(t, server.api.StartService(s.ID))