Refactor Quota Summary API #10505

julien-vaz · 2025-03-05T13:42:16Z

Description

The quotaSummary API has abstract behaviors and codes, as well as return values not aligned with its purposes. Furthermore, when the account is a project, no information is returned.

Also, in the UI, when opening the Quota Summary details for accounts who owned removed domains, the CloudStack launches an error to the user.

Therefore, this PR:

improves the API's behavior and return values;
adds information for project accounts (through parameter listall=true);
adds information for accounts/domains which have been already removed and a filter for accounts in the UI;

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

How Has This Been Tested?

On CloudMonkey I called quotaSummary API and checked the return value:

only relevant information about the summaries is being displayed;
accounts and domains which have been removed are especified in the summary;
project accounts are also being considered by the API.

On the UI, the filter for removed accounts is working properly.

julien-vaz · 2025-03-05T13:50:09Z

@blueorangutan package

blueorangutan · 2025-03-05T13:52:04Z

@julien-vaz 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-03-05T14:12:33Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 12665

codecov · 2025-03-05T21:05:53Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 3.63%. Comparing base (3a28a87) to head (ba99ec8).
⚠️ Report is 675 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (3a28a87) and HEAD (ba99ec8). Click for more details.

HEAD has 1 upload less than BASE

Flag BASE (3a28a87) HEAD (ba99ec8)

unittests 1 0

Additional details and impacted files

@@              Coverage Diff              @@
##               main   #10505       +/-   ##
=============================================
- Coverage     16.15%    3.63%   -12.53%     
=============================================
  Files          5666      441     -5225     
  Lines        498081    37019   -461062     
  Branches      60267     6785    -53482     
=============================================
- Hits          80475     1345    -79130     
+ Misses       408593    35513   -373080     
+ Partials       9013      161     -8852

Flag	Coverage Δ
uitests	`3.63% <ø> (-0.37%)`	⬇️
unittests	`?`

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.

julien-vaz · 2025-03-06T17:30:25Z

@blueorangutan package

blueorangutan · 2025-03-06T17:32:03Z

@julien-vaz 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-03-06T17:59:03Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 12690

julien-vaz · 2025-03-11T15:45:34Z

I've just successfully builded the packages locally with -Dnoredist. Therefore, I'm requesting the package building again

julien-vaz · 2025-03-11T15:45:49Z

@blueorangutan package

blueorangutan · 2025-03-11T15:46:05Z

@julien-vaz 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-03-11T16:37:19Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 12739

julien-vaz · 2025-03-11T17:05:44Z

@blueorangutan package

blueorangutan · 2025-03-11T17:08:03Z

@julien-vaz 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-03-11T18:22:04Z

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

plugins/database/quota/src/main/java/org/apache/cloudstack/api/command/QuotaSummaryCmd.java

…/command/QuotaSummaryCmd.java Co-authored-by: Fabricio Duarte <[email protected]>

sureshanaparti · 2025-06-05T09:25:19Z

@blueorangutan package

blueorangutan · 2025-06-05T09:26:04Z

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

julien-vaz · 2025-08-07T20:29:09Z

I still need to work on projectid behavior, but accountid and domainid are working properly.

julien-vaz · 2025-08-08T17:58:24Z

@blueorangutan package

blueorangutan · 2025-08-08T18:00:04Z

@julien-vaz 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-08-08T19:13:56Z

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

plugins/database/quota/src/main/java/org/apache/cloudstack/api/command/QuotaSummaryCmd.java

julien-vaz · 2025-08-28T15:26:12Z

@blueorangutan package

blueorangutan · 2025-08-28T15:28:04Z

@julien-vaz 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-08-28T15:54:05Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 14755

DaanHoogland · 2025-08-29T07:39:54Z

@julien-vaz :

17:48:34 [ERROR] /jenkins/workspace/acs-centos8-pkg-builder/dist/rpmbuild/BUILD/cloudstack-4.22.0.0-SNAPSHOT/plugins/database/quota/src/test/java/org/apache/cloudstack/api/response/QuotaResponseBuilderImplTest.java:72:8: Unused import - org.apache.commons.compress.utils.Sets. [UnusedImports]

julien-vaz · 2025-09-02T17:34:29Z

@blueorangutan package

blueorangutan · 2025-09-02T17:36:04Z

@julien-vaz 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-09-02T18:00:22Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 14821

harikrishna-patnala · 2025-09-22T06:34:26Z

@julien-vaz There is still failure in the build, can you please fix it and suggest how far this PR is ready, has this been tested recently ?

nvazquez

Thanks @julien-vaz, some comments from my review

nvazquez · 2025-10-01T00:36:58Z

framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaAccountStateFilter.java

+            }
+        }
+
+        return null;


Possibly also add a StringUtils.isBlank(value) check and return null in that case before the for loop?

nvazquez · 2025-10-01T00:37:57Z

engine/schema/src/main/java/com/cloud/domain/dao/DomainDaoImpl.java

        sc.setParameters("id", parentId, childId);

-        List<DomainVO> domainPair = listBy(sc);
+        List<DomainVO> domainPair = listIncludingRemovedBy(sc);


Sorry I'm not clear why should removed domains should be considered?

nvazquez · 2025-10-01T00:41:14Z

plugins/database/quota/src/main/java/org/apache/cloudstack/api/command/QuotaSummaryCmd.java

+    QuotaService quotaService;
+
+    @ACL
+    @Parameter(name = ApiConstants.ACCOUNT_ID, type = CommandType.UUID, entityType = AccountResponse.class, description = "ID of the account for which balance will be listed. Can not be specified with projectId.", since = "4.21.0")


Since parameter needs updating :)

nvazquez · 2025-10-01T00:41:51Z

