Replace slash and period with underscore for label names

pkg/logging/labels.go

@@ -1,15 +1,44 @@
 package logging
 
 import (
+	"fmt"
+	"strings"
+
 	"github.com/go-logr/logr"
 )
 
 // WithLabels decorates a logr.Logger so that any log entries contain all
 // labels which keys are prefix by labelKeyPrefix
 func WithLabels(logger logr.Logger, labels map[string]string, labelKeyPrefix string) logr.Logger {
 	for key, value := range labels {
-		logger = logger.WithValues(labelKeyPrefix+key, value)
+		logger = logger.WithValues(
+			fmt.Sprintf(
+				"%s%s",
+				labelKeyPrefix,
+				linearLabelKey(key),
+			),
+			value,
+		)
 	}
 
 	return logger
 }
+
+// linearLabelKey reduces a given label key to a linear form such that
+// an incoming label key will have underscores in place of periods and
+// forward slashes. This does have the potential to have multiple keys
+// map down onto a single key. This is not likely to occur, and is
+// likely avoidable for most installations.
+//
+// This behaviour matches the behaviour seen in some other systems
+// such as Prometheus where labels are reduced to a alphanumeric
+// string with underscore spacers.
+//
+// e.g. app.kubernetes.io/instance would become
+// app_kubernetes_io_instance
+func linearLabelKey(labelKey string) string {
+	labelKey = strings.ReplaceAll(labelKey, "/", "_")
+	labelKey = strings.ReplaceAll(labelKey, ".", "_")
+
+	return labelKey
+}

pkg/workloads/console/runner/integration/integration_test.go

@@ -27,6 +27,10 @@ func newNamespace(name string) corev1.Namespace {
 	}
 }
 
+const (
+	shortTimeout time.Duration = 30 * time.Millisecond
+)
+
 func newConsoleTemplate(namespace, name string, labels map[string]string) workloadsv1alpha1.ConsoleTemplate {
 	return workloadsv1alpha1.ConsoleTemplate{
 		ObjectMeta: metav1.ObjectMeta{
@@ -276,7 +280,7 @@ var _ = Describe("Runner", func() {
 
 		Context("When console phase is Pending", func() {
 			It("Fails with a timeout waiting", func() {
-				ctx, cancel := context.WithTimeout(context.Background(), 10*time.Millisecond)
+				ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
 				defer cancel()
 				_, err := consoleRunner.WaitUntilReady(ctx, console, true)
 
@@ -431,7 +435,7 @@ var _ = Describe("Runner", func() {
 					rb.Subjects = nil
 					mustCreateRoleBinding(rb)
 
-					ctx, cancel := context.WithTimeout(context.Background(), 10*time.Millisecond)
+					ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
 					defer cancel()
 					_, err := consoleRunner.WaitUntilReady(ctx, csl, true)
 
@@ -482,7 +486,7 @@ var _ = Describe("Runner", func() {
 						},
 					)
 
-					ctx, cancel := context.WithTimeout(context.Background(), 10*time.Millisecond)
+					ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
 					defer cancel()
 					_, err := consoleRunner.WaitUntilReady(ctx, csl, true)