config cleanup by DaanHoogland · Pull Request #13884 · apache/cloudstack

DaanHoogland · 2026-08-15T11:43:29Z

Description

This PR tries to get rid of the Config enum or the old mechanism to define configuration items, which is long overdue. The change should be transparent, but is huge so good regression testing is required. And merg early in the release cycle is recommended.
Commits are being done in batches for review convenience. They could have been done in separate PRs but in the end the changes are rather trivial.

Fixes: #10752

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?

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

codecov · 2026-08-15T11:52:48Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 3.70%. Comparing base (c76c01e) to head (e107d8c).
⚠️ Report is 1 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (c76c01e) and HEAD (e107d8c). Click for more details.

HEAD has 1 upload less than BASE

Flag BASE (c76c01e) HEAD (e107d8c)

unittests 1 0

Additional details and impacted files

@@              Coverage Diff              @@
##               main   #13884       +/-   ##
=============================================
- Coverage     20.45%    3.70%   -16.75%     
=============================================
  Files          6487      493     -5994     
  Lines        589329    42558   -546771     
  Branches      72246     8063    -64183     
=============================================
- Hits         120554     1578   -118976     
+ Misses       455642    40751   -414891     
+ Partials      13133      229    -12904

Flag	Coverage Δ
uitests	`3.70% <ø> (ø)`
unittests	`?`

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-08-15T12:46:39Z

🔴 Test Coverage Grade: `D` — Marginal

Metric	Value
Line coverage	25.51%
Branch coverage	19.83%

Grade Scale

Grade	Line Coverage	Meaning
🟢 A	≥ 80%	Excellent - this code sleeps well at night 😴
🟡 B	60-79%	Good - almost there, don't stop now 😉
🟠 C	40-59%	Acceptable - your code is wearing a seatbelt, but no airbags 😬
🔴 D	20-39%	Marginal - boldly shipping where no test has gone before 🖖
⛔ F	< 20%	Failing - tests? what tests? 🔥

Branch coverage is shown as a secondary signal. Grade is determined by line coverage.
View full Actions run

… gate

…nDao

DaanHoogland · 2026-10-22T07:12:42Z

@blueorangutan package

blueorangutan · 2026-10-22T07:14:05Z

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

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

11 open issues