plugins/database/quota/src/main/java/org/apache/cloudstack/api/command/QuotaSummaryCmd.java

-        super();
-    }
+    @ACL
+    @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Project Id for which balance will be listed. Can not be specified with accountId.", since = "4.21.0")


nvazquez · 2025-10-01T00:43:20Z

plugins/database/quota/src/main/java/org/apache/cloudstack/api/command/QuotaSummaryCmd.java

+    private Long projectId;

    @Override
    public void execute() {


Should this method include some pre-checks for accountId vs projectId parameters?

nvazquez · 2025-10-01T00:48:38Z

plugins/database/quota/src/main/java/org/apache/cloudstack/quota/QuotaServiceImpl.java

+     * Returns the Id of the account that will be used when provided with either accountId, projectId or accountName and domainId.
+     */
+    @Override
+    public Long finalizeAccountId(Long accountId, String accountName, Long domainId, Long projectId) {


I think this logic could be extracted into submethods

github-actions · 2025-10-16T09:11:47Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

Refactor Quota Summary API

115d303

boring-cyborg bot added component:api component:quota labels Mar 5, 2025

winterhazel added this to the 4.21.0 milestone Mar 5, 2025

winterhazel self-requested a review March 6, 2025 13:06

Fixes imports

36fe76e

Fix QuotaServiceImplTest

6897eeb

winterhazel requested changes Apr 8, 2025

View reviewed changes

plugins/database/quota/src/main/java/org/apache/cloudstack/api/command/QuotaSummaryCmd.java Outdated Show resolved Hide resolved

plugins/database/quota/src/main/java/org/apache/cloudstack/api/command/QuotaSummaryCmd.java Outdated Show resolved Hide resolved

Update plugins/database/quota/src/main/java/org/apache/cloudstack/api…

87feb02

…/command/QuotaSummaryCmd.java Co-authored-by: Fabricio Duarte <[email protected]>

bernardodemarco self-requested a review June 4, 2025 17:39

Fix QuotaSummaryCmd

1dcfbbf

sureshanaparti added this to Apache CloudStack 4.21.0 Jun 5, 2025

sureshanaparti moved this to In Progress in Apache CloudStack 4.21.0 Jun 5, 2025

sureshanaparti requested a review from DaanHoogland June 5, 2025 09:25

DaanHoogland modified the milestones: 4.21.0, 4.22.0 Aug 8, 2025

Fix projectid behavior

8cdd7fd

winterhazel reviewed Aug 14, 2025

View reviewed changes

plugins/database/quota/src/main/java/org/apache/cloudstack/api/command/QuotaSummaryCmd.java Show resolved Hide resolved

Simplify QuotaSummary and deprecate listall

37ebd68

harikrishna-patnala added this to Apache CloudStack 4.22.0 Aug 19, 2025

harikrishna-patnala removed this from Apache CloudStack 4.21.0 Aug 19, 2025

harikrishna-patnala moved this to In Progress in Apache CloudStack 4.22.0 Aug 19, 2025

Fix createQuotaSummaryResponse

75e851e

Remove unused import

ba99ec8

nvazquez reviewed Oct 1, 2025

View reviewed changes

rosi-shapeblue assigned rosi-shapeblue and unassigned rosi-shapeblue Oct 13, 2025

github-actions bot added the status:has-conflicts label Oct 16, 2025

harikrishna-patnala modified the milestones: 4.22.0, 4.22.1 Nov 12, 2025

harikrishna-patnala removed this from Apache CloudStack 4.22.0 Nov 12, 2025

Refactor Quota Summary API #10505

Are you sure you want to change the base?

Refactor Quota Summary API #10505

Uh oh!

Conversation

julien-vaz commented Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

How Has This Been Tested?

Uh oh!

julien-vaz commented Mar 5, 2025

Uh oh!

blueorangutan commented Mar 5, 2025

Uh oh!

blueorangutan commented Mar 5, 2025

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

julien-vaz commented Mar 6, 2025

Uh oh!

blueorangutan commented Mar 6, 2025

Uh oh!

blueorangutan commented Mar 6, 2025

Uh oh!

julien-vaz commented Mar 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

julien-vaz commented Mar 11, 2025

Uh oh!

blueorangutan commented Mar 11, 2025

Uh oh!

blueorangutan commented Mar 11, 2025

Uh oh!

julien-vaz commented Mar 11, 2025

Uh oh!

blueorangutan commented Mar 11, 2025

Uh oh!

blueorangutan commented Mar 11, 2025

Uh oh!

Uh oh!

Uh oh!

sureshanaparti commented Jun 5, 2025

Uh oh!

blueorangutan commented Jun 5, 2025

Uh oh!

julien-vaz commented Aug 7, 2025

Uh oh!

julien-vaz commented Aug 8, 2025

Uh oh!

blueorangutan commented Aug 8, 2025

Uh oh!

blueorangutan commented Aug 8, 2025

Uh oh!

Uh oh!

julien-vaz commented Aug 28, 2025

Uh oh!

blueorangutan commented Aug 28, 2025

Uh oh!

blueorangutan commented Aug 28, 2025

Uh oh!

DaanHoogland commented Aug 29, 2025

Uh oh!

julien-vaz commented Sep 2, 2025

Uh oh!

blueorangutan commented Sep 2, 2025

Uh oh!

blueorangutan commented Sep 2, 2025

Uh oh!

harikrishna-patnala commented Sep 22, 2025

Uh oh!

nvazquez left a comment

Choose a reason for hiding this comment

Uh oh!

nvazquez Oct 1, 2025

Choose a reason for hiding this comment

julien-vaz commented Mar 5, 2025 •

edited

Loading

codecov bot commented Mar 5, 2025 •

edited

Loading

julien-vaz commented Mar 11, 2025 •

edited

Loading