Improve Quota Statement by julien-vaz · Pull Request #10506 · apache/cloudstack

julien-vaz · 2025-03-05T14:07:53Z

Description

In the current version, the quotaStatement API is returning the internal ID for account and domain, which is not useful for users, since all APIs use/return the UUID. Also, when the usage_type parameter is informed, the API shows dummy records.

To address those problems:

the API was modified so it returns the resources' UUID;
the dummy records bug was fixed;
a new parameter showresources was added to display more information to the user about each usage type;
a new quotaStatementDetails API was created to list more details about each usage type;

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 the quotaStatement API was called and:

the resources' UUID was returned instead of the internal ID;
when specified a usage_type no dummy records were showed;
the showresources parameter is properly working;

The quotaStatementDetails API was called successfully as well.

julien-vaz · 2025-03-05T17:01:42Z

@blueorangutan package

blueorangutan · 2025-03-05T17:04: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-05T18:23:20Z

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

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

Codecov Report

❌ Patch coverage is 23.44498% with 320 lines in your changes missing coverage. Please review.
✅ Project coverage is 18.01%. Comparing base (c361409) to head (fdeb202).

Files with missing lines	Patch %	Lines
...udstack/api/response/QuotaResponseBuilderImpl.java	32.05%	105 Missing and 1 partial ⚠️
...g/apache/cloudstack/quota/vo/QuotaUsageJoinVO.java	35.41%	62 Missing ⚠️
...he/cloudstack/quota/dao/QuotaUsageJoinDaoImpl.java	0.00%	37 Missing ⚠️
...apache/cloudstack/quota/vo/QuotaUsageDetailVO.java	0.00%	31 Missing ⚠️
...ache/cloudstack/quota/vo/QuotaUsageResourceVO.java	0.00%	27 Missing ⚠️
...ache/cloudstack/api/command/QuotaStatementCmd.java	15.78%	16 Missing ⚠️
.../cloudstack/quota/dao/QuotaUsageDetailDaoImpl.java	0.00%	15 Missing ⚠️
...i/response/QuotaStatementItemResourceResponse.java	0.00%	13 Missing ⚠️
...loudstack/api/response/QuotaStatementResponse.java	36.36%	7 Missing ⚠️
...c/main/java/com/cloud/utils/db/SearchCriteria.java	0.00%	4 Missing ⚠️
... and 1 more

Additional details and impacted files

@@            Coverage Diff             @@
##               main   #10506    +/-   ##
==========================================
  Coverage     18.00%   18.01%            
- Complexity    16466    16481    +15     
==========================================
  Files          5977     5983     +6     
  Lines        537777   538072   +295     
  Branches      66037    66059    +22     
==========================================
+ Hits          96844    96912    +68     
- Misses       430011   430244   +233     
+ Partials      10922    10916     -6

