Format quota email currency values #7605

JoaoJandre · 2023-06-07T11:14:44Z

Description

Currently, in the Quota emails, the formatting of monetary values does not include the currency symbol defined in the quota.currency.symbol configuration. Additionally, the values are not formatted.

This PR changes the Quota emails to use the quota.currency.symbol configuration to set the currency symbol. Additionally, a new configuration has also been created, quota.currency.locale, which should be set to format the value's punctuation in the quota emails using the wanted locale, en-US or pt-BR for example.

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)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

I tested different combinations to observe the changes in the received quota emails.

Test value = 12863.56

`quota.currency.symbol`	`quota.currency.locale`	How it is received in the emails
R$	pt-BR	R$ 12.863,56
test	`null`	test 12863.56
`null`	ja-JP	$ 12,863.56

codecov · 2023-06-07T13:06:13Z

Codecov Report

Merging #7605 (3d725f9) into main (819dd7b) will increase coverage by 0.00%.
Report is 1 commits behind head on main.
The diff coverage is 68.75%.

@@            Coverage Diff            @@
##               main    #7605   +/-   ##
=========================================
  Coverage     14.40%   14.40%           
- Complexity    10109    10110    +1     
=========================================
  Files          2748     2748           
  Lines        259390   259401   +11     
  Branches      40381    40382    +1     
=========================================
+ Hits          37353    37361    +8     
- Misses       217207   217209    +2     
- Partials       4830     4831    +1

Files Changed	Coverage Δ
.../org/apache/cloudstack/quota/QuotaServiceImpl.java	`35.86% <0.00%> (ø)`
...apache/cloudstack/quota/QuotaAlertManagerImpl.java	`64.24% <71.42%> (+0.31%)`	⬆️
.../apache/cloudstack/quota/constant/QuotaConfig.java	`100.00% <100.00%> (ø)`

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

DaanHoogland

good functionality, small remarks

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

utils/src/main/java/com/cloud/utils/NumbersUtil.java

DaanHoogland · 2023-06-08T13:08:26Z

@blueorangutan package

blueorangutan · 2023-06-08T13:10:03Z

@DaanHoogland a [LL] 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 · 2023-06-08T14:13:53Z

Packaging result [LL]: ✔️ el7 ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 6110

DaanHoogland · 2023-06-08T14:18:28Z

@blueorangutan test

blueorangutan · 2023-06-08T14:20:03Z

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

blueorangutan · 2023-06-08T20:40:37Z

[SF] Trillian test result (tid-6708)
Environment: kvm-centos7 (x2), Advanced Networking with Mgmt server 7
Total time taken: 21396 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr7605-t6708-kvm-centos7.zip
Smoke tests completed. 86 look OK, 0 have errors, 24 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
all_test_safe_shutdown	`Skipped`	---	test_safe_shutdown.py
all_test_metrics_api	`Skipped`	---	test_metrics_api.py
all_test_outofbandmanagement	`Skipped`	---	test_outofbandmanagement.py
all_test_outofbandmanagement_nestedplugin	`Skipped`	---	test_outofbandmanagement_nestedplugin.py
all_test_routers_iptables_default_policy	`Skipped`	---	test_routers_iptables_default_policy.py
all_test_secondary_storage	`Skipped`	---	test_secondary_storage.py
all_test_service_offerings	`Skipped`	---	test_service_offerings.py
all_test_storage_policy	`Skipped`	---	test_storage_policy.py
all_test_templates	`Skipped`	---	test_templates.py
all_test_update_security_group	`Skipped`	---	test_update_security_group.py
all_test_usage_events	`Skipped`	---	test_usage_events.py
all_test_vm_autoscaling	`Skipped`	---	test_vm_autoscaling.py
all_test_vm_deployment_planner	`Skipped`	---	test_vm_deployment_planner.py
all_test_vm_life_cycle	`Skipped`	---	test_vm_life_cycle.py
all_test_vm_lifecycle_unmanage_import	`Skipped`	---	test_vm_lifecycle_unmanage_import.py
all_test_vm_snapshot_kvm	`Skipped`	---	test_vm_snapshot_kvm.py
all_test_vm_snapshots	`Skipped`	---	test_vm_snapshots.py
all_test_volumes	`Skipped`	---	test_volumes.py
all_test_vpc_ipv6	`Skipped`	---	test_vpc_ipv6.py
all_test_vpc_redundant	`Skipped`	---	test_vpc_redundant.py
all_test_vpc_router_nics	`Skipped`	---	test_vpc_router_nics.py
all_test_vpc_vpn	`Skipped`	---	test_vpc_vpn.py
all_test_host_maintenance	`Skipped`	---	test_host_maintenance.py
all_test_hostha_kvm	`Skipped`	---	test_hostha_kvm.py

JoaoJandre · 2023-08-09T17:29:09Z

@DaanHoogland could we rerun the tests for this PR?

JoaoJandre · 2023-08-09T17:29:16Z

@blueorangutan package

blueorangutan · 2023-08-09T17:30:04Z

@JoaoJandre a [SF] 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 · 2023-08-09T18:39:28Z

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

DaanHoogland · 2023-08-10T06:52:08Z

@blueorangutan test

blueorangutan · 2023-08-10T06:54:06Z

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

blueorangutan · 2023-08-10T19:09:15Z

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

