Fixes issue with loading Capacity dashboard when mulitple backup providers configured by Pearl1594 · Pull Request #12550 · apache/cloudstack

Pearl1594 · 2026-01-29T18:21:26Z

Description

This PR fixed: #12449
The capacity dashboard issue is seen on 4.22 - but in general the getBackupProvider() is fixed to return the first provider set in the global settings when a comma separated list of providers is set.

94ac3ea - adds a validator, that prevents adding a comma separated list for backup provider setting. It also checks if the entered value is a valid one.

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?

…iders configured

codecov · 2026-01-29T18:28:00Z

Codecov Report

❌ Patch coverage is 18.51852% with 22 lines in your changes missing coverage. Please review.
✅ Project coverage is 16.37%. Comparing base (a6ccde4) to head (7b21739).
⚠️ Report is 7 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
...loudstack/framework/config/ValidatedConfigKey.java	27.27%	8 Missing ⚠️
...va/org/apache/cloudstack/backup/BackupManager.java	22.22%	7 Missing ⚠️
.../cloud/configuration/ConfigurationManagerImpl.java	0.00%	4 Missing ⚠️
...rg/apache/cloudstack/backup/BackupManagerImpl.java	0.00%	3 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               4.20   #12550      +/-   ##
============================================
+ Coverage     16.26%   16.37%   +0.10%     
- Complexity    13428    13467      +39     
============================================
  Files          5660     5661       +1     
  Lines        499907   502387    +2480     
  Branches      60696    61802    +1106     
============================================
+ Hits          81316    82264     +948     
- Misses       409521   410996    +1475     
- Partials       9070     9127      +57

Flag	Coverage Δ
uitests	`5.06% <ø> (+0.91%)`	⬆️
unittests	`17.17% <18.51%> (+0.05%)`	⬆️

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.

Pearl1594 · 2026-01-29T20:33:33Z

@blueorangutan package

blueorangutan · 2026-01-29T20:34:04Z

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

Pearl1594 · 2026-01-29T21:29:09Z

@abh1sar @DaanHoogland I've added this bit : 94ac3ea to add a validator that can be used for any configuration. Do you think this is useful?

blueorangutan · 2026-01-29T21:39:01Z

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

Pearl1594 · 2026-01-30T00:03:53Z

@blueorangutan package

blueorangutan · 2026-01-30T00:06:06Z

@Pearl1594 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-01-30T01:00:55Z

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

api/src/main/java/org/apache/cloudstack/backup/BackupManager.java

framework/config/src/main/java/org/apache/cloudstack/framework/config/ValidatedConfigKey.java

abh1sar

Code LGTM.
just a few nitpicks.

abh1sar · 2026-01-30T15:58:18Z

api/src/main/java/org/apache/cloudstack/backup/BackupManager.java

            "dummy",
-            "The backup and recovery provider plugin.", true, ConfigKey.Scope.Zone, BackupFrameworkEnabled.key());
+            "The backup and recovery provider plugin. Valid plugin values: dummy, veeam, networker and nas",
+            true, ConfigKey.Scope.Zone, BackupFrameworkEnabled.key(), value -> validateBackupProviderConfig((String)value));


Suggested change

true, ConfigKey.Scope.Zone, BackupFrameworkEnabled.key(), value -> validateBackupProviderConfig((String)value));

true, ConfigKey.Scope.Zone, BackupFrameworkEnabled.key(), value -> validateBackupProviderConfig((String) value));

abh1sar · 2026-01-30T15:59:48Z

server/src/main/java/org/apache/cloudstack/backup/BackupManagerImpl.java

            throw new CloudRuntimeException("Invalid backup provider name provided");
        }
-        if (!backupProvidersMap.containsKey(name)) {
+        String[] backupProviderNames = name.split(",");


This is not possible now, right?

I don't think so, currently, ACS allows taking any string as input, so if we provide a comma separated string, it would compare that with providers supported in ACS, and would fail and report Cannot find backup provider by name: dummy,nas (if both were set)

I meant that validator will not allow , in the name, so no need for splitting the name by comma. We can revert to old code.

--@abh1sar , what do you mean by “the validator”? are you talking about the ui/service/manager…—

never mind, got it.

You're right, with the validator - this isn't required.

DaanHoogland · 2026-02-04T12:59:57Z

@Pearl1594 , can you address @abh1sar ’s comments?

DaanHoogland

clgtm

DaanHoogland · 2026-02-04T13:22:00Z

@blueorangutan package

blueorangutan · 2026-02-04T13:24:09Z

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

sonarqubecloud · 2026-02-04T14:09:03Z

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 40%)
C Maintainability 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-02-04T14:18:43Z

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

