Dockerfile Outerloop Support (#580)

* Add Image Comp, add Deploy Cmd Kind & handle conversion to v1alpha1

Signed-off-by: Maysun J Faisal <[email protected]>

* Move GitLocation into Git project source

Moves GitLocation in DockerfileImage Image component type under the Git
struct to make clear that this field is intended only for use when
specifying a git repo.

(Files not regenerated for readability)

Signed-off-by: Angel Misevski <[email protected]>

* Address PR reviews, update src

Signed-off-by: Maysun J Faisal <[email protected]>

* Add variable subs for image component

Signed-off-by: Maysun J Faisal <[email protected]>

* Add more tests for the new image component

Signed-off-by: Maysun J Faisal <[email protected]>

* Apply Outerloop PR feedback

Signed-off-by: Maysun J Faisal <[email protected]>

* Review feedback: Update var name, nesting and test coverage

Signed-off-by: Maysun J Faisal <[email protected]>

Co-authored-by: Angel Misevski <[email protected]>

Author: maysunfaisal

crds/workspace.devfile.io_devworkspaces.v1beta1.yaml

@@ -40,8 +40,36 @@ func convertCommandTo_v1alpha2(src *Command, dest *v1alpha2.Command) error {
 	return nil
 }
 
+// getGroup returns the group the command belongs to
+func getGroup(dc v1alpha2.Command) *v1alpha2.CommandGroup {
+	switch {
+	case dc.Composite != nil:
+		return dc.Composite.Group
+	case dc.Exec != nil:
+		return dc.Exec.Group
+	case dc.Apply != nil:
+		return dc.Apply.Group
+	case dc.Custom != nil:
+		return dc.Custom.Group
+
+	default:
+		return nil
+	}
+}
+
 func convertCommandFrom_v1alpha2(src *v1alpha2.Command, dest *Command) error {
+	if src == nil {
+		return nil
+	}
+
 	id := src.Key()
+
+	srcCmdGroup := getGroup(*src)
+	if srcCmdGroup != nil && srcCmdGroup.Kind == v1alpha2.DeployCommandGroupKind {
+		// skip converting deploy kind commands as deploy kind commands are not supported in v1alpha1
+		return nil
+	}
+
 	jsonCommand, err := json.Marshal(src)
 	if err != nil {
 		return err

crds/workspace.devfile.io_devworkspaces.yaml

@@ -33,3 +33,30 @@ func TestCommandConversion_v1alpha1(t *testing.T) {
 		}
 	}
 }
+
+func TestCommandConversionFrom_v1alpha2(t *testing.T) {
+
+	src := &v1alpha2.Command{
+		Id: "test1",
+		CommandUnion: v1alpha2.CommandUnion{
+			Exec: &v1alpha2.ExecCommand{
+				LabeledCommand: v1alpha2.LabeledCommand{
+					BaseCommand: v1alpha2.BaseCommand{
+						Group: &v1alpha2.CommandGroup{
+							Kind: v1alpha2.DeployCommandGroupKind,
+						},
+					},
+				},
+			},
+		},
+	}
+
+	output := &Command{}
+
+	err := convertCommandFrom_v1alpha2(src, output)
+	if !assert.NoError(t, err, "Should not return error when converting from v1alpha2") {
+		return
+	}
+
+	assert.Equal(t, &Command{}, output, "Conversion from v1alpha2 should be skipped for deploy kind command")
+}

crds/workspace.devfile.io_devworkspacetemplates.v1beta1.yaml

@@ -31,6 +31,9 @@ func convertComponentFrom_v1alpha2(src *v1alpha2.Component, dest *Component) err
 	if src.Plugin != nil {
 		// Need to handle plugin components separately.
 		return convertPluginComponentFrom_v1alpha2(src, dest)
+	} else if src.Image != nil {
+		// Skip converting an Image component since v1alpha1 does not have an Image component
+		return nil
 	}
 	name := src.Key()
 	jsonComponent, err := json.Marshal(src)

crds/workspace.devfile.io_devworkspacetemplates.yaml

@@ -36,3 +36,25 @@ func TestComponentConversion_v1alpha1(t *testing.T) {
 		}
 	}
 }
+
+func TestComponentConversionFrom_v1alpha2(t *testing.T) {
+
+	src := &v1alpha2.Component{
+		Name: "test1",
+		ComponentUnion: v1alpha2.ComponentUnion{
+			Image: &v1alpha2.ImageComponent{
+				Image: v1alpha2.Image{
+					ImageName: "image:latest",
+				},
+			},
+		},
+	}
+	output := &Component{}
+
+	err := convertComponentFrom_v1alpha2(src, output)
+	if !assert.NoError(t, err, "Should not return error when converting from v1alpha2") {
+		return
+	}
+
+	assert.Equal(t, &Component{}, output, "Conversion from v1alpha2 should be skipped for Image Component")
+}

pkg/apis/workspaces/v1alpha1/commands_conversion.go

@@ -18,14 +18,15 @@ const (
 )
 
 // CommandGroupKind describes the kind of command group.
-// +kubebuilder:validation:Enum=build;run;test;debug
+// +kubebuilder:validation:Enum=build;run;test;debug;deploy
 type CommandGroupKind string
 
 const (
-	BuildCommandGroupKind CommandGroupKind = "build"
-	RunCommandGroupKind   CommandGroupKind = "run"
-	TestCommandGroupKind  CommandGroupKind = "test"
-	DebugCommandGroupKind CommandGroupKind = "debug"
+	BuildCommandGroupKind  CommandGroupKind = "build"
+	RunCommandGroupKind    CommandGroupKind = "run"
+	TestCommandGroupKind   CommandGroupKind = "test"
+	DebugCommandGroupKind  CommandGroupKind = "debug"
+	DeployCommandGroupKind CommandGroupKind = "deploy"
 )
 
 type CommandGroup struct {

pkg/apis/workspaces/v1alpha1/commands_conversion_test.go

@@ -0,0 +1,38 @@
+package v1alpha2
+
+// ImageType describes the type of image.
+// Only one of the following image type may be specified.
+// +kubebuilder:validation:Enum=Dockerfile
+type ImageType string
+
+const (
+	DockerfileImageType ImageType = "Dockerfile"
+)
+
+type BaseImage struct {
+}
+
+// Component that allows the developer to build a runtime image for outerloop
+type ImageComponent struct {
+	BaseComponent `json:",inline"`
+	Image         `json:",inline"`
+}
+
+type Image struct {
+	// Name of the image for the resulting outerloop build
+	ImageName  string `json:"imageName"`
+	ImageUnion `json:",inline"`
+}
+
+// +union
+type ImageUnion struct {
+	// Type of image
+	//
+	// +unionDiscriminator
+	// +optional
+	ImageType ImageType `json:"imageType,omitempty"`
+
+	// Allows specifying dockerfile type build
+	// +optional
+	Dockerfile *DockerfileImage `json:"dockerfile,omitempty"`
+}