Flag	Coverage Δ
uitests	`3.52% <ø> (ø)`
unittests	`19.17% <23.44%> (+<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.

julien-vaz · 2025-03-06T17:16:19Z

@blueorangutan package

blueorangutan · 2025-03-06T17:18: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-06T17:40:29Z

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

…uotaServiceImplTest

julien-vaz · 2025-03-11T16:58:34Z

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

julien-vaz · 2025-03-11T16:58:52Z

@blueorangutan package

blueorangutan · 2025-03-11T17: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-03-11T18:15:32Z

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

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

...atabase/quota/src/main/java/org/apache/cloudstack/api/response/QuotaResponseBuilderImpl.java

lucas-a-martins

CLGTM

DaanHoogland

clgtm

DaanHoogland · 2025-04-16T06:05:17Z

...atabase/quota/src/main/java/org/apache/cloudstack/api/response/QuotaResponseBuilderImpl.java

+                    "accountName", "accountId", "domainId", "startDate", "endDate", "type", "showDetails")));
        }
+        logger.debug("Creating quota statement from [{}] usage records for parameters [{}].", quotaUsages.size(),
+                ReflectionToStringBuilderUtils.reflectOnlySelectedFields(cmd, "accountName", "accountId", "domainId", "startDate", "endDate", "type", "showDetails"));


this seems the reuse of the same array of strings. Not for this PR but maybe we should allow String[] as parameter for ReflectionToStringBuilderUtils.reflectOnlySelectedFields. Or allow some kind of predefined default per class to be registered.

...atabase/quota/src/main/java/org/apache/cloudstack/api/response/QuotaResponseBuilderImpl.java

sureshanaparti · 2025-06-05T09:24:46Z

@blueorangutan package

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

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

harikrishna-patnala · 2025-09-22T06:53:46Z

@blueorangutan package

blueorangutan · 2025-09-22T06:56:04Z

@harikrishna-patnala 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-22T08:21:23Z

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

Copilot

Pull Request Overview

This PR enhances the quota statement API by addressing UUID usage, fixing dummy record bugs, and adding new functionality for resource detail display. The changes improve API consistency by returning UUIDs instead of internal IDs, resolve issues with dummy records when usage_type is specified, and introduce a new showresources parameter for detailed resource information.

Return UUIDs instead of internal IDs for accounts and domains in quota statements
Fix dummy record generation bug when usage_type parameter is provided
Add new showresources parameter and quotaStatementDetails API for enhanced resource visibility

Reviewed Changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
QuotaServiceImpl.java	Updates to use QuotaUsageJoinDao instead of QuotaUsageDao
QuotaResponseBuilderImpl.java	Major refactoring to handle new UUID responses and resource details
QuotaStatementResponse.java	Changes account/domain ID fields from Long to String for UUID support
QuotaStatementItemResponse.java	Removes duplicate account/domain fields and adds resources field
QuotaStatementCmd.java	Adds showresources parameter and simplifies date handling
Test files	Updates to accommodate new DAO and method signature changes
New VO classes	Addition of join and resource VOs to support enhanced functionality
New DAO classes	Implementation of join and detail DAOs for improved data access

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

...ase/quota/src/test/java/org/apache/cloudstack/api/response/QuotaResponseBuilderImplTest.java

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

shwstppr

Are schema changes missing here? Seeing some new VO classes but no corresponding SQL changes I can find

engine/schema/src/main/java/com/cloud/user/dao/AccountDao.java

shwstppr · 2025-09-23T06:52:49Z

framework/quota/src/main/java/org/apache/cloudstack/quota/vo/QuotaUsageDetailVO.java

+import org.apache.commons.lang3.builder.ToStringStyle;
+
+@Entity
+@Table(name = "quota_usage_detail")


I feel table should be named differently as CLoudStack uses *_detail table for the details of the entity mostly in the similar format resource_id,name,value

shwstppr · 2025-09-23T07:05:38Z

framework/quota/src/main/java/org/apache/cloudstack/quota/vo/QuotaUsageResourceVO.java

+
+import java.util.Date;
+
+public class QuotaUsageResourceVO {


Is this referring to any DB table?

nvazquez · 2025-10-01T01:00:26Z

Hi @julien-vaz is this PR ready for review? Looks like its missing SQL statements for new tables and views?

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

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

winterhazel · 2026-04-07T20:17:17Z

Are schema changes missing here? Seeing some new VO classes but no corresponding SQL changes I can find

@shwstppr good catch, some schema changes are missing. I will add them.

…ment

winterhazel · 2026-04-08T21:18:37Z

@blueorangutan package

blueorangutan · 2026-04-08T21:20: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-04-08T22:10:33Z

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

Improve Quota Statement

9617344

boring-cyborg bot added component:api component:database 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

Removes unused import

e702bb3

Fix QuotaUsageJoinDao, QuotaResponseBuilderImpl, QuotaServiceImpl e Q…

0a996dc

…uotaServiceImplTest

DaanHoogland reviewed Mar 12, 2025

View reviewed changes

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

...atabase/quota/src/main/java/org/apache/cloudstack/api/response/QuotaResponseBuilderImpl.java Outdated Show resolved Hide resolved

Julien Hervot de Mattos Vaz added 2 commits March 12, 2025 11:45

Reorganize imports

7d06715

Updates QuotaStatementCmd responseBuilder scope to default

58c0b5c

lucas-a-martins approved these changes Apr 15, 2025

View reviewed changes

DaanHoogland approved these changes Apr 16, 2025

View reviewed changes

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

Fix log4j syntax

412a4bd

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

weizhouapache added this to the 4.22.0 milestone Aug 29, 2025

sureshanaparti added this to Apache CloudStack 4.22.0 Aug 29, 2025

sureshanaparti removed this from Apache CloudStack 4.21.0 Aug 29, 2025

sureshanaparti moved this to In Progress in Apache CloudStack 4.22.0 Aug 29, 2025

shwstppr requested a review from Copilot September 23, 2025 05:02

Copilot AI reviewed Sep 23, 2025

View reviewed changes

shwstppr reviewed Sep 23, 2025

View reviewed changes

RosiKyu assigned RosiKyu and unassigned RosiKyu 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

winterhazel modified the milestones: 4.22.1, 4.23.0 Dec 20, 2025

winterhazel self-assigned this Feb 3, 2026

winterhazel added 4 commits April 8, 2026 16:16

Address reviews + other improvements

bb32371

Merge remote-tracking branch 'upstream/main' into improve-quota-state…

f5c8d84

…ment

Add missing SQL scripts and injections

d05ab01

Change accountid and domainid logic + add unit tests

fdeb202

winterhazel removed the status:has-conflicts label Apr 8, 2026

Conversation

julien-vaz commented Mar 5, 2025

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

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!

lucas-a-martins left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland Apr 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sureshanaparti commented Jun 5, 2025

Uh oh!

blueorangutan commented Jun 5, 2025

Uh oh!

harikrishna-patnala commented Sep 22, 2025

Uh oh!

blueorangutan commented Sep 22, 2025

Uh oh!

blueorangutan commented Sep 22, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shwstppr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shwstppr Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

shwstppr Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

winterhazel Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

nvazquez commented Oct 1, 2025

Uh oh!

codecov bot commented Mar 5, 2025 •

edited

Loading