First pass of filtering devfile obj via attributes

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

Author: maysunfaisal

devfile.yaml

@@ -2,15 +2,46 @@ schemaVersion: 2.0.0
 metadata:
   name: nodejs
   version: 1.0.0
-  alpha.build-dockerfile: https://raw.githubusercontent.com/odo-devfiles/registry/master/devfiles/nodejs/build/Dockerfile
-  alpha.deployment-manifest: https://raw.githubusercontent.com/odo-devfiles/registry/master/devfiles/nodejs/deploy/deployment-manifest.yaml
+  attributes:
+    alpha.build-dockerfile: https://raw.githubusercontent.com/odo-devfiles/registry/master/devfiles/nodejs/build/Dockerfile
+    alpha.deployment-manifest: https://raw.githubusercontent.com/odo-devfiles/registry/master/devfiles/nodejs/deploy/deployment-manifest.yaml
 starterProjects:
 - name: nodejs-starter
   git:
     remotes:
       origin: https://github.com/odo-devfiles/nodejs-ex.git
 components:
 - name: runtime
+  attributes:
+    first: a
+    last: c
+  container:
+    endpoints:
+    - name: http-3000
+      targetPort: 3000
+    image: registry.access.redhat.com/ubi8/nodejs-12:1-45
+    memoryLimit: 1024Mi
+    mountSources: true
+    sourceMapping: /project
+- name: runtime2
+  attributes:
+    name:
+      first: a
+    middle: b
+  container:
+    endpoints:
+    - name: http-3000
+      targetPort: 3000
+    image: registry.access.redhat.com/ubi8/nodejs-12:1-45
+    memoryLimit: 1024Mi
+    mountSources: true
+    sourceMapping: /project
+- name: runtime3
+  attributes:
+    first: maysun
+    names:
+      first: a
+      middle: b
   container:
     endpoints:
     - name: http-3000
@@ -28,6 +59,9 @@ commands:
       kind: build
     workingDir: /project
   id: install
+  attributes:
+    first: a
+    last: c
 - exec:
     commandLine: npm start
     component: runtime
@@ -36,6 +70,8 @@ commands:
       kind: run
     workingDir: /project
   id: run
+  attributes:
+    first: a
 - exec:
     commandLine: npm run debug
     component: runtime

go.mod

