Address global attribute PR feedback

Signed-off-by: Maysun J Faisal <maysunaneek@gmail.com>

crds/workspace.devfile.io_devworkspaces.v1beta1.yaml

@@ -4141,15 +4141,17 @@ spec:
                   of a workspace template.
                 properties:
                   attributes:
+                    additionalProperties:
+                      type: string
                     description: Map of implementation-dependant free-form YAML attributes.
                       Attribute values can be referenced throughout the devfile in
                       string type fields in the form {{attribute-key}} except for
-                      schemaVersion, metadata and events. Exception to the string
-                      field include element's key identifiers(command id, component
-                      name, endpoint name, project name, etc.) and string enums(command
-                      group kind, endpoint exposure, etc.)
+                      schemaVersion, metadata, parent source. Exception to the string
+                      field also include element's key identifiers (command id, component
+                      name, endpoint name, project name, etc.) and their references(events,
+                      command's component, container's volume mount name, etc.) and
+                      string enums(command group kind, endpoint exposure, etc.)
                     type: object
-                    x-kubernetes-preserve-unknown-fields: true
                   commands:
                     description: Predefined, ready-to-use, workspace-related commands
                     items:
@@ -5572,11 +5574,12 @@ spec:
                       - kubernetes
                     properties:
                       attributes:
+                        additionalProperties:
+                          type: string
                         description: Overrides of attributes encapsulated in a parent
                           devfile. Overriding is done according to K8S strategic merge
                           patch standard rules.
                         type: object
-                        x-kubernetes-preserve-unknown-fields: true
                       commands:
                         description: Overrides of commands encapsulated in a parent
                           devfile or a plugin. Overriding is done according to K8S

crds/workspace.devfile.io_devworkspaces.yaml

@@ -4139,15 +4139,17 @@ spec:
                   of a workspace template.
                 properties:
                   attributes:
+                    additionalProperties:
+                      type: string
                     description: Map of implementation-dependant free-form YAML attributes.
                       Attribute values can be referenced throughout the devfile in
                       string type fields in the form {{attribute-key}} except for
-                      schemaVersion, metadata and events. Exception to the string
-                      field include element's key identifiers(command id, component
-                      name, endpoint name, project name, etc.) and string enums(command
-                      group kind, endpoint exposure, etc.)
+                      schemaVersion, metadata, parent source. Exception to the string
+                      field also include element's key identifiers (command id, component
+                      name, endpoint name, project name, etc.) and their references(events,
+                      command's component, container's volume mount name, etc.) and
+                      string enums(command group kind, endpoint exposure, etc.)
                     type: object
-                    x-kubernetes-preserve-unknown-fields: true
                   commands:
                     description: Predefined, ready-to-use, workspace-related commands
                     items:
@@ -5577,11 +5579,12 @@ spec:
                       - kubernetes
                     properties:
                       attributes:
+                        additionalProperties:
+                          type: string
                         description: Overrides of attributes encapsulated in a parent
                           devfile. Overriding is done according to K8S strategic merge
                           patch standard rules.
                         type: object
-                        x-kubernetes-preserve-unknown-fields: true
                       commands:
                         description: Overrides of commands encapsulated in a parent
                           devfile or a plugin. Overriding is done according to K8S

crds/workspace.devfile.io_devworkspacetemplates.v1beta1.yaml

@@ -3915,15 +3915,17 @@ spec:
               of a workspace template.
             properties:
               attributes:
+                additionalProperties:
+                  type: string
                 description: Map of implementation-dependant free-form YAML attributes.
                   Attribute values can be referenced throughout the devfile in string
                   type fields in the form {{attribute-key}} except for schemaVersion,
-                  metadata and events. Exception to the string field include element's
-                  key identifiers(command id, component name, endpoint name, project
-                  name, etc.) and string enums(command group kind, endpoint exposure,
-                  etc.)
+                  metadata, parent source. Exception to the string field also include
+                  element's key identifiers (command id, component name, endpoint
+                  name, project name, etc.) and their references(events, command's
+                  component, container's volume mount name, etc.) and string enums(command
+                  group kind, endpoint exposure, etc.)
                 type: object
-                x-kubernetes-preserve-unknown-fields: true
               commands:
                 description: Predefined, ready-to-use, workspace-related commands
                 items:
@@ -5294,11 +5296,12 @@ spec:
                   - kubernetes
                 properties:
                   attributes:
+                    additionalProperties:
+                      type: string
                     description: Overrides of attributes encapsulated in a parent
                       devfile. Overriding is done according to K8S strategic merge
                       patch standard rules.
                     type: object
-                    x-kubernetes-preserve-unknown-fields: true
                   commands:
                     description: Overrides of commands encapsulated in a parent devfile
                       or a plugin. Overriding is done according to K8S strategic merge

crds/workspace.devfile.io_devworkspacetemplates.yaml

@@ -3913,15 +3913,17 @@ spec:
               of a workspace template.
             properties:
               attributes:
+                additionalProperties:
+                  type: string
                 description: Map of implementation-dependant free-form YAML attributes.
                   Attribute values can be referenced throughout the devfile in string
                   type fields in the form {{attribute-key}} except for schemaVersion,
