Refactor labels (#5618)

* refacto labels

* Getters

* Builder

* Do not export labels

* Move to pkg/labels + doc

* Fix rebase

pkg/component/component.go

@@ -11,8 +11,8 @@ import (
 	"github.com/devfile/library/pkg/devfile/parser"
 	dfutil "github.com/devfile/library/pkg/util"
 
-	componentlabels "github.com/redhat-developer/odo/pkg/component/labels"
 	"github.com/redhat-developer/odo/pkg/kclient"
+	odolabels "github.com/redhat-developer/odo/pkg/labels"
 
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/klog"
@@ -80,7 +80,7 @@ func Exists(client kclient.ClientInterface, componentName, applicationName strin
 
 // GetOnePod gets a pod using the component and app name
 func GetOnePod(client kclient.ClientInterface, componentName string, appName string) (*corev1.Pod, error) {
-	return client.GetOnePodFromSelector(componentlabels.GetSelector(componentName, appName))
+	return client.GetOnePodFromSelector(odolabels.GetSelector(componentName, appName, odolabels.ComponentDevMode))
 }
 
 // ComponentExists checks whether a deployment by the given name exists in the given app
@@ -149,31 +149,24 @@ func ListAllClusterComponents(client kclient.ClientInterface, namespace string)
 		// Figure out the correct name to use
 		// if there is no instance label, we SKIP the resource as
 		// it is not a component essential for Kubernetes.
-		var name string
-		if labels[componentlabels.KubernetesInstanceLabel] != "" {
-			name = labels[componentlabels.KubernetesInstanceLabel]
-		} else {
+		name := odolabels.GetComponentName(labels)
+		if name == "" {
 			continue
 		}
 
 		// Get the component type (if there is any..)
-		var componentType string
-		switch {
-		case annotations[componentlabels.OdoProjectTypeAnnotation] != "":
-			componentType = annotations[componentlabels.OdoProjectTypeAnnotation]
-		default:
+		componentType, err := odolabels.GetProjectType(nil, annotations)
+		if err != nil || componentType == "" {
 			componentType = StateTypeUnknown
 		}
 
 		// Get the managedBy label
 		// IMPORTANT. If "managed-by" label is BLANK, it is most likely an operator
 		// or a non-component. We do not want to show these in the list of components
 		// so we skip them if there is no "managed-by" label.
-		var managedBy string
-		switch {
-		case labels[componentlabels.KubernetesManagedByLabel] != "":
-			managedBy = labels[componentlabels.KubernetesManagedByLabel]
-		default:
+
+		managedBy := odolabels.GetManagedBy(labels)
+		if managedBy == "" {
 			continue
 		}
 
@@ -183,7 +176,7 @@ func ListAllClusterComponents(client kclient.ClientInterface, namespace string)
 			ManagedBy: managedBy,
 			Type:      componentType,
 		}
-		mode := labels[componentlabels.OdoModeLabel]
+		mode := odolabels.GetMode(labels)
 		found := false
 		for v, otherCompo := range components {
 			if component.Name == otherCompo.Name {

pkg/component/component_test.go

@@ -7,8 +7,8 @@ import (
 	devfilepkg "github.com/devfile/api/v2/pkg/devfile"
 	"github.com/golang/mock/gomock"
 	"github.com/kylelemons/godebug/pretty"
-	"github.com/redhat-developer/odo/pkg/component/labels"
 	"github.com/redhat-developer/odo/pkg/kclient"
+	"github.com/redhat-developer/odo/pkg/labels"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
@@ -263,12 +263,12 @@ func getUnstructured(name, kind, apiVersion, managed, componentType, namespace s
 	u.SetKind(kind)
 	u.SetAPIVersion(apiVersion)
 	u.SetNamespace(namespace)
-	u.SetLabels(map[string]string{
-		labels.KubernetesInstanceLabel:  name,
-		labels.KubernetesManagedByLabel: managed,
-	})
-	u.SetAnnotations(map[string]string{
-		labels.OdoProjectTypeAnnotation: componentType,
-	})
+	u.SetLabels(labels.Builder().
+		WithComponentName(name).
+		WithManager(managed).
+		Labels())
+	u.SetAnnotations(labels.Builder().
+		WithProjectType(componentType).
+		Labels())
 	return
 }

pkg/component/delete/delete.go

@@ -11,10 +11,9 @@ import (
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/klog"
 
-	applabels "github.com/redhat-developer/odo/pkg/application/labels"
 	"github.com/redhat-developer/odo/pkg/component"
-	componentlabels "github.com/redhat-developer/odo/pkg/component/labels"
 	"github.com/redhat-developer/odo/pkg/kclient"
+	odolabels "github.com/redhat-developer/odo/pkg/labels"
 	"github.com/redhat-developer/odo/pkg/libdevfile"
 	"github.com/redhat-developer/odo/pkg/log"
 	"github.com/redhat-developer/odo/pkg/util"
@@ -34,9 +33,7 @@ func NewDeleteComponentClient(kubeClient kclient.ClientInterface) *DeleteCompone
 // It only returns resources not owned by another resource of the component, letting the garbage collector do its job
 func (do *DeleteComponentClient) ListClusterResourcesToDelete(componentName string, namespace string) ([]unstructured.Unstructured, error) {
 	var result []unstructured.Unstructured
-	labels := componentlabels.GetLabels(componentName, "app", false)
-	labels[applabels.ManagedBy] = "odo"
-	selector := util.ConvertLabelsToSelector(labels)
+	selector := odolabels.GetSelector(componentName, "app", odolabels.ComponentAnyMode)
 	list, err := do.kubeClient.GetAllResourcesFromSelector(selector, namespace)
 	if err != nil {
 		return nil, err
@@ -149,7 +146,7 @@ func (do *DeleteComponentClient) ExecutePreStopEvents(devfileObj parser.DevfileO
 	klog.V(4).Infof("Gathering information for component: %q", componentName)
 
 	klog.V(3).Infof("Checking component status for %q", componentName)
-	selector := componentlabels.GetSelector(componentName, appName)
+	selector := odolabels.GetSelector(componentName, appName, odolabels.ComponentDevMode)
 	pod, err := do.kubeClient.GetOnePodFromSelector(selector)
 	if err != nil {
 		klog.V(1).Info("Component not found on the cluster.")

pkg/component/delete/delete_test.go

@@ -16,8 +16,8 @@ import (
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 
-	componentlabels "github.com/redhat-developer/odo/pkg/component/labels"
 	"github.com/redhat-developer/odo/pkg/kclient"
+	odolabels "github.com/redhat-developer/odo/pkg/labels"
 	odoTestingUtil "github.com/redhat-developer/odo/pkg/testingutil"
 	"github.com/redhat-developer/odo/pkg/util"
 )
@@ -498,7 +498,7 @@ func TestDeleteComponentClient_ExecutePreStopEvents(t *testing.T) {
 				kubeClient: func(ctrl *gomock.Controller) kclient.ClientInterface {
 					client := kclient.NewMockClientInterface(ctrl)
 
-					selector := componentlabels.GetSelector(componentName, "app")
+					selector := odolabels.GetSelector(componentName, "app", odolabels.ComponentDevMode)
 					client.EXPECT().GetOnePodFromSelector(selector).Return(&corev1.Pod{}, &kclient.PodNotFoundError{Selector: selector})
 					return client
 				},
@@ -515,7 +515,7 @@ func TestDeleteComponentClient_ExecutePreStopEvents(t *testing.T) {
 				kubeClient: func(ctrl *gomock.Controller) kclient.ClientInterface {
 					client := kclient.NewMockClientInterface(ctrl)
 
-					selector := componentlabels.GetSelector(componentName, "app")
+					selector := odolabels.GetSelector(componentName, "app", odolabels.ComponentDevMode)
 					client.EXPECT().GetOnePodFromSelector(selector).Return(nil, errors.New("some un-ignorable error"))
 					return client
 				},
@@ -532,7 +532,7 @@ func TestDeleteComponentClient_ExecutePreStopEvents(t *testing.T) {
 				kubeClient: func(ctrl *gomock.Controller) kclient.ClientInterface {
 					client := kclient.NewMockClientInterface(ctrl)
 
-					selector := componentlabels.GetSelector(componentName, "app")
+					selector := odolabels.GetSelector(componentName, "app", odolabels.ComponentDevMode)
 					client.EXPECT().GetOnePodFromSelector(selector).Return(odoTestingUtil.CreateFakePod(componentName, "runtime"), nil)
 
 					cmd := []string{"/bin/sh", "-c", "cd /projects/nodejs-starter && echo \"Hello World!\""}
@@ -553,7 +553,7 @@ func TestDeleteComponentClient_ExecutePreStopEvents(t *testing.T) {
 				kubeClient: func(ctrl *gomock.Controller) kclient.ClientInterface {
 					client := kclient.NewMockClientInterface(ctrl)
 
-					selector := componentlabels.GetSelector(componentName, "app")
+					selector := odolabels.GetSelector(componentName, "app", odolabels.ComponentDevMode)
 					pod := odoTestingUtil.CreateFakePod(componentName, "runtime")
 					pod.Status.Phase = corev1.PodFailed
 					client.EXPECT().GetOnePodFromSelector(selector).Return(pod, nil)
@@ -572,7 +572,7 @@ func TestDeleteComponentClient_ExecutePreStopEvents(t *testing.T) {
 				kubeClient: func(ctrl *gomock.Controller) kclient.ClientInterface {
 					client := kclient.NewMockClientInterface(ctrl)
 
-					selector := componentlabels.GetSelector(componentName, "app")
+					selector := odolabels.GetSelector(componentName, "app", odolabels.ComponentDevMode)
 					client.EXPECT().GetOnePodFromSelector(selector).Return(odoTestingUtil.CreateFakePod(componentName, "runtime"), nil)
 
 					cmd := []string{"/bin/sh", "-c", "cd /projects/nodejs-starter && echo \"Hello World!\""}