fixup! feat: Nutanix VM image preflight check

Mock nutanix clients to allow unit tests

Author: dlipovetsky

pkg/webhook/preflight/nutanix/checker.go

@@ -12,8 +12,6 @@ import (
 	ctrlclient "sigs.k8s.io/controller-runtime/pkg/client"
 
 	prismgoclient "github.com/nutanix-cloud-native/prism-go-client"
-	prismv3 "github.com/nutanix-cloud-native/prism-go-client/v3"
-	prismv4 "github.com/nutanix-cloud-native/prism-go-client/v4"
 
 	carenv1 "github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/api/v1alpha1"
 	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/webhook/preflight"
@@ -23,6 +21,9 @@ func New(kclient ctrlclient.Client, cluster *clusterv1.Cluster) preflight.Checke
 	return &nutanixChecker{
 		kclient: kclient,
 		cluster: cluster,
+
+		v3clientFactory: newV3Client,
+		v4clientFactory: newV4Client,
 	}
 }
 
@@ -34,8 +35,12 @@ type nutanixChecker struct {
 	nutanixWorkerNodeConfigSpecByMachineDeploymentName map[string]*carenv1.NutanixWorkerNodeConfigSpec
 
 	credentials prismgoclient.Credentials
-	v3client    *prismv3.Client
-	v4client    *prismv4.Client
+
+	v3client        v3client
+	v3clientFactory func(prismgoclient.Credentials) (v3client, error)
+
+	v4client        v4client
+	v4clientFactory func(prismgoclient.Credentials) (v4client, error)
 
 	log logr.Logger
 }

pkg/webhook/preflight/nutanix/clients.go

@@ -0,0 +1,94 @@
+package nutanix
+
+import (
+	"context"
+
+	vmmv4 "github.com/nutanix/ntnx-api-golang-clients/vmm-go-client/v4/models/vmm/v4/content"
+
+	prismgoclient "github.com/nutanix-cloud-native/prism-go-client"
+	prismv3 "github.com/nutanix-cloud-native/prism-go-client/v3"
+	prismv4 "github.com/nutanix-cloud-native/prism-go-client/v4"
+)
+
+type v3client interface {
+	GetCurrentLoggedInUser(ctx context.Context) (*prismv3.UserIntentResponse, error)
+}
+
+type v3clientWrapper struct {
+	prismv3.Service
+}
+
+var _ = v3client(&v3clientWrapper{})
+
+func newV3Client(
+	credentials prismgoclient.Credentials, //nolint:gocritic // hugeParam is fine
+) (v3client, error) {
+	client, err := prismv3.NewV3Client(credentials)
+	if err != nil {
+		return nil, err
+	}
+	return &v3clientWrapper{
+		client.V3,
+	}, nil
+}
+
+type v4client interface {
+	GetImageById(id *string) (*vmmv4.GetImageApiResponse, error)
+	ListImages(page_ *int,
+		limit_ *int,
+		filter_ *string,
+		orderby_ *string,
+		select_ *string,
+		args ...map[string]interface{},
+	) (
+		*vmmv4.ListImagesApiResponse,
+		error,
+	)
+}
+
+type v4clientWrapper struct {
+	client *prismv4.Client
+}
+
+var _ = v4client(&v4clientWrapper{})
+
+func (c *v4clientWrapper) GetImageById(id *string) (*vmmv4.GetImageApiResponse, error) {
+	resp, err := c.client.ImagesApiInstance.GetImageById(id)
+	if err != nil {
+		return nil, err
+	}
+	return resp, nil
+}
+
+func (c *v4clientWrapper) ListImages(page_ *int,
+	limit_ *int,
+	filter_ *string,
+	orderby_ *string,
+	select_ *string,
+	args ...map[string]interface{},
+) (*vmmv4.ListImagesApiResponse, error) {
+	resp, err := c.client.ImagesApiInstance.ListImages(
+		page_,
+		limit_,
+		filter_,
+		orderby_,
+		select_,
+		args...,
+	)
+	if err != nil {
+		return nil, err
+	}
+	return resp, nil
+}
+
+func newV4Client(
+	credentials prismgoclient.Credentials, //nolint:gocritic // hugeParam is fine
+) (v4client, error) {
+	client, err := prismv4.NewV4Client(credentials)
+	if err != nil {
+		return nil, err
+	}
+	return &v4clientWrapper{
+		client: client,
+	}, nil
+}

pkg/webhook/preflight/nutanix/credentials.go

@@ -12,8 +12,6 @@ import (
 
 	prismgoclient "github.com/nutanix-cloud-native/prism-go-client"
 	prismcredentials "github.com/nutanix-cloud-native/prism-go-client/environment/credentials"
-	prismv3 "github.com/nutanix-cloud-native/prism-go-client/v3"
-	prismv4 "github.com/nutanix-cloud-native/prism-go-client/v4"
 
 	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/webhook/preflight"
 )
@@ -164,7 +162,7 @@ func (n *nutanixChecker) initCredentialsCheck(ctx context.Context) preflight.Che
 	}
 
 	// Initialize the clients.
-	n.v4client, err = prismv4.NewV4Client(n.credentials)
+	n.v4client, err = n.v4clientFactory(n.credentials)
 	if err != nil {
 		result.Allowed = false
 		result.Error = true
@@ -176,7 +174,7 @@ func (n *nutanixChecker) initCredentialsCheck(ctx context.Context) preflight.Che
 		)
 	}
 
-	n.v3client, err = prismv3.NewV3Client(n.credentials)
+	n.v3client, err = n.v3clientFactory(n.credentials)
 	if err != nil {
 		result.Allowed = false
 		result.Error = true
@@ -187,7 +185,7 @@ func (n *nutanixChecker) initCredentialsCheck(ctx context.Context) preflight.Che
 			},
 		)
 	}
-	_, err = n.v3client.V3.GetCurrentLoggedInUser(ctx)
+	_, err = n.v3client.GetCurrentLoggedInUser(ctx)
 	if err != nil {
 		result.Allowed = false
 		result.Error = true

pkg/webhook/preflight/nutanix/image.go

@@ -9,8 +9,6 @@ import (
 
 	vmmv4 "github.com/nutanix/ntnx-api-golang-clients/vmm-go-client/v4/models/vmm/v4/content"
 
-	prismv4 "github.com/nutanix-cloud-native/prism-go-client/v4"
-
 	capxv1 "github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/api/external/github.com/nutanix-cloud-native/cluster-api-provider-nutanix/api/v1beta1"
 	carenv1 "github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/api/v1alpha1"
 	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/webhook/preflight"
@@ -118,12 +116,12 @@ func (n *nutanixChecker) vmImageCheck(
 }
 
 func getVMImages(
-	client *prismv4.Client,
+	client v4client,
 	id *capxv1.NutanixResourceIdentifier,
 ) ([]vmmv4.Image, error) {
 	switch {
 	case id.IsUUID():
-		resp, err := client.ImagesApiInstance.GetImageById(id.UUID)
+		resp, err := client.GetImageById(id.UUID)
 		if err != nil {
 			return nil, err
 		}
@@ -134,7 +132,7 @@ func getVMImages(
 		return []vmmv4.Image{image}, nil
 	case id.IsName():
 		filter_ := fmt.Sprintf("name eq '%s'", *id.Name)
-		resp, err := client.ImagesApiInstance.ListImages(nil, nil, &filter_, nil, nil)
+		resp, err := client.ListImages(nil, nil, &filter_, nil, nil)
 		if err != nil {
 			return nil, err
 		}