Add support for contributions through .spec.contributions field in DevWorkspace

Makefile

@@ -29,7 +29,7 @@ export PROJECT_CLONE_IMG ?= quay.io/devfile/project-clone:next
 export PULL_POLICY ?= Always
 export DEFAULT_ROUTING ?= basic
 export KUBECONFIG ?= ${HOME}/.kube/config
-export DEVWORKSPACE_API_VERSION ?= 32cae1f8e42c22035138ef6ee93080bc47d751c6
+export DEVWORKSPACE_API_VERSION ?= fe7c10eaa530b12b19cfb0e22e221e753391304c
 
 # Enable using Podman instead of Docker
 export DOCKER ?= docker

controllers/workspace/devworkspace_controller.go

@@ -259,7 +259,7 @@ func (r *DevWorkspaceReconciler) Reconcile(ctx context.Context, req ctrl.Request
 		wsDefaults.ApplyDefaultTemplate(workspace)
 	}
 
-	flattenedWorkspace, warnings, err := flatten.ResolveDevWorkspace(&workspace.Spec.Template, flattenHelpers)
+	flattenedWorkspace, warnings, err := flatten.ResolveDevWorkspace(&workspace.Spec.Template, workspace.Spec.Contributions, flattenHelpers)
 	if err != nil {
 		return r.failWorkspace(workspace, fmt.Sprintf("Error processing devfile: %s", err), metrics.ReasonBadRequest, reqLogger, &reconcileStatus)
 	}

deploy/generate-deployment.sh

@@ -115,7 +115,7 @@ if $USE_DEFAULT_ENV; then
   export PROJECT_CLONE_IMG=${PROJECT_CLONE_IMG:-"quay.io/devfile/project-clone:next"}
   export PULL_POLICY=Always
   export DEFAULT_ROUTING=basic
-  export DEVWORKSPACE_API_VERSION=32cae1f8e42c22035138ef6ee93080bc47d751c6
+  export DEVWORKSPACE_API_VERSION=fe7c10eaa530b12b19cfb0e22e221e753391304c
   export ROUTING_SUFFIX='""'
   export FORCE_DEVWORKSPACE_CRDS_UPDATE=true
 fi

go.mod

