Merge all the proxy install and upgrade flags into a single struct

In order to share code and bring consistency to the code, use a single structure for all the common proxy install and upgrade flags. The structs for Kubernetes flags are also merged into one.
uyuni-project · Nov 13, 2024 · 2a9f8f0 · 2a9f8f0
1 parent a24cc43
commit 2a9f8f0
Show file tree

Hide file tree

Showing 13 changed files with 38 additions and 38 deletions.
diff --git a/mgrpxy/cmd/install/kubernetes/kubernetes.go b/mgrpxy/cmd/install/kubernetes/kubernetes.go
@@ -13,13 +13,7 @@ import (
 	"github.com/uyuni-project/uyuni-tools/shared/utils"
 )
 
-type kubernetesProxyInstallFlags struct {
-	pxy_utils.ProxyImageFlags `mapstructure:",squash"`
-	Helm                      kubernetes.HelmFlags
-	SCC                       types.SCCCredentials
-}
-
-func newCmd(globalFlags *types.GlobalFlags, run utils.CommandFunc[kubernetesProxyInstallFlags]) *cobra.Command {
+func newCmd(globalFlags *types.GlobalFlags, run utils.CommandFunc[kubernetes.ProxyFlags]) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "kubernetes [path/to/config.tar.gz]",
 		Short: L("Install a new proxy on a running kubernetes cluster"),
@@ -34,7 +28,7 @@ NOTE: for now installing on a remote kubernetes cluster is not supported!
 `),
 		Args: cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
-			var flags kubernetesProxyInstallFlags
+			var flags kubernetes.ProxyFlags
 			return utils.CommandHelper(globalFlags, cmd, args, &flags, nil, run)
 		},
 	}

diff --git a/mgrpxy/cmd/install/kubernetes/kubernetes_test.go b/mgrpxy/cmd/install/kubernetes/kubernetes_test.go
@@ -8,6 +8,7 @@ import (
 	"testing"
 
 	"github.com/spf13/cobra"
+	"github.com/uyuni-project/uyuni-tools/mgrpxy/shared/kubernetes"
 	"github.com/uyuni-project/uyuni-tools/shared/testutils"
 	"github.com/uyuni-project/uyuni-tools/shared/testutils/flagstests"
 	"github.com/uyuni-project/uyuni-tools/shared/types"
@@ -23,8 +24,8 @@ func TestParamsParsing(t *testing.T) {
 	args = append(args, flagstests.SCCFlagTestArgs...)
 
 	// Test function asserting that the args are properly parsed
-	tester := func(globalFlags *types.GlobalFlags, flags *kubernetesProxyInstallFlags,
-		cmd *cobra.Command, args []string,
+	tester := func(_ *types.GlobalFlags, flags *kubernetes.ProxyFlags,
+		cmd *cobra.Command, _ []string,
 	) error {
 		flagstests.AssertProxyImageFlags(t, cmd, &flags.ProxyImageFlags)
 		flagstests.AssertProxyHelmFlags(t, cmd, &flags.Helm)

diff --git a/mgrpxy/cmd/install/kubernetes/utils.go b/mgrpxy/cmd/install/kubernetes/utils.go
@@ -19,7 +19,7 @@ import (
 )
 
 func installForKubernetes(globalFlags *types.GlobalFlags,
-	flags *kubernetesProxyInstallFlags, cmd *cobra.Command, args []string,
+	flags *kubernetes.ProxyFlags, cmd *cobra.Command, args []string,
 ) error {
 	for _, binary := range []string{"kubectl", "helm"} {
 		if _, err := exec.LookPath(binary); err != nil {
@@ -28,6 +28,7 @@ func installForKubernetes(globalFlags *types.GlobalFlags,
 	}
 
 	// Unpack the tarball
+	// This would not be in an operator as the configuration would be expected to be set up before.
 	configPath := utils.GetConfigPath(args)
 
 	tmpDir, cleaner, err := shared_utils.TempDir()
@@ -47,6 +48,7 @@ func installForKubernetes(globalFlags *types.GlobalFlags,
 	}
 
 	// If installing on k3s, install the traefik helm config in manifests
+	// In an operator, this would be delegated to the cluster admin.
 	isK3s := clusterInfos.IsK3s()
 	IsRke2 := clusterInfos.IsRke2()
 	ports := shared_utils.GetProxyPorts()

diff --git a/mgrpxy/cmd/support/ptf/kubernetes/kubernetes.go b/mgrpxy/cmd/support/ptf/kubernetes/kubernetes.go
@@ -14,11 +14,7 @@ import (
 	"github.com/uyuni-project/uyuni-tools/shared/utils"
 )
 
-type kubernetesPTFFlags struct {
-	UpgradeFlags kubernetes.KubernetesProxyUpgradeFlags `mapstructure:",squash"`
-}
-
-func newCmd(globalFlags *types.GlobalFlags, run utils.CommandFunc[kubernetesPTFFlags]) *cobra.Command {
+func newCmd(globalFlags *types.GlobalFlags, run utils.CommandFunc[kubernetes.ProxyFlags]) *cobra.Command {
 	kubernetesCmd := &cobra.Command{
 		Use:   "kubernetes",
 		Short: L("Install a PTF or Test package on a kubernetes cluster"),
@@ -35,7 +31,7 @@ NOTE: installing on a remote cluster is not supported yet!
 
 		Args: cobra.MaximumNArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
-			var flags kubernetesPTFFlags
+			var flags kubernetes.ProxyFlags
 			return utils.CommandHelper(globalFlags, cmd, args, &flags, nil, run)
 		},
 	}

diff --git a/mgrpxy/cmd/support/ptf/kubernetes/kubernetes_test.go b/mgrpxy/cmd/support/ptf/kubernetes/kubernetes_test.go
@@ -9,6 +9,7 @@ import (
 	"testing"
 
 	"github.com/spf13/cobra"
+	"github.com/uyuni-project/uyuni-tools/mgrpxy/shared/kubernetes"
 	"github.com/uyuni-project/uyuni-tools/shared/testutils"
 	"github.com/uyuni-project/uyuni-tools/shared/testutils/flagstests"
 	"github.com/uyuni-project/uyuni-tools/shared/types"
@@ -21,11 +22,11 @@ func TestParamsParsing(t *testing.T) {
 	args = append(args, flagstests.ProxyHelmFlagsTestArgs...)
 
 	// Test function asserting that the args are properly parsed
-	tester := func(globalFlags *types.GlobalFlags, flags *kubernetesPTFFlags,
-		cmd *cobra.Command, args []string,
+	tester := func(_ *types.GlobalFlags, flags *kubernetes.ProxyFlags,
+		cmd *cobra.Command, _ []string,
 	) error {
-		flagstests.AssertProxyImageFlags(t, cmd, &flags.UpgradeFlags.ProxyImageFlags)
-		flagstests.AssertProxyHelmFlags(t, cmd, &flags.UpgradeFlags.Helm)
+		flagstests.AssertProxyImageFlags(t, cmd, &flags.ProxyImageFlags)
+		flagstests.AssertProxyHelmFlags(t, cmd, &flags.Helm)
 		return nil
 	}
 

diff --git a/mgrpxy/cmd/support/ptf/kubernetes/utils.go b/mgrpxy/cmd/support/ptf/kubernetes/utils.go
@@ -12,9 +12,9 @@ import (
 )
 
 func ptfForKubernetes(globalFlags *types.GlobalFlags,
-	flags *kubernetesPTFFlags,
+	flags *kubernetes.ProxyFlags,
 	cmd *cobra.Command,
 	args []string,
 ) error {
-	return kubernetes.Upgrade(&flags.UpgradeFlags, cmd, args)
+	return kubernetes.Upgrade(flags, cmd, args)
 }
diff --git a/mgrpxy/cmd/upgrade/kubernetes/kubernetes.go b/mgrpxy/cmd/upgrade/kubernetes/kubernetes.go
@@ -15,7 +15,7 @@ import (
 
 func newCmd(
 	globalFlags *types.GlobalFlags,
-	run utils.CommandFunc[kubernetes.KubernetesProxyUpgradeFlags],
+	run utils.CommandFunc[kubernetes.ProxyFlags],
 ) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "kubernetes",
@@ -28,7 +28,7 @@ NOTE: for now upgrading on a remote kubernetes cluster is not supported!
 `),
 		Args: cobra.ExactArgs(0),
 		RunE: func(cmd *cobra.Command, args []string) error {
-			var flags kubernetes.KubernetesProxyUpgradeFlags
+			var flags kubernetes.ProxyFlags
 			return utils.CommandHelper(globalFlags, cmd, args, &flags, nil, run)
 		},
 	}