configDepot is changed from a mocked ConfigurationDao to a plain ConfigDepotImpl field, but… · New
configDepot is changed from a mocked ConfigurationDao to a plain ConfigDepotImpl field, but… · New
The default value hard-codes credentials (\"admin1:AdMiN123\") for HAProxy stats auth. This is an…
Long.parseLong(_configDao.getValue(...)) can throw NPE/NumberFormatException when the config key…
The defaults introduced in the new ConfigKeys appear to change behavior vs the prior… · New
This PR introduces multiple local duplicated ConfigKey declarations for the same underlying…
The HAProxy stats port is modeled as a String but is consumed numerically elsewhere (e.g., parsed…
This introduces yet another local ConfigKey definition for detail.batch.query.size (similar…
The description for publish.resource.state.events says it controls publishing of 'alert events',… · New
The description for publish.resource.state.events is inaccurate: it refers to 'alert events', but…
The description text should use the plural form for units. Consider changing 'In second' to 'In…

_{Review effort: Lite}

+            "network.securitygroups.work.cleanup.interval", "120",
+            "Time interval (seconds) in which finished work is cleaned up from the work table", true);
+
+    ConfigKey<Integer> SecurityGroupWorkerThreads = new ConfigKey<>("Network", Integer.class,
+            "network.securitygroups.workers.pool.size", "50",


+    // Registered/owned by com.cloud.server.ManagementServer#PublishResourceStateEvent; declared here too so this
+    // module can read it without a reverse dependency on the server module.
+    private static final ConfigKey<Boolean> PublishResourceStateEvent = new ConfigKey<>("Advanced", Boolean.class, "publish.resource.state.events", "true",
+            "enable or disable publishing of alert events on the event bus", true);


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

14 open issues

configDepot is no longer annotated as a Mockito mock in the diff (it’s declared as a field but… · New
configDepot is no longer annotated as a Mockito mock in the diff (it’s declared as a field but… · New
configDepot is changed from a mocked ConfigurationDao to a plain ConfigDepotImpl field, but…
configDepot is changed from a mocked ConfigurationDao to a plain ConfigDepotImpl field, but…
The default value hard-codes credentials (\"admin1:AdMiN123\") for HAProxy stats auth. This is an…
Long.parseLong(_configDao.getValue(...)) can throw NPE/NumberFormatException when the config key…
The defaults introduced in the new ConfigKeys appear to change behavior vs the prior…
This PR introduces multiple local duplicated ConfigKey declarations for the same underlying…
The HAProxy stats port is modeled as a String but is consumed numerically elsewhere (e.g., parsed…
This introduces yet another local ConfigKey definition for detail.batch.query.size (similar…
The PublishResourceStateEvent description says it controls publishing of \"alert events\", but… · New
The description for publish.resource.state.events says it controls publishing of 'alert events',…
The description for publish.resource.state.events is inaccurate: it refers to 'alert events', but…
The description text should use the plural form for units. Consider changing 'In second' to 'In…

_{Review effort: Lite}

    @Mock
-    ConfigurationDao _configDao;
+    ConfigDepotImpl configDepot;


    @Before
    public void setup() {
-        when(_configDao.getValue(batchSizeConfigurationKey)).thenReturn(batchSizeValue);
+        ConfigKey.init(configDepot);
+        when(configDepot.getConfigStringValue(batchSizeConfigurationKey, ConfigKey.Scope.Global, null)).thenReturn(batchSizeValue);


+    // Registered/owned by com.cloud.server.ManagementServer#PublishResourceStateEvent; declared here too so this
+    // module can read it without a reverse dependency on the server module.
+    private static final ConfigKey<Boolean> PublishResourceStateEvent = new ConfigKey<>("Advanced", Boolean.class, "publish.resource.state.events", "true",
+            "enable or disable publishing of alert events on the event bus", true);


DaanHoogland · 2026-10-22T07:54:13Z

@nvazquez , as discussed I am busy splitting this PR with the help of AI. I will close this one as soon as I am satisfied the cascade of PRs, that I'll be creating cover everything. I will keep this open and mark as draft for testing purposes.

sonarqubecloud · 2026-10-22T08:26:24Z

Quality Gate failed

Failed conditions
23.9% Coverage on New Code (required ≥ 40%)
C Reliability Rating on New Code (required ≥ B)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

blueorangutan · 2026-10-22T08:38:21Z

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

DaanHoogland · 2026-10-23T09:26:32Z

This PR has been split into smaller PRs:

Foundation (merge first)

declare and register ConfigKeys for all remaining Config enum entries #14467 declare and register ConfigKeys for all remaining Config enum entries

Parallel (based on the foundation; can be reviewed and merged in any order)

use ConfigKeys for account, domain, project and SSO settings #14468 use ConfigKeys for account, domain, project and SSO settings
use ConfigKeys for remote access VPN and VPC settings #14469 use ConfigKeys for remote access VPN and VPC settings
use ConfigKeys for snapshot, VM snapshot and usage settings #14470 use ConfigKeys for snapshot, VM snapshot and usage settings
use ConfigKeys for event bus settings #14471 use ConfigKeys for event bus settings
use ConfigKeys for UCS settings and remaining getValue() literals #14472 use ConfigKeys for UCS settings and remaining getValue() literals

Stacked (merge in this order, starting after the foundation)

use ConfigKeys for alert, storage, guest network and hidden settings #14473 core-1: alert, storage, guest network and hidden settings
use ConfigKeys for ManagementServer, agent, secondary storage and router settings #14474 core-2: ManagementServer, agent, secondary storage and router settings
use ConfigKeys for network, stats collector, storage, user VM and account manager settings #14475 core-3: network, stats collector, storage, user VM and account manager settings
use ConfigKeys for deployment planning, ELB, API rate limit, LB and firewall settings #14476 core-4: deployment planning, ELB, API rate limit, LB and firewall settings
use ConfigKeys for assorted management server, VMware, XenServer and baremetal settings #14477 core-5: assorted management server, VMware, XenServer and baremetal settings

Last: removing the dead Config enum entries will be opened once all of the above are merged.

DaanHoogland added this to the 4.24.0 milestone Aug 15, 2026

Copilot AI lite review requested due to automatic review settings August 15, 2026 11:43

This comment was marked as duplicate.

Sign in to view

Copilot AI review requested due to automatic review settings August 15, 2026 15:12

boring-cyborg Bot added component:agent component:hyperv component:vmware component:XenServer labels Aug 15, 2026

This comment was marked as duplicate.

Sign in to view

Copilot AI review requested due to automatic review settings August 15, 2026 15:49

This comment was marked as duplicate.

Sign in to view

Copilot AI review requested due to automatic review settings August 15, 2026 16:07

This comment was marked as duplicate.

Sign in to view

Copilot AI review requested due to automatic review settings August 15, 2026 19:40

boring-cyborg Bot added the component:ipv6 label Aug 15, 2026

Daan Hoogland added 8 commits October 21, 2026 12:19

add ConfigKey wiring tests for ApiRateLimitServiceImpl

24f49c5

add ConfigKey wiring tests for ApiResponseSerializer version-exposure…

0b7d360

… gate

remove duplicate config key

ce93456

sonar alerts and other suggestions

268b971

remaining configs moved

ae96f20

more literals removed

2df6c21

replace ConfigurationDao.getValue() literals with ConfigKeys

6701363

register missing ConfigKeys and fix tests still stubbing Configuratio…

f7a0c3e

…nDao

Copilot AI reviewed Oct 22, 2026

View reviewed changes

bhouse-nexthop mentioned this pull request Oct 22, 2026

VPC ACL: match all ports for a tcp/udp rule given without ports #14364

Open

3 of 12 tasks

remove null check that is always false

e107d8c

Conversation

DaanHoogland commented Aug 15, 2026

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

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

Uh oh!

This comment was marked as duplicate.

Uh oh!

codecov Bot commented Aug 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions Bot commented Aug 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔴 Test Coverage Grade: D — Marginal

Grade Scale

Uh oh!

This comment was marked as duplicate.

Uh oh!

This comment was marked as duplicate.

Uh oh!

This comment was marked as duplicate.

Uh oh!

DaanHoogland commented Oct 22, 2026

Uh oh!

blueorangutan commented Oct 22, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

Uh oh!

DaanHoogland commented Oct 22, 2026

Uh oh!

sonarqubecloud Bot commented Oct 22, 2026

Quality Gate failed

Uh oh!

blueorangutan commented Oct 22, 2026

Uh oh!

DaanHoogland commented Oct 23, 2026

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov Bot commented Aug 15, 2026 •

edited

Loading

github-actions Bot commented Aug 15, 2026 •

edited

Loading

🔴 Test Coverage Grade: `D` — Marginal