@@ -3,7 +3,7 @@ module github.com/devfile/devworkspace-operator
 go 1.16
 
 require (
-	github.com/devfile/api/v2 v2.0.0-20220414122024-32cae1f8e42c
+	github.com/devfile/api/v2 v2.0.0-20220928161623-fe7c10eaa530
 	github.com/go-git/go-git/v5 v5.2.0
 	github.com/go-logr/logr v0.4.0
 	github.com/google/go-cmp v0.5.5

go.sum

@@ -106,8 +106,8 @@ github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSs
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/daviddengcn/go-colortext v0.0.0-20160507010035-511bcaf42ccd/go.mod h1:dv4zxwHi5C/8AeI+4gX4dCWOIvNi7I6JCSX0HvlKPgE=
-github.com/devfile/api/v2 v2.0.0-20220414122024-32cae1f8e42c h1:yyidoxal8ngJWDxRuVZMNh4PBwqDIzOkTeOagtmRiy0=
-github.com/devfile/api/v2 v2.0.0-20220414122024-32cae1f8e42c/go.mod h1:kLX/nW93gigOHXK3NLeJL2fSS/sgEe+OHu8bo3aoOi4=
+github.com/devfile/api/v2 v2.0.0-20220928161623-fe7c10eaa530 h1:pZvf4AZrf/ZwV2AwQnTInlUpns+Wj9JYtPRtBDiFHzk=
+github.com/devfile/api/v2 v2.0.0-20220928161623-fe7c10eaa530/go.mod h1:dN7xFrOVG+iPqn4UKGibXLd5oVsdE8XyK9OEb5JL3aI=
 github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
 github.com/dgryski/go-sip13 v0.0.0-20181026042036-e10d5fee7954/go.mod h1:vAd38F8PWV+bWy6jNmig1y/TA+kYO4g3RSRF0IAv0no=
 github.com/docker/distribution v2.7.1+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w=

pkg/library/container/container.go

@@ -44,7 +44,7 @@ import (
 //
 // Note: Requires DevWorkspace to be flattened (i.e. the DevWorkspace contains no Parent or Components of type Plugin)
 func GetKubeContainersFromDevfile(workspace *dw.DevWorkspaceTemplateSpec, pullPolicy string) (*v1alpha1.PodAdditions, error) {
-	if !flatten.DevWorkspaceIsFlattened(workspace) {
+	if !flatten.DevWorkspaceIsFlattened(workspace, nil) {
 		return nil, fmt.Errorf("devfile is not flattened")
 	}
 	podAdditions := &v1alpha1.PodAdditions{}

pkg/library/flatten/common.go

@@ -17,14 +17,24 @@ package flatten
 
 import dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
 
-func DevWorkspaceIsFlattened(devworkspace *dw.DevWorkspaceTemplateSpec) bool {
+func DevWorkspaceIsFlattened(devworkspace *dw.DevWorkspaceTemplateSpec, contributions []dw.ComponentContribution) bool {
+	if devworkspace == nil {
+		return len(contributions) == 0
+	}
+
 	if devworkspace.Parent != nil {
 		return false
 	}
+
+	if len(contributions) > 0 {
+		return false
+	}
+
 	for _, component := range devworkspace.Components {
 		if component.Plugin != nil {
 			return false
 		}
 	}
+
 	return true
 }

pkg/library/flatten/flatten.go

@@ -52,9 +52,9 @@ type ResolverTools struct {
 
 // ResolveDevWorkspace takes a devworkspace and returns a "resolved" version of it -- i.e. one where all plugins and parents
 // are inlined as components.
-func ResolveDevWorkspace(workspace *dw.DevWorkspaceTemplateSpec, tooling ResolverTools) (*dw.DevWorkspaceTemplateSpec, *variables.VariableWarning, error) {
+func ResolveDevWorkspace(workspace *dw.DevWorkspaceTemplateSpec, contributions []dw.ComponentContribution, tooling ResolverTools) (*dw.DevWorkspaceTemplateSpec, *variables.VariableWarning, error) {
 	resolutionCtx := &resolutionContextTree{}
-	resolvedDW, err := recursiveResolve(workspace, tooling, resolutionCtx)
+	resolvedDW, err := recursiveResolve(workspace, contributions, tooling, resolutionCtx)
 	if err != nil {
 		return nil, nil, err
 	}
@@ -75,49 +75,73 @@ func ResolveDevWorkspace(workspace *dw.DevWorkspaceTemplateSpec, tooling Resolve
 	return resolvedDW, nil, nil
 }
 
-func recursiveResolve(workspace *dw.DevWorkspaceTemplateSpec, tooling ResolverTools, resolveCtx *resolutionContextTree) (*dw.DevWorkspaceTemplateSpec, error) {
-	if DevWorkspaceIsFlattened(workspace) {
+func recursiveResolve(workspace *dw.DevWorkspaceTemplateSpec, contributions []dw.ComponentContribution, tooling ResolverTools, resolveCtx *resolutionContextTree) (*dw.DevWorkspaceTemplateSpec, error) {
+	if DevWorkspaceIsFlattened(workspace, contributions) {
 		return workspace.DeepCopy(), nil
 	}
 
-	resolvedParent := &dw.DevWorkspaceTemplateSpecContent{}
-	if workspace.Parent != nil {
-		resolvedParentSpec, err := resolveParentComponent(workspace.Parent, tooling)
+	var pluginSpecContents []*dw.DevWorkspaceTemplateSpecContent
+	for _, contribution := range contributions {
+		pluginComponent, err := resolvePluginComponent(contribution.Name, &contribution.PluginComponent, tooling)
 		if err != nil {
 			return nil, err
 		}
-		if !DevWorkspaceIsFlattened(resolvedParentSpec) {
-			// TODO: implemenent this
-			return nil, fmt.Errorf("parents containing plugins or parents are not supported")
+		newCtx := resolveCtx.addPlugin(contribution.Name, &contribution.PluginComponent)
+		if err := newCtx.hasCycle(); err != nil {
+			return nil, err
+		}
+
+		resolvedPlugin, err := recursiveResolve(pluginComponent, nil, tooling, newCtx)
+		if err != nil {
+			return nil, err
 		}
-		annotate.AddSourceAttributesForTemplate("parent", resolvedParentSpec)
-		resolvedParent = &resolvedParentSpec.DevWorkspaceTemplateSpecContent
+
+		annotate.AddSourceAttributesForTemplate(contribution.Name, resolvedPlugin)
+		pluginSpecContents = append(pluginSpecContents, &resolvedPlugin.DevWorkspaceTemplateSpecContent)
 	}
-	resolvedContent := workspace.DevWorkspaceTemplateSpecContent.DeepCopy()
-	resolvedContent.Components = nil
 
-	var pluginSpecContents []*dw.DevWorkspaceTemplateSpecContent
-	for _, component := range workspace.Components {
-		if component.Plugin == nil {
-			// No action necessary
-			resolvedContent.Components = append(resolvedContent.Components, component)
-		} else {
-			pluginComponent, err := resolvePluginComponent(component.Name, component.Plugin, tooling)
+	resolvedParent := &dw.DevWorkspaceTemplateSpecContent{}
+	resolvedContent := &dw.DevWorkspaceTemplateSpecContent{}
+	if workspace != nil {
+		resolvedContent = workspace.DevWorkspaceTemplateSpecContent.DeepCopy()
+		resolvedContent.Components = nil
+	}
+	if workspace != nil {
+		if workspace.Parent != nil {
+			resolvedParentSpec, err := resolveParentComponent(workspace.Parent, tooling)
 			if err != nil {
 				return nil, err
 			}
-			newCtx := resolveCtx.addPlugin(component.Name, component.Plugin)
-			if err := newCtx.hasCycle(); err != nil {
-				return nil, err
+			if !DevWorkspaceIsFlattened(resolvedParentSpec, nil) {
+				// TODO: implemenent this
+				return nil, fmt.Errorf("parents containing plugins or parents are not supported")
 			}
+			annotate.AddSourceAttributesForTemplate("parent", resolvedParentSpec)
+			resolvedParent = &resolvedParentSpec.DevWorkspaceTemplateSpecContent
+		}
 
-			resolvedPlugin, err := recursiveResolve(pluginComponent, tooling, newCtx)
-			if err != nil {
-				return nil, err
+		for _, component := range workspace.Components {
+			if component.Plugin == nil {
+				// No action necessary
+				resolvedContent.Components = append(resolvedContent.Components, component)
+			} else {
+				pluginComponent, err := resolvePluginComponent(component.Name, component.Plugin, tooling)
+				if err != nil {
+					return nil, err
+				}
+				newCtx := resolveCtx.addPlugin(component.Name, component.Plugin)
+				if err := newCtx.hasCycle(); err != nil {
+					return nil, err
+				}
+
+				resolvedPlugin, err := recursiveResolve(pluginComponent, nil, tooling, newCtx)
+				if err != nil {
+					return nil, err
+				}
+
+				annotate.AddSourceAttributesForTemplate(component.Name, resolvedPlugin)
+				pluginSpecContents = append(pluginSpecContents, &resolvedPlugin.DevWorkspaceTemplateSpecContent)
 			}
-
-			annotate.AddSourceAttributesForTemplate(component.Name, resolvedPlugin)
-			pluginSpecContents = append(pluginSpecContents, &resolvedPlugin.DevWorkspaceTemplateSpecContent)
 		}
 	}
 

pkg/library/flatten/flatten_test.go

@@ -32,7 +32,7 @@ func TestResolveDevWorkspaceKubernetesReference(t *testing.T) {
 			// sanity check: input defines components
 			assert.True(t, len(tt.Input.DevWorkspace.Components) > 0, "Test case defines workspace with no components")
 			testResolverTools := getTestingTools(tt.Input, "test-ignored")
-			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, testResolverTools)
+			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, nil, testResolverTools)
 			if tt.Output.ErrRegexp != nil && assert.Error(t, err) {
 				assert.Regexp(t, *tt.Output.ErrRegexp, err.Error(), "Error message should match")
 			} else {
@@ -55,7 +55,7 @@ func TestResolveDevWorkspacePluginRegistry(t *testing.T) {
 			assert.True(t, len(tt.Input.DevWorkspace.Components) > 0, "Test case defines workspace with no components")
 			testResolverTools := getTestingTools(tt.Input, "test-ignored")
 
-			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, testResolverTools)
+			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, nil, testResolverTools)
 			if tt.Output.ErrRegexp != nil && assert.Error(t, err) {
 				assert.Regexp(t, *tt.Output.ErrRegexp, err.Error(), "Error message should match")
 			} else {
@@ -78,7 +78,7 @@ func TestResolveDevWorkspacePluginURI(t *testing.T) {
 			assert.True(t, len(tt.Input.DevWorkspace.Components) > 0, "Test case defines workspace with no components")
 			testResolverTools := getTestingTools(tt.Input, "test-ignored")
 
-			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, testResolverTools)
+			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, nil, testResolverTools)
 			if tt.Output.ErrRegexp != nil && assert.Error(t, err) {
 				assert.Regexp(t, *tt.Output.ErrRegexp, err.Error(), "Error message should match")
 			} else {
@@ -101,7 +101,7 @@ func TestResolveDevWorkspaceParents(t *testing.T) {
 			assert.True(t, len(tt.Input.DevWorkspace.Components) > 0, "Test case defines workspace with no components")
 			testResolverTools := getTestingTools(tt.Input, "test-ignored")
 
-			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, testResolverTools)
+			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, nil, testResolverTools)
 			if tt.Output.ErrRegexp != nil && assert.Error(t, err) {
 				assert.Regexp(t, *tt.Output.ErrRegexp, err.Error(), "Error message should match")
 			} else {
@@ -127,7 +127,7 @@ func TestResolveDevWorkspaceMissingDefaults(t *testing.T) {
 			assert.True(t, len(tt.Input.DevWorkspace.Components) > 0, "Test case defines workspace with no components")
 			testResolverTools := getTestingTools(tt.Input, "")
 
-			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, testResolverTools)
+			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, nil, testResolverTools)
 			if tt.Output.ErrRegexp != nil && assert.Error(t, err) {
 				assert.Regexp(t, *tt.Output.ErrRegexp, err.Error(), "Error message should match")
 			} else {
@@ -150,7 +150,7 @@ func TestResolveDevWorkspaceAnnotations(t *testing.T) {
 			assert.True(t, len(tt.Input.DevWorkspace.Components) > 0, "Test case defines devworkspace with no components")
 			testResolverTools := getTestingTools(tt.Input, "test-ignored")
 
-			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, testResolverTools)
+			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, nil, testResolverTools)
 			if tt.Output.ErrRegexp != nil && assert.Error(t, err) {
 				assert.Regexp(t, *tt.Output.ErrRegexp, err.Error(), "Error message should match")
 			} else {
@@ -173,7 +173,7 @@ func TestResolveDevWorkspaceTemplateNamespaceRestriction(t *testing.T) {
 			assert.True(t, len(tt.Input.DevWorkspace.Components) > 0, "Test case defines devworkspace with no components")
 			testResolverTools := getTestingTools(tt.Input, "test-namespace")
 
-			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, testResolverTools)
+			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, nil, testResolverTools)
 			if tt.Output.ErrRegexp != nil && assert.Error(t, err) {
 				assert.Regexp(t, *tt.Output.ErrRegexp, err.Error(), "Error message should match")
 			} else {
@@ -196,7 +196,7 @@ func TestMergesDuplicateVolumeComponents(t *testing.T) {
 			assert.True(t, len(tt.Input.DevWorkspace.Components) > 0, "Test case defines workspace with no components")
 			testResolverTools := getTestingTools(tt.Input, "test-ignored")
 
-			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, testResolverTools)
+			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, nil, testResolverTools)
 			if tt.Output.ErrRegexp != nil && assert.Error(t, err) {
 				assert.Regexp(t, *tt.Output.ErrRegexp, err.Error(), "Error message should match")
 			} else {
@@ -219,7 +219,28 @@ func TestMergeContainerContributions(t *testing.T) {
 			assert.True(t, len(tt.Input.DevWorkspace.Components) > 0, "Test case defines workspace with no components")
 			testResolverTools := getTestingTools(tt.Input, "test-ignored")
 
-			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, testResolverTools)
+			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, nil, testResolverTools)
+			if tt.Output.ErrRegexp != nil && assert.Error(t, err) {
+				assert.Regexp(t, *tt.Output.ErrRegexp, err.Error(), "Error message should match")
+			} else {
+				if !assert.NoError(t, err, "Should not return error") {
+					return
+				}
+				assert.Truef(t, cmp.Equal(tt.Output.DevWorkspace, outputWorkspace, testutil.WorkspaceTemplateDiffOpts),
+					"DevWorkspace should match expected output:\n%s",
+					cmp.Diff(tt.Output.DevWorkspace, outputWorkspace, testutil.WorkspaceTemplateDiffOpts))
+			}
+		})
+	}
+}
+
+func TestMergeSpecContributions(t *testing.T) {
+	tests := testutil.LoadAllTestsOrPanic(t, "testdata/spec-contributions")
+	for _, tt := range tests {
+		t.Run(tt.Name, func(t *testing.T) {
+			testResolverTools := getTestingTools(tt.Input, "test-namespace")
+
+			outputWorkspace, _, err := ResolveDevWorkspace(tt.Input.DevWorkspace, tt.Input.Contributions, testResolverTools)
 			if tt.Output.ErrRegexp != nil && assert.Error(t, err) {
 				assert.Regexp(t, *tt.Output.ErrRegexp, err.Error(), "Error message should match")
 			} else {

pkg/library/flatten/internal/testutil/common.go

@@ -54,7 +54,10 @@ type TestCase struct {
 }
 
 type TestInput struct {
+	// DevWorkspace is the .spec.template field of a DevWorkspace
 	DevWorkspace *dw.DevWorkspaceTemplateSpec `json:"devworkspace,omitempty"`
+	// Contributions is the .spec.containerContributions field of a DevWorkspace
+	Contributions []dw.ComponentContribution `json:"contributions,omitempty"`
 	// DevWorkspaceResources is a map of string keys to devworkspace templates
 	DevWorkspaceResources map[string]dw.DevWorkspaceTemplate `json:"devworkspaceResources,omitempty"`
 	// DevfileResources is a map of string keys to devfile resources

pkg/library/flatten/testdata/spec-contributions/adds-resources.yaml

@@ -0,0 +1,46 @@
+name: "Adds attributes from contribution"
+
+input:
+  devworkspace:
+    components:
+      - name: test-component
+        attributes:
+          controller.devfile.io/merge-contribution: true
+        container:
+          image: test-image
+          memoryLimit: 1Gi
+          memoryRequest: 1000Mi
+          cpuLimit: 1500m
+          cpuRequest: "1"
+  contributions:
+    - name: test-contribution
+      uri: test-contribution.yaml
+
+  devfileResources:
+    test-contribution.yaml:
+      schemaVersion: 2.1.0
+      metadata:
+        name: test-contribution
+      components:
+      - name: test-contribution
+        attributes:
+          controller.devfile.io/container-contribution: true
+        container:
+          image: contribution-image
+          memoryLimit: 512Mi
+          memoryRequest: 1.5G
+          cpuLimit: "0.5"
+          cpuRequest: 500m
+
+output:
+  devworkspace:
+    components:
+      - name: test-component
+        attributes:
+          controller.devfile.io/merged-contributions: "test-contribution"
+        container:
+          image: test-image
+          memoryLimit: 1536Mi
+          memoryRequest: "2548576000" # 1.5G + 1000Mi = 1.5*1000^3 + 1000*1024^2
+          cpuLimit: "2"
+          cpuRequest: 1500m