Refactor Quota Summary API by julien-vaz · Pull Request #10505 · apache/cloudstack

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

❌ Patch coverage is 6.66667% with 210 lines in your changes missing coverage. Please review.
✅ Project coverage is 18.01%. Comparing base (faaf766) to head (abfc638).
⚠️ Report is 31 commits behind head on main.

Files with missing lines	Patch %	Lines
...udstack/api/response/QuotaResponseBuilderImpl.java	20.31%	50 Missing and 1 partial ⚠️
...org/apache/cloudstack/quota/vo/QuotaSummaryVO.java	0.00%	47 Missing ⚠️
...ache/cloudstack/quota/dao/QuotaSummaryDaoImpl.java	0.00%	28 Missing ⚠️
...c/main/java/com/cloud/user/AccountManagerImpl.java	0.00%	28 Missing ⚠️
.../cloudstack/api/response/QuotaSummaryResponse.java	0.00%	24 Missing ⚠️
...apache/cloudstack/api/command/QuotaSummaryCmd.java	4.76%	18 Missing and 2 partials ⚠️
...ache/cloudstack/quota/QuotaAccountStateFilter.java	0.00%	11 Missing ⚠️
.../main/java/com/cloud/domain/dao/DomainDaoImpl.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@ Coverage Diff @@## main #10505 +/- ##
============================================
+ Coverage 17.92% 18.01% +0.08% - Complexity 16178 16456 +278 
============================================
Files 5949 5971 +22 Lines 534058 537334 +3276 Branches 65301 65992 +691 ============================================
+ Hits 95751 96785 +1034 - Misses 427551 429637 +2086 - Partials 10756 10912 +156

Flag	Coverage Δ
uitests	`3.53% <ø> (-0.14%)`	⬇️
unittests	`19.17% <6.66%> (+0.13%)`	⬆️

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

…/command/QuotaSummaryCmd.java Co-authored-by: Fabricio Duarte <fabricio.duarte.jr@gmail.com>

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.

blueorangutan · 2026-03-02T10:22:43Z

[SF] Trillian Build Failed (tid-15549)

github-actions · 2026-03-09T16:13:26Z

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

DaanHoogland · 2026-03-10T12:18:25Z

@julien-vaz , can you solve the conflicts so we can give it another try?

…y-api

winterhazel · 2026-03-11T19:30:49Z

@julien-vaz , can you solve the conflicts so we can give it another try?

Solved. @julien-vaz has not been active in the community recently, so I am maintaning his Quota-related PRs instead.

winterhazel · 2026-03-11T19:31:00Z

@blueorangutan package

blueorangutan · 2026-03-11T19:32:04Z

@winterhazel a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-03-11T20:30:28Z

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

DaanHoogland · 2026-03-12T12:37:13Z

@blueorangutan test

blueorangutan · 2026-03-12T12:38:04Z

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

blueorangutan · 2026-03-13T03:49:01Z

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

Test	Result	Time (s)	Test File
ContextSuite context=TestListIdsParams>:teardown	`Error`	1.13	test_list_ids_parameter.py
test_01_snapshot_root_disk	`Error`	4.96	test_snapshots.py
test_02_list_snapshots_with_removed_data_store	`Error`	47.70	test_snapshots.py
test_02_list_snapshots_with_removed_data_store	`Error`	47.70	test_snapshots.py
ContextSuite context=TestSnapshotStandaloneBackup>:teardown	`Error`	27.74	test_snapshots.py
test_01_snapshot_usage	`Error`	24.82	test_usage.py
test_01_vpn_usage	`Error`	1.09	test_usage.py

GutoVeronezi

Overall CLGTM; I left some minor remarks.

winterhazel · 2026-03-31T00:05:28Z

@blueorangutan package

blueorangutan · 2026-03-31T00:06:05Z

@winterhazel a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-03-31T00:53:12Z

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

DaanHoogland · 2026-03-31T08:04:28Z

@blueorangutan test

blueorangutan · 2026-03-31T08:06:05Z

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

