Wait for component deletion, Add --wait flag to odo delete (#2732)

* Added --wait flag to odo delete

Added --wait flag to odo delete
added propgation policy for deletion, setup watch on dc to recieve
deleted event.

* Added Integration test

Added Integration test for owned resource deletion.

pkg/application/application.go

@@ -91,7 +91,7 @@ func Delete(client *occlient.Client, name string) error {
 		}
 	}
 	// delete application from cluster
-	err = client.Delete(labels)
+	err = client.Delete(labels, false)
 	if err != nil {
 		return errors.Wrapf(err, "unable to delete application %s", name)
 	}

pkg/component/component.go

@@ -271,14 +271,14 @@ func CreateFromPath(client *occlient.Client, params occlient.CreateArgs) error {
 }
 
 // Delete whole component
-func Delete(client *occlient.Client, componentName string, applicationName string) error {
+func Delete(client *occlient.Client, wait bool, componentName, applicationName string) error {
 
 	// Loading spinner
 	s := log.Spinnerf("Deleting component %s", componentName)
 	defer s.End(false)
 
 	labels := componentlabels.GetLabels(componentName, applicationName, false)
-	err := client.Delete(labels)
+	err := client.Delete(labels, wait)
 	if err != nil {
 		return errors.Wrapf(err, "error deleting component %s", componentName)
 	}

pkg/occlient/occlient.go

@@ -93,10 +93,11 @@ type CreateArgs struct {
 }
 
 const (
-	failedEventCount   = 5
-	OcUpdateTimeout    = 5 * time.Minute
-	OcBuildTimeout     = 5 * time.Minute
-	OpenShiftNameSpace = "openshift"
+	failedEventCount                = 5
+	OcUpdateTimeout                 = 5 * time.Minute
+	OcBuildTimeout                  = 5 * time.Minute
+	OpenShiftNameSpace              = "openshift"
+	waitForComponentDeletionTimeout = 120 * time.Second
 
 	// timeout for getting the default service account
 	getDefaultServiceAccTimeout = 1 * time.Minute
@@ -2089,15 +2090,22 @@ func (c *Client) DisplayDeploymentConfigLog(deploymentConfigName string, followL
 }
 
 // Delete takes labels as a input and based on it, deletes respective resource
-func (c *Client) Delete(labels map[string]string) error {
+func (c *Client) Delete(labels map[string]string, wait bool) error {
+
 	// convert labels to selector
 	selector := util.ConvertLabelsToSelector(labels)
 	glog.V(4).Infof("Selectors used for deletion: %s", selector)
 
 	var errorList []string
+	var deletionPolicy = metav1.DeletePropagationBackground
+
+	// for --wait flag, it deletes component dependents first and then delete component
+	if wait {
+		deletionPolicy = metav1.DeletePropagationForeground
+	}
 	// Delete DeploymentConfig
 	glog.V(4).Info("Deleting DeploymentConfigs")
-	err := c.appsClient.DeploymentConfigs(c.Namespace).DeleteCollection(&metav1.DeleteOptions{}, metav1.ListOptions{LabelSelector: selector})
+	err := c.appsClient.DeploymentConfigs(c.Namespace).DeleteCollection(&metav1.DeleteOptions{PropagationPolicy: &deletionPolicy}, metav1.ListOptions{LabelSelector: selector})
 	if err != nil {
 		errorList = append(errorList, "unable to delete deploymentconfig")
 	}
@@ -2114,6 +2122,16 @@ func (c *Client) Delete(labels map[string]string) error {
 		errorList = append(errorList, "unable to delete imagestream")
 	}
 
+	// for --wait it waits for component to be deleted
+	// TODO: Need to modify for `odo app delete`, currently wait flag is added only in `odo component delete`
+	//       so only one component gets passed in selector
+	if wait {
+		err = c.WaitForComponentDeletion(selector)
+		if err != nil {
+			errorList = append(errorList, err.Error())
+		}
+	}
+
 	// Error string
 	errString := strings.Join(errorList, ",")
 	if len(errString) != 0 {
@@ -2123,6 +2141,39 @@ func (c *Client) Delete(labels map[string]string) error {
 
 }
 
+// WaitForComponentDeletion waits for component to be deleted
+func (c *Client) WaitForComponentDeletion(selector string) error {
+
+	glog.V(4).Infof("Waiting for component to get deleted")
+
+	watcher, err := c.appsClient.DeploymentConfigs(c.Namespace).Watch(metav1.ListOptions{LabelSelector: selector})
+	if err != nil {
+		return err
+	}
+	defer watcher.Stop()
+	eventCh := watcher.ResultChan()
+
+	for {
+		select {
+		case event, ok := <-eventCh:
+			_, typeOk := event.Object.(*appsv1.DeploymentConfig)
+			if !ok || !typeOk {
+				return errors.New("Unable to watch deployment config")
+			}
+			if event.Type == watch.Deleted {
+				glog.V(4).Infof("WaitForComponentDeletion, Event Recieved:Deleted")
+				return nil
+			} else if event.Type == watch.Error {
+				glog.V(4).Infof("WaitForComponentDeletion, Event Recieved:Deleted ")
+				return errors.New("Unable to watch deployment config")
+			}
+		case <-time.After(waitForComponentDeletionTimeout):
+			glog.V(4).Infof("WaitForComponentDeletion, Timeout")
+			return errors.New("Time out waiting for component to get deleted")
+		}
+	}
+}
+
 // DeleteServiceInstance takes labels as a input and based on it, deletes respective service instance
 func (c *Client) DeleteServiceInstance(labels map[string]string) error {
 	glog.V(4).Infof("Deleting Service Instance")

pkg/odo/cli/application/delete.go

@@ -2,6 +2,7 @@ package application
 
 import (
 	"fmt"
+
 	odoUtil "github.com/openshift/odo/pkg/odo/util"
 
 	"github.com/openshift/odo/pkg/application"

pkg/odo/cli/component/delete.go

@@ -2,9 +2,10 @@ package component
 
 import (
 	"fmt"
+	"path/filepath"
+
 	"github.com/openshift/odo/pkg/envinfo"
 	"github.com/openshift/odo/pkg/odo/util/experimental"
-	"path/filepath"
 
 	"github.com/openshift/odo/pkg/util"
 
@@ -36,6 +37,7 @@ var deleteExample = ktemplates.Examples(`  # Delete component named 'frontend'.
 type DeleteOptions struct {
 	componentForceDeleteFlag bool
 	componentDeleteAllFlag   bool
+	componentDeleteWaitFlag  bool
 	componentContext         string
 	isCmpExists              bool
 	*ComponentOptions
@@ -48,7 +50,7 @@ type DeleteOptions struct {
 
 // NewDeleteOptions returns new instance of DeleteOptions
 func NewDeleteOptions() *DeleteOptions {
-	return &DeleteOptions{false, false, "", false, &ComponentOptions{}, "", "", nil}
+	return &DeleteOptions{false, false, false, "", false, &ComponentOptions{}, "", "", nil}
 }
 
 // Complete completes log args
@@ -171,7 +173,7 @@ func (do *DeleteOptions) Run() (err error) {
 					log.Successf(fmt.Sprintf("Unlinked component %q from component %q for secret %q", parentComponent.Name, component, secretName))
 				}
 			}
-			err = component.Delete(do.Client, do.componentName, do.Application)
+			err = component.Delete(do.Client, do.componentDeleteWaitFlag, do.componentName, do.Application)
 			if err != nil {
 				return err
 			}
@@ -235,6 +237,7 @@ func NewCmdDelete(name, fullName string) *cobra.Command {
 
 	componentDeleteCmd.Flags().BoolVarP(&do.componentForceDeleteFlag, "force", "f", false, "Delete component without prompting")
 	componentDeleteCmd.Flags().BoolVarP(&do.componentDeleteAllFlag, "all", "a", false, "Delete component and local config")
+	componentDeleteCmd.Flags().BoolVarP(&do.componentDeleteWaitFlag, "wait", "w", false, "Wait for complete deletion of component and its dependent")
 
 	componentDeleteCmd.SetUsageTemplate(odoutil.CmdUsageTemplate)
 	completion.RegisterCommandHandler(componentDeleteCmd, completion.ComponentNameCompletionHandler)

tests/helper/helper_oc.go

@@ -481,3 +481,11 @@ func (oc *OcRunner) GetServices(namespace string) string {
 	output := string(session.Wait().Out.Contents())
 	return output
 }
+
+// VerifyResourceDeleted verifies if the given resource is deleted from cluster
+func (oc *OcRunner) VerifyResourceDeleted(resourceType, resourceName, namespace string) {
+	session := CmdRunner(oc.path, "get", resourceType, "--namespace", namespace)
+	Eventually(session).Should(gexec.Exit(0))
+	output := string(session.Wait().Out.Contents())
+	Expect(output).NotTo(ContainSubstring(resourceName))
+}

tests/integration/component.go

@@ -852,13 +852,14 @@ func componentTests(args ...string) {
 		It("should delete the component and the owned resources", func() {
 			helper.CopyExample(filepath.Join("source", "nodejs"), context)
 			helper.CmdShouldPass("odo", append(args, "create", "nodejs", cmpName, "--app", appName, "--project", project, "--context", context)...)
-			helper.CmdShouldPass("odo", "url", "create", "example", "--context", context)
-			helper.CmdShouldPass("odo", "storage", "create", "storage-name", "--size", "1Gi", "--path", "/data", "--context", context)
-			helper.ValidateLocalCmpExist(context, "Type,nodejs", "Name,"+cmpName, "Application,"+appName, "URL,0,Name,example")
+			helper.CmdShouldPass("odo", "url", "create", "example-1", "--context", context)
+
+			helper.CmdShouldPass("odo", "storage", "create", "storage-1", "--size", "1Gi", "--path", "/data1", "--context", context)
+			helper.ValidateLocalCmpExist(context, "Type,nodejs", "Name,"+cmpName, "Application,"+appName, "URL,0,Name,example-1")
 			helper.CmdShouldPass("odo", append(args, "push", "--context", context)...)
 
-			helper.CmdShouldPass("odo", "url", "create", "example-1", "--context", context)
-			helper.CmdShouldPass("odo", "storage", "create", "storage-name-1", "--size", "1Gi", "--path", "/data-1", "--context", context)
+			helper.CmdShouldPass("odo", "url", "create", "example-2", "--context", context)
+			helper.CmdShouldPass("odo", "storage", "create", "storage-2", "--size", "1Gi", "--path", "/data2", "--context", context)
 			helper.CmdShouldPass("odo", append(args, "push", "--context", context)...)
 
 			helper.CmdShouldPass("odo", append(args, "delete", "-f", "--context", context)...)
@@ -870,5 +871,30 @@ func componentTests(args ...string) {
 			oc.WaitAndCheckForExistence("is", project, 1)
 			oc.WaitAndCheckForExistence("service", project, 1)
 		})
+
+		It("should delete the component and the owned resources with wait flag", func() {
+			helper.CopyExample(filepath.Join("source", "nodejs"), context)
+			helper.CmdShouldPass("odo", append(args, "create", "nodejs", cmpName, "--app", appName, "--project", project, "--context", context)...)
+			helper.CmdShouldPass("odo", "url", "create", "example-1", "--context", context)
+
+			helper.CmdShouldPass("odo", "storage", "create", "storage-1", "--size", "1Gi", "--path", "/data1", "--context", context)
+			helper.ValidateLocalCmpExist(context, "Type,nodejs", "Name,"+cmpName, "Application,"+appName, "URL,0,Name,example-1")
+			helper.CmdShouldPass("odo", append(args, "push", "--context", context)...)
+
+			helper.CmdShouldPass("odo", "url", "create", "example-2", "--context", context)
+			helper.CmdShouldPass("odo", "storage", "create", "storage-2", "--size", "1Gi", "--path", "/data2", "--context", context)
+			helper.CmdShouldPass("odo", append(args, "push", "--context", context)...)
+
+			// delete with --wait flag
+			helper.CmdShouldPass("odo", append(args, "delete", "-f", "-w", "--context", context)...)
+
+			oc.VerifyResourceDeleted("routes", "example", project)
+			oc.VerifyResourceDeleted("service", cmpName, project)
+			// verify s2i pvc is delete
+			oc.VerifyResourceDeleted("pvc", "s2idata", project)
+			oc.VerifyResourceDeleted("pvc", "storage-1", project)
+			oc.VerifyResourceDeleted("pvc", "storage-2", project)
+			oc.VerifyResourceDeleted("dc", cmpName, project)
+		})
 	})
 }