@@ -3,7 +3,7 @@ module github.com/devfile/library
 go 1.13
 
 require (
-	github.com/devfile/api v0.0.0-20201103130402-29b8738e196e
+	github.com/devfile/api v0.0.0-20201126204309-ec222215253e
 	github.com/fatih/color v1.7.0
 	github.com/ghodss/yaml v1.0.1-0.20190212211648-25d852aebe32
 	github.com/gobwas/glob v0.2.3
@@ -16,12 +16,12 @@ require (
 	github.com/spf13/afero v1.2.2
 	github.com/stretchr/testify v1.6.1 // indirect
 	github.com/xeipuuv/gojsonschema v1.2.0
-	golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e // indirect
 	golang.org/x/sys v0.0.0-20200509044756-6aff5f38e54f // indirect
+	gonum.org/v1/netlib v0.0.0-20190331212654-76723241ea4e // indirect
 	gopkg.in/yaml.v2 v2.3.0 // indirect
-	k8s.io/api v0.18.2
-	k8s.io/apimachinery v0.18.2
+	k8s.io/api v0.18.6
+	k8s.io/apimachinery v0.18.6
 	k8s.io/klog v1.0.0
-	sigs.k8s.io/controller-runtime v0.6.0 // indirect
+	sigs.k8s.io/structured-merge-diff v1.0.1-0.20191108220359-b1b620dd3f06 // indirect
 	sigs.k8s.io/yaml v1.2.0
 )

go.sum

@@ -7,6 +7,7 @@ import (
 	devfilepkg "github.com/devfile/library/pkg/devfile"
 	"github.com/devfile/library/pkg/devfile/parser"
 	v2 "github.com/devfile/library/pkg/devfile/parser/data/v2"
+	"github.com/devfile/library/pkg/devfile/parser/data/v2/common"
 )
 
 func main() {
@@ -17,20 +18,39 @@ func main() {
 		devdata := devfile.Data
 		if (reflect.TypeOf(devdata) == reflect.TypeOf(&v2.DevfileV2{})) {
 			d := devdata.(*v2.DevfileV2)
-			fmt.Println(d.SchemaVersion)
+			fmt.Printf("schema version: %s\n", d.SchemaVersion)
 		}
 
-		for _, component := range devfile.Data.GetComponents() {
+		compOptions := common.DevfileOptions{
+			Filter: map[string]interface{}{
+				"first": "a",
+				"last":  "c",
+				// "middle": "b",
+				// "name": map[string]interface{}{
+				// 	"first": "a",
+				// },
+			},
+		}
+
+		for _, component := range devfile.Data.GetComponents(compOptions) {
 			if component.Container != nil {
-				fmt.Println(component.Container.Image)
+				fmt.Printf("component container: %s\n", component.Name)
 			}
 		}
 
-		for _, command := range devfile.Data.GetCommands() {
+		for _, command := range devfile.Data.GetCommands(compOptions) {
 			if command.Exec != nil {
-				fmt.Println(command.Exec.Group.Kind)
+				fmt.Printf("exec command kind: %s\n", command.Exec.Group.Kind)
 			}
 		}
+
+		var err error
+		metadataAttr := devfile.Data.GetMetadata().Attributes
+		dockerfilePath := metadataAttr.GetString("alpha.build-dockerfile", &err)
+		if err != nil {
+			fmt.Printf("err: %v\n", err)
+		}
+		fmt.Printf("dockerfilePath: %s\n", dockerfilePath)
 	}
 
 }

main.go

@@ -11,6 +11,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 	"github.com/devfile/library/pkg/devfile/parser"
+	"github.com/devfile/library/pkg/devfile/parser/data/v2/common"
 )
 
 const (
@@ -49,9 +50,9 @@ func GetObjectMeta(name, namespace string, labels, annotations map[string]string
 }
 
 // GetContainers iterates through the devfile components and returns a slice of the corresponding containers
-func GetContainers(devfileObj parser.DevfileObj) ([]corev1.Container, error) {
+func GetContainers(devfileObj parser.DevfileObj, options common.DevfileOptions) ([]corev1.Container, error) {
 	var containers []corev1.Container
-	for _, comp := range devfileObj.Data.GetDevfileContainerComponents() {
+	for _, comp := range devfileObj.Data.GetDevfileContainerComponents(options) {
 		envVars := convertEnvs(comp.Container.Env)
 		resourceReqs := getResourceReqs(comp)
 		ports := convertPorts(comp.Container.Endpoints)
@@ -71,7 +72,7 @@ func GetContainers(devfileObj parser.DevfileObj) ([]corev1.Container, error) {
 		if comp.Container.MountSources == nil || *comp.Container.MountSources {
 			syncRootFolder := addSyncRootFolder(container, comp.Container.SourceMapping)
 
-			err := addSyncFolder(container, syncRootFolder, devfileObj.Data.GetProjects())
+			err := addSyncFolder(container, syncRootFolder, devfileObj.Data.GetProjects(common.DevfileOptions{}))
 			if err != nil {
 				return nil, err
 			}

pkg/devfile/generator/generators.go

@@ -6,6 +6,7 @@ import (
 
 	v1 "github.com/devfile/api/pkg/apis/workspaces/v1alpha2"
 	"github.com/devfile/library/pkg/devfile/parser"
+	"github.com/devfile/library/pkg/devfile/parser/data/v2/common"
 	"github.com/devfile/library/pkg/testingutil"
 
 	corev1 "k8s.io/api/core/v1"
@@ -131,7 +132,7 @@ func TestGetContainers(t *testing.T) {
 				},
 			}
 
-			containers, err := GetContainers(devObj)
+			containers, err := GetContainers(devObj, common.DevfileOptions{})
 			// Unexpected error
 			if (err != nil) != tt.wantErr {
 				t.Errorf("TestGetContainers() error = %v, wantErr %v", err, tt.wantErr)

pkg/devfile/generator/generators_test.go

@@ -7,6 +7,7 @@ import (
 
 	v1 "github.com/devfile/api/pkg/apis/workspaces/v1alpha2"
 	"github.com/devfile/library/pkg/devfile/parser"
+	"github.com/devfile/library/pkg/devfile/parser/data/v2/common"
 	"github.com/devfile/library/pkg/util"
 	buildv1 "github.com/openshift/api/build/v1"
 	routev1 "github.com/openshift/api/route/v1"
@@ -197,7 +198,7 @@ func getServiceSpec(devfileObj parser.DevfileObj, selectorLabels map[string]stri
 
 	var containerPorts []corev1.ContainerPort
 	portExposureMap := getPortExposure(devfileObj)
-	containers, err := GetContainers(devfileObj)
+	containers, err := GetContainers(devfileObj, common.DevfileOptions{})
 	if err != nil {
 		return nil, err
 	}
@@ -240,7 +241,7 @@ func getServiceSpec(devfileObj parser.DevfileObj, selectorLabels map[string]stri
 // exposure level: public > internal > none
 func getPortExposure(devfileObj parser.DevfileObj) map[int]v1.EndpointExposure {
 	portExposureMap := make(map[int]v1.EndpointExposure)
-	containerComponents := devfileObj.Data.GetDevfileContainerComponents()
+	containerComponents := devfileObj.Data.GetDevfileContainerComponents(common.DevfileOptions{})
 	for _, comp := range containerComponents {
 		for _, endpoint := range comp.Container.Endpoints {
 			// if exposure=public, no need to check for existence

pkg/devfile/generator/utils.go

@@ -6,6 +6,7 @@ import (
 	"strings"
 
 	v1 "github.com/devfile/api/pkg/apis/workspaces/v1alpha2"
+	"github.com/devfile/library/pkg/devfile/parser/data/v2/common"
 	corev1 "k8s.io/api/core/v1"
 )
 
@@ -27,7 +28,7 @@ func (d DevfileObj) SetMetadataName(name string) error {
 
 // AddEnvVars adds environment variables to all the components in a devfile
 func (d DevfileObj) AddEnvVars(otherList []v1.EnvVar) error {
-	components := d.Data.GetComponents()
+	components := d.Data.GetComponents(common.DevfileOptions{})
 	for _, component := range components {
 		if component.Container != nil {
 			component.Container.Env = Merge(component.Container.Env, otherList)
@@ -39,7 +40,7 @@ func (d DevfileObj) AddEnvVars(otherList []v1.EnvVar) error {
 
 // RemoveEnvVars removes the environment variables which have the keys from all the components in a devfile
 func (d DevfileObj) RemoveEnvVars(keys []string) (err error) {
-	components := d.Data.GetComponents()
+	components := d.Data.GetComponents(common.DevfileOptions{})
 	for _, component := range components {
 		if component.Container != nil {
 			component.Container.Env, err = RemoveEnvVarsFromList(component.Container.Env, keys)
@@ -54,7 +55,7 @@ func (d DevfileObj) RemoveEnvVars(keys []string) (err error) {
 
 // SetPorts converts ports to endpoints, adds to a devfile
 func (d DevfileObj) SetPorts(ports ...string) error {
-	components := d.Data.GetComponents()
+	components := d.Data.GetComponents(common.DevfileOptions{})
 	endpoints, err := portsToEndpoints(ports...)
 	if err != nil {
 		return err
@@ -70,7 +71,7 @@ func (d DevfileObj) SetPorts(ports ...string) error {
 
 // RemovePorts removes all container endpoints from a devfile
 func (d DevfileObj) RemovePorts() error {
-	components := d.Data.GetComponents()
+	components := d.Data.GetComponents(common.DevfileOptions{})
 	for _, component := range components {
 		if component.Container != nil {
 			component.Container.Endpoints = []v1.Endpoint{}
@@ -82,7 +83,7 @@ func (d DevfileObj) RemovePorts() error {
 
 // HasPorts checks if a devfile contains container endpoints
 func (d DevfileObj) HasPorts() bool {
-	components := d.Data.GetComponents()
+	components := d.Data.GetComponents(common.DevfileOptions{})
 	for _, component := range components {
 		if component.Container != nil {
 			if len(component.Container.Endpoints) > 0 {
@@ -95,7 +96,7 @@ func (d DevfileObj) HasPorts() bool {
 
 // SetMemory sets memoryLimit in devfile container
 func (d DevfileObj) SetMemory(memory string) error {
-	components := d.Data.GetComponents()
+	components := d.Data.GetComponents(common.DevfileOptions{})
 	for _, component := range components {
 		if component.Container != nil {
 			component.Container.MemoryLimit = memory
@@ -107,7 +108,7 @@ func (d DevfileObj) SetMemory(memory string) error {
 
 // GetMemory gets memoryLimit from devfile container
 func (d DevfileObj) GetMemory() string {
-	components := d.Data.GetComponents()
+	components := d.Data.GetComponents(common.DevfileOptions{})
 	for _, component := range components {
 		if component.Container != nil {
 			if component.Container.MemoryLimit != "" {

pkg/devfile/parser/configurables.go

@@ -3,6 +3,7 @@ package data
 import (
 	v1 "github.com/devfile/api/pkg/apis/workspaces/v1alpha2"
 	devfilepkg "github.com/devfile/api/pkg/devfile"
+	"github.com/devfile/library/pkg/devfile/parser/data/v2/common"
 )
 
 // DevfileData is an interface that defines functions for Devfile data operations
@@ -22,22 +23,22 @@ type DevfileData interface {
 	UpdateEvents(postStart, postStop, preStart, preStop []string)
 
 	// component related methods
-	GetComponents() []v1.Component
+	GetComponents(common.DevfileOptions) []v1.Component
 	AddComponents(components []v1.Component) error
 	UpdateComponent(component v1.Component)
 
 	// project related methods
-	GetProjects() []v1.Project
+	GetProjects(common.DevfileOptions) []v1.Project
 	AddProjects(projects []v1.Project) error
 	UpdateProject(project v1.Project)
 
 	// starter projects related commands
-	GetStarterProjects() []v1.StarterProject
+	GetStarterProjects(common.DevfileOptions) []v1.StarterProject
 	AddStarterProjects(projects []v1.StarterProject) error
 	UpdateStarterProject(project v1.StarterProject)
 
 	// command related methods
-	GetCommands() map[string]v1.Command
+	GetCommands(common.DevfileOptions) []v1.Command
 	AddCommands(commands ...v1.Command) error
 	UpdateCommand(command v1.Command)
 
@@ -47,6 +48,6 @@ type DevfileData interface {
 	GetVolumeMountPath(name string) (string, error)
 
 	//utils
-	GetDevfileContainerComponents() []v1.Component
-	GetDevfileVolumeComponents() []v1.Component
+	GetDevfileContainerComponents(common.DevfileOptions) []v1.Component
+	GetDevfileVolumeComponents(common.DevfileOptions) []v1.Component
 }