Make cluster type overwritable, e.g. for testing purposes

Author: Moritz Clasmeier

cmd/deploy.go

@@ -347,11 +347,15 @@ func runDeploy(cmd *cobra.Command, args []string) error {
 }
 
 func configureConfig(log *logger.Logger, components component.Component, deploySettings *deployer.Config) error {
-	clusterType := env.GetCurrentClusterType()
-	log.Dimf("Detected cluster type: %v", clusterType)
-	defaults, err := clusterdefaults.ApplyClusterDefaults(clusterType, deploySettings)
+	if deploySettings.Roxie.ClusterType == types.ClusterTypeUnknown {
+		clusterType := env.GetCurrentClusterType()
+		log.Dimf("Detected cluster type: %v", clusterType)
+		deploySettings.Roxie.ClusterType = clusterType
+	}
+	clusterType := deploySettings.Roxie.ClusterType
+	defaults, err := clusterdefaults.ApplyClusterDefaults(deploySettings)
 	if err != nil {
-		return fmt.Errorf("applying defaults for cluster type %v: %w", clusterType, err)
+		return err
 	}
 	if verbose {
 		log.Dimf("Applying the following defaults based on detected cluster type %v:", clusterType)
@@ -409,6 +413,8 @@ func deployValidate(components component.Component, deploySettings *deployer.Con
 		return errors.New("running without a controlling terminal requires --envrc to be set")
 	}
 
+	clusterType := deploySettings.Roxie.ClusterType
+
 	if env.RunningInRoxieContainer {
 		// For running containerized we have specific requirements.
 		if deploySettings.Central.PortForwardingEnabled() {
@@ -419,7 +425,7 @@ func deployValidate(components component.Component, deploySettings *deployer.Con
 		}
 
 		// On infra OpenShift we already get image pull secrets for Quay automatically.
-		if clusterType := env.GetCurrentClusterType(); clusterType != types.ClusterTypeInfraOpenShift4 {
+		if clusterType != types.ClusterTypeInfraOpenShift4 {
 			if os.Getenv("REGISTRY_USERNAME") == "" || os.Getenv("REGISTRY_PASSWORD") == "" {
 				return fmt.Errorf("containerized mode requires REGISTRY_USERNAME and REGISTRY_PASSWORD environment variables for clusters of type %s", clusterType)
 			}
@@ -437,7 +443,6 @@ func deployValidate(components component.Component, deploySettings *deployer.Con
 		if deploySettings.Operator.DeployViaOlm {
 			return errors.New("using Konflux images while deploying operator via OLM is not supported")
 		}
-		clusterType := env.GetCurrentClusterType()
 		if !clusterType.IsOpenShift() {
 			return fmt.Errorf("--konflux flag is only supported on OpenShift 4 clusters (current cluster type: %s)", clusterType.String())
 		}

internal/clusterdefaults/clusterdefaults.go

@@ -13,12 +13,12 @@ import (
 // provided deployer.Config.
 // Returns *just* the assembled defaults for the given cluster type for logging purposes.
 func ApplyClusterDefaults(
-	clusterType types.ClusterType,
 	config *deployer.Config,
 ) (*deployer.Config, error) {
 	if config == nil {
 		panic("applying cluster defaults to nil config")
 	}
+	clusterType := config.Roxie.ClusterType
 	defaults := getDefaultsForClusterType(clusterType)
 	if defaults == nil {
 		return nil, nil
@@ -27,11 +27,11 @@ func ApplyClusterDefaults(
 	// Make a copy.
 	defaultsCopy, err := defaults.DeepCopy()
 	if err != nil {
-		return nil, fmt.Errorf("deep-copying cluster defaults: %w", err)
+		return nil, fmt.Errorf("deep-copying cluster defaults for cluster type %s: %w", clusterType, err)
 	}
 
 	if err := mergo.Merge(config, defaultsCopy, mergo.WithoutDereference); err != nil {
-		return nil, fmt.Errorf("merging-in cluster defaults: %w", err)
+		return nil, fmt.Errorf("merging-in cluster defaults for cluster type %s: %w", clusterType, err)
 	}
 
 	return defaultsCopy, nil

internal/clusterdefaults/clusterdefaults_test.go

@@ -113,7 +113,8 @@ func TestClusterDefaults(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			config := tt.config
-			_, err := ApplyClusterDefaults(tt.clusterType, &config)
+			config.Roxie.ClusterType = tt.clusterType
+			_, err := ApplyClusterDefaults(&config)
 			require.NoError(t, err)
 
 			if tt.wantConfig.Central.Exposure == nil {

internal/deployer/config.go

@@ -44,9 +44,10 @@ func (c *Config) DeepCopy() (*Config, error) {
 
 // RoxieConfig holds roxie-level settings such as version and feature flags.
 type RoxieConfig struct {
-	Version       string          `yaml:"version,omitempty"`
-	KonfluxImages bool            `yaml:"konfluxImages,omitempty"`
-	FeatureFlags  map[string]bool `yaml:"featureFlags,omitempty"`
+	Version       string            `yaml:"version,omitempty"`
+	KonfluxImages bool              `yaml:"konfluxImages,omitempty"`
+	FeatureFlags  map[string]bool   `yaml:"featureFlags,omitempty"`
+	ClusterType   types.ClusterType `yaml:"clusterType,omitempty"`
 }
 
 // NewRoxieConfig returns a RoxieConfig with initialized defaults.

internal/deployer/deploy_via_operator.go

@@ -119,7 +119,7 @@ func (d *Deployer) ensureOperatorDeployed(ctx context.Context) error {
 func (d *Deployer) deployCentralOperator(ctx context.Context) error {
 	d.logger.Info("🚀 Deploying Central via Operator...")
 
-	needPullSecrets := env.GetCurrentClusterType() != types.ClusterTypeInfraOpenShift4
+	needPullSecrets := d.config.Roxie.ClusterType != types.ClusterTypeInfraOpenShift4
 	if err := d.prepareNamespace(ctx, d.config.Central.Namespace, needPullSecrets); err != nil {
 		return fmt.Errorf("failed to prepare namespace: %w", err)
 	}
@@ -655,7 +655,7 @@ func (d *Deployer) configureCentralEndpoint(ctx context.Context) error {
 func (d *Deployer) deploySecuredClusterOperator(ctx context.Context) error {
 	d.logger.Info("🚀 Deploying SecuredCluster via Operator...")
 
-	needPullSecrets := env.GetCurrentClusterType() != types.ClusterTypeInfraOpenShift4
+	needPullSecrets := d.config.Roxie.ClusterType != types.ClusterTypeInfraOpenShift4
 	if err := d.prepareNamespace(ctx, d.config.SecuredCluster.Namespace, needPullSecrets); err != nil {
 		return fmt.Errorf("failed to prepare namespace: %w", err)
 	}

internal/deployer/deployer.go

@@ -298,7 +298,7 @@ func (d *Deployer) stopDetachedPortForward() {
 // Deploy deploys the specified components to the cluster.
 func (d *Deployer) Deploy(ctx context.Context, components component.Component) error {
 	// Prepare and verify credentials early to fail fast.
-	if env.GetCurrentClusterType() != types.ClusterTypeInfraOpenShift4 {
+	if d.config.Roxie.ClusterType != types.ClusterTypeInfraOpenShift4 {
 		if err := d.prepareCredentials(); err != nil {
 			return fmt.Errorf("failed to prepare credentials: %w", err)
 		}
@@ -778,7 +778,7 @@ func (d *Deployer) PrintCentralDeploymentSummary() {
 
 	// Deployment details
 	log.Info(cyan.Sprint("│") + createRow("Component", component))
-	log.Info(cyan.Sprint("│") + createRow("Cluster Type", env.GetCurrentClusterType().String()))
+	log.Info(cyan.Sprint("│") + createRow("Cluster Type", d.config.Roxie.ClusterType.String()))
 	log.Info(cyan.Sprint("│") + createRow("Main Tag", mainImageTag))
 	log.Info(cyan.Sprint("│") + createRow("Kubernetes Context", kubeContext))
 
@@ -957,7 +957,7 @@ func (d *Deployer) PrintSecuredClusterDeploymentSummary() {
 
 	// Deployment details
 	log.Info(cyan.Sprint("│") + createRow("Component", component))
-	log.Info(cyan.Sprint("│") + createRow("Cluster Type", env.GetCurrentClusterType().String()))
+	log.Info(cyan.Sprint("│") + createRow("Cluster Type", d.config.Roxie.ClusterType.String()))
 	log.Info(cyan.Sprint("│") + createRow("Main Tag", mainImageTag))
 	log.Info(cyan.Sprint("│") + createRow("Kubernetes Context", kubeContext))
 

internal/deployer/operator.go

@@ -14,7 +14,6 @@ import (
 
 	"gopkg.in/yaml.v3"
 
-	"github.com/stackrox/roxie/internal/env"
 	"github.com/stackrox/roxie/internal/k8s"
 	"github.com/stackrox/roxie/internal/ocihelper"
 	"github.com/stackrox/roxie/internal/types"
@@ -202,7 +201,7 @@ func (d *Deployer) getOperatorBundleImage() string {
 
 // ensureKonfluxImageRewriting configures image rewriting for Konflux images
 func (d *Deployer) ensureKonfluxImageRewriting(ctx context.Context) error {
-	if !env.GetCurrentClusterType().IsOpenShift() {
+	if !d.config.Roxie.ClusterType.IsOpenShift() {
 		return errors.New("image rewriting for Konflux is only supported on OpenShift4 clusters")
 	}
 
@@ -290,7 +289,7 @@ func (d *Deployer) applyImageContentSourcePolicy(ctx context.Context) error {
 
 // removeKonfluxImageRewriting removes the ImageContentSourcePolicy for Konflux images if it exists
 func (d *Deployer) removeKonfluxImageRewriting(ctx context.Context) error {
-	if !env.GetCurrentClusterType().IsOpenShift() {
+	if !d.config.Roxie.ClusterType.IsOpenShift() {
 		return nil
 	}
 
@@ -320,7 +319,7 @@ func (d *Deployer) deployOperatorFromCSV(ctx context.Context, bundleDir string)
 	}
 
 	serviceAccountName := deploymentSpec["service_account"].(string)
-	d.useOperatorPullSecrets = d.config.Roxie.KonfluxImages && env.GetCurrentClusterType() != types.ClusterTypeInfraOpenShift4
+	d.useOperatorPullSecrets = d.config.Roxie.KonfluxImages && d.config.Roxie.ClusterType != types.ClusterTypeInfraOpenShift4
 
 	d.logger.Info("📋 Operator deployment plan:")
 	d.logger.Dim(fmt.Sprintf("  • Namespace: %s", operatorNamespace))

internal/types/cluster_type.go

@@ -1,5 +1,7 @@
 package types
 
+import "fmt"
+
 // ClusterType represents different types of Kubernetes clusters
 type ClusterType int
 
@@ -22,6 +24,27 @@ const (
 	ClusterTypeCRC
 )
 
+var (
+	clusterTypeToIdentifier = map[ClusterType]string{
+		ClusterTypeUnknown:         "Unknown",
+		ClusterTypeInfraGKE:        "InfraGKE",
+		ClusterTypeInfraOpenShift4: "InfraOpenShift4",
+		ClusterTypeOpenShift4:      "OpenShift4",
+		ClusterTypeKind:            "Kind",
+		ClusterTypeMinikube:        "Minikube",
+		ClusterTypeK3s:             "K3s",
+		ClusterTypeCRC:             "CRC",
+	}
+
+	identifierToClusterType = func() map[string]ClusterType {
+		m := make(map[string]ClusterType, len(clusterTypeToIdentifier))
+		for k, v := range clusterTypeToIdentifier {
+			m[v] = k
+		}
+		return m
+	}()
+)
+
 func (ct ClusterType) IsOpenShift() bool {
 	return ct == ClusterTypeInfraOpenShift4 || ct == ClusterTypeOpenShift4
 }
@@ -59,3 +82,23 @@ func AllClusterTypes() []ClusterType {
 		ClusterTypeOpenShift4,
 	}
 }
+
+func (ct ClusterType) MarshalYAML() (any, error) {
+	if id, ok := clusterTypeToIdentifier[ct]; ok {
+		return id, nil
+	}
+	return nil, fmt.Errorf("unknown cluster type: %d", ct)
+}
+
+func (ct *ClusterType) UnmarshalYAML(unmarshal func(any) error) error {
+	var s string
+	if err := unmarshal(&s); err != nil {
+		return err
+	}
+	parsed, ok := identifierToClusterType[s]
+	if !ok {
+		return fmt.Errorf("unknown cluster type identifier: %q", s)
+	}
+	*ct = parsed
+	return nil
+}