Merge pull request #606 from gdbranco/feat/ocm-6030

OCM-6030 | feat: allow to edit component routes of ingress

cmd/ocm/edit/ingress/cmd.go

@@ -20,6 +20,7 @@ import (
 
 	c "github.com/openshift-online/ocm-cli/pkg/cluster"
 	"github.com/openshift-online/ocm-cli/pkg/ocm"
+	"github.com/openshift-online/ocm-cli/pkg/utils"
 	cmv1 "github.com/openshift-online/ocm-sdk-go/clustersmgmt/v1"
 	"github.com/spf13/cobra"
 )
@@ -31,6 +32,15 @@ var ValidWildcardPolicies = []string{string(cmv1.WildcardPolicyWildcardsDisallow
 	string(cmv1.WildcardPolicyWildcardsAllowed)}
 var ValidNamespaceOwnershipPolicies = []string{string(cmv1.NamespaceOwnershipPolicyStrict),
 	string(cmv1.NamespaceOwnershipPolicyInterNamespaceAllowed)}
+var expectedComponentRoutes = []string{
+	string(cmv1.ComponentRouteTypeOauth),
+	string(cmv1.ComponentRouteTypeConsole),
+	string(cmv1.ComponentRouteTypeDownloads),
+}
+var expectedParameters = []string{
+	hostnameParameter,
+	tlsSecretRefParameter,
+}
 
 var args struct {
 	clusterKey    string
@@ -43,6 +53,8 @@ var args struct {
 	namespaceOwnershipPolicy  string
 	clusterRoutesHostname     string
 	clusterRoutesTlsSecretRef string
+
+	componentRoutes string
 }
 
 const (
@@ -55,6 +67,12 @@ const (
 	namespaceOwnershipPolicyFlag  = "namespace-ownership-policy"
 	clusterRoutesHostnameFlag     = "cluster-routes-hostname"
 	clusterRoutesTlsSecretRefFlag = "cluster-routes-tls-secret-ref"
+	componentRoutesFlag           = "component-routes"
+
+	expectedLengthOfParsedComponent = 2
+	hostnameParameter               = "hostname"
+	//nolint:gosec
+	tlsSecretRefParameter = "tlsSecretRef"
 )
 
 var Cmd = &cobra.Command{
@@ -139,14 +157,23 @@ func init() {
 		&args.clusterRoutesHostname,
 		clusterRoutesHostnameFlag,
 		"",
-		"Components route hostname for oauth, console, download.",
+		"Components route hostname for oauth, console, downloads.",
 	)
 
 	flags.StringVar(
 		&args.clusterRoutesTlsSecretRef,
 		clusterRoutesTlsSecretRefFlag,
 		"",
-		"Components route TLS secret reference for oauth, console, download.",
+		"Components route TLS secret reference for oauth, console, downloads.",
+	)
+
+	flags.StringVar(
+		&args.componentRoutes,
+		componentRoutesFlag,
+		"",
+		//nolint:lll
+		"Component routes settings. Available keys [oauth, console, downloads]. For each key a pair of hostname and tlsSecretRef is expected to be supplied. "+
+			"Format should be a comma separate list 'oauth: hostname=example-hostname;tlsSecretRef=example-secret-ref,downloads:...",
 	)
 }
 
@@ -284,6 +311,17 @@ func run(cmd *cobra.Command, argv []string) error {
 		ingressBuilder = ingressBuilder.ClusterRoutesTlsSecretRef(args.clusterRoutesTlsSecretRef)
 	}
 
+	if cmd.Flags().Changed(componentRoutesFlag) {
+		if cluster.Hypershift().Enabled() {
+			return fmt.Errorf("Can't edit `%s` for Hosted Control Plane clusters", componentRoutesFlag)
+		}
+		componentRoutes, err := parseComponentRoutes(args.componentRoutes)
+		if err != nil {
+			return fmt.Errorf("An error occurred whilst parsing the supplied component routes: %s", err)
+		}
+		ingressBuilder = ingressBuilder.ComponentRoutes(componentRoutes)
+	}
+
 	ingress, err = ingressBuilder.Build()
 	if err != nil {
 		return fmt.Errorf("Failed to edit ingress for cluster '%s': %v", clusterKey, err)
@@ -302,6 +340,66 @@ func run(cmd *cobra.Command, argv []string) error {
 	return nil
 }
 
+func parseComponentRoutes(input string) (map[string]*cmv1.ComponentRouteBuilder, error) {
+	result := map[string]*cmv1.ComponentRouteBuilder{}
+	input = strings.TrimSpace(input)
+	components := strings.Split(input, ",")
+	if len(components) != len(expectedComponentRoutes) {
+		return nil, fmt.Errorf(
+			"the expected amount of component routes is %d, but %d have been supplied",
+			len(expectedComponentRoutes),
+			len(components),
+		)
+	}
+	for _, component := range components {
+		component = strings.TrimSpace(component)
+		parsedComponent := strings.Split(component, ":")
+		if len(parsedComponent) != expectedLengthOfParsedComponent {
+			return nil, fmt.Errorf(
+				"only the name of the component should be followed by ':'",
+			)
+		}
+		componentName := strings.TrimSpace(parsedComponent[0])
+		if !utils.Contains(expectedComponentRoutes, componentName) {
+			return nil, fmt.Errorf(
+				"'%s' is not a valid component name. Expected include %s",
+				componentName,
+				utils.SliceToSortedString(expectedComponentRoutes),
+			)
+		}
+		parameters := strings.TrimSpace(parsedComponent[1])
+		componentRouteBuilder := new(cmv1.ComponentRouteBuilder)
+		parsedParameter := strings.Split(parameters, ";")
+		if len(parsedParameter) != len(expectedParameters) {
+			return nil, fmt.Errorf(
+				"only %d parameters are expected for each component",
+				len(expectedParameters),
+			)
+		}
+		for _, values := range parsedParameter {
+			values = strings.TrimSpace(values)
+			parsedValues := strings.Split(values, "=")
+			parameterName := strings.TrimSpace(parsedValues[0])
+			if !utils.Contains(expectedParameters, parameterName) {
+				return nil, fmt.Errorf(
+					"'%s' is not a valid parameter for a component route. Expected include %s",
+					parameterName,
+					utils.SliceToSortedString(expectedParameters),
+				)
+			}
+			parameterValue := strings.TrimSpace(parsedValues[1])
+			// TODO: use reflection, couldn't get it to work
+			if parameterName == hostnameParameter {
+				componentRouteBuilder.Hostname(parameterValue)
+			} else if parameterName == tlsSecretRefParameter {
+				componentRouteBuilder.TlsSecretRef(parameterValue)
+			}
+		}
+		result[componentName] = componentRouteBuilder
+	}
+	return result, nil
+}
+
 func GetExcludedNamespaces(excludedNamespaces string) []string {
 	if excludedNamespaces == "" {
 		return []string{}

cmd/ocm/edit/ingress/cmd_test.go

@@ -0,0 +1,78 @@
+package ingress
+
+import (
+	"fmt"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("Parse component routes", func() {
+	It("Parses input string for component routes", func() {
+		componentRouteBuilder, err := parseComponentRoutes(
+			//nolint:lll
+			"oauth: hostname=oauth-host;tlsSecretRef=oauth-secret,downloads: hostname=downloads-host;tlsSecretRef=downloads-secret,console: hostname=console-host;tlsSecretRef=console-secret",
+		)
+		Expect(err).To(BeNil())
+		for key, builder := range componentRouteBuilder {
+			expectedHostname := fmt.Sprintf("%s-host", key)
+			expectedTlsRef := fmt.Sprintf("%s-secret", key)
+			componentRoute, err := builder.Build()
+			Expect(err).To(BeNil())
+			Expect(componentRoute.Hostname()).To(Equal(expectedHostname))
+			Expect(componentRoute.TlsSecretRef()).To(Equal(expectedTlsRef))
+		}
+	})
+	Context("Fails to parse input string for component routes", func() {
+		It("fails due to invalid component route", func() {
+			_, err := parseComponentRoutes(
+				//nolint:lll
+				"unknown: hostname=oauth-host;tlsSecretRef=oauth-secret,downloads: hostname=downloads-host;tlsSecretRef=downloads-secret,console: hostname=console-host;tlsSecretRef=console-secret",
+			)
+			Expect(err).ToNot(BeNil())
+			Expect(
+				err.Error(),
+			).To(Equal("'unknown' is not a valid component name. Expected include [oauth, console, downloads]"))
+		})
+		It("fails due to wrong amount of component routes", func() {
+			_, err := parseComponentRoutes(
+				//nolint:lll
+				"oauth: hostname=oauth-host;tlsSecretRef=oauth-secret,downloads: hostname=downloads-host;tlsSecretRef=downloads-secret",
+			)
+			Expect(err).ToNot(BeNil())
+			Expect(
+				err.Error(),
+			).To(Equal("the expected amount of component routes is 3, but 2 have been supplied"))
+		})
+		It("fails if it can split ':' in more than they key separation", func() {
+			_, err := parseComponentRoutes(
+				//nolint:lll
+				"oauth: hostname=oauth:-host;tlsSecretRef=oauth-secret,downloads: hostname=downloads-host;tlsSecretRef=downloads-secret,",
+			)
+			Expect(err).ToNot(BeNil())
+			Expect(
+				err.Error(),
+			).To(Equal("only the name of the component should be followed by ':'"))
+		})
+		It("fails due to invalid parameter", func() {
+			_, err := parseComponentRoutes(
+				//nolint:lll
+				"oauth: unknown=oauth-host;tlsSecretRef=oauth-secret,downloads: hostname=downloads-host;tlsSecretRef=downloads-secret,console: hostname=console-host;tlsSecretRef=console-secret",
+			)
+			Expect(err).ToNot(BeNil())
+			Expect(
+				err.Error(),
+			).To(Equal("'unknown' is not a valid parameter for a component route. Expected include [hostname, tlsSecretRef]"))
+		})
+		It("fails due to wrong amount of parameters", func() {
+			_, err := parseComponentRoutes(
+				//nolint:lll
+				"oauth: hostname=oauth-host,downloads: hostname=downloads-host;tlsSecretRef=downloads-secret,console: hostname=console-host;tlsSecretRef=console-secret",
+			)
+			Expect(err).ToNot(BeNil())
+			Expect(
+				err.Error(),
+			).To(Equal("only 2 parameters are expected for each component"))
+		})
+	})
+})

cmd/ocm/edit/ingress/main_test.go

@@ -0,0 +1,13 @@
+package ingress
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestEditCluster(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Edit ingress suite")
+}

go.mod

@@ -12,7 +12,7 @@ require (
 	github.com/nwidger/jsoncolor v0.3.2
 	github.com/onsi/ginkgo/v2 v2.11.0
 	github.com/onsi/gomega v1.27.8
-	github.com/openshift-online/ocm-sdk-go v0.1.405
+	github.com/openshift-online/ocm-sdk-go v0.1.407
 	github.com/openshift/rosa v1.2.24
 	github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8
 	github.com/spf13/cobra v1.7.0

go.sum

@@ -312,8 +312,8 @@ github.com/onsi/ginkgo/v2 v2.11.0 h1:WgqUCUt/lT6yXoQ8Wef0fsNn5cAuMK7+KT9UFRz2tcU
 github.com/onsi/ginkgo/v2 v2.11.0/go.mod h1:ZhrRA5XmEE3x3rhlzamx/JJvujdZoJ2uvgI7kR0iZvM=
 github.com/onsi/gomega v1.27.8 h1:gegWiwZjBsf2DgiSbf5hpokZ98JVDMcWkUiigk6/KXc=
 github.com/onsi/gomega v1.27.8/go.mod h1:2J8vzI/s+2shY9XHRApDkdgPo1TKT7P2u6fXeJKFnNQ=
-github.com/openshift-online/ocm-sdk-go v0.1.405 h1:ozU85KTekcp6Qhsu7zwicjB03k1W0uslRbrkF1ctLSg=
-github.com/openshift-online/ocm-sdk-go v0.1.405/go.mod h1:zeh3RU78O6HVpiUhwXRNcF3FmiaSP4SeqoQAzow0vZE=
+github.com/openshift-online/ocm-sdk-go v0.1.407 h1:KAeTfpG4I3QWiDThJD3VBAi4APuVwlnouBFAeWJ7tHI=
+github.com/openshift-online/ocm-sdk-go v0.1.407/go.mod h1:8ECJertR5BiblaX5f2siXHXpi+ydYZjoROlVMppmmV4=
 github.com/openshift/rosa v1.2.24 h1:vv0yYnWHx6CCPEAau/0rS54P2ksaf+uWXb1TQPWxiYE=
 github.com/openshift/rosa v1.2.24/go.mod h1:MVXB27O3PF8WoOic23I03mmq6/9kVxpFx6FKyLMCyrQ=
 github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8 h1:KoWmjvw+nsYOo29YJK9vDA65RGE3NrOnUtO7a+RF9HU=

pkg/utils/main_test.go

@@ -0,0 +1,13 @@
+package utils
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestEditCluster(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Utils suite")
+}

pkg/utils/slices.go

@@ -0,0 +1,13 @@
+package utils
+
+import "reflect"
+
+func Contains[T comparable](slice []T, element T) bool {
+	for _, sliceElement := range slice {
+		if reflect.DeepEqual(sliceElement, element) {
+			return true
+		}
+	}
+
+	return false
+}

pkg/utils/slices_test.go

@@ -0,0 +1,22 @@
+package utils
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("Slices", func() {
+	Context("Validates Contains", func() {
+		It("Return false when input is empty", func() {
+			Expect(false).To(Equal(Contains([]string{}, "any")))
+		})
+
+		It("Return true when input is populated and present", func() {
+			Expect(true).To(Equal(Contains([]string{"test", "any"}, "any")))
+		})
+
+		It("Return false when input is populated and not present", func() {
+			Expect(false).To(Equal(Contains([]string{"test", "any"}, "none")))
+		})
+	})
+})

pkg/utils/strings.go

@@ -0,0 +1,24 @@
+package utils
+
+import (
+	"sort"
+	"strings"
+)
+
+func SliceToSortedString(s []string) string {
+	if len(s) == 0 {
+		return ""
+	}
+	SortStringRespectLength(s)
+	return "[" + strings.Join(s, ", ") + "]"
+}
+
+func SortStringRespectLength(s []string) {
+	sort.Slice(s, func(i, j int) bool {
+		l1, l2 := len(s[i]), len(s[j])
+		if l1 != l2 {
+			return l1 < l2
+		}
+		return s[i] < s[j]
+	})
+}

pkg/utils/strings_test.go

@@ -0,0 +1,18 @@
+package utils
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("Validates SliceToSortedString", func() {
+	It("Empty when slice is empty", func() {
+		s := SliceToSortedString([]string{})
+		Expect("").To(Equal(s))
+	})
+
+	It("Sorted when slice is filled", func() {
+		s := SliceToSortedString([]string{"b", "a", "c", "a10", "a1", "a20", "a2", "1", "2", "10", "20"})
+		Expect("[1, 2, a, b, c, 10, 20, a1, a2, a10, a20]").To(Equal(s))
+	})
+})