-                  metadata and events. Exception to the string field include element's
-                  key identifiers(command id, component name, endpoint name, project
-                  name, etc.) and string enums(command group kind, endpoint exposure,
-                  etc.)
+                  metadata, parent source. Exception to the string field also include
+                  element's key identifiers (command id, component name, endpoint
+                  name, project name, etc.) and their references(events, command's
+                  component, container's volume mount name, etc.) and string enums(command
+                  group kind, endpoint exposure, etc.)
                 type: object
-                x-kubernetes-preserve-unknown-fields: true
               commands:
                 description: Predefined, ready-to-use, workspace-related commands
                 items:
@@ -5299,11 +5301,12 @@ spec:
                   - kubernetes
                 properties:
                   attributes:
+                    additionalProperties:
+                      type: string
                     description: Overrides of attributes encapsulated in a parent
                       devfile. Overriding is done according to K8S strategic merge
                       patch standard rules.
                     type: object
-                    x-kubernetes-preserve-unknown-fields: true
                   commands:
                     description: Overrides of commands encapsulated in a parent devfile
                       or a plugin. Overriding is done according to K8S strategic merge

pkg/apis/workspaces/v1alpha2/devworkspaceTemplateSpec.go

@@ -1,7 +1,5 @@
 package v1alpha2
 