diff --git a/mgrpxy/cmd/upgrade/kubernetes/kubernetes_test.go b/mgrpxy/cmd/upgrade/kubernetes/kubernetes_test.go
@@ -22,8 +22,8 @@ func TestParamsParsing(t *testing.T) {
 	args = append(args, flagstests.ProxyHelmFlagsTestArgs...)
 
 	// Test function asserting that the args are properly parsed
-	tester := func(globalFlags *types.GlobalFlags, flags *kubernetes.KubernetesProxyUpgradeFlags,
-		cmd *cobra.Command, args []string,
+	tester := func(_ *types.GlobalFlags, flags *kubernetes.ProxyFlags,
+		cmd *cobra.Command, _ []string,
 	) error {
 		flagstests.AssertProxyImageFlags(t, cmd, &flags.ProxyImageFlags)
 		flagstests.AssertProxyHelmFlags(t, cmd, &flags.Helm)

diff --git a/mgrpxy/cmd/upgrade/kubernetes/utils.go b/mgrpxy/cmd/upgrade/kubernetes/utils.go
@@ -11,7 +11,7 @@ import (
 )
 
 func upgradeKubernetes(globalFlags *types.GlobalFlags,
-	flags *kubernetes.KubernetesProxyUpgradeFlags, cmd *cobra.Command, args []string,
+	flags *kubernetes.ProxyFlags, cmd *cobra.Command, args []string,
 ) error {
 	return kubernetes.Upgrade(flags, cmd, args)
 }
diff --git a/mgrpxy/shared/kubernetes/cmd.go b/mgrpxy/shared/kubernetes/cmd.go
@@ -8,11 +8,18 @@ import (
 	"fmt"
 
 	"github.com/spf13/cobra"
+	pxy_utils "github.com/uyuni-project/uyuni-tools/mgrpxy/shared/utils"
 	. "github.com/uyuni-project/uyuni-tools/shared/l10n"
 	"github.com/uyuni-project/uyuni-tools/shared/types"
 	"github.com/uyuni-project/uyuni-tools/shared/utils"
 )
 
+// ProxyFlags is storing all the kubernetes install and upgrade flags for the proxy.
+type ProxyFlags struct {
+	pxy_utils.ProxyFlags `mapstructure:",squash"`
+	Helm                 HelmFlags
+}
+
 // HelmFlags it's used for helm chart flags.
 type HelmFlags struct {
 	Proxy types.ChartFlags

diff --git a/mgrpxy/shared/kubernetes/deploy.go b/mgrpxy/shared/kubernetes/deploy.go
@@ -21,12 +21,6 @@ import (
 
 const helmAppName = "uyuni-proxy"
 
-// KubernetesProxyUpgradeFlags represents the flags for the mgrpxy upgrade kubernetes command.
-type KubernetesProxyUpgradeFlags struct {
-	utils.ProxyImageFlags `mapstructure:",squash"`
-	Helm                  HelmFlags
-}
-
 // Deploy will deploy proxy in kubernetes.
 func Deploy(imageFlags *utils.ProxyImageFlags, helmFlags *HelmFlags, configDir string,
 	kubeconfig string, helmArgs ...string,
@@ -146,7 +140,7 @@ func getConfigYaml(directory string) (string, error) {
 }
 
 // Upgrade will upgrade the current kubernetes proxy.
-func Upgrade(flags *KubernetesProxyUpgradeFlags, cmd *cobra.Command, args []string,
+func Upgrade(flags *ProxyFlags, cmd *cobra.Command, args []string,
 ) error {
 	for _, binary := range []string{"kubectl", "helm"} {
 		if _, err := exec.LookPath(binary); err != nil {

diff --git a/mgrpxy/shared/podman/podman.go b/mgrpxy/shared/podman/podman.go
@@ -25,9 +25,8 @@ import (
 
 // PodmanProxyFlags are the flags used by podman proxy install and upgrade command.
 type PodmanProxyFlags struct {
-	utils.ProxyImageFlags `mapstructure:",squash"`
-	SCC                   types.SCCCredentials
-	Podman                podman.PodmanFlags
+	utils.ProxyFlags `mapstructure:",squash"`
+	Podman           podman.PodmanFlags
 }
 
 // GenerateSystemdService generates all the systemd files required by proxy.

diff --git a/mgrpxy/shared/utils/flags.go b/mgrpxy/shared/utils/flags.go
@@ -15,6 +15,12 @@ import (
 	"github.com/uyuni-project/uyuni-tools/shared/utils"
 )
 
+// ProxyFlags is the object holding all the common proxy installation and upgrade flags.
+type ProxyFlags struct {
+	ProxyImageFlags `mapstructure:",squash"`
+	SCC             types.SCCCredentials
+}
+
 // ProxyImageFlags are the flags used by install proxy command.
 type ProxyImageFlags struct {
 	Registry   string           `mapstructure:"registry"`