framework,api,server,ui: improve error messaging by shwstppr · Pull Request #12336 · apache/cloudstack

shwstppr · 2025-12-24T10:40:47Z

Description

Framework-level improvements for contextual and localized API error messages

Design spec: Error Message Consistency, Customization, and Localization Framework

Documentation PR: apache/cloudstack-documentation#684

Developed focused documentation is also added at api/src/main/java/org/apache/cloudstack/error/README.md

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):

Refined error message with additional context for admin

User facing error, with localization

Example API response

{
    "deployvirtualmachineresponse": {
        "uuidList": [],
        "errorcode": 535,
        "cserrorcode": 9999,
        "errortext": "Unable to deploy Instance because allocating 1 more Instance would exceed the Account limits. Current: 2, Reserved: 0, Limit: 2. Release unused resources, then retry.",
        "errortextkey": "vm.deploy.resourcelimit.exceeded.account",
        "errormetadata": {
            "resourceRequested": "1",
            "resourceTypeDisplay": "Instance",
            "resourceOwnerType": "Account",
            "resourceAmount": "2",
            "resourceReserved": "0",
            "resourceLimit": "2"
        }
    }
}

How Has This Been Tested?

End-to-end testing and the following smoke test,

[root@qa1-improve-err-88bf966b-kvm-mgmt1 marvin]# nosetests --with-xunit --xunit-file=results.xml --with-marvin --marvin-config=./marvin.cfg -s -a tags=advanced --hypervisor=KVM tests/smoke/test_error_message_framework.py 
/usr/local/lib/python3.6/site-packages/paramiko/transport.py:32: CryptographyDeprecationWarning: Python 3.6 is no longer supported by the Python core team. Therefore, support for it is deprecated in cryptography. The next release of cryptography will remove support for Python 3.6.
  from cryptography.hazmat.backends import default_backend

==== Marvin Init Started ====

=== Marvin Parse Config Successful ===

=== Marvin Setting TestData Successful===

==== Log Folder Path: /tmp/MarvinLogs/Sep_18_2026_04_59_46_OYCP7L All logs will be available here ====

=== Marvin Init Logging Successful===

==== Marvin Init Successful ====
=== TestName: test_01_runtime_error_message_override_for_regular_user | Status : SUCCESS ===

=== TestName: test_02_runtime_error_message_override_for_admin | Status : SUCCESS ===

=== Final results are now copied to: /tmp//MarvinLogs/test_error_message_framework_DBR9CT ===

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

codecov · 2025-12-24T10:49:06Z

Codecov Report

❌ Patch coverage is 64.73430% with 219 lines in your changes missing coverage. Please review.
✅ Project coverage is 18.13%. Comparing base (cdd03d7) to head (ea881f7).
⚠️ Report is 19 commits behind head on 4.22.

Files with missing lines	Patch %	Lines
...n/java/com/cloud/vm/VirtualMachineManagerImpl.java	11.72%	128 Missing ⚠️
...n/java/org/apache/cloudstack/error/Exceptions.java	50.68%	34 Missing and 2 partials ⚠️
...he/cloudstack/context/ResponseMessageResolver.java	86.23%	17 Missing and 17 partials ⚠️
...udstack/engine/cloud/entity/api/db/VMEntityVO.java	0.00%	4 Missing ⚠️
...rc/main/java/com/cloud/configuration/Resource.java	90.90%	2 Missing ⚠️
...loudstack/api/command/user/vm/BaseDeployVMCmd.java	0.00%	2 Missing ⚠️
...ava/org/apache/cloudstack/context/CallContext.java	93.10%	0 Missing and 2 partials ⚠️
...ine/cloud/entity/api/VirtualMachineEntityImpl.java	0.00%	2 Missing ⚠️
...main/java/com/cloud/api/ApiAsyncJobDispatcher.java	60.00%	2 Missing ⚠️
...c/main/java/com/cloud/user/AccountManagerImpl.java	85.71%	1 Missing and 1 partial ⚠️
... and 5 more

Additional details and impacted files

@@             Coverage Diff              @@
##               4.22   #12336      +/-   ##
============================================
+ Coverage     18.02%   18.13%   +0.11%     
- Complexity    16247    16441     +194     
============================================
  Files          5936     5939       +3     
  Lines        535778   537342    +1564     
  Branches      65608    65864     +256     
============================================
+ Hits          96556    97454     +898     
- Misses       428225   428774     +549     
- Partials      10997    11114     +117

Flag	Coverage Δ
uitests	`4.05% <ø> (+<0.01%)`	⬆️
unittests	`19.21% <64.73%> (+0.12%)`	⬆️

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

☔ View full report in Codecov by Harness.
📢 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.

github-actions · 2026-01-26T07:21:01Z

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

github-actions · 2026-01-28T14:25:32Z

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

github-actions · 2026-03-26T16:36:17Z

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

blueorangutan · 2026-10-05T12:10:05Z

@shwstppr 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-10-05T13:15:03Z

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

github-actions · 2026-10-05T14:41:11Z

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

github-actions · 2026-10-05T14:48:14Z

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

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

shwstppr · 2026-10-06T06:09:50Z

@blueorangutan package

blueorangutan · 2026-10-06T06:12:06Z

@shwstppr 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-10-06T07:15:49Z

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

harikrishna-patnala

code LGTM

harikrishna-patnala

code LGTM

blueorangutan · 2026-10-06T07:54:04Z

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

