Fix issue when restoring backup after migration of volume#12549

Open

Pearl1594 wants to merge 5 commits into4.20 from

Open

Fix issue when restoring backup after migration of volume #12549
Pearl1594 wants to merge 5 commits into4.20 from
ghi12517-fix-restoreBkp-after-migration

Conversation


 Fix issue when restoring backup after migration of volume

f51e048

@Pearl1594 Pearl1594 requested review from abh1sar and sureshanaparti

January 29, 2026 16:45

@boring-cyborg boring-cyborg bot added the component:backup label

Jan 29, 2026

@codecov

Copy link

codecov bot commented Jan 29, 2026 •

edited

Loading

Codecov Report

❌ Patch coverage is 0% with 11 lines in your changes missing coverage. Please review.
✅ Project coverage is 16.37%. Comparing base (a6ccde4) to head (fe764c0).
⚠️ Report is 9 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
...rg/apache/cloudstack/backup/NASBackupProvider.java	0.00%	11 Missing ⚠️

Additional details and impacted files

@@ Coverage Diff @@
## 4.20 #12549 +/- ##
============================================
+ Coverage 16.26% 16.37% +0.10% 
- Complexity 13428 13622 +194 
============================================
 Files 5660 5661 +1 
 Lines 499907 502480 +2573 
 Branches 60696 61846 +1150 
============================================
+ Hits 81316 82267 +951 
- Misses 409521 411087 +1566 
- Partials 9070 9126 +56

