API to validate Quota activation rule #9605

hsato03 · 2024-08-29T23:11:30Z

Description

When entering an activation rule during the creation and editing of Quota tariffs, the defined rule is not validated. This way, errors are only identified while processing the tariff.

Because of this, the quotaValidateActivationRule API was created, which informs whether the activation rule is valid or not. Also, the activation rule field was added when creating and editing the tariff via UI.

API parameters

Parameter	Description	Required
activationrule	The activation rule that will be validated.	Yes
quotaresourcetype	tariff usage type to validate the variables used in the script.	Yes

Example

🐱 > quota validateactivationrule activationrule="if (account.name == 'admin') { 0 } else { 300 }" usagetype=6
{
  "validactivationrule": {
    "activationrule": "if (account.name == 'admin') { 0 } else { 300 }",
    "isvalid": true,
    "message": "The script has no syntax errors and all variables are compatible with the given usage type.",
    "quotatype": "VOLUME"
  }
}

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

How Has This Been Tested?

N°	Test	Valid activation rule
1	Activation rule with valid JS code and with variables compatible with the given usage type	Yes
2	Activation rule with valid JS code and with variables that are not compatible with the given usage type	No
3	Activation rule with invalid JS code	No

hsato03 · 2024-08-29T23:12:59Z

@blueorangutan package

blueorangutan · 2024-08-29T23:14:03Z

@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 · 2024-08-29T23:18:57Z

Codecov Report

Attention: Patch coverage is 78.29787% with 51 lines in your changes missing coverage. Please review.

Project coverage is 15.81%. Comparing base (04c428c) to head (83ad4d1).
Report is 9 commits behind head on main.

Files with missing lines	Patch %	Lines
.../cloudstack/jsinterpreter/JsInterpreterHelper.java	89.51%	10 Missing and 3 partials ⚠️
...ck/api/command/QuotaValidateActivationRuleCmd.java	33.33%	12 Missing ⚠️
.../response/QuotaValidateActivationRuleResponse.java	62.96%	9 Missing and 1 partial ⚠️
...g/apache/cloudstack/quota/constant/QuotaTypes.java	0.00%	9 Missing ⚠️
...ctivationrule/presetvariables/PresetVariables.java	0.00%	6 Missing ⚠️
.../org/apache/cloudstack/quota/QuotaServiceImpl.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #9605      +/-   ##
============================================
+ Coverage     15.78%   15.81%   +0.02%     
- Complexity    12551    12597      +46     
============================================
  Files          5625     5628       +3     
  Lines        491958   492225     +267     
  Branches      63091    61373    -1718     
============================================
+ Hits          77663    77847     +184     
- Misses       405836   405916      +80     
- Partials       8459     8462       +3

Flag	Coverage Δ
uitests	`4.03% <ø> (-0.01%)`	⬇️
unittests	`16.63% <78.29%> (+0.03%)`	⬆️

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.

blueorangutan · 2024-08-30T00:16:29Z

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

github-actions · 2024-09-17T14:45:50Z

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

bernardodemarco

LGTM, manually tested in a local environment.

Test descriptions

Firstly, I validated whether the quotaValidateActivationRule API would correctly identify JavaScript syntax errors.

The API correctly recognized the syntax error, which is the expected behavior.

Next, I inserted a valid syntax, and no errors were returned in the API response.

Relating to the validations of the preset variables, I selected the Template usage type and inserted the value.computingResources.cpuNumber variable into the script. Since it is not compatible with the selected usage type, an error was returned.

Then, I changed the usage type to Running VM and the script had been successfully validated, since the variable value.computingResources.cpuNumber is compatible with the selected usage type.

BryanMLima

Just some minor suggestions, overall, LGTM.

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

...ta/src/main/java/org/apache/cloudstack/api/response/QuotaValidateActivationRuleResponse.java

server/src/main/java/org/apache/cloudstack/jsinterpreter/JsInterpreterHelper.java

BryanMLima · 2024-09-23T13:36:24Z

@hsato03, the build is failing due to the logger variable in the VmwareHelper.java class, it should be fixed by #9714.

Co-authored-by: Bryan Lima <[email protected]>

hsato03 · 2024-09-27T23:56:09Z

@blueorangutan package

blueorangutan · 2024-09-27T23:58:04Z

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

blueorangutan · 2024-09-28T00:58:17Z

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

DaanHoogland · 2024-09-30T13:20:44Z

@blueorangutan test

blueorangutan · 2024-09-30T13:22:04Z

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

blueorangutan · 2024-10-01T09:10:38Z

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

Test	Result	Time (s)	Test File
ContextSuite context=TestISOUsage>:setup	`Error`	0.00	test_usage.py
all_test_vpc_router_nics	`Skipped`	---	test_vpc_router_nics.py
all_test_vpc_vpn	`Skipped`	---	test_vpc_vpn.py
all_test_webhook_delivery	`Skipped`	---	test_webhook_delivery.py
all_test_webhook_lifecycle	`Skipped`	---	test_webhook_lifecycle.py
all_test_host_maintenance	`Skipped`	---	test_host_maintenance.py
all_test_hostha_kvm	`Skipped`	---	test_hostha_kvm.py

