Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ListWithInstanceView to Azure vm client #6166

Merged
merged 1 commit into from
May 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions pkg/azureclients/vmclient/azure_vmclient.go
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,15 @@ func (c *Client) getVM(ctx context.Context, resourceGroupName string, VMName str

// List gets a list of VirtualMachine in the resourceGroupName.
func (c *Client) List(ctx context.Context, resourceGroupName string) ([]compute.VirtualMachine, *retry.Error) {
return c.list(ctx, resourceGroupName, false)
}

// ListWithInstanceView gets a list of VirtualMachine in the resourceGroupName with InstanceView.
func (c *Client) ListWithInstanceView(ctx context.Context, resourceGroupName string) ([]compute.VirtualMachine, *retry.Error) {
return c.list(ctx, resourceGroupName, true)
}

func (c *Client) list(ctx context.Context, resourceGroupName string, withInstanceView bool) ([]compute.VirtualMachine, *retry.Error) {
mc := metrics.NewMetricContext("vm", "list", resourceGroupName, c.subscriptionID, "")

// Report errors if the client is rate limited.
Expand All @@ -164,7 +173,7 @@ func (c *Client) List(ctx context.Context, resourceGroupName string) ([]compute.
return nil, rerr
}

result, rerr := c.listVM(ctx, resourceGroupName)
result, rerr := c.listVM(ctx, resourceGroupName, withInstanceView)
mc.Observe(rerr)
if rerr != nil {
if rerr.IsThrottled() {
Expand All @@ -179,14 +188,22 @@ func (c *Client) List(ctx context.Context, resourceGroupName string) ([]compute.
}

// listVM gets a list of VirtualMachines in the resourceGroupName.
func (c *Client) listVM(ctx context.Context, resourceGroupName string) ([]compute.VirtualMachine, *retry.Error) {
func (c *Client) listVM(ctx context.Context, resourceGroupName string, withInstanceView bool) ([]compute.VirtualMachine, *retry.Error) {
resourceID := armclient.GetResourceListID(c.subscriptionID, resourceGroupName, vmResourceType)

result := make([]compute.VirtualMachine, 0)
page := &VirtualMachineListResultPage{}
page.fn = c.listNextResults

resp, rerr := c.armClient.GetResource(ctx, resourceID)
var resp *http.Response
var rerr *retry.Error
if withInstanceView {
queries := make(map[string]interface{})
queries["$expand"] = autorest.Encode("query", "instanceView")
resp, rerr = c.armClient.GetResourceWithQueries(ctx, resourceID, queries)
} else {
resp, rerr = c.armClient.GetResource(ctx, resourceID)
}
defer c.armClient.CloseResponse(ctx, resp)
if rerr != nil {
klog.V(5).Infof("Received error in %s: resourceID: %s, error: %s", "vm.list.request", resourceID, rerr.Error())
Expand Down
44 changes: 44 additions & 0 deletions pkg/azureclients/vmclient/azure_vmclient_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,31 @@ func TestList(t *testing.T) {
assert.Equal(t, 3, len(result))
}

func TestListWithInstanceView(t *testing.T) {
ctrl := gomock.NewController(t)
defer ctrl.Finish()

armClient := mockarmclient.NewMockInterface(ctrl)
vmList := []compute.VirtualMachine{getTestVMWithInstanceView("vm1"), getTestVMWithInstanceView("vm2")}
responseBody, err := json.Marshal(compute.VirtualMachineListResult{Value: &vmList})
assert.NoError(t, err)

queryparams := map[string]interface{}{
"$expand": "instanceView",
}
armClient.EXPECT().GetResourceWithQueries(gomock.Any(), testResourcePrefix, queryparams).Return(
&http.Response{
StatusCode: http.StatusOK,
Body: io.NopCloser(bytes.NewReader(responseBody)),
}, nil).Times(1)
armClient.EXPECT().CloseResponse(gomock.Any(), gomock.Any()).Times(1)

vmClient := getTestVMClient(armClient)
result, rerr := vmClient.ListWithInstanceView(context.TODO(), "rg")
assert.Nil(t, rerr)
assert.Equal(t, 2, len(result))
}

func TestListNotFound(t *testing.T) {
ctrl := gomock.NewController(t)
defer ctrl.Finish()
Expand Down Expand Up @@ -1160,6 +1185,25 @@ func getTestVM(vmName string) compute.VirtualMachine {
}
}

func getTestVMWithInstanceView(vmName string) compute.VirtualMachine {
resourceID := fmt.Sprintf("/subscriptions/subscriptionID/resourceGroups/rg/providers/Microsoft.Compute/virtualMachines/%s", vmName)
vm := compute.VirtualMachine{
ID: pointer.String(resourceID),
Name: pointer.String(vmName),
Location: pointer.String("eastus"),
VirtualMachineProperties: &compute.VirtualMachineProperties{
InstanceView: &compute.VirtualMachineInstanceView{
Statuses: &[]compute.InstanceViewStatus{
{
Code: pointer.String("PowerState/running"),
},
},
},
},
}
return vm
}

func getTestVMClient(armClient armclient.Interface) *Client {
rateLimiterReader, rateLimiterWriter := azclients.NewRateLimiter(&azclients.RateLimitConfig{})
return &Client{
Expand Down
3 changes: 3 additions & 0 deletions pkg/azureclients/vmclient/interface.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ type Interface interface {
// List gets a list of VirtualMachines in the resourceGroupName.
List(ctx context.Context, resourceGroupName string) ([]compute.VirtualMachine, *retry.Error)

// ListWithInstanceView gets a list of VirtualMachines in the resourceGroupName with InstanceView.
ListWithInstanceView(ctx context.Context, resourceGroupName string) ([]compute.VirtualMachine, *retry.Error)

// ListVmssFlexVMsWithoutInstanceView gets a list of VirtualMachine in the VMSS Flex without InstanceView.
ListVmssFlexVMsWithoutInstanceView(ctx context.Context, vmssFlexID string) ([]compute.VirtualMachine, *retry.Error)

Expand Down
15 changes: 15 additions & 0 deletions pkg/azureclients/vmclient/mockvmclient/interface.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading