feat: CDK v1 delete (#1402)

Author: jon-stewart

cli/cmd/component.go

@@ -32,7 +32,9 @@ import (
 	"github.com/lacework/go-sdk/lwcomponent"
 )
 
-const componentTypeAnnotation string = "component"
+const (
+	componentTypeAnnotation string = "component"
+)
 
 var (
 	// componentsCmd represents the components command
@@ -467,6 +469,44 @@ func runComponentsDelete(_ *cobra.Command, args []string) (err error) {
 }
 
 func deleteComponent(args []string) (err error) {
+	var (
+		componentName string = args[0]
+	)
+
+	cli.StartProgress("Loading components Catalog...")
+
+	catalog, err := lwcomponent.NewCatalog(cli.LwApi, lwcomponent.NewStageTarGz)
+	defer catalog.Cache()
+
+	cli.StopProgress()
+	if err != nil {
+		return errors.Wrap(err, "unable to load component Catalog")
+	}
+
+	component, err := catalog.GetComponent(componentName)
+	if err != nil {
+		return err
+	}
+
+	// @jon-stewart: TODO: component life cycle: cleanup
+
+	cli.StartProgress("Deleting component...")
+	defer cli.StopProgress()
+
+	err = catalog.Delete(component)
+	if err != nil {
+		return
+	}
+
+	cli.StopProgress()
+
+	cli.OutputChecklist(successIcon, "Component %s deleted\n", color.HiYellowString(component.Name))
+
+	msg := fmt.Sprintf(`\n- We will do better next time.\n\nDo you want to provide feedback?\nReach out to us at %s\n`,
+		color.HiCyanString("[email protected]"))
+
+	cli.OutputHuman(msg)
+
 	return
 }
 

lwcomponent/catalog.go

@@ -200,6 +200,26 @@ func (c *Catalog) Install(component *CDKComponent) (err error) {
 	return component.stage.Commit(componentDir)
 }
 
+// Delete a CDKComponent
+//
+// Remove the Component install directory and all sub-directory.  This function will not return an
+// error if the Component is not installed.
+func (c *Catalog) Delete(component *CDKComponent) (err error) {
+	componentDir, err := componentDirectory(component.Name)
+	if err != nil {
+		return
+	}
+
+	_, err = os.Stat(componentDir)
+	if err != nil {
+		return errors.Errorf("component not installed. Try running 'lacework component install %s'", component.Name)
+	}
+
+	os.RemoveAll(componentDir)
+
+	return
+}
+
 func NewCatalog(client *api.Client, stageConstructor StageConstructor) (*Catalog, error) {
 	if stageConstructor == nil {
 		return nil, errors.New("nil Catalog StageConstructor")

lwcomponent/catalog_test.go

@@ -610,6 +610,113 @@ func TestCatalogInstall(t *testing.T) {
 	})
 }
 
+func TestCatalogDelete(t *testing.T) {
+	var (
+		apiComponentCount int    = 4
+		prefix            string = "staging"
+		version           string = "1.0.0"
+	)
+
+	fakeServer := lacework.MockServer()
+	defer fakeServer.Close()
+
+	_, home := FakeHome()
+	defer ResetHome(home)
+
+	fakeServer.MockAPI("Components", func(w http.ResponseWriter, r *http.Request) {
+		assert.Equal(t, "GET", r.Method, "Components API only accepts HTTP GET")
+		fmt.Fprint(w, generateComponentsResponse(prefix, apiComponentCount))
+	})
+
+	client, _ := api.NewClient("catalog_test",
+		api.WithToken("TOKEN"),
+		api.WithURL(fakeServer.URL()))
+
+	t.Run("delete-installed", func(t *testing.T) {
+		name := fmt.Sprintf("%s-1", prefix)
+
+		CreateLocalComponent(name, version, false)
+
+		catalog, err := lwcomponent.NewCatalog(client, newTestStage)
+		assert.NotNil(t, catalog)
+		assert.Nil(t, err)
+
+		component, err := catalog.GetComponent(name)
+		assert.NotNil(t, component)
+		assert.Nil(t, err)
+
+		err = catalog.Delete(component)
+		assert.Nil(t, err)
+
+		dir, _ := lwcomponent.CatalogCacheDir()
+		dir = filepath.Join(dir, name)
+
+		_, err = os.Stat(dir)
+		assert.NotNil(t, err)
+		assert.True(t, os.IsNotExist(err))
+	})
+
+	t.Run("delete-development", func(t *testing.T) {
+		name := "delete-dev"
+
+		CreateLocalComponent(name, version, true)
+
+		catalog, err := lwcomponent.NewCatalog(client, newTestStage)
+		assert.NotNil(t, catalog)
+		assert.Nil(t, err)
+
+		component, err := catalog.GetComponent(name)
+		assert.NotNil(t, component)
+		assert.Nil(t, err)
+
+		err = catalog.Delete(component)
+		assert.Nil(t, err)
+
+		dir, _ := lwcomponent.CatalogCacheDir()
+		dir = filepath.Join(dir, name)
+
+		_, err = os.Stat(dir)
+		assert.NotNil(t, err)
+		assert.True(t, os.IsNotExist(err))
+	})
+
+	t.Run("delete-not-installed", func(t *testing.T) {
+		name := fmt.Sprintf("%s-1", prefix)
+
+		catalog, err := lwcomponent.NewCatalog(client, newTestStage)
+		assert.NotNil(t, catalog)
+		assert.Nil(t, err)
+
+		component, err := catalog.GetComponent(name)
+		assert.NotNil(t, component)
+		assert.Nil(t, err)
+
+		err = catalog.Delete(component)
+		assert.NotNil(t, err)
+	})
+
+	t.Run("delete-twice", func(t *testing.T) {
+		name := fmt.Sprintf("%s-2", prefix)
+
+		CreateLocalComponent(name, version, false)
+
+		catalog, err := lwcomponent.NewCatalog(client, newTestStage)
+		assert.NotNil(t, catalog)
+		assert.Nil(t, err)
+
+		component, err := catalog.GetComponent(name)
+		assert.NotNil(t, component)
+		assert.Nil(t, err)
+
+		err = catalog.Delete(component)
+		assert.Nil(t, err)
+
+		err = catalog.Delete(component)
+		assert.NotNil(t, err)
+	})
+
+}
+
 func generateComponentsResponse(prefix string, count int) string {
 	var (
 		components = []api.LatestComponentVersion{}