Fix listing of VMs with removed NICs #10204

bernardodemarco · 2025-01-18T21:00:22Z

Description

Currently, when listing VMs by network (networkid) or VPC (vpcid), CloudStack does not check whether the VMs still belong to the specified network or VPC. Therefore, this PR fixes this issue by only filtering the VMs that have non-removed NICs in the specified network or VPC.

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
build/CI
test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

First, I created an isolated network (nw-01) and a VPC (vpc-01) with two tiers (tier-01 and tier-02). Next, I deployed a VM (vm-01) with one NIC in each one of these networks.

After that, I checked that the listVirtualMachines API had the same behavior as prior to the PR changes:

List VMs that belong to the nw-01 network

(localcloud) 🌍 > listVirtualMachines networkid="f839708e-a21b-4116-a978-c2b6155fa5db" filter=displayname
{
  "count": 1,
  "virtualmachine": [
    {
      "displayname": "vm-01"
    }
  ]
}

List VMs that belong to the tier-01 network

(localcloud) 🐛 > listVirtualMachines networkid="58932108-cb7b-4be8-8663-bde09fc98920" filter=displayname
{
  "count": 1,
  "virtualmachine": [
    {
      "displayname": "vm-01"
    }
  ]
}

List VMs that belong to the tier-02 network

(localcloud) 🐀 > listVirtualMachines networkid="c17a596c-8ac9-483f-84cd-a55dcca0929d" filter=displayname
{
  "count": 1,
  "virtualmachine": [
    {
      "displayname": "vm-01"
    }
  ]
}

List VMs that belong to the vpc-01 VPC

(localcloud) 🐃 > listVirtualMachines vpcid="16938b3c-955a-475f-b72d-f60ad3814c7b" filter=displayname
{
  "count": 1,
  "virtualmachine": [
    {
      "displayname": "vm-01"
    }
  ]
}

List VMs that belong to the vpc-01 VPC and tier-01 tier

(localcloud) 🦈 > listVirtualMachines vpcid="16938b3c-955a-475f-b72d-f60ad3814c7b" networkid="58932108-cb7b-4be8-8663-bde09fc98920" filter=displayname
{
  "count": 1,
  "virtualmachine": [
    {
      "displayname": "vm-01"
    }
  ]
}

List VMs that belong to the vpc-01 VPC and tier-02 tier

(localcloud) 🐦 > listVirtualMachines vpcid="16938b3c-955a-475f-b72d-f60ad3814c7b" networkid="c17a596c-8ac9-483f-84cd-a55dcca0929d" filter=displayname
{
  "count": 1,
  "virtualmachine": [
    {
      "displayname": "vm-01"
    }
  ]
}

Next, I removed the NIC associated to the nw-01 network from the VM. When listing the VMs by that network, I verified that no VMs were returned:

List VMs that belong to the nw-01 network

(localcloud) 🐃 > listVirtualMachines networkid="f839708e-a21b-4116-a978-c2b6155fa5db" filter=displayname
(localcloud) 🐰 >

Then, I removed the NIC associated to the tier-02 tier. When listing the VMs by that network, I verified that no VMs were returned:

List VMs that belong to the tier-02 network

(localcloud) 🐰 > listVirtualMachines networkid="c17a596c-8ac9-483f-84cd-a55dcca0929d" filter=displayname
(localcloud) 🦂 >

I also verified that when listing the VMs by the tier-02 tier and the vpc-01 VPC, no VMs were returned:

List VMs that belong to the vpc-01 VPC and tier-02 tier

(localcloud) 🦂 > listVirtualMachines vpcid="16938b3c-955a-475f-b72d-f60ad3814c7b" networkid="c17a596c-8ac9-483f-84cd-a55dcca0929d" filter=displayname
(localcloud) 🐋 >

Furthermore, when only listing by VPC, the VM was returned since it still had a NIC associated to the tier-01 network:

List VMs that belong to the vpc-01 VPC

(localcloud) 🐋 > listVirtualMachines vpcid="16938b3c-955a-475f-b72d-f60ad3814c7b" filter=displayname
{
  "count": 1,
  "virtualmachine": [
    {
      "displayname": "vm-01"
    }
  ]
}

Next, in order to be able to remove the tier-01 NIC, I added a NIC corresponding to a Layer 2 network, and set it to be the default VM's NIC. After removing the tier-01 NIC, I verified that no VMs were returned when listing by the tier-01 network:

List VMs that belong to the tier-01 network

(localcloud) 🍄 > listVirtualMachines networkid="58932108-cb7b-4be8-8663-bde09fc98920" filter=displayname
(localcloud) 🌴 >

No VMs were returned when listing by the vpc-01 VPC and tier-01 network:

List VMs that belong to the vpc-01 VPC and tier-01 tier

(localcloud) 🌴 > listVirtualMachines networkid="58932108-cb7b-4be8-8663-bde09fc98920" vpcid="16938b3c-955a-475f-b72d-f60ad3814c7b" filter=displayname
(localcloud) 🐐 >

