Add offering preset variables for Network and VPC Quota tariffs

[hsato03]

Description

This PR adds two new preset variables for Network and VPC usage type Quota tariffs.

For Network tariffs, the variables value.networkOffering.id and value.networkOffering.name have been created. For VPC tariffs, the variables value.vpcOffering.id and value.vpcOffering.name have been added.

They represent the resource's offering ID and name, respectively.

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

• BLOCKER
• Critical
• Major
• Minor
• Trivial

Screenshots (if appropriate):

How Has This Been Tested?

I created an isolated network and a VPC with the following offerings.

Offering	ID	Name
Network	30b8c61a-f75a-4b65-8ff3-52a20b179333	DefaultIsolatedNetworkOfferingWithSourceNatService
VPC	2128acd0-9753-4e2a-8c99-2815da566873	Default VPC offering

Then, I created a Network tariff (offering-test-network) with the following activation rule.

if(value.networkOffering.id==='30b8c61a-f75a-4b65-8ff3-52a20b179333 && value.networkOffering.name === 'DefaultIsolatedNetworkOfferingWithSourceNatService'){300}else{0}

Next, I created a VPC tariff (offering-test-vpc) with the following activation rule.

if(value.vpcOffering.id==='2128acd0-9753-4e2a-8c99-2815da566873 && value.vpcOffering.name === 'DefaultVPCoffering'){500}else{0}

I called the quotaUpdate API and verified that the value 300 was returned by the offering-test-network activation rule, while offering-test-vpc returned 500.

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

[hsato03]

@blueorangutan package

[blueorangutan]

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

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 18.03%. Comparing base (1bff543) to head (61715c4).
⚠️ Report is 133 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #11810 +/- ##
=========================================
Coverage 18.02% 18.03% - Complexity 16460 16473 +13 
=========================================
Files 5968 5968 Lines 537213 537248 +35 Branches 65975 65977 +2 =========================================
+ Hits 96825 96884 +59 + Misses 429469 429445 -24 
Partials 10919 10919 

Flag	Coverage Δ
uitests	3.53% <ø> (ø)
unittests	19.20% <100.00%> (+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.

[blueorangutan]

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

[github-actions]

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

[DaanHoogland]

@blueorangutan package

[blueorangutan]

@DaanHoogland 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]

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

[DaanHoogland]

@blueorangutan test keepEnv

[blueorangutan]

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

[blueorangutan]

[SF] Trillian test result (tid-15218)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 57521 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr11810-t15218-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
test_03_deploy_and_scale_kubernetes_cluster	Failure	28.78	test_kubernetes_clusters.py

[Copilot]

Pull request overview

This PR adds offering preset variables for Network and VPC quota tariffs, enabling users to create activation rules based on the network offering and VPC offering properties.

Changes:

• Added networkOffering and vpcOffering preset variables to the Value class with appropriate getters/setters
• Implemented helper methods to retrieve network and VPC offering information
• Relocated VPC offering DAO beans to the common Spring context for usage module access

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
PresetVariableHelper.java	Added getPresetVariableValueNetworkOffering and getPresetVariableValueVpcOffering methods to populate offering information; updated load methods to set the new fields
Value.java	Added networkOffering and vpcOffering fields with @PresetVariableDefinition annotations and corresponding getters/setters
PresetVariableHelperTest.java	Added unit tests for the new getPresetVariableValueNetworkOffering and getPresetVariableValueVpcOffering methods; added VpcOfferingDao mock
spring-engine-schema-core-daos-context.xml	Removed vpcOfferingDaoImpl and vpcOfferingDetailsDaoImpl bean definitions
spring-engine-schema-core-common-daos-between-management-and-usage-context.xml	Added vpcOfferingDaoImpl and vpcOfferingDetailsDaoImpl bean definitions to make them accessible in the usage context

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[DaanHoogland]

@hsato03 , I feel a bit out of my depth on these preset variables and they only appear once in the documentation when it comes to storage; i.e. https://docs.cloudstack.apache.org/en/4.22.0.0/adminguide/storage.html#direct-resources-to-a-specific-secondary-storage. Is there some wiki page I can read to be able to concoct sensible tests for this?

@winterhazel , will you review?

[winterhazel]

@winterhazel , will you review?

@DaanHoogland yes, I should be able to review and test this one by the end of the week.

@hsato03 , I feel a bit out of my depth on these preset variables and they only appear once in the documentation when it comes to storage; i.e. https://docs.cloudstack.apache.org/en/4.22.0.0/adminguide/storage.html#direct-resources-to-a-specific-secondary-storage. Is there some wiki page I can read to be able to concoct sensible tests for this?

The Quota documentation needs some updating on how to use the activation rules and preset variables. There is no wiki on how to use them at the moment. We hope to address it in version 23/24 along with the pending code changes.

Here's a basic guide on how to test the changes in this PR:

1. Install Usage and ensure it is running. Also, have a look at the configured execution time, which is defined through the global settings usage.stats.job.exec.time and usage.execution.timezone.

2. Enable Quota and JS interpretation. This can be done by toggling quota.enable.service and js.interpretation.enabled on and restarting the Management Server.

3. Create different network and VPC offerings to be used for the tests.

4. Create some tariffs (through quotaTariffCreate) using the preset variables in the activation rule.

   For the network usage type tariff, you can use the following activation rule:

   if(value.networkOffering.id==='<uuid-of-network-offering-X>'){200}else{100}

   This tariff will charge users 200 credits in a month for each network using network offering X, and 100 for all other offerings. As this rule already returns a value, the tariff value can be left as 0 (it will be ignored). Another option is returning a true/false instead in the rule to inform whether or not the tariff value should be applied. The other non-required fields may be left as blank to use default values.

   (localcloud) 🐱 quota tariffcreate name="network tariff" usagetype=30 activationrule="if (value.networkOffering.id === '<uuid-of-network-offering-X>') { 200 } else { 100 }" value=0

   For the VPC usage type tariff, the following activation rule can be used:

   if(value.vpcOffering.id==='<uuid-of-VPC-offering-Y>'){300}else{200}

   This one will charge users 300 credits in a month for each VPC using the VPC offering Y, and 200 for all others.

   (localcloud) 🐱 quota tariffcreate name="vpc tariff" usagetype=31 activationrule="if (value.vpcOffering.id === '<uuid-of-VPC-offering-Y>') { 300 } else { 200 }" value=0

5. Create and implement some networks and VPCs with the different offerings for this so that usage records are later generated.

6. Run the Usage job. I usually do this by manually setting the date of the VM running the Usage server to some minutes before the execution of the next day and restarting the service.

After the Usage job finishes generating all usage records, Quota will process them and charge credits from users based on the tariffs. You can follow Usage's logs during the job's execution to see which values are being charged for that execution, debug it to see which values are being injected as preset variables (I usually place my breakpoint in org.apache.cloudstack.quota.QuotaManagerImpl#injectPresetVariablesIntoJsInterpreter), and see the new balances in the Quota summary page.

The idea for debugging other PRs that add preset variables is the same.

[winterhazel]

While testing this, I found that preset variables are not being injected correctly into the JS interpreter anymore, which prevents this change from working as expected. #12515 needs to be merged first.

[hsato03]

@blueorangutan package

[blueorangutan]

@hsato03 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]

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

[winterhazel]

@DaanHoogland can we run the CI here?

[bernardodemarco]

code lgtm, did not test it

[DaanHoogland]

@blueorangutan test

[blueorangutan]

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

[blueorangutan]

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

Test	Result	Time (s)	Test File
ContextSuite context=TestResetVmOnReboot>:setup	Error	0.00	test_reset_vm_on_reboot.py
ContextSuite context=TestRAMCPUResourceAccounting>:setup	Error	0.00	test_resource_accounting.py

[winterhazel]

Looks good. I tested by following the steps in #11810 (comment) and validating that the network and VPC tariffs were applying the correct values depending on the resource's offering.