fixup! feat: Nutanix VM image preflight check

Run VM Image check only if Nutanix clients are initialized. This avoids returning errors that are not actionable. The user will see an error from the credentials check only.

Author: dlipovetsky

pkg/webhook/preflight/nutanix/checker.go

@@ -39,8 +39,6 @@ type nutanixChecker struct {
 	nutanixClusterConfigSpec                           *carenv1.NutanixClusterConfigSpec
 	nutanixWorkerNodeConfigSpecByMachineDeploymentName map[string]*carenv1.NutanixWorkerNodeConfigSpec
 
-	credentials prismgoclient.Credentials
-
 	v3client        v3client
 	v3clientFactory func(prismgoclient.Credentials) (v3client, error)
 

pkg/webhook/preflight/nutanix/credentials.go

@@ -146,7 +146,7 @@ func initCredentialsCheck(
 	}
 
 	// Initialize the credentials.
-	n.credentials = prismgoclient.Credentials{
+	credentials := prismgoclient.Credentials{
 		Endpoint: fmt.Sprintf("%s:%d", host, port),
 		URL:      fmt.Sprintf("https://%s:%d", host, port),
 		Username: usernamePassword.Username,
@@ -155,7 +155,7 @@ func initCredentialsCheck(
 	}
 
 	// Initialize the clients.
-	n.v4client, err = n.v4clientFactory(n.credentials)
+	v4client, err := n.v4clientFactory(credentials)
 	if err != nil {
 		result.Allowed = false
 		result.Error = true
@@ -167,7 +167,7 @@ func initCredentialsCheck(
 		)
 	}
 
-	n.v3client, err = n.v3clientFactory(n.credentials)
+	v3client, err := n.v3clientFactory(credentials)
 	if err != nil {
 		result.Allowed = false
 		result.Error = true
@@ -177,21 +177,35 @@ func initCredentialsCheck(
 				Field:   "cluster.spec.topology.variables[.name=clusterConfig].nutanix.prismCentralEndpoint.credentials",
 			},
 		)
-	} else {
-		// Validate the credentials using an API call.
-		_, err = n.v3client.GetCurrentLoggedInUser(ctx)
-		if err != nil {
-			result.Allowed = false
-			result.Error = true
-			result.Causes = append(result.Causes,
-				preflight.Cause{
-					Message: fmt.Sprintf("failed to validate credentials using the v3 API client: %s", err),
-					Field:   "cluster.spec.topology.variables[.name=clusterConfig].nutanix.prismCentralEndpoint.credentials",
-				},
-			)
+	}
+
+	if v3client == nil || v4client == nil {
+		return func(ctx context.Context) preflight.CheckResult {
+			return result
 		}
 	}
 
+	// Validate the credentials using an API call.
+	_, err = v3client.GetCurrentLoggedInUser(ctx)
+	if err != nil {
+		result.Allowed = false
+		result.Error = true
+		result.Causes = append(result.Causes,
+			preflight.Cause{
+				Message: fmt.Sprintf("Failed to validate credentials using the v3 API client. "+
+					"The URL and/or credentials may be incorrect. (Error: %q)", err),
+				Field: "cluster.spec.topology.variables[.name=clusterConfig].nutanix.prismCentralEndpoint",
+			},
+		)
+		return func(ctx context.Context) preflight.CheckResult {
+			return result
+		}
+	}
+
+	// We initialized both clients, and verified the credentials using the v3 client.
+	n.v3client = v3client
+	n.v4client = v4client
+
 	return func(ctx context.Context) preflight.CheckResult {
 		return result
 	}

pkg/webhook/preflight/nutanix/image.go

@@ -19,6 +19,10 @@ func initVMImageChecks(
 ) []preflight.Check {
 	checks := []preflight.Check{}
 
+	if n.v3client == nil || n.v4client == nil {
+		return checks
+	}
+
 	if n.nutanixClusterConfigSpec != nil && n.nutanixClusterConfigSpec.ControlPlane != nil &&
 		n.nutanixClusterConfigSpec.ControlPlane.Nutanix != nil {
 		checks = append(checks,