Test	Result	Time (s)	Test File
test_01_migrate_VM_and_root_volume	`Error`	76.76	test_vm_life_cycle.py
test_02_migrate_VM_with_two_data_disks	`Error`	53.47	test_vm_life_cycle.py

github-actions · 2023-08-29T18:58:35Z

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

…a-emails

GutoVeronezi

CLGTM

GutoVeronezi · 2023-10-09T11:10:14Z

utils/src/main/java/com/cloud/utils/NumbersUtil.java

+     * <li>value.toString() if the numberFormat is null;</li>
+     * <li>the value formatted if both parameters are not null;</li>
+     */
+    public static String formatBigDecimalAccordingToNumberFormat(BigDecimal value, NumberFormat numberFormat) {


We could add some unit tests for this method.

GutoVeronezi · 2023-10-09T11:10:22Z

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

@@ -238,19 +248,29 @@ public void sendQuotaAlert(DeferredQuotaEmail emailToBeSent) {
        }
    }

+    private NumberFormat getLocaleFormatIfCurrencyLocaleNotNull() {


We could add some unit tests for this method.

DaanHoogland · 2023-10-09T15:16:39Z

@blueorangutan package

blueorangutan · 2023-10-09T15:18:04Z

@DaanHoogland a [SF] 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 · 2023-10-09T16:22:20Z

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

DaanHoogland · 2023-10-09T17:15:28Z

@blueorangutan test

blueorangutan · 2023-10-09T17:16:03Z

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

blueorangutan · 2023-10-10T08:23:53Z

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

Test	Result	Time (s)	Test File
test_02_upgrade_kubernetes_cluster	`Failure`	610.23	test_kubernetes_clusters.py
test_08_upgrade_kubernetes_ha_cluster	`Failure`	711.00	test_kubernetes_clusters.py

format quota email values

9f1ee16

boring-cyborg bot added the component:quota label Jun 7, 2023

DaanHoogland approved these changes Jun 7, 2023

View reviewed changes

framework/quota/src/main/java/org/apache/cloudstack/quota/QuotaAlertManagerImpl.java Outdated Show resolved Hide resolved

utils/src/main/java/com/cloud/utils/NumbersUtil.java Outdated Show resolved Hide resolved

Address daans reviews

2dd7f5a

DaanHoogland added this to the 4.19.0.0 milestone Jun 22, 2023

github-actions bot added the status:has-conflicts label Aug 29, 2023

Merge remote-tracking branch 'origin/main' into format-values-in-quot…

3d725f9

…a-emails

github-actions bot removed the status:has-conflicts label Aug 30, 2023

GutoVeronezi approved these changes Oct 9, 2023

View reviewed changes

DaanHoogland merged commit 43aed45 into apache:main Oct 10, 2023
25 of 26 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Format quota email currency values #7605

Format quota email currency values #7605

JoaoJandre commented Jun 7, 2023

codecov bot commented Jun 7, 2023 •

edited

DaanHoogland left a comment

DaanHoogland commented Jun 8, 2023

blueorangutan commented Jun 8, 2023

blueorangutan commented Jun 8, 2023

DaanHoogland commented Jun 8, 2023

blueorangutan commented Jun 8, 2023

blueorangutan commented Jun 8, 2023

JoaoJandre commented Aug 9, 2023

JoaoJandre commented Aug 9, 2023

blueorangutan commented Aug 9, 2023

blueorangutan commented Aug 9, 2023

DaanHoogland commented Aug 10, 2023

blueorangutan commented Aug 10, 2023

blueorangutan commented Aug 10, 2023

github-actions bot commented Aug 29, 2023

GutoVeronezi left a comment

GutoVeronezi Oct 9, 2023

GutoVeronezi Oct 9, 2023

DaanHoogland commented Oct 9, 2023

blueorangutan commented Oct 9, 2023

blueorangutan commented Oct 9, 2023

DaanHoogland commented Oct 9, 2023

blueorangutan commented Oct 9, 2023

blueorangutan commented Oct 10, 2023

Format quota email currency values #7605

Format quota email currency values #7605

Conversation

JoaoJandre commented Jun 7, 2023

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

codecov bot commented Jun 7, 2023 • edited

Codecov Report

DaanHoogland left a comment

Choose a reason for hiding this comment

DaanHoogland commented Jun 8, 2023

blueorangutan commented Jun 8, 2023

blueorangutan commented Jun 8, 2023

DaanHoogland commented Jun 8, 2023

blueorangutan commented Jun 8, 2023

blueorangutan commented Jun 8, 2023

JoaoJandre commented Aug 9, 2023

JoaoJandre commented Aug 9, 2023

blueorangutan commented Aug 9, 2023

blueorangutan commented Aug 9, 2023

DaanHoogland commented Aug 10, 2023

blueorangutan commented Aug 10, 2023

blueorangutan commented Aug 10, 2023

github-actions bot commented Aug 29, 2023

GutoVeronezi left a comment

Choose a reason for hiding this comment

GutoVeronezi Oct 9, 2023

Choose a reason for hiding this comment

GutoVeronezi Oct 9, 2023

Choose a reason for hiding this comment

DaanHoogland commented Oct 9, 2023

blueorangutan commented Oct 9, 2023

blueorangutan commented Oct 9, 2023

DaanHoogland commented Oct 9, 2023

blueorangutan commented Oct 9, 2023

blueorangutan commented Oct 10, 2023

codecov bot commented Jun 7, 2023 •

edited