sureshanaparti · 2026-02-04T15:03:15Z

api/src/main/java/org/apache/cloudstack/backup/BackupManager.java

+        if (value != null && (value.contains(",") || value.trim().contains(" "))) {
+            throw new IllegalArgumentException("Multiple backup provider plugins are not supported. Please provide a single plugin value.");
+        }
+        List<String> validPlugins = List.of("dummy", "veeam", "networker", "nas");


can check these values with the enum?

we don't have enums - do you want me to create one?

abh1sar

Code LGTM. Thanks @Pearl1594 .

DaanHoogland · 2026-02-05T09:25:24Z

94ac3ea

@Pearl1594 , I never answerred this query; I think it is great, I wonder though if it shouldn’t just be part of ConfigKey instead of in a derived class??

Fixes issue with loading Capacity dashboard when mulitple backup prov…

0bb1616

…iders configured

Pearl1594 requested a review from abh1sar January 29, 2026 18:21

boring-cyborg bot added the component:backup label Jan 29, 2026

Add validator for config key

94ac3ea

boring-cyborg bot added the component:api label Jan 29, 2026

Pearl1594 requested a review from DaanHoogland January 29, 2026 21:29

cleanup

2d146fa

abh1sar reviewed Jan 30, 2026

View reviewed changes

Pearl1594 added 2 commits January 29, 2026 23:33

extract code

de23052

trim spaces when checking for commas

174f92d

abh1sar reviewed Jan 30, 2026

View reviewed changes

api/src/main/java/org/apache/cloudstack/backup/BackupManager.java Outdated Show resolved Hide resolved

framework/config/src/main/java/org/apache/cloudstack/framework/config/ValidatedConfigKey.java Outdated Show resolved Hide resolved

DaanHoogland added this to the 4.20.3 milestone Jan 30, 2026

DaanHoogland linked an issue Jan 30, 2026 that may be closed by this pull request

Capacity dashboard doesn't load if incorrect backup.framework.provider.plugin value is given #12449

Open

address comments

0669ac3

abh1sar approved these changes Jan 30, 2026

View reviewed changes

revert old code

7b21739

DaanHoogland approved these changes Feb 4, 2026

View reviewed changes

DaanHoogland added the status:needs-testing label Feb 4, 2026

sureshanaparti reviewed Feb 4, 2026

View reviewed changes

RosiKyu self-assigned this Feb 4, 2026

abh1sar approved these changes Feb 5, 2026

View reviewed changes

	true, ConfigKey.Scope.Zone, BackupFrameworkEnabled.key(), value -> validateBackupProviderConfig((String)value));
	true, ConfigKey.Scope.Zone, BackupFrameworkEnabled.key(), value -> validateBackupProviderConfig((String) value));

Conversation

Pearl1594 commented Jan 29, 2026 • 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):

How Has This Been Tested?

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

Uh oh!

codecov bot commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Pearl1594 commented Jan 29, 2026

Uh oh!

blueorangutan commented Jan 29, 2026

Uh oh!

Pearl1594 commented Jan 29, 2026

Uh oh!

blueorangutan commented Jan 29, 2026

Uh oh!

Pearl1594 commented Jan 30, 2026

Uh oh!

blueorangutan commented Jan 30, 2026

Uh oh!

blueorangutan commented Jan 30, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

abh1sar left a comment

Choose a reason for hiding this comment

Uh oh!

abh1sar Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

abh1sar Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Pearl1594 Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

abh1sar Feb 1, 2026

Choose a reason for hiding this comment

Uh oh!

DaanHoogland Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Pearl1594 Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

DaanHoogland commented Feb 4, 2026

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland commented Feb 4, 2026

Uh oh!

blueorangutan commented Feb 4, 2026

Uh oh!

sonarqubecloud bot commented Feb 4, 2026

Quality Gate failed

Uh oh!

blueorangutan commented Feb 4, 2026

Uh oh!

sureshanaparti Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Pearl1594 Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

abh1sar left a comment

Choose a reason for hiding this comment

Uh oh!

Pearl1594 commented Jan 29, 2026 •

edited

Loading

codecov bot commented Jan 29, 2026 •

edited

Loading

DaanHoogland Feb 4, 2026 •

edited

Loading