Merge pull request #65 from maysunfaisal/357-1

Add Delete Comp, Command, Proj, StarterProj

go.mod

@@ -15,7 +15,7 @@ require (
 	github.com/openshift/api v0.0.0-20200930075302-db52bc4ef99f
 	github.com/pkg/errors v0.9.1
 	github.com/spf13/afero v1.2.2
-	github.com/stretchr/testify v1.6.1 // indirect
+	github.com/stretchr/testify v1.6.1
 	github.com/xeipuuv/gojsonschema v1.2.0
 	k8s.io/api v0.19.0
 	k8s.io/apimachinery v0.19.0

go.sum

@@ -494,6 +494,7 @@ gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU=
 gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gotest.tools v2.2.0+incompatible h1:VsBPFP1AI068pPrMxtb/S8Zkgf9xEmTLJjfM+P5UIEo=
 gotest.tools v2.2.0+incompatible/go.mod h1:DsYFclhRJ6vuDpmuTbkuFWG+y2sxOXAzmJt81HFBacw=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190106161140-3f1c8253044a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=

pkg/devfile/parser/data/interface.go

@@ -26,26 +26,30 @@ type DevfileData interface {
 	GetComponents(common.DevfileOptions) ([]v1.Component, error)
 	AddComponents(components []v1.Component) error
 	UpdateComponent(component v1.Component)
+	DeleteComponent(name string) error
 
 	// project related methods
 	GetProjects(common.DevfileOptions) ([]v1.Project, error)
 	AddProjects(projects []v1.Project) error
 	UpdateProject(project v1.Project)
+	DeleteProject(name string) error
 
 	// starter projects related commands
 	GetStarterProjects(common.DevfileOptions) ([]v1.StarterProject, error)
 	AddStarterProjects(projects []v1.StarterProject) error
 	UpdateStarterProject(project v1.StarterProject)
+	DeleteStarterProject(name string) error
 
 	// command related methods
 	GetCommands(common.DevfileOptions) ([]v1.Command, error)
-	AddCommands(commands ...v1.Command) error
+	AddCommands(commands []v1.Command) error
 	UpdateCommand(command v1.Command)
+	DeleteCommand(id string) error
 
-	// volume related methods
-	AddVolume(volume v1.Component, path string) error
-	DeleteVolume(name string) error
-	GetVolumeMountPath(name string) (string, error)
+	// volume mount related methods
+	AddVolumeMounts(componentName string, volumeMounts []v1.VolumeMount) error
+	DeleteVolumeMount(name string) error
+	GetVolumeMountPath(mountName, componentName string) (string, error)
 
 	// workspace related methods
 	GetDevfileWorkspace() *v1.DevWorkspaceTemplateSpecContent

pkg/devfile/parser/data/v2/commands.go

@@ -31,14 +31,10 @@ func (d *DevfileV2) GetCommands(options common.DevfileOptions) ([]v1.Command, er
 
 // AddCommands adds the slice of Command objects to the Devfile's commands
 // if a command is already defined, error out
-func (d *DevfileV2) AddCommands(commands ...v1.Command) error {
-	devfileCommands, err := d.GetCommands(common.DevfileOptions{})
-	if err != nil {
-		return err
-	}
+func (d *DevfileV2) AddCommands(commands []v1.Command) error {
 
 	for _, command := range commands {
-		for _, devfileCommand := range devfileCommands {
+		for _, devfileCommand := range d.Commands {
 			if command.Id == devfileCommand.Id {
 				return &common.FieldAlreadyExistError{Name: command.Id, Field: "command"}
 			}
@@ -57,3 +53,19 @@ func (d *DevfileV2) UpdateCommand(command v1.Command) {
 		}
 	}
 }
+
+// DeleteCommand removes the specified command
+func (d *DevfileV2) DeleteCommand(id string) error {
+
+	for i := range d.Commands {
+		if d.Commands[i].Id == id {
+			d.Commands = append(d.Commands[:i], d.Commands[i+1:]...)
+			return nil
+		}
+	}
+
+	return &common.FieldNotFoundError{
+		Field: "command",
+		Name:  id,
+	}
+}

pkg/devfile/parser/data/v2/commands_test.go

@@ -7,6 +7,7 @@ import (
 	v1 "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
 	"github.com/devfile/api/v2/pkg/attributes"
 	"github.com/devfile/library/pkg/devfile/parser/data/v2/common"
+	"github.com/stretchr/testify/assert"
 )
 
 func TestDevfile200_GetCommands(t *testing.T) {
@@ -216,7 +217,7 @@ func TestDevfile200_AddCommands(t *testing.T) {
 				},
 			}
 
-			got := d.AddCommands(tt.newCommands...)
+			got := d.AddCommands(tt.newCommands)
 			if !tt.wantErr && got != nil {
 				t.Errorf("TestDevfile200_AddCommands() unexpected error - %v", got)
 			} else if tt.wantErr && got == nil {
@@ -300,3 +301,83 @@ func TestDevfile200_UpdateCommands(t *testing.T) {
 		})
 	}
 }
+
+func TestDeleteCommands(t *testing.T) {
+
+	d := &DevfileV2{
+		v1.Devfile{
+			DevWorkspaceTemplateSpec: v1.DevWorkspaceTemplateSpec{
+				DevWorkspaceTemplateSpecContent: v1.DevWorkspaceTemplateSpecContent{
+					Commands: []v1.Command{
+						{
+							Id: "command1",
+							CommandUnion: v1.CommandUnion{
+								Exec: &v1.ExecCommand{},
+							},
+						},
+						{
+							Id: "command2",
+							CommandUnion: v1.CommandUnion{
+								Exec: &v1.ExecCommand{},
+							},
+						},
+						{
+							Id: "command3",
+							CommandUnion: v1.CommandUnion{
+								Composite: &v1.CompositeCommand{
+									Commands: []string{"command1", "command2", "command1"},
+								},
+							},
+						},
+					},
+				},
+			},
+		},
+	}
+
+	tests := []struct {
+		name            string
+		commandToDelete string
+		wantCommands    []v1.Command
+		wantErr         bool
+	}{
+		{
+			name:            "Successfully delete command",
+			commandToDelete: "command1",
+			wantCommands: []v1.Command{
+				{
+					Id: "command2",
+					CommandUnion: v1.CommandUnion{
+						Exec: &v1.ExecCommand{},
+					},
+				},
+				{
+					Id: "command3",
+					CommandUnion: v1.CommandUnion{
+						Composite: &v1.CompositeCommand{
+							Commands: []string{"command1", "command2", "command1"},
+						},
+					},
+				},
+			},
+			wantErr: false,
+		},
+		{
+			name:            "Missing Command",
+			commandToDelete: "command34",
+			wantErr:         true,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			err := d.DeleteCommand(tt.commandToDelete)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("DeleteCommand() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			} else if err == nil {
+				assert.Equal(t, tt.wantCommands, d.Commands, "The two values should be the same.")
+			}
+		})
+	}
+
+}

pkg/devfile/parser/data/v2/components.go

@@ -60,17 +60,13 @@ func (d *DevfileV2) GetDevfileVolumeComponents(options common.DevfileOptions) ([
 // if a component is already defined, error out
 func (d *DevfileV2) AddComponents(components []v1.Component) error {
 
-	componentMap := make(map[string]bool)
-
-	for _, component := range d.Components {
-		componentMap[component.Name] = true
-	}
 	for _, component := range components {
-		if _, ok := componentMap[component.Name]; !ok {
-			d.Components = append(d.Components, component)
-		} else {
-			return &common.FieldAlreadyExistError{Name: component.Name, Field: "component"}
+		for _, devfileComponent := range d.Components {
+			if component.Name == devfileComponent.Name {
+				return &common.FieldAlreadyExistError{Name: component.Name, Field: "component"}
+			}
 		}
+		d.Components = append(d.Components, component)
 	}
 	return nil
 }
@@ -88,3 +84,19 @@ func (d *DevfileV2) UpdateComponent(component v1.Component) {
 		d.Components[index] = component
 	}
 }
+
+// DeleteComponent removes the specified component
+func (d *DevfileV2) DeleteComponent(name string) error {
+
+	for i := range d.Components {
+		if d.Components[i].Name == name {
+			d.Components = append(d.Components[:i], d.Components[i+1:]...)
+			return nil
+		}
+	}
+
+	return &common.FieldNotFoundError{
+		Field: "component",
+		Name:  name,
+	}
+}

pkg/devfile/parser/data/v2/components_test.go

@@ -8,6 +8,7 @@ import (
 	"github.com/devfile/api/v2/pkg/attributes"
 	"github.com/devfile/library/pkg/devfile/parser/data/v2/common"
 	"github.com/devfile/library/pkg/testingutil"
+	"github.com/stretchr/testify/assert"
 )
 
 func TestDevfile200_AddComponent(t *testing.T) {
@@ -403,3 +404,94 @@ func TestGetDevfileVolumeComponents(t *testing.T) {
 	}
 
 }
+
+func TestDeleteComponents(t *testing.T) {
+
+	d := &DevfileV2{
+		v1.Devfile{
+			DevWorkspaceTemplateSpec: v1.DevWorkspaceTemplateSpec{
+				DevWorkspaceTemplateSpecContent: v1.DevWorkspaceTemplateSpecContent{
+					Components: []v1.Component{
+						{
+							Name: "comp2",
+							ComponentUnion: v1.ComponentUnion{
+								Container: &v1.ContainerComponent{
+									Container: v1.Container{
+										VolumeMounts: []v1.VolumeMount{
+											testingutil.GetFakeVolumeMount("comp2", "/path"),
+											testingutil.GetFakeVolumeMount("comp2", "/path2"),
+											testingutil.GetFakeVolumeMount("comp3", "/path"),
+										},
+									},
+								},
+							},
+						},
+						{
+							Name: "comp2",
+							ComponentUnion: v1.ComponentUnion{
+								Volume: &v1.VolumeComponent{},
+							},
+						},
+						{
+							Name: "comp3",
+							ComponentUnion: v1.ComponentUnion{
+								Volume: &v1.VolumeComponent{},
+							},
+						},
+					},
+				},
+			},
+		},
+	}
+
+	tests := []struct {
+		name              string
+		componentToDelete string
+		wantComponents    []v1.Component
+		wantErr           bool
+	}{
+		{
+			name:              "Successfully delete a Component",
+			componentToDelete: "comp3",
+			wantComponents: []v1.Component{
+				{
+					Name: "comp2",
+					ComponentUnion: v1.ComponentUnion{
+						Container: &v1.ContainerComponent{
+							Container: v1.Container{
+								VolumeMounts: []v1.VolumeMount{
+									testingutil.GetFakeVolumeMount("comp2", "/path"),
+									testingutil.GetFakeVolumeMount("comp2", "/path2"),
+									testingutil.GetFakeVolumeMount("comp3", "/path"),
+								},
+							},
+						},
+					},
+				},
+				{
+					Name: "comp2",
+					ComponentUnion: v1.ComponentUnion{
+						Volume: &v1.VolumeComponent{},
+					},
+				},
+			},
+			wantErr: false,
+		},
+		{
+			name:              "Missing Component",
+			componentToDelete: "comp12",
+			wantErr:           true,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			err := d.DeleteComponent(tt.componentToDelete)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("DeleteComponent() error = %v, wantErr %v", err, tt.wantErr)
+			} else if err == nil {
+				assert.Equal(t, tt.wantComponents, d.Components, "The two values should be the same.")
+			}
+		})
+	}
+
+}

pkg/devfile/parser/data/v2/events.go

@@ -16,6 +16,11 @@ func (d *DevfileV2) GetEvents() v1.Events {
 // AddEvents adds the Events Object to the devfile's events
 // if the event is already defined in the devfile, error out
 func (d *DevfileV2) AddEvents(events v1.Events) error {
+
+	if d.Events == nil {
+		d.Events = &v1.Events{}
+	}
+
 	if len(events.PreStop) > 0 {
 		if len(d.Events.PreStop) > 0 {
 			return &common.FieldAlreadyExistError{Field: "pre stop"}
@@ -50,16 +55,21 @@ func (d *DevfileV2) AddEvents(events v1.Events) error {
 // UpdateEvents updates the devfile's events
 // it only updates the events passed to it
 func (d *DevfileV2) UpdateEvents(postStart, postStop, preStart, preStop []string) {
-	if len(postStart) != 0 {
+
+	if d.Events == nil {
+		d.Events = &v1.Events{}
+	}
+
+	if postStart != nil {
 		d.Events.PostStart = postStart
 	}
-	if len(postStop) != 0 {
+	if postStop != nil {
 		d.Events.PostStop = postStop
 	}
-	if len(preStart) != 0 {
+	if preStart != nil {
 		d.Events.PreStart = preStart
 	}
-	if len(preStop) != 0 {
+	if preStop != nil {
 		d.Events.PreStop = preStop
 	}
 }