wip

pkg/binding/add.go

@@ -10,6 +10,7 @@ import (
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 
+	"github.com/redhat-developer/odo/pkg/component"
 	sboApi "github.com/redhat-developer/service-binding-operator/apis/binding/v1alpha1"
 
 	"github.com/redhat-developer/odo/pkg/binding/asker"
@@ -112,7 +113,12 @@ func (o *BindingClient) AddBindingToDevfile(
 		return obj, err
 	}
 
-	deploymentName := fmt.Sprintf("%s-app", obj.GetMetadataName())
+	componentName, err := component.GatherName(obj)
+	if err != nil {
+		return obj, err
+	}
+
+	deploymentName := fmt.Sprintf("%s-app", componentName)
 	deploymentGVK, err := o.kubernetesClient.GetDeploymentAPIVersion()
 	if err != nil {
 		return obj, err

pkg/component/component.go

@@ -3,7 +3,6 @@ package component
 import (
 	"fmt"
 	"io"
-	"path/filepath"
 	"sort"
 	"strings"
 
@@ -13,14 +12,14 @@ import (
 	"github.com/devfile/library/pkg/devfile/parser/data"
 	dfutil "github.com/devfile/library/pkg/util"
 
+	"github.com/redhat-developer/odo/pkg/alizer"
 	"github.com/redhat-developer/odo/pkg/api"
 	"github.com/redhat-developer/odo/pkg/kclient"
 	"github.com/redhat-developer/odo/pkg/labels"
 	odolabels "github.com/redhat-developer/odo/pkg/labels"
 
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
-	"k8s.io/klog"
 )
 
 const (
@@ -42,32 +41,17 @@ func GetComponentTypeFromDevfileMetadata(metadata devfile.DevfileMetadata) strin
 	return componentType
 }
 
-// GatherName parses the Devfile and retrieves an appropriate name in two ways.
-// 1. If metadata.name exists, we use it
-// 2. If metadata.name does NOT exist, we use the folder name where the devfile.yaml is located
-func GatherName(devObj parser.DevfileObj, devfilePath string) (string, error) {
-
-	metadata := devObj.Data.GetMetadata()
-
-	klog.V(4).Infof("metadata.Name: %s", metadata.Name)
-
-	// 1. Use metadata.name if it exists
-	if metadata.Name != "" {
-
-		// Remove any suffix's that end with `-`. This is because many Devfile's use the original v1 Devfile pattern of
-		// having names such as "foo-bar-" in order to prepend container names such as "foo-bar-container1"
-		return strings.TrimSuffix(metadata.Name, "-"), nil
-	}
-
-	// 2. Use the folder name as a last resort if nothing else exists
-	sourcePath, err := dfutil.GetAbsPath(devfilePath)
-	if err != nil {
-		return "", fmt.Errorf("unable to get source path: %w", err)
+// GatherName returns the name of the component.
+//// If a name is set in the Devfile metadata (which is optional) and is not blank, it returns that.
+//// Otherwise, it uses Alizer to detect the name of the component, from the project build tools (pom.xml, package.json, ...),
+//// or from the component directory name.
+func GatherName(devfileObj parser.DevfileObj) (string, error) {
+	m := devfileObj.GetMetadataName()
+	if m != "" && strings.TrimSpace(m) != "" {
+		return m, nil
 	}
-	klog.V(4).Infof("Source path: %s", sourcePath)
-	klog.V(4).Infof("devfile dir: %s", filepath.Dir(sourcePath))
 
-	return filepath.Base(filepath.Dir(sourcePath)), nil
+	return alizer.DetectName(devfileObj.Ctx.GetAbsPath())
 }
 
 // Exists checks whether a component with the given name exists in the current application or not

pkg/component/delete/delete.go

@@ -94,7 +94,11 @@ func (do DeleteComponentClient) ListResourcesToDeleteFromDevfile(devfileObj pars
 	if mode == odolabels.ComponentDevMode || mode == odolabels.ComponentAnyMode {
 		// Inner Loop
 		// Fetch the deployment of the devfile component
-		componentName := devfileObj.GetMetadataName()
+		componentName, err := component.GatherName(devfileObj)
+		if err != nil {
+			return isInnerLoopDeployed, resources, err
+		}
+
 		var deploymentName string
 		deploymentName, err = util.NamespaceKubernetesObject(componentName, appName)
 		if err != nil {
@@ -151,7 +155,12 @@ func (do *DeleteComponentClient) ExecutePreStopEvents(devfileObj parser.DevfileO
 	if !libdevfile.HasPreStopEvents(devfileObj) {
 		return nil
 	}
-	componentName := devfileObj.GetMetadataName()
+
+	componentName, err := component.GatherName(devfileObj)
+	if err != nil {
+		return err
+	}
+
 	klog.V(4).Infof("Gathering information for component: %q", componentName)
 
 	klog.V(3).Infof("Checking component status for %q", componentName)

pkg/deploy/deploy.go

@@ -73,7 +73,12 @@ func (o *deployHandler) ApplyKubernetes(kubernetes v1alpha2.Component) error {
 
 	// Get the most common labels that's applicable to all resources being deployed.
 	// Set the mode to DEPLOY. Regardless of what Kubernetes resource we are deploying.
-	labels := odolabels.GetLabels(o.devfileObj.Data.GetMetadata().Name, o.appName, odolabels.ComponentDeployMode)
+	componentName, err := component.GatherName(o.devfileObj)
+	if err != nil {
+		return err
+	}
+
+	labels := odolabels.GetLabels(componentName, o.appName, odolabels.ComponentDeployMode)
 	klog.V(4).Infof("Injecting labels: %+v into k8s artifact", labels)
 
 	// Create the annotations

pkg/dev/dev.go

@@ -13,8 +13,9 @@ import (
 	"github.com/devfile/library/pkg/devfile/parser"
 	"k8s.io/klog/v2"
 
+	"github.com/redhat-developer/odo/pkg/component"
 	"github.com/redhat-developer/odo/pkg/devfile/adapters"
-	"github.com/redhat-developer/odo/pkg/devfile/adapters/kubernetes/component"
+	k8sComponent "github.com/redhat-developer/odo/pkg/devfile/adapters/kubernetes/component"
 	"github.com/redhat-developer/odo/pkg/watch"
 )
 
@@ -56,10 +57,16 @@ func (o *DevClient) Start(
 	errOut io.Writer,
 ) (watch.ComponentStatus, error) {
 	klog.V(4).Infoln("Creating new adapter")
-	adapter := component.NewKubernetesAdapter(
+
+	componentName, err := component.GatherName(devfileObj)
+	if err != nil {
+		return watch.ComponentStatus{}, err
+	}
+
+	adapter := k8sComponent.NewKubernetesAdapter(
 		o.kubernetesClient, o.prefClient, o.portForwardClient, o.bindingClient,
-		component.AdapterContext{
-			ComponentName: devfileObj.GetMetadataName(),
+		k8sComponent.AdapterContext{
+			ComponentName: componentName,
 			Context:       path,
 			AppName:       "app",
 			Devfile:       devfileObj,
@@ -115,10 +122,15 @@ func (o *DevClient) Watch(
 		return err
 	}
 
+	componentName, err := component.GatherName(devfileObj)
+	if err != nil {
+		return err
+	}
+
 	watchParameters := watch.WatchParameters{
 		DevfilePath:         devfilePath,
 		Path:                path,
-		ComponentName:       devfileObj.GetMetadataName(),
+		ComponentName:       componentName,
 		ApplicationName:     "app",
 		DevfileWatchHandler: h.RegenerateAdapterAndPush,
 		EnvSpecificInfo:     envSpecificInfo,

pkg/odo/cli/add/binding/binding.go

@@ -12,6 +12,7 @@ import (
 
 	"github.com/redhat-developer/odo/pkg/binding/asker"
 	"github.com/redhat-developer/odo/pkg/binding/backend"
+	"github.com/redhat-developer/odo/pkg/component"
 	"github.com/redhat-developer/odo/pkg/log"
 	"github.com/redhat-developer/odo/pkg/odo/cmdline"
 	"github.com/redhat-developer/odo/pkg/odo/genericclioptions"
@@ -123,7 +124,10 @@ func (o *AddBindingOptions) Run(_ context.Context) error {
 		}
 		componentName = workloadName
 	} else {
-		componentName = o.EnvSpecificInfo.GetDevfileObj().GetMetadataName()
+		componentName, err = component.GatherName(o.EnvSpecificInfo.GetDevfileObj())
+		if err != nil {
+			return err
+		}
 	}
 
 	bindingName, err := o.clientset.BindingClient.AskBindingName(serviceName, componentName, o.flags)

pkg/odo/cli/delete/component/component.go

@@ -10,6 +10,7 @@ import (
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	ktemplates "k8s.io/kubectl/pkg/util/templates"
 
+	"github.com/redhat-developer/odo/pkg/component"
 	"github.com/redhat-developer/odo/pkg/labels"
 	"github.com/redhat-developer/odo/pkg/log"
 	"github.com/redhat-developer/odo/pkg/odo/cli/ui"
@@ -122,7 +123,12 @@ func (o *ComponentOptions) deleteNamedComponent() error {
 // deleteDevfileComponent deletes all the components defined by the devfile in the current directory
 func (o *ComponentOptions) deleteDevfileComponent() error {
 	devfileObj := o.EnvSpecificInfo.GetDevfileObj()
-	componentName := devfileObj.GetMetadataName()
+
+	componentName, err := component.GatherName(devfileObj)
+	if err != nil {
+		return err
+	}
+
 	namespace := o.GetProject()
 	appName := "app"
 

pkg/odo/cli/deploy/deploy.go

@@ -146,7 +146,12 @@ func (o *DeployOptions) Validate() error {
 // Run contains the logic for the odo command
 func (o *DeployOptions) Run(ctx context.Context) error {
 	devfileObj := o.EnvSpecificInfo.GetDevfileObj()
-	devfileName := devfileObj.GetMetadataName()
+
+	devfileName, err := component.GatherName(devfileObj)
+	if err != nil {
+		return err
+	}
+
 	path := filepath.Dir(o.EnvSpecificInfo.GetDevfilePath())
 	appName := o.GetApplication()
 	namespace := o.GetProject()
@@ -160,7 +165,7 @@ func (o *DeployOptions) Run(ctx context.Context) error {
 		"odo version: "+version.VERSION)
 
 	// Run actual deploy command to be used
-	err := o.clientset.DeployClient.Deploy(o.clientset.FS, devfileObj, path, appName)
+	err = o.clientset.DeployClient.Deploy(o.clientset.FS, devfileObj, path, appName)
 
 	if err == nil {
 		log.Info("\nYour Devfile has been successfully deployed")

pkg/odo/cli/describe/component.go

@@ -139,7 +139,13 @@ func (o *ComponentOptions) describeDevfileComponent() (result api.Component, dev
 	if err != nil {
 		return api.Component{}, nil, err
 	}
-	runningIn, err := component.GetRunningModes(o.clientset.KubernetesClient, devfileObj.GetMetadataName())
+
+	componentName, err := component.GatherName(devfileObj)
+	if err != nil {
+		return api.Component{}, nil, err
+	}
+
+	runningIn, err := component.GetRunningModes(o.clientset.KubernetesClient, componentName)
 	if err != nil {
 		if !errors.As(err, &component.NoComponentFoundError{}) {
 			return api.Component{}, nil, err
@@ -159,7 +165,11 @@ func (o *ComponentOptions) describeDevfileComponent() (result api.Component, dev
 
 func printHumanReadableOutput(cmp api.Component, devfileObj *parser.DevfileObj) error {
 	if cmp.DevfileData != nil {
-		log.Describef("Name: ", cmp.DevfileData.Devfile.GetMetadata().Name)
+		componentName, err := component.GatherName(*devfileObj)
+		if err != nil {
+			return err
+		}
+		log.Describef("Name: ", componentName)
 		log.Describef("Display Name: ", cmp.DevfileData.Devfile.GetMetadata().DisplayName)
 		log.Describef("Project Type: ", cmp.DevfileData.Devfile.GetMetadata().ProjectType)
 		log.Describef("Language: ", cmp.DevfileData.Devfile.GetMetadata().Language)

pkg/odo/cli/dev/dev.go

@@ -196,12 +196,16 @@ func (o *DevOptions) Validate() error {
 
 func (o *DevOptions) Run(ctx context.Context) (err error) {
 	var (
-		devFileObj  = o.Context.EnvSpecificInfo.GetDevfileObj()
-		path        = filepath.Dir(o.Context.EnvSpecificInfo.GetDevfilePath())
-		devfileName = devFileObj.GetMetadataName()
-		namespace   = o.GetProject()
+		devFileObj = o.Context.EnvSpecificInfo.GetDevfileObj()
+		path       = filepath.Dir(o.Context.EnvSpecificInfo.GetDevfilePath())
+		namespace  = o.GetProject()
 	)
 
+	devfileName, err := component.GatherName(devFileObj)
+	if err != nil {
+		return err
+	}
+
 	defer func() {
 		if err != nil {
 			_ = o.clientset.WatchClient.CleanupDevResources(devFileObj, log.GetStdout())
@@ -248,7 +252,7 @@ func (o *DevOptions) Run(ctx context.Context) (err error) {
 	scontext.SetComponentType(ctx, component.GetComponentTypeFromDevfileMetadata(devFileObj.Data.GetMetadata()))
 	scontext.SetLanguage(ctx, devFileObj.Data.GetMetadata().Language)
 	scontext.SetProjectType(ctx, devFileObj.Data.GetMetadata().ProjectType)
-	scontext.SetDevfileName(ctx, devFileObj.GetMetadataName())
+	scontext.SetDevfileName(ctx, devfileName)
 
 	d := Handler{
 		clientset:   *o.clientset,

pkg/odo/cli/list/list.go

@@ -100,8 +100,12 @@ func (lo *ListOptions) Complete(cmdline cmdline.Cmdline, args []string) (err err
 		}
 
 		// Create a local component from the parse devfile
+		componentName, err := component.GatherName(devObj)
+		if err != nil {
+			return err
+		}
 		localComponent := api.ComponentAbstract{
-			Name:      devObj.Data.GetMetadata().Name,
+			Name:      componentName,
 			ManagedBy: "",
 			RunningIn: []api.RunningMode{},
 			Type:      component.GetComponentTypeFromDevfileMetadata(devObj.Data.GetMetadata()),

pkg/odo/cli/logs/logs.go

@@ -5,25 +5,29 @@ import (
 	"context"
 	"errors"
 	"fmt"
-	"github.com/fatih/color"
-	odolabels "github.com/redhat-developer/odo/pkg/labels"
 	"io"
 	"os"
 	"strconv"
 	"strings"
 	"sync"
 	"sync/atomic"
 
+	"github.com/fatih/color"
+
+	"github.com/redhat-developer/odo/pkg/component"
+	odolabels "github.com/redhat-developer/odo/pkg/labels"
+
 	"github.com/redhat-developer/odo/pkg/log"
 
 	"github.com/redhat-developer/odo/pkg/devfile/location"
 	odoutil "github.com/redhat-developer/odo/pkg/odo/util"
 
+	"github.com/spf13/cobra"
+	ktemplates "k8s.io/kubectl/pkg/util/templates"
+
 	"github.com/redhat-developer/odo/pkg/odo/cmdline"
 	"github.com/redhat-developer/odo/pkg/odo/genericclioptions"
 	"github.com/redhat-developer/odo/pkg/odo/genericclioptions/clientset"
-	"github.com/spf13/cobra"
-	ktemplates "k8s.io/kubectl/pkg/util/templates"
 )
 
 const RecommendedCommandName = "logs"
@@ -88,7 +92,10 @@ func (o *LogsOptions) Complete(cmdline cmdline.Cmdline, _ []string) error {
 		return fmt.Errorf("unable to create context: %v", err)
 	}
 
-	o.componentName = o.Context.EnvSpecificInfo.GetDevfileObj().GetMetadataName()
+	o.componentName, err = component.GatherName(o.Context.EnvSpecificInfo.GetDevfileObj())
+	if err != nil {
+		return err
+	}
 
 	o.clientset.KubernetesClient.SetNamespace(o.Context.GetProject())
 

pkg/registry/registry.go

@@ -14,7 +14,6 @@ import (
 	"github.com/devfile/registry-support/registry-library/library"
 
 	"github.com/redhat-developer/odo/pkg/api"
-	"github.com/redhat-developer/odo/pkg/component"
 	"github.com/redhat-developer/odo/pkg/devfile"
 	"github.com/redhat-developer/odo/pkg/devfile/location"
 	"github.com/redhat-developer/odo/pkg/log"
@@ -51,7 +50,7 @@ func (o RegistryClient) DownloadFileInMemory(params dfutil.HTTPRequestParams) ([
 // DownloadStarterProject downloads a starter project referenced in devfile
 // This will first remove the content of the contextDir
 func (o RegistryClient) DownloadStarterProject(starterProject *devfilev1.StarterProject, decryptedToken string, contextDir string, verbose bool) error {
-	return component.DownloadStarterProject(starterProject, decryptedToken, contextDir, verbose)
+	return DownloadStarterProject(starterProject, decryptedToken, contextDir, verbose)
 }
 
 // GetDevfileRegistries gets devfile registries from preference file,

pkg/component/starter_project.go → pkg/registry/starter_project.go

@@ -1,4 +1,4 @@
-package component
+package registry
 
 import (
 	"errors"