Skip to content

Commit

Permalink
fixup! refactor: Make available complete image info, instead of UUID …
Browse files Browse the repository at this point in the history 
…only

Refactor further; add unit tests with mocks
  • Loading branch information
@dlipovetsky
dlipovetsky committed Dec 11, 2024
1 parent 236044f commit 1434308
Show file tree
Hide file tree
Showing 2 changed files with 212 additions and 18 deletions.
30 changes: 12 additions & 18 deletions controllers/helpers.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -301,20 +301,16 @@ func GetSubnetUUID(ctx context.Context, client *prismclientv3.Client, peUUID str
// GetImageByNameOrUUID returns an image. If no UUID is provided, returns the unique image with the name.
// Returns an error if no image has the UUID, if no image has the name, or more than one image has the name.
func GetImageByNameOrUUID(ctx context.Context, client *prismclientv3.Client, image infrav1.NutanixResourceIdentifier) (*prismclientv3.ImageIntentResponse, error) {
var imageIntentResponse *prismclientv3.ImageIntentResponse

if image.UUID == nil && image.Name == nil {
return nil, fmt.Errorf("image name or image uuid must be passed in order to retrieve the image")
}
if image.UUID != nil {
switch {
case image.UUID != nil:
resp, err := client.V3.GetImage(ctx, *image.UUID)
if err != nil {
if strings.Contains(fmt.Sprint(err), "ENTITY_NOT_FOUND") {
return nil, fmt.Errorf("failed to find image with UUID %s: %v", *image.UUID, err)
}
}
imageIntentResponse = resp
} else if image.Name != nil { // else search by name
return resp, nil
case image.Name != nil:
responseImages, err := client.V3.ListAllImage(ctx, "")
if err != nil {
return nil, err
Expand All @@ -327,20 +323,18 @@ func GetImageByNameOrUUID(ctx context.Context, client *prismclientv3.Client, ima
foundImages = append(foundImages, s)
}
}
if len(foundImages) == 0 {
return nil, fmt.Errorf("failed to retrieve image by name %s", *image.Name)
} else if len(foundImages) > 1 {

switch {
case len(foundImages) == 1:
return foundImages[0], nil
case len(foundImages) > 1:
return nil, fmt.Errorf("more than one image found with name %s", *image.Name)
} else {
imageIntentResponse = foundImages[0]
}
if imageIntentResponse == nil {
return nil, fmt.Errorf("failed to retrieve image by name or uuid. Verify input parameters")
default:
return nil, fmt.Errorf("failed to retrieve image by name %s", *image.Name)
}
} else {
default:
return nil, fmt.Errorf("input parameters must include either name or uuid")
}
return imageIntentResponse, nil
}

// HasTaskInProgress returns true if the given task is in progress
Expand Down
200 changes: 200 additions & 0 deletions controllers/helpers_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
"context"
"encoding/json"
"errors"
"reflect"
"testing"

credentialtypes "github.com/nutanix-cloud-native/prism-go-client/environment/credentials"
Expand All @@ -31,10 +32,12 @@ import (
"go.uber.org/mock/gomock"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/utils/ptr"
"sigs.k8s.io/cluster-api/util"

infrav1 "github.com/nutanix-cloud-native/cluster-api-provider-nutanix/api/v1beta1"
mockk8sclient "github.com/nutanix-cloud-native/cluster-api-provider-nutanix/mocks/k8sclient"
mocknutanixv3 "github.com/nutanix-cloud-native/cluster-api-provider-nutanix/mocks/nutanix"
nutanixclient "github.com/nutanix-cloud-native/cluster-api-provider-nutanix/pkg/client"
)

Expand Down Expand Up @@ -229,3 +232,200 @@ func TestGetPrismCentralClientForCluster(t *testing.T) {
assert.NoError(t, err)
})
}

func TestGetImageByNameOrUUID(t *testing.T) {
tests := []struct {
name string
clientBuilder func() *prismclientv3.Client
image infrav1.NutanixResourceIdentifier
want *prismclientv3.ImageIntentResponse
wantErr bool
}{
{
name: "missing name and UUID in the input",
clientBuilder: func() *prismclientv3.Client {
mockctrl := gomock.NewController(t)
mockv3Service := mocknutanixv3.NewMockService(mockctrl)

return &prismclientv3.Client{V3: mockv3Service}
},
image: infrav1.NutanixResourceIdentifier{},
wantErr: true,
},
{
name: "image UUID not found",
clientBuilder: func() *prismclientv3.Client {
mockctrl := gomock.NewController(t)
mockv3Service := mocknutanixv3.NewMockService(mockctrl)
mockv3Service.EXPECT().GetImage(gomock.Any(), gomock.Any()).Return(nil, errors.New("ENTITY_NOT_FOUND"))

return &prismclientv3.Client{V3: mockv3Service}
},
image: infrav1.NutanixResourceIdentifier{
Type: infrav1.NutanixIdentifierUUID,
UUID: ptr.To("32432daf-fb0e-4202-b444-2439f43a24c5"),
},
wantErr: true,
},
{
name: "image name query fails",
clientBuilder: func() *prismclientv3.Client {
mockctrl := gomock.NewController(t)
mockv3Service := mocknutanixv3.NewMockService(mockctrl)
mockv3Service.EXPECT().ListAllImage(gomock.Any(), gomock.Any()).Return(nil, errors.New("fake error"))

return &prismclientv3.Client{V3: mockv3Service}
},
image: infrav1.NutanixResourceIdentifier{
Type: infrav1.NutanixIdentifierName,
Name: ptr.To("example"),
},
wantErr: true,
},
{
name: "image UUID found",
clientBuilder: func() *prismclientv3.Client {
mockctrl := gomock.NewController(t)
mockv3Service := mocknutanixv3.NewMockService(mockctrl)
mockv3Service.EXPECT().GetImage(gomock.Any(), gomock.Any()).Return(
&prismclientv3.ImageIntentResponse{
Spec: &prismclientv3.Image{
Name: ptr.To("example"),
},
}, nil,
)

return &prismclientv3.Client{V3: mockv3Service}
},
image: infrav1.NutanixResourceIdentifier{
Type: infrav1.NutanixIdentifierUUID,
UUID: ptr.To("32432daf-fb0e-4202-b444-2439f43a24c5"),
},
want: &prismclientv3.ImageIntentResponse{
Spec: &prismclientv3.Image{
Name: ptr.To("example"),
},
},
},
{
name: "image name found",
clientBuilder: func() *prismclientv3.Client {
mockctrl := gomock.NewController(t)
mockv3Service := mocknutanixv3.NewMockService(mockctrl)
mockv3Service.EXPECT().ListAllImage(gomock.Any(), gomock.Any()).Return(
&prismclientv3.ImageListIntentResponse{
Entities: []*prismclientv3.ImageIntentResponse{
{
Spec: &prismclientv3.Image{
Name: ptr.To("example"),
},
},
},
}, nil,
)

return &prismclientv3.Client{V3: mockv3Service}
},
image: infrav1.NutanixResourceIdentifier{
Type: infrav1.NutanixIdentifierName,
Name: ptr.To("example"),
},
want: &prismclientv3.ImageIntentResponse{
Spec: &prismclientv3.Image{
Name: ptr.To("example"),
},
},
},
{
name: "image name matches multiple images",
clientBuilder: func() *prismclientv3.Client {
mockctrl := gomock.NewController(t)
mockv3Service := mocknutanixv3.NewMockService(mockctrl)
mockv3Service.EXPECT().ListAllImage(gomock.Any(), gomock.Any()).Return(
&prismclientv3.ImageListIntentResponse{
Entities: []*prismclientv3.ImageIntentResponse{
{
Spec: &prismclientv3.Image{
Name: ptr.To("example"),
},
},
{
Spec: &prismclientv3.Image{
Name: ptr.To("example"),
},
},
},
}, nil,
)

return &prismclientv3.Client{V3: mockv3Service}
},
image: infrav1.NutanixResourceIdentifier{
Type: infrav1.NutanixIdentifierName,
Name: ptr.To("example"),
},
wantErr: true,
},
{
name: "image name matches zero images",
clientBuilder: func() *prismclientv3.Client {
mockctrl := gomock.NewController(t)
mockv3Service := mocknutanixv3.NewMockService(mockctrl)
mockv3Service.EXPECT().ListAllImage(gomock.Any(), gomock.Any()).Return(
&prismclientv3.ImageListIntentResponse{
Entities: []*prismclientv3.ImageIntentResponse{},
}, nil,
)

return &prismclientv3.Client{V3: mockv3Service}
},
image: infrav1.NutanixResourceIdentifier{
Type: infrav1.NutanixIdentifierName,
Name: ptr.To("example"),
},
wantErr: true,
},
{
name: "image name matches one image",
clientBuilder: func() *prismclientv3.Client {
mockctrl := gomock.NewController(t)
mockv3Service := mocknutanixv3.NewMockService(mockctrl)
mockv3Service.EXPECT().ListAllImage(gomock.Any(), gomock.Any()).Return(
&prismclientv3.ImageListIntentResponse{
Entities: []*prismclientv3.ImageIntentResponse{
{
Spec: &prismclientv3.Image{
Name: ptr.To("example"),
},
},
},
}, nil,
)

return &prismclientv3.Client{V3: mockv3Service}
},
image: infrav1.NutanixResourceIdentifier{
Type: infrav1.NutanixIdentifierName,
Name: ptr.To("example"),
},
want: &prismclientv3.ImageIntentResponse{
Spec: &prismclientv3.Image{
Name: ptr.To("example"),
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
ctx := context.Background()
got, err := GetImageByNameOrUUID(ctx, tt.clientBuilder(), tt.image)
if (err != nil) != tt.wantErr {
t.Errorf("GetImageByNameOrUUID() error = %v, wantErr %v", err, tt.wantErr)
return
}
if !reflect.DeepEqual(got, tt.want) {
t.Errorf("GetImageByNameOrUUID() = %v, want %v", got, tt.want)
}
})
}
}

0 comments on commit 1434308

Please sign in to comment.