Flag	Coverage Δ
uitests	`5.04% <ø> (+0.89%)`	⬆️
unittests	`17.17% <0.00%> (+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.

sureshanaparti

sureshanaparti reviewed

Jan 29, 2026

View reviewed changes

plugins/backup/nas/src/main/java/org/apache/cloudstack/backup/NASBackupProvider.java Outdated

List<Backup.VolumeInfo> backedVolumes = backup.getBackedUpVolumes();

List<VolumeVO> volumes = backedVolumes.stream()

.map(volume -> volumeDao.findByUuid(volume.getUuid()))

.map(volume -> volumeDao.findByUuid(volume.getPath()))

Copy link

Contributor

@sureshanaparti sureshanaparti Jan 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the new uuid or path after migration needs to be updated in the backed-up volumes metadata if any backups existing for them? any case path might also change?

Copy link

Contributor Author

@Pearl1594 Pearl1594 Jan 29, 2026 •

edited

Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new UUID / path for the backed up volume doesn't need to be updated as the uuid - points to the volume UUID - which is always the same on subsequent backups, and the path points to the backup path - which shouldn't vary even if volume is migrated. I don't see the path of the backup changing.

Copy link

Contributor

@sureshanaparti sureshanaparti Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

.map(volume -> volumeDao.findByUuid(volume.getPath()))

.map(backedVolumeInfo -> volumeDao.findByUuid(backedVolumeInfo.getPath()))

it's better change to backedVolumeInfo to avoid confusion.

@Pearl1594 Correct, path of the backup doesn't change. I mean, the volume path after migration might change as the volume is checked by its backed up path (which is before migration). cc @abh1sar

Copy link

Collaborator

@abh1sar abh1sar Feb 6, 2026 •

edited

Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should not have path in the backed-up volumes metadata at all.

Backup files are named suing the volume uuid
The path in backed-up volumes is not being referenced anywhere apart from UI

volume.getPath() already gives us the path where we have to restore. I don't see a point in maintaining it in backup metadata also and updating it whenever volume path changes.

There was a PR merged on main that makes the UI reference uuid instead of path. (#12156)
So I propose removing path entirely from Backup.VolumeInfo in the main branch. We don't need upgrade handling also. The path in the DB for older backups will simply get ignored.

Now in the context of this PR, we should get the path from volume.getPath() not from backup-up volumes metadata.

Thoughts? @sureshanaparti @Pearl1594

Copy link

Contributor Author

@Pearl1594 Pearl1594 Feb 6, 2026 •

edited

Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With respect to this statement:

Now in the context of this PR, we should get the path from volume.getPath() not from backup-up volumes metadata.

I think we need to consider backedVolume.getPath() - as a volume could have gotten migrated and the path changes. But when restoring from a backup, we need to reference the path of the backedVolume (which was the path of the volume prior to the migrate operation). Correct me if I'm wrong.
If volumeUuid is passed, then volume's uuid is used, but, when null, it uses the backupVolume path to determine the backup file as seen in : https://github.com/apache/cloudstack/blob/main/plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapper.java#L224-L225

@Pearl1594 Pearl1594 added this to the 4.20.3 milestone

Jan 29, 2026

@Pearl1594

Copy link

Contributor Author

Pearl1594 commented Jan 29, 2026

@blueorangutan package

@blueorangutan

Copy link

blueorangutan commented Jan 29, 2026

@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

Copy link

blueorangutan commented Jan 29, 2026

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

@Pearl1594

Copy link

Contributor Author

Pearl1594 commented Jan 30, 2026

@blueorangutan test

@blueorangutan

Copy link

blueorangutan commented Jan 30, 2026

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

abh1sar

abh1sar reviewed

Jan 30, 2026

View reviewed changes

plugins/backup/nas/src/main/java/org/apache/cloudstack/backup/NASBackupProvider.java Outdated Show resolved Hide resolved

@blueorangutan

Copy link

blueorangutan commented Jan 30, 2026

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

Test	Result	Time (s)	Test File

@Pearl1594


 use the backed volume path to get the right location of backed volume...

348c9ee

... to be restored

sureshanaparti

sureshanaparti reviewed

Feb 2, 2026

View reviewed changes

plugins/backup/nas/src/main/java/org/apache/cloudstack/backup/NASBackupProvider.java Show resolved Hide resolved

@Pearl1594


 fix logic to prevent take backup from failing

101e2a0

@sureshanaparti sureshanaparti added the status:needs-testing label

Feb 3, 2026

@RosiKyu RosiKyu self-assigned this

Feb 3, 2026

@DaanHoogland

Copy link

Contributor

DaanHoogland commented Feb 3, 2026

@blueorangutan package

@blueorangutan

Copy link

blueorangutan commented Feb 3, 2026

@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

Copy link

blueorangutan commented Feb 3, 2026

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

DaanHoogland

DaanHoogland approved these changes

Feb 4, 2026

View reviewed changes

Copy link

Contributor

@DaanHoogland DaanHoogland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clgtm

sureshanaparti

sureshanaparti reviewed

Feb 4, 2026

View reviewed changes

plugins/backup/nas/src/main/java/org/apache/cloudstack/backup/NASBackupProvider.java Show resolved Hide resolved

@Pearl1594


 address comment

896bae2

@Pearl1594

Copy link

Contributor Author

Pearl1594 commented Feb 4, 2026

@blueorangutan package

@RosiKyu RosiKyu added status:testing and removed status:needs-testing labels

Feb 5, 2026

@Pearl1594

fix

fe764c0

sureshanaparti

sureshanaparti approved these changes

Feb 5, 2026

View reviewed changes

Copy link

Contributor

@sureshanaparti sureshanaparti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clgtm

@sureshanaparti

Copy link

Contributor

sureshanaparti commented Feb 5, 2026

@blueorangutan package

@blueorangutan

Copy link

blueorangutan commented Feb 5, 2026

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

Copy link

sonarqubecloud bot commented Feb 5, 2026

Quality Gate Failed Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 40%)

See analysis details on SonarQube Cloud

@blueorangutan

Copy link

blueorangutan commented Feb 5, 2026

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

Labels

component:backup status:testing

6 participants

@Pearl1594 @blueorangutan @DaanHoogland @sureshanaparti @abh1sar @RosiKyu

Conversation

@Pearl1594 Pearl1594 commented Jan 29, 2026

Description

Types of changes

Feature/Enhancement Scale or 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!

@sureshanaparti sureshanaparti Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

@Pearl1594 Pearl1594 Jan 29, 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!

@sureshanaparti sureshanaparti Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

@abh1sar abh1sar Feb 6, 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 Pearl1594 Feb 6, 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 commented Jan 29, 2026

Uh oh!

blueorangutan 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!

Uh oh!

blueorangutan commented Jan 30, 2026

Uh oh!

Uh oh!

DaanHoogland commented Feb 3, 2026

Uh oh!

blueorangutan commented Feb 3, 2026

Uh oh!

blueorangutan commented Feb 3, 2026

Uh oh!

@DaanHoogland DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Pearl1594 commented Feb 4, 2026

Uh oh!

@sureshanaparti sureshanaparti left a comment

Choose a reason for hiding this comment

Uh oh!

sureshanaparti commented Feb 5, 2026

Uh oh!

blueorangutan commented Feb 5, 2026

Uh oh!

sonarqubecloud bot commented Feb 5, 2026

Quality Gate Failed Quality Gate failed

Uh oh!

blueorangutan commented Feb 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov bot commented Jan 29, 2026 •

edited

Loading

@Pearl1594 Pearl1594 Jan 29, 2026 •

edited

Loading

@abh1sar abh1sar Feb 6, 2026 •

edited

Loading

@Pearl1594 Pearl1594 Feb 6, 2026 •

edited

Loading