-import attributes "github.com/devfile/api/v2/pkg/attributes"
-
 // Structure of the workspace. This is also the specification of a workspace template.
 // +devfile:jsonschema:generate
 type DevWorkspaceTemplateSpec struct {
@@ -16,12 +14,13 @@ type DevWorkspaceTemplateSpec struct {
 type DevWorkspaceTemplateSpecContent struct {
 	// Map of implementation-dependant free-form YAML attributes.
 	// Attribute values can be referenced throughout the devfile in string type fields in the form {{attribute-key}}
-	// except for schemaVersion, metadata and events. Exception to the string field include element's key identifiers(command id,
-	// component name, endpoint name, project name, etc.) and string enums(command group kind, endpoint exposure, etc.)
+	// except for schemaVersion, metadata, parent source. Exception to the string field also include element's key identifiers
+	// (command id, component name, endpoint name, project name, etc.) and their references(events, command's component, container's
+	// volume mount name, etc.) and string enums(command group kind, endpoint exposure, etc.)
 	// +optional
 	// +patchStrategy=merge
 	// +devfile:overrides:include:omitInPlugin=true,description=Overrides of attributes encapsulated in a parent devfile.
-	Attributes attributes.Attributes `json:"attributes,omitempty" patchStrategy:"merge"`
+	Attributes map[string]string `json:"attributes,omitempty" patchStrategy:"merge"`
 
 	// List of the workspace components, such as editor and plugins,
 	// user-provided containers, or other types of components

pkg/utils/overriding/keys.go

@@ -5,7 +5,6 @@ import (
 	"reflect"
 
 	workspaces "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
-	attributesPkg "github.com/devfile/api/v2/pkg/attributes"
 	"github.com/hashicorp/go-multierror"
 	"k8s.io/apimachinery/pkg/util/sets"
 )
@@ -42,14 +41,17 @@ func checkKeys(doCheck checkFn, toplevelListContainers ...workspaces.TopLevelLis
 			attributeValue = value.FieldByName("Attributes")
 		}
 
-		if attributeValue.IsValid() && attributeValue.CanInterface() {
-			attributes, ok := attributeValue.Interface().(attributesPkg.Attributes)
-			if !ok {
-				return fmt.Errorf("unable to fetch Attributes from the devfile data")
-			}
+		if attributeValue.IsValid() && attributeValue.Kind() == reflect.Map {
+			mapIter := attributeValue.MapRange()
+
 			var attributeKeys []string
-			for k := range attributes {
-				attributeKeys = append(attributeKeys, k)
+			for mapIter.Next() {
+				k := mapIter.Key()
+				v := mapIter.Value()
+				if k.Kind() != reflect.String || v.Kind() != reflect.String {
+					return fmt.Errorf("unable to fetch Global Attributes, Global Attributes should be map of strings")
+				}
+				attributeKeys = append(attributeKeys, k.String())
 			}
 			listTypeToKeys["Attributes"] = append(listTypeToKeys["Attributes"], sets.NewString(attributeKeys...))
 		}

pkg/utils/overriding/merging.go

@@ -6,7 +6,6 @@ import (
 	"strings"
 
 	workspaces "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
-	"github.com/devfile/api/v2/pkg/attributes"
 	"k8s.io/apimachinery/pkg/util/json"
 	"k8s.io/apimachinery/pkg/util/sets"
 	"k8s.io/apimachinery/pkg/util/yaml"
@@ -107,18 +106,12 @@ func MergeDevWorkspaceTemplateSpec(
 			postStopCommands = postStopCommands.Union(sets.NewString(content.Events.PostStop...))
 		}
 
-		var err error
 		if len(content.Attributes) > 0 {
 			if len(result.Attributes) == 0 {
-				result.Attributes = attributes.Attributes{}
+				result.Attributes = make(map[string]string)
 			}
 			for k, v := range content.Attributes {
-				result.Attributes.FromMap(map[string]interface{}{
-					k: v,
-				}, &err)
-				if err != nil {
-					return nil, err
-				}
+				result.Attributes[k] = v
 			}
 		}
 	}

pkg/utils/overriding/merging_test.go

@@ -7,7 +7,6 @@ import (
 	"testing"
 
 	workspaces "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
-	attributesPkg "github.com/devfile/api/v2/pkg/attributes"
 	"github.com/stretchr/testify/assert"
 	"k8s.io/apimachinery/pkg/util/json"
 	yamlMachinery "k8s.io/apimachinery/pkg/util/yaml"
@@ -27,9 +26,9 @@ func TestBasicMerging(t *testing.T) {
 		{
 			name: "Basic Merging",
 			mainContent: &workspaces.DevWorkspaceTemplateSpecContent{
-				Attributes: attributesPkg.Attributes{}.FromMap(map[string]interface{}{
-					"main": true,
-				}, nil),
+				Attributes: map[string]string{
+					"version1": "main",
+				},
 				Commands: []workspaces.Command{
 					{
 						Id: "mainCommand",
@@ -72,9 +71,9 @@ func TestBasicMerging(t *testing.T) {
 			},
 			pluginFlattenedContents: []*workspaces.DevWorkspaceTemplateSpecContent{
 				{
-					Attributes: attributesPkg.Attributes{}.FromMap(map[string]interface{}{
+					Attributes: map[string]string{
 						"version2": "plugin",
-					}, nil),
+					},
 					Commands: []workspaces.Command{
 						{
 							Id: "pluginCommand",
@@ -105,9 +104,9 @@ func TestBasicMerging(t *testing.T) {
 				},
 			},
 			parentFlattenedContent: &workspaces.DevWorkspaceTemplateSpecContent{
-				Attributes: attributesPkg.Attributes{}.FromMap(map[string]interface{}{
-					"version": "parent",
-				}, nil),
+				Attributes: map[string]string{
+					"version3": "parent",
+				},
 				Commands: []workspaces.Command{
 					{
 						Id: "parentCommand",
@@ -138,11 +137,11 @@ func TestBasicMerging(t *testing.T) {
 				},
 			},
 			expected: &workspaces.DevWorkspaceTemplateSpecContent{
-				Attributes: attributesPkg.Attributes{}.FromMap(map[string]interface{}{
-					"version":  "parent",
+				Attributes: map[string]string{
+					"version3": "parent",
 					"version2": "plugin",
-					"main":     true,
-				}, nil),
+					"version1": "main",
+				},
 				Commands: []workspaces.Command{
 					{
 						Id: "parentCommand",

pkg/utils/overriding/overriding_test.go

@@ -8,7 +8,6 @@ import (
 	"testing"
 
 	workspaces "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
-	attributesPkg "github.com/devfile/api/v2/pkg/attributes"
 	"github.com/stretchr/testify/assert"
 	"k8s.io/apimachinery/pkg/util/json"
 	yamlMachinery "k8s.io/apimachinery/pkg/util/yaml"
@@ -52,10 +51,10 @@ func TestBasicToplevelOverriding(t *testing.T) {
 				},
 			},
 		},
-		Attributes: attributesPkg.Attributes{}.FromMap(map[string]interface{}{
+		Attributes: map[string]string{
 			"version": "main",
 			"xyz":     "xyz",
-		}, nil),
+		},
 	}
 
 	patch := workspaces.ParentOverrides{
@@ -86,9 +85,9 @@ func TestBasicToplevelOverriding(t *testing.T) {
 				},
 			},
 		},
-		Attributes: attributesPkg.Attributes{}.FromMap(map[string]interface{}{
+		Attributes: map[string]string{
 			"version": "patch",
-		}, nil),
+		},
 	}
 
 	expected := &workspaces.DevWorkspaceTemplateSpecContent{
@@ -133,10 +132,10 @@ func TestBasicToplevelOverriding(t *testing.T) {
 				},
 			},
 		},
-		Attributes: attributesPkg.Attributes{}.FromMap(map[string]interface{}{
+		Attributes: map[string]string{
 			"version": "patch",
 			"xyz":     "xyz",
-		}, nil),
+		},
 	}
 
 	result, err := OverrideDevWorkspaceTemplateSpec(&original, &patch)

pkg/utils/overriding/test-fixtures/merges/duplicate-with-parent/main.yaml

@@ -1,8 +1,7 @@
 parent:
   uri: "anyParent"
 attributes:
-  objectAttribute:
-    attributeField: 9.9
+  objectAttribute: mainValue
 components:
   - container:
       image: "aDifferentValue"

pkg/utils/overriding/test-fixtures/merges/duplicate-with-parent/parent.yaml

@@ -1,6 +1,5 @@
 attributes:
-  objectAttribute:
-    attributeField: 10.10
+  objectAttribute: parentValue
 components:
   - container:
       image: "aValue"