No VMs were returned when listing by the vpc-01 VPC:

List VMs that belong to the vpc-01 VPC

(localcloud) 🐐 > listVirtualMachines  vpcid="16938b3c-955a-475f-b72d-f60ad3814c7b" filter=displayname
(localcloud) 🌍 >

Fixes #10188

bernardodemarco · 2025-01-18T21:02:40Z

@blueorangutan package

blueorangutan · 2025-01-18T21:04:03Z

@bernardodemarco a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

codecov · 2025-01-18T21:08:09Z

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 15.13%. Comparing base (9967bb3) to head (7693008).
Report is 4 commits behind head on 4.19.

Files with missing lines	Patch %	Lines
...ain/java/com/cloud/api/query/QueryManagerImpl.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               4.19   #10204      +/-   ##
============================================
- Coverage     15.13%   15.13%   -0.01%     
  Complexity    11274    11274              
============================================
  Files          5408     5408              
  Lines        473974   473975       +1     
  Branches      57813    57813              
============================================
  Hits          71730    71730              
- Misses       394227   394228       +1     
  Partials       8017     8017

Flag	Coverage Δ
uitests	`4.30% <ø> (ø)`
unittests	`15.85% <0.00%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

blueorangutan · 2025-01-18T21:59:43Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 12114

DaanHoogland

clgtm

DaanHoogland · 2025-01-20T08:29:28Z

@blueorangutan test keepEnv

blueorangutan · 2025-01-20T08:30:03Z

@DaanHoogland a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2025-01-20T21:40:10Z

[SF] Trillian test result (tid-12131)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 45009 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10204-t12131-kvm-ol8.zip
Smoke tests completed. 133 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

weizhouapache

code lgtm

DaanHoogland · 2025-01-21T09:33:33Z

monkey tested in a lab env, all good

* 4.20: linstor: Fix ZFS snapshot backup (#10219) fix listing of VMs by network (#10204) Configure org.eclipse.jetty.server.Request.maxFormKeys from server.properties and increase the default value (#10214) api: fix access for listSystemVmUsageHistory (#10032) Fix NPE issues during host rolling maintenance, due to host tags and custom constrained/unconstrained service offering (#9844)

fix listing of VMs by network

7693008

bernardodemarco added component:api status:needs-testing labels Jan 18, 2025

bernardodemarco added this to the 4.19.2 milestone Jan 18, 2025

DaanHoogland linked an issue Jan 20, 2025 that may be closed by this pull request

[API] Incorrect listing of VMs with previous NICs on networks #10188

Closed

DaanHoogland approved these changes Jan 20, 2025

View reviewed changes

DaanHoogland self-assigned this Jan 20, 2025

weizhouapache approved these changes Jan 21, 2025

View reviewed changes

DaanHoogland merged commit 70776b0 into apache:4.19 Jan 21, 2025
24 of 25 checks passed

DaanHoogland mentioned this pull request Jan 22, 2025

[API] Incorrect listing of VMs with previous NICs on networks #10188

Closed

bernardodemarco mentioned this pull request Jan 24, 2025

Unable to delete shared network (specifyVlan=false and no services) #10261

Closed

DaanHoogland removed the status:needs-testing label Jan 27, 2025

rg9975 pushed a commit to rg9975/cloudstack that referenced this pull request Jan 31, 2025

fix listing of VMs by network (apache#10204)

7cda4a5

dhslove pushed a commit to ablecloud-team/ablestack-cloud that referenced this pull request Jun 19, 2025

fix listing of VMs by network (apache#10204)

bc0d24d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix listing of VMs with removed NICs #10204

Fix listing of VMs with removed NICs #10204

Uh oh!

bernardodemarco commented Jan 18, 2025

Uh oh!

bernardodemarco commented Jan 18, 2025

Uh oh!

blueorangutan commented Jan 18, 2025

Uh oh!

codecov bot commented Jan 18, 2025 •

edited

Loading

Uh oh!

blueorangutan commented Jan 18, 2025

Uh oh!

DaanHoogland left a comment

Uh oh!

DaanHoogland commented Jan 20, 2025

Uh oh!

blueorangutan commented Jan 20, 2025

Uh oh!

blueorangutan commented Jan 20, 2025

Uh oh!

weizhouapache left a comment

Uh oh!

DaanHoogland commented Jan 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Fix listing of VMs with removed NICs #10204

Fix listing of VMs with removed NICs #10204

Uh oh!

Conversation

bernardodemarco commented Jan 18, 2025

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

Uh oh!

bernardodemarco commented Jan 18, 2025

Uh oh!

blueorangutan commented Jan 18, 2025

Uh oh!

codecov bot commented Jan 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

blueorangutan commented Jan 18, 2025

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland commented Jan 20, 2025

Uh oh!

blueorangutan commented Jan 20, 2025

Uh oh!

blueorangutan commented Jan 20, 2025

Uh oh!

weizhouapache left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland commented Jan 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov bot commented Jan 18, 2025 •

edited

Loading