fix: Make EarlyReadiness field *bool (#208)

Co-authored-by: Moritz Clasmeier <mclasmeier@redhat.com>

Author: mclasmeier

cmd/deploy.go

@@ -228,8 +228,8 @@ Examples:
 	registerFlag(cmd, settings, "early-readiness", "Only wait for essential workloads (central/sensor) to be ready",
 		withNoOptDefVal("true"),
 		withApplyFnBool(func(config *deployer.Config, val bool) error {
-			config.Central.EarlyReadiness = val
-			config.SecuredCluster.EarlyReadiness = val
+			config.Central.EarlyReadiness = new(val)
+			config.SecuredCluster.EarlyReadiness = new(val)
 			return nil
 		}),
 	)
@@ -282,7 +282,7 @@ func runDeploy(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	if !deploySettings.Central.EarlyReadiness || !deploySettings.SecuredCluster.EarlyReadiness {
+	if !deploySettings.Central.EarlyReadinessEnabled() || !deploySettings.SecuredCluster.EarlyReadinessEnabled() {
 		// Explanation on the versions involved here:
 		// Deploying StackRox begins with picking a "main image tag" -- this is a version identifier, which cannot be reliably parsed as a semver.
 		// But there is a derived version from that -- the operator version -- which can be parsed as a semver.

cmd/deploy_test.go

@@ -94,16 +94,16 @@ func TestNewDeployCmd_Flags(t *testing.T) {
 			name: "early-readiness",
 			args: []string{"--early-readiness"},
 			assert: func(t *testing.T, cfg deployer.Config) {
-				assert.True(t, cfg.Central.EarlyReadiness, "Central.EarlyReadiness mismatch")
-				assert.True(t, cfg.SecuredCluster.EarlyReadiness, "SecuredCluster.EarlyReadiness mismatch")
+				assert.True(t, cfg.Central.EarlyReadinessEnabled(), "Central.EarlyReadiness mismatch")
+				assert.True(t, cfg.SecuredCluster.EarlyReadinessEnabled(), "SecuredCluster.EarlyReadiness mismatch")
 			},
 		},
 		{
 			name: "disable early-readiness",
 			args: []string{"--early-readiness=false"},
 			assert: func(t *testing.T, cfg deployer.Config) {
-				assert.False(t, cfg.Central.EarlyReadiness, "Central.EarlyReadiness mismatch")
-				assert.False(t, cfg.SecuredCluster.EarlyReadiness, "SecuredCluster.EarlyReadiness mismatch")
+				assert.False(t, cfg.Central.EarlyReadinessEnabled(), "Central.EarlyReadiness mismatch")
+				assert.False(t, cfg.SecuredCluster.EarlyReadinessEnabled(), "SecuredCluster.EarlyReadiness mismatch")
 			},
 		},
 		{
@@ -135,7 +135,8 @@ func TestNewDeployCmd_Flags(t *testing.T) {
 				assert.Equal(t, "4.7.0", cfg.Roxie.Version, "Roxie.Version mismatch")
 				require.NotNil(t, cfg.Central.Exposure, "Central.Exposure should be set")
 				assert.Equal(t, types.ExposureLoadBalancer, *cfg.Central.Exposure, "Central.Exposure mismatch")
-				assert.True(t, cfg.Central.EarlyReadiness, "Central.EarlyReadiness mismatch")
+				assert.True(t, cfg.Central.EarlyReadinessEnabled(), "Central.EarlyReadiness mismatch")
+				assert.True(t, cfg.SecuredCluster.EarlyReadinessEnabled(), "SecuredCluster.EarlyReadiness mismatch")
 				assert.Equal(t, types.ResourceProfileSmall, cfg.Central.ResourceProfile, "Central.ResourceProfile mismatch")
 			},
 		},
@@ -161,6 +162,18 @@ securedCluster:
 			},
 		},
 
+		{
+			name: "config file can disable early-readiness",
+			config: `
+central:
+  earlyReadiness: false
+`,
+			args: []string{"--config", configFilePath},
+			assert: func(t *testing.T, cfg deployer.Config) {
+				assert.False(t, cfg.Central.EarlyReadinessEnabled(), "Central.EarlyReadiness should be false")
+			},
+		},
+
 		{
 			name: "flags can override earlier specified config file",
 			config: `

internal/deployer/config.go

@@ -86,16 +86,20 @@ type CentralConfig struct {
 	Exposure            *types.Exposure        `yaml:"exposure,omitempty"`
 	DeployTimeout       time.Duration          `yaml:"deployTimeout,omitempty"`
 	PortForwarding      *bool                  `yaml:"portForwarding,omitempty"`
-	EarlyReadiness      bool                   `yaml:"earlyReadiness,omitempty"`
+	EarlyReadiness      *bool                  `yaml:"earlyReadiness,omitempty"`
 	Spec                map[string]interface{} `yaml:"spec,omitempty"`
 }
 
+func (c *CentralConfig) EarlyReadinessEnabled() bool {
+	return c.EarlyReadiness != nil && *c.EarlyReadiness
+}
+
 // DefaultCentralConfig returns a CentralConfig with sensible defaults.
 func DefaultCentralConfig() CentralConfig {
 	return CentralConfig{
 		DeployTimeout:  DefaultCentralWaitTimeout,
 		Namespace:      "acs-central",
-		EarlyReadiness: true,
+		EarlyReadiness: new(true),
 		Spec: map[string]interface{}{
 			"central": map[string]interface{}{
 				"telemetry": map[string]interface{}{
@@ -112,12 +116,12 @@ func (c *CentralConfig) GetWaitConfig() WaitConfig {
 	// With earlyReadiness we just wait for the Available condition of that component's core
 	// Deployment to be True.
 	waitFor := "central/" + centralCrName
-	if c.EarlyReadiness {
+	if c.EarlyReadinessEnabled() {
 		waitFor = "deployment/central"
 	}
 	return WaitConfig{
 		Namespace:      c.Namespace,
-		EarlyReadiness: c.EarlyReadiness,
+		EarlyReadiness: c.EarlyReadinessEnabled(),
 		WaitFor:        waitFor,
 		Timeout:        c.DeployTimeout,
 	}
@@ -204,28 +208,32 @@ type SecuredClusterConfig struct {
 	ResourceProfile     types.ResourceProfile  `yaml:"resourceProfile,omitempty"`
 	PauseReconciliation bool                   `yaml:"pauseReconciliation,omitempty"`
 	DeployTimeout       time.Duration          `yaml:"deployTimeout,omitempty"`
-	EarlyReadiness      bool                   `yaml:"earlyReadiness,omitempty"`
+	EarlyReadiness      *bool                  `yaml:"earlyReadiness,omitempty"`
 	Spec                map[string]interface{} `yaml:"spec,omitempty"`
 }
 
+func (s *SecuredClusterConfig) EarlyReadinessEnabled() bool {
+	return s.EarlyReadiness != nil && *s.EarlyReadiness
+}
+
 // DefaultSecuredClusterConfig returns a SecuredClusterConfig with sensible defaults.
 func DefaultSecuredClusterConfig() SecuredClusterConfig {
 	return SecuredClusterConfig{
 		DeployTimeout:  DefaultSecuredClusterWaitTimeout,
 		Namespace:      "acs-sensor",
-		EarlyReadiness: true,
+		EarlyReadiness: new(true),
 		Spec:           make(map[string]interface{}),
 	}
 }
 
 func (s *SecuredClusterConfig) GetWaitConfig() WaitConfig {
 	waitFor := "securedcluster/" + securedClusterCrName
-	if s.EarlyReadiness {
+	if s.EarlyReadinessEnabled() {
 		waitFor = "deployment/sensor"
 	}
 	return WaitConfig{
 		Namespace:      s.Namespace,
-		EarlyReadiness: s.EarlyReadiness,
+		EarlyReadiness: s.EarlyReadinessEnabled(),
 		WaitFor:        waitFor,
 		Timeout:        s.DeployTimeout,
 	}