blueorangutan · 2026-03-31T22:37:02Z

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

Test	Result	Time (s)	Test File

@acl

* Refactor Quota Summary API * Fixes imports * Fix QuotaServiceImplTest * Update plugins/database/quota/src/main/java/org/apache/cloudstack/api/command/QuotaSummaryCmd.java Co-authored-by: Fabricio Duarte <fabricio.duarte.jr@gmail.com> * Fix QuotaSummaryCmd * Remove unnecessary imports * Remove unused createQuotaSummaryResponse declarations * Remove unnecessary imports * Update plugins/database/quota/src/main/java/org/apache/cloudstack/api/command/QuotaSummaryCmd.java Co-authored-by: dahn <daan.hoogland@gmail.com> * Fix QuotaSummaryCmd * Fix QuotaResponseBuilderImplTest * Refactor test * Fix QuotaSummaryCmd * Fix projectid behavior * Simplify QuotaSummary and deprecate listall * Fix createQuotaSummaryResponse * Remove unused import * Apply suggestions + some adjustments * Remove duplicated check * Fix checkstyle * Adjust entity owner * Remove unused method + fix tests * Add missing @acl to some parameters * Adjust how the parameters behave * Allow domain admins and users to use keyword * Address reviews --------- Co-authored-by: Julien Hervot de Mattos Vaz <julien.vaz@scclouds.com.br> Co-authored-by: Fabricio Duarte <fabricio.duarte.jr@gmail.com> Co-authored-by: dahn <daan.hoogland@gmail.com>

Refactor Quota Summary API
115d303

boring-cyborgBot 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

Comment threadplugins/database/quota/src/main/java/org/apache/cloudstack/api/command/QuotaSummaryCmd.java Outdated
Comment threadplugins/database/quota/src/main/java/org/apache/cloudstack/api/command/QuotaSummaryCmd.java Outdated

Update plugins/database/quota/src/main/java/org/apache/cloudstack/api…
87feb02
…/command/QuotaSummaryCmd.java Co-authored-by: Fabricio Duarte <fabricio.duarte.jr@gmail.com>

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

winterhazel added the status:needs-review label Mar 3, 2026

github-actionsBot added the status:has-conflicts label Mar 9, 2026

Merge remote-tracking branch 'origin/main' into refactor-quota-summar…
2ae0806
…y-api

winterhazel removed the status:has-conflicts label Mar 11, 2026

GutoVeronezi approved these changes Mar 30, 2026
View reviewed changes

Address reviews
abfc638

winterhazel added status:waiting-for-smoketest-results and removed status:needs-review labels Mar 31, 2026

winterhazel merged commit 4f93ba8 into apache:mainMar 31, 2026
26 of 28 checks passed

winterhazel mentioned this pull request Apr 23, 2026
Improve Quota Statement #10506
Merged
9 tasks

winterhazel mentioned this pull request Jun 18, 2026
Quota UI rework #13449
Merged
9 tasks

This was referenced Jul 16, 2026
Add new Quota Plugin documentation apache/cloudstack-documentation#668
Open
Ignore projectid=-1 on Quota summary #13658
Merged

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!

codecovBot 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!

blueorangutan commented Mar 2, 2026

Uh oh!

github-actionsBot commented Mar 9, 2026

Uh oh!

DaanHoogland commented Mar 10, 2026

Uh oh!

winterhazel commented Mar 11, 2026

Uh oh!

winterhazel commented Mar 11, 2026

Uh oh!

blueorangutan commented Mar 11, 2026

Uh oh!

blueorangutan commented Mar 11, 2026

Uh oh!

DaanHoogland commented Mar 12, 2026

Uh oh!

blueorangutan commented Mar 12, 2026

Uh oh!

blueorangutan commented Mar 13, 2026

Uh oh!

GutoVeronezi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

julien-vaz commented Mar 5, 2025•
edited
Loading

codecovBot commented Mar 5, 2025•
edited
Loading

julien-vaz commented Mar 11, 2025•
edited
Loading