blueorangutan · 2026-10-06T23:06:07Z

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

Test	Result	Time (s)	Test File

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

shwstppr · 2026-10-08T07:46:18Z

@blueorangutan package

blueorangutan · 2026-10-08T07:48:04Z

@shwstppr 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-10-08T08:49:29Z

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

shwstppr · 2026-10-13T04:55:50Z

@blueorangutan test

blueorangutan · 2026-10-13T04:58:04Z

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

blueorangutan · 2026-10-13T21:39:00Z

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

Test	Result	Time (s)	Test File
ContextSuite context=TestIsolatedNetworksPasswdServer>:setup	`Error`	0.00	test_password_server.py

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

shwstppr · 2026-10-19T12:17:18Z

@blueorangutan package

blueorangutan · 2026-10-19T12:18:05Z

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

Copilot

Warning

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Copilot review overview

4 open issues

getVariableNamesInErrorKey explicitly supports whitespace inside placeholders ({{ var }}), but… · New
Avoid committing auto-generated TODO stubs in test utilities. Either implement this method… · New
The line numbers reported for missing opening/closing braces are incorrect when the file has… · New
The CLI exit code behavior for fix/sort doesn’t match the module docstring (“fix was a no-op” →… · New

10 resolved since last review

_{Review effort: Lite}

blueorangutan · 2026-10-19T13:30:54Z

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

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

shwstppr · 2026-10-20T07:14:51Z

@blueorangutan package

blueorangutan · 2026-10-20T07:16:04Z

@shwstppr 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-10-20T08:13:24Z

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

boring-cyborg Bot added component:api component:networking component:packaging component:UI distro:ubuntu labels Dec 24, 2025

shwstppr force-pushed the improve-error-messages branch from 86379b7 to c938bd1 Compare December 24, 2025 11:55

boring-cyborg Bot added the component:build label Dec 24, 2025

shwstppr closed this Jan 6, 2026

shwstppr reopened this Jan 6, 2026

apache deleted a comment from blueorangutan Jan 6, 2026

github-actions Bot added the status:has-conflicts label Jan 26, 2026

github-actions Bot removed the status:has-conflicts label Jan 27, 2026

DaanHoogland added this to the 4.22.1 milestone Jan 28, 2026

github-actions Bot added the status:has-conflicts label Jan 28, 2026

github-actions Bot removed the status:has-conflicts label Jan 29, 2026

sureshanaparti added this to Apache CloudStack 4.22.1 Feb 3, 2026

sureshanaparti moved this to In Progress in Apache CloudStack 4.22.1 Feb 3, 2026

apache deleted a comment from blueorangutan Feb 9, 2026

github-actions Bot added the status:has-conflicts label Mar 26, 2026

shwstppr removed the status:has-conflicts label Apr 14, 2026

sureshanaparti removed this from Apache CloudStack 4.22.1 Apr 24, 2026

sureshanaparti removed this from the 4.22.1 milestone Apr 24, 2026

harikrishna-patnala reviewed Oct 5, 2026

View reviewed changes

Comment thread client/conf/messages/error-messages.json.in

Merge remote-tracking branch 'apache/4.22' into improve-error-messages

5c4269f

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

harikrishna-patnala approved these changes Oct 6, 2026

View reviewed changes

shwstppr added 2 commits October 8, 2026 11:40

localization fix for non-async APIs lost in rebase

037b968

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

fix il8n error

9447c67

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

enhance error messages script and fix issues

74771e0

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

Copilot AI reviewed Oct 19, 2026

View reviewed changes

address comments

ea881f7

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

Conversation

shwstppr commented Dec 24, 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

Bug Severity

Screenshots (if appropriate):

Example API response

How Has This Been Tested?

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

Uh oh!

codecov Bot commented Dec 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions Bot commented Jan 26, 2026

Uh oh!

github-actions Bot commented Jan 28, 2026

Uh oh!

github-actions Bot commented Mar 26, 2026

Uh oh!

blueorangutan commented Oct 5, 2026

Uh oh!

blueorangutan commented Oct 5, 2026

Uh oh!

Uh oh!

github-actions Bot commented Oct 5, 2026

Uh oh!

github-actions Bot commented Oct 5, 2026

Uh oh!

shwstppr commented Oct 6, 2026

Uh oh!

blueorangutan commented Oct 6, 2026

Uh oh!

blueorangutan commented Oct 6, 2026

Uh oh!

harikrishna-patnala left a comment

Choose a reason for hiding this comment

Uh oh!

harikrishna-patnala left a comment

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Oct 6, 2026

Uh oh!

blueorangutan commented Oct 6, 2026

Uh oh!

shwstppr commented Oct 8, 2026

Uh oh!

blueorangutan commented Oct 8, 2026

Uh oh!

blueorangutan commented Oct 8, 2026

Uh oh!

shwstppr commented Oct 13, 2026

Uh oh!

blueorangutan commented Oct 13, 2026

Uh oh!

blueorangutan commented Oct 13, 2026

Uh oh!

shwstppr commented Oct 19, 2026

Uh oh!

blueorangutan commented Oct 19, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

blueorangutan commented Oct 19, 2026

Uh oh!

shwstppr commented Oct 20, 2026

Uh oh!

blueorangutan commented Oct 20, 2026

Uh oh!

blueorangutan commented Oct 20, 2026

Uh oh!

shwstppr commented Dec 24, 2025 •

edited

Loading

codecov Bot commented Dec 24, 2025 •

edited

Loading