Fix listCapacity sort by usage #11316

abh1sar · 2025-07-29T03:55:46Z

Description

This PR fixes listCapacity api's sort by usage parameter.

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

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

Before:

(localhost) 🐱 > list capacity  sortby="usage"                                                                                                                                                                                                                                                                  [21/495]
{                                                                             
  "capacity": [                                                               
    {                                                                         
      "capacitytotal": 6997340160,                                            
      "capacityused": 5368709120,                                             
      "name": "MEMORY",                                                       
      "percentused": "76.72",                                                 
      "type": 0,                                                              
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },                                                                        
    {                                                                         
      "capacitytotal": 14400,                                                 
      "capacityused": 4500,                                                   
      "name": "CPU",                                                          
      "percentused": "31.25",                                                 
      "type": 1,                                                              
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },                                                                        
    {                                                                         
      "capacitytotal": 0,                                                     
      "capacityused": 0,                                                      
      "name": "STORAGE",                                                      
      "percentused": "0",                                                     
      "type": 2,                                                              
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },                                                                        
    {                                                                         
      "capacitytotal": 1572431986688,                                         
      "capacityused": 0,                                                      
      "name": "STORAGE_ALLOCATED",                                            
      "percentused": "0",                                                     
      "type": 3,                                                              
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },                                                                        
    {                                                                         
      "capacitytotal": 125,                                                   
      "capacityused": 5,                                                      
      "name": "VIRTUAL_NETWORK_PUBLIC_IP",                                    
      "percentused": "4",                                                     
      "type": 4,                                                              
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },                                                                        
    {                                                                         
      "capacitytotal": 125,                                                   
      "capacityused": 2,                                                      
      "name": "PRIVATE_IP",                                                   
      "percentused": "1.6",                                                   
      "type": 5,                                                              
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },                                                                        
    {                                                                         
      "capacitytotal": 0,                                                     
      "capacityused": 0,                                                      
      "name": "SECONDARY_STORAGE",                                            
      "percentused": "0",                                                     
      "type": 6,                                                              
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },                                                                        
    {                                                                         
      "capacitytotal": 100,                                                   
      "capacityused": 3,                                                      
      "name": "VLAN",                                                         
      "percentused": "3",                                                     
      "type": 7,                                                              
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },                                                                        
    {                                                                         
      "capacitytotal": 0,                                                     
      "capacityused": 0,                                                      
      "name": "GPU",                                                          
      "percentused": "0",                                                     
      "type": 19,                                                             
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },

After:

(localhost) 🐱 > list capacity  sortby="usage"                                
{                                                                             
  "capacity": [                                                               
    {                                                                         
      "capacitytotal": 4,                                                     
      "capacityused": 9,                                                      
      "name": "CPU_CORE",                                                     
      "percentused": "225",                                                   
      "type": 90,                                                             
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },                                                                        
    {                                                                         
      "capacitytotal": 6997340160,                                            
      "capacityused": 5368709120,                                             
      "name": "MEMORY",                                                       
      "percentused": "76.72",                                                 
      "type": 0,                                                              
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },                                                                        
    {                                                                         
      "capacitytotal": 393107996672,                                          
      "capacityused": 301029392384,                                           
      "name": "SECONDARY_STORAGE",                                            
      "percentused": "76.58",                                                 
      "type": 6,                                                              
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },                                                                        
    {                                                                         
      "capacitytotal": 786215993344,                                          
      "capacityused": 602058784768,                                           
      "name": "STORAGE",                                                      
      "percentused": "76.58",                                                 
      "type": 2,                                                              
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },                                                                        
    {                                                                         
      "capacitytotal": 393107996672,                                          
      "capacityused": 301026246656,                                           
      "name": "BACKUP_STORAGE",                                               
      "percentused": "76.58",                                                 
      "type": 21,                                                             
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },                                                                        
    {                                                                         
      "capacitytotal": 14400,                                                 
      "capacityused": 4500,                                                   
      "name": "CPU",                                                          
      "percentused": "31.25",                                                 
      "type": 1,                                                              
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },                                                                        
    {                                                                         
      "capacitytotal": 125,                                                   
      "capacityused": 5,                                                      
      "name": "VIRTUAL_NETWORK_PUBLIC_IP",                                    
      "percentused": "4",                                                     
      "type": 4,                                                              
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },                                                                        
    {                                                                         
      "capacitytotal": 1572431986688,                                         
      "capacityused": 60574728480,                                            
      "name": "STORAGE_ALLOCATED",                                            
      "percentused": "3.85",                                                  
      "type": 3,                                                              
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },                                                                        
    {                                                                         
      "capacitytotal": 100,                                                   
      "capacityused": 3,                                                      
      "name": "VLAN",                                                         
      "percentused": "3",                                                     
      "type": 7,                                                              
      "zoneid": "16cc239c-adbc-49cf-b100-4e3ce08ab858",                       
      "zonename": "DC"                                                        
    },

How did you try to break this feature and the system with this change?

codecov · 2025-07-29T04:03:45Z

Codecov Report

❌ Patch coverage is 0% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 15.17%. Comparing base (ca6d2dc) to head (21d509a).
⚠️ Report is 5 commits behind head on 4.19.

Files with missing lines	Patch %	Lines
...ck/api/command/admin/resource/ListCapacityCmd.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##               4.19   #11316   +/-   ##
=========================================
  Coverage     15.17%   15.17%           
- Complexity    11362    11364    +2     
=========================================
  Files          5415     5415           
  Lines        476030   476043   +13     
  Branches      58115    58117    +2     
=========================================
+ Hits          72246    72255    +9     
- Misses       395701   395703    +2     
- Partials       8083     8085    +2

Flag	Coverage Δ
uitests	`4.28% <ø> (ø)`
unittests	`15.90% <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.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

sureshanaparti

clgtm

sureshanaparti · 2025-07-29T04:09:29Z

@blueorangutan package

Copilot

Pull Request Overview

This PR fixes a bug in the listCapacity API where the sort by usage parameter was not working correctly. The issue was that when sorting by usage, the comparator would fall back to sorting by capacity type even when a specific sort parameter was provided.

Fixes comparator logic to respect the sortBy parameter when zones have the same name
Prevents unintended fallback to capacity type sorting when sortBy is specified

api/src/main/java/org/apache/cloudstack/api/command/admin/resource/ListCapacityCmd.java

borisstoyanov · 2025-07-29T07:29:00Z

@blueorangutan package

blueorangutan · 2025-07-29T07:30:05Z

@borisstoyanov 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.

blueorangutan · 2025-07-29T08:28:14Z

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

borisstoyanov · 2025-07-29T10:35:12Z

@blueorangutan test

blueorangutan · 2025-07-29T10:36:03Z

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

abh1sar · 2025-07-29T11:40:26Z

@blueorangutan package

blueorangutan · 2025-07-29T11:42:04Z

@abh1sar 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.

DaanHoogland

clgtm

blueorangutan · 2025-07-29T13:01:50Z

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

blueorangutan · 2025-07-30T00:13:02Z

[SF] Trillian test result (tid-13961)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 46201 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr11316-t13961-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

borisstoyanov

LGTM, manually checked it

fix listCapacity sort by usage

5d758fc

boring-cyborg bot added the component:api label Jul 29, 2025

sureshanaparti approved these changes Jul 29, 2025

View reviewed changes

sureshanaparti requested review from DaanHoogland and Copilot July 29, 2025 04:09

sureshanaparti added the status:needs-testing label Jul 29, 2025

Copilot AI reviewed Jul 29, 2025

View reviewed changes

api/src/main/java/org/apache/cloudstack/api/command/admin/resource/ListCapacityCmd.java Outdated Show resolved Hide resolved

borisstoyanov self-assigned this Jul 29, 2025

make the code more readable, add comments

21d509a

DaanHoogland approved these changes Jul 29, 2025

View reviewed changes

borisstoyanov approved these changes Jul 30, 2025

View reviewed changes

DaanHoogland removed the status:needs-testing label Jul 30, 2025

DaanHoogland merged commit 294aef5 into apache:4.19 Jul 30, 2025
25 of 26 checks passed

DaanHoogland deleted the list-capacity branch July 30, 2025 12:05

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

Fix listCapacity sort by usage (apache#11316)

d60fffb

Fix listCapacity sort by usage #11316

Fix listCapacity sort by usage #11316

Uh oh!

Conversation

abh1sar commented Jul 29, 2025

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

sureshanaparti left a comment

Choose a reason for hiding this comment

Uh oh!

sureshanaparti commented Jul 29, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

borisstoyanov commented Jul 29, 2025

Uh oh!

blueorangutan commented Jul 29, 2025

Uh oh!

blueorangutan commented Jul 29, 2025

Uh oh!

borisstoyanov commented Jul 29, 2025

Uh oh!

blueorangutan commented Jul 29, 2025

Uh oh!

abh1sar commented Jul 29, 2025

Uh oh!

blueorangutan commented Jul 29, 2025

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Jul 29, 2025

Uh oh!

blueorangutan commented Jul 30, 2025

Uh oh!

borisstoyanov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented Jul 29, 2025 •

edited

Loading