hsato03 · 2024-10-02T17:41:58Z

@DaanHoogland the test error logs don't seem to be related to the PR.

Traceback (most recent call last):
  File "/usr/local/lib/python3.6/site-packages/nose/suite.py", line 210, in run
    self.setUp()
  File "/usr/local/lib/python3.6/site-packages/nose/suite.py", line 293, in setUp
    self.setupContext(ancestor)
  File "/usr/local/lib/python3.6/site-packages/nose/suite.py", line 316, in setupContext
    try_run(context, names)
  File "/usr/local/lib/python3.6/site-packages/nose/util.py", line 471, in try_run
    return func()
  File "/marvin/tests/smoke/test_usage.py", line 1025, in setUpClass
    cls.iso.id
Exception: ISO download failed exception: Failed to download ISO: 2785331c-21e7-47d5-91d5-ffb46b2dbe32

Could you run the smoke tests again?

DaanHoogland · 2024-10-04T10:06:12Z

@blueorangutan package

blueorangutan · 2024-10-04T10:08:04Z

@DaanHoogland 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 · 2024-10-04T11:14:45Z

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

DaanHoogland · 2024-10-04T15:20:24Z

@blueorangutan test

blueorangutan · 2024-10-04T15:22:07Z

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

blueorangutan · 2024-10-05T08:39:51Z

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

Test	Result	Time (s)	Test File
all_test_vm_strict_host_tags	`Skipped`	---	test_vm_strict_host_tags.py
all_test_vnf_templates	`Skipped`	---	test_vnf_templates.py

API to validate Quota activation rule

6b37e33

boring-cyborg bot added component:quota component:UI labels Aug 29, 2024

github-actions bot added the status:has-conflicts label Sep 17, 2024

Resolve conflicts & use POST

ea810e1

github-actions bot removed the status:has-conflicts label Sep 19, 2024

DaanHoogland added this to the 4.20.1.0 milestone Sep 20, 2024

DaanHoogland requested review from bernardodemarco, BryanMLima and JoaoJandre September 20, 2024 07:49

bernardodemarco approved these changes Sep 22, 2024

View reviewed changes

BryanMLima approved these changes Sep 23, 2024

View reviewed changes

hsato03 and others added 3 commits September 25, 2024 13:34

Apply suggestions from code review

378dae0

Co-authored-by: Bryan Lima <[email protected]>

Merge branch 'main' into quota-activation-rule-validator

8a9bc33

Use constants

83ad4d1

DaanHoogland added component:api status:needs-testing labels Oct 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API to validate Quota activation rule #9605

API to validate Quota activation rule #9605

hsato03 commented Aug 29, 2024

hsato03 commented Aug 29, 2024

blueorangutan commented Aug 29, 2024

codecov bot commented Aug 29, 2024 •

edited

Loading

blueorangutan commented Aug 30, 2024

github-actions bot commented Sep 17, 2024

bernardodemarco left a comment •

edited

Loading

BryanMLima left a comment

BryanMLima commented Sep 23, 2024

hsato03 commented Sep 27, 2024

blueorangutan commented Sep 27, 2024

blueorangutan commented Sep 28, 2024

DaanHoogland commented Sep 30, 2024

blueorangutan commented Sep 30, 2024

blueorangutan commented Oct 1, 2024

hsato03 commented Oct 2, 2024

DaanHoogland commented Oct 4, 2024

blueorangutan commented Oct 4, 2024

blueorangutan commented Oct 4, 2024

DaanHoogland commented Oct 4, 2024

blueorangutan commented Oct 4, 2024

blueorangutan commented Oct 5, 2024

API to validate Quota activation rule #9605

Are you sure you want to change the base?

API to validate Quota activation rule #9605

Conversation

hsato03 commented Aug 29, 2024

Description

API parameters

Example

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

hsato03 commented Aug 29, 2024

blueorangutan commented Aug 29, 2024

codecov bot commented Aug 29, 2024 • edited Loading

Codecov Report

blueorangutan commented Aug 30, 2024

github-actions bot commented Sep 17, 2024

bernardodemarco left a comment • edited Loading

Choose a reason for hiding this comment

Test descriptions

BryanMLima left a comment

Choose a reason for hiding this comment

BryanMLima commented Sep 23, 2024

hsato03 commented Sep 27, 2024

blueorangutan commented Sep 27, 2024

blueorangutan commented Sep 28, 2024

DaanHoogland commented Sep 30, 2024

blueorangutan commented Sep 30, 2024

blueorangutan commented Oct 1, 2024

hsato03 commented Oct 2, 2024

DaanHoogland commented Oct 4, 2024

blueorangutan commented Oct 4, 2024

blueorangutan commented Oct 4, 2024

DaanHoogland commented Oct 4, 2024

blueorangutan commented Oct 4, 2024

blueorangutan commented Oct 5, 2024

codecov bot commented Aug 29, 2024 •

edited

Loading

bernardodemarco left a comment •

edited

Loading