Merge main into v1.10-branch with known resolved conflicts

Author: github-actions[bot]

.editorconfig

@@ -0,0 +1,27 @@
+# https://editorconfig.org/
+
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{js,py,go,sh}]
+charset = utf-8
+
+[*.py]
+indent_style = space
+indent_size = 4
+
+[*.{yaml,yml,md}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+[Makefile]
+indent_style = tab
+
+[*.go]
+indent_style = tab

OWNERS

@@ -3,6 +3,7 @@ approvers:
   - atheo89
   - caponetto
   - harshad16
+  - jesuino
   - jiridanek
   - jstourac
   - paulovmr
@@ -13,6 +14,7 @@ reviewers:
   - caponetto
   - dibryant
   - harshad16
+  - jesuino
   - jiridanek
   - jstourac
   - paulovmr

components/notebook-controller/controllers/notebook_controller.go

@@ -439,6 +439,7 @@ func generateStatefulSet(instance *v1beta1.Notebook, isGenerateName bool) *appsv
 	ssObjectMeta := metav1.ObjectMeta{
 		Name:      instance.Name,
 		Namespace: instance.Namespace,
+		Labels:    map[string]string{},
 	}
 	if isGenerateName {
 		ssObjectMeta = metav1.ObjectMeta{
@@ -470,6 +471,11 @@ func generateStatefulSet(instance *v1beta1.Notebook, isGenerateName bool) *appsv
 		},
 	}
 
+	sl := &ss.Labels
+	for k, v := range instance.Labels {
+		(*sl)[k] = v
+	}
+
 	// copy all of the Notebook labels to the pod including poddefault related labels
 	l := &ss.Spec.Template.ObjectMeta.Labels
 	for k, v := range instance.ObjectMeta.Labels {

components/notebook-controller/controllers/notebook_controller_bdd_test.go

@@ -37,6 +37,9 @@ var _ = Describe("Notebook controller", func() {
 		Namespace = "default"
 		timeout   = time.Second * 10
 		interval  = time.Millisecond * 250
+
+		testLabelName  = "testLabel"
+		testLabelValue = "testLabelValue"
 	)
 
 	Context("When validating the notebook controller", func() {
@@ -47,6 +50,9 @@ var _ = Describe("Notebook controller", func() {
 				ObjectMeta: metav1.ObjectMeta{
 					Name:      Name,
 					Namespace: Namespace,
+					Labels: map[string]string{
+						testLabelName: testLabelValue,
+					},
 				},
 				Spec: nbv1beta1.NotebookSpec{
 					Template: nbv1beta1.NotebookTemplateSpec{
@@ -62,10 +68,7 @@ var _ = Describe("Notebook controller", func() {
 
 			Eventually(func() bool {
 				err := k8sClient.Get(ctx, notebookLookupKey, createdNotebook)
-				if err != nil {
-					return false
-				}
-				return true
+				return err == nil
 			}, timeout, interval).Should(BeTrue())
 			/*
 				Checking for the underlying statefulset.
@@ -82,6 +85,10 @@ var _ = Describe("Notebook controller", func() {
 				if err != nil {
 					return false, err
 				}
+
+				By("By checking that the StatefulSet has identical Labels as the Notebook")
+				Expect(sts.GetLabels()).To(Equal(notebook.GetLabels()))
+
 				return true, nil
 			}, timeout, interval).Should(BeTrue())
 		})

components/odh-notebook-controller/Makefile

@@ -93,12 +93,10 @@ vet: ## Run go vet against code.
 test: test-with-rbac-false test-with-rbac-true
 test-with-rbac-false: manifests generate fmt vet envtest ## Run tests.
 	export SET_PIPELINE_RBAC=false && \
-	ACK_GINKGO_DEPRECATIONS=1.16.5 \
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" \
 		go test ./controllers/... -ginkgo.v -ginkgo.progress -test.v -coverprofile cover-rbac-false.out
 test-with-rbac-true: manifests generate fmt vet envtest ## Run tests.
 	export SET_PIPELINE_RBAC=true && \
-	ACK_GINKGO_DEPRECATIONS=1.16.5 \
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" \
 		go test ./controllers/... -ginkgo.v -ginkgo.progress -test.v -coverprofile cover-rbac-true.out
 

components/odh-notebook-controller/controllers/notebook_controller_test.go

@@ -93,8 +93,6 @@ var _ = Describe("The Openshift Notebook controller", func() {
 		route := &routev1.Route{}
 
 		It("Should create a Route to expose the traffic externally", func() {
-			ctx := context.Background()
-
 			By("By creating a new Notebook")
 			Expect(cli.Create(ctx, notebook)).Should(Succeed())
 
@@ -185,8 +183,6 @@ var _ = Describe("The Openshift Notebook controller", func() {
 		})
 
 		It("Should create a RoleBinding when the referenced Role exists", func() {
-			ctx := context.Background()
-
 			By("Creating a Notebook and ensuring the Role exists")
 			Expect(cli.Create(ctx, notebook)).Should(Succeed())
 			time.Sleep(interval)
@@ -217,8 +213,6 @@ var _ = Describe("The Openshift Notebook controller", func() {
 		})
 
 		It("Should delete the RoleBinding when the Notebook is deleted", func() {
-			ctx := context.Background()
-
 			By("Ensuring the RoleBinding exists")
 			roleBinding := &rbacv1.RoleBinding{}
 			Eventually(func() error {
@@ -244,7 +238,6 @@ var _ = Describe("The Openshift Notebook controller", func() {
 		)
 
 		It("Should mount a trusted-ca when it exists on the given namespace", func() {
-			ctx := context.Background()
 			logger := logr.Discard()
 
 			By("By simulating the existence of odh-trusted-ca-bundle ConfigMap")
@@ -381,8 +374,6 @@ var _ = Describe("The Openshift Notebook controller", func() {
 		route := &routev1.Route{}
 
 		It("Should create a Route to expose the traffic externally", func() {
-			ctx := context.Background()
-
 			By("By creating a new Notebook")
 			Expect(cli.Create(ctx, notebook)).Should(Succeed())
 			time.Sleep(interval)
@@ -471,8 +462,6 @@ var _ = Describe("The Openshift Notebook controller", func() {
 		notebook := createNotebook(Name, Namespace)
 
 		It("Should update the Notebook specification", func() {
-			ctx := context.Background()
-
 			By("By creating a new Notebook")
 			Expect(cli.Create(ctx, notebook)).Should(Succeed())
 
@@ -492,7 +481,6 @@ var _ = Describe("The Openshift Notebook controller", func() {
 		})
 
 		It("When notebook CR is updated, should mount a trusted-ca if it exists on the given namespace", func() {
-			ctx := context.Background()
 			logger := logr.Discard()
 
 			By("By simulating the existence of odh-trusted-ca-bundle ConfigMap")
@@ -622,8 +610,6 @@ var _ = Describe("The Openshift Notebook controller", func() {
 		notebookOAuthNetworkPolicy := &netv1.NetworkPolicy{}
 
 		It("Should create network policies to restrict undesired traffic", func() {
-			ctx := context.Background()
-
 			By("By creating a new Notebook")
 			Expect(cli.Create(ctx, notebook)).Should(Succeed())
 
@@ -803,8 +789,6 @@ var _ = Describe("The Openshift Notebook controller", func() {
 		}
 
 		It("Should inject the OAuth proxy as a sidecar container", func() {
-			ctx := context.Background()
-
 			By("By creating a new Notebook")
 			Expect(cli.Create(ctx, notebook)).Should(Succeed())
 
@@ -1045,7 +1029,6 @@ var _ = Describe("The Openshift Notebook controller", func() {
 		It("Should not add OAuth sidecar", func() {
 			notebook := createNotebook(name, namespace)
 			notebook.SetAnnotations(map[string]string{AnnotationServiceMesh: "true"})
-			ctx := context.Background()
 			Expect(cli.Create(ctx, notebook)).Should(Succeed())
 
 			actualNotebook := &nbv1.Notebook{}
@@ -1060,7 +1043,7 @@ var _ = Describe("The Openshift Notebook controller", func() {
 		It("Should not define OAuth network policy", func() {
 			policies := &netv1.NetworkPolicyList{}
 			Eventually(func() error {
-				return cli.List(context.Background(), policies, client.InNamespace(namespace))
+				return cli.List(ctx, policies, client.InNamespace(namespace))
 			}, duration, interval).Should(Succeed())
 
 			Expect(policies.Items).To(Not(ContainElement(notebookOAuthNetworkPolicy)))
@@ -1069,7 +1052,7 @@ var _ = Describe("The Openshift Notebook controller", func() {
 		It("Should not create routes", func() {
 			routes := &routev1.RouteList{}
 			Eventually(func() error {
-				return cli.List(context.Background(), routes, client.InNamespace(namespace))
+				return cli.List(ctx, routes, client.InNamespace(namespace))
 			}, duration, interval).Should(Succeed())
 
 			Expect(routes.Items).To(BeEmpty())
@@ -1080,7 +1063,7 @@ var _ = Describe("The Openshift Notebook controller", func() {
 
 			serviceAccounts := &corev1.ServiceAccountList{}
 			Eventually(func() error {
-				return cli.List(context.Background(), serviceAccounts, client.InNamespace(namespace))
+				return cli.List(ctx, serviceAccounts, client.InNamespace(namespace))
 			}, duration, interval).Should(Succeed())
 
 			Expect(serviceAccounts.Items).ToNot(ContainElement(oauthServiceAccount))
@@ -1094,7 +1077,7 @@ var _ = Describe("The Openshift Notebook controller", func() {
 				},
 			}
 			Eventually(func() error {
-				return cli.List(context.Background(), secrets, client.InNamespace(namespace))
+				return cli.List(ctx, secrets, client.InNamespace(namespace))
 			}, duration, interval).Should(Succeed())
 
 			Expect(secrets.Items).To(BeEmpty())

components/odh-notebook-controller/controllers/notebook_runtime.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"reflect"
+	"regexp"
 	"strings"
 
 	"github.com/go-logr/logr"
@@ -182,9 +183,12 @@ func extractDisplayName(metadata string) string {
 	return displayName
 }
 
+var multiDash = regexp.MustCompile(`-+`)
+
 func formatKeyName(displayName string) string {
-	replacer := strings.NewReplacer(" ", "-", "(", "", ")", "")
-	return strings.ToLower(replacer.Replace(displayName)) + ".json"
+	s := strings.NewReplacer(" ", "-", "(", "", ")", "", "|", "").Replace(displayName)
+	s = multiDash.ReplaceAllString(strings.ToLower(s), "-")
+	return strings.Trim(s, "-") + ".json"
 }
 
 // parseRuntimeImageMetadata extracts the first object from the JSON array

components/odh-notebook-controller/controllers/notebook_runtime_test.go

@@ -1,7 +1,6 @@
 package controllers
 
 import (
-	"context"
 	"fmt"
 	"time"
 
@@ -27,8 +26,6 @@ const (
 )
 
 var _ = Describe("Runtime images ConfigMap should be mounted", func() {
-	ctx := context.Background()
-
 	When("Empty ConfigMap for runtime images", func() {
 
 		BeforeEach(func() {