Fix restore from NAS backup when datadisk is older than the root disk. #11258

abh1sar · 2025-07-22T10:18:50Z

Description

This PR fixes #11257.

Libvirt backs up the volumes in the order of their deviceId.
However, during restore, volumes are processed based on their id in the volumes table.
If data volume has a lower id in the volumes table than the root volume, restore mistakenly assumes the data disk to be the root disk.
Restore fails silently, without any error

Another minor issue exists with Volume attach and detach operations on Instances that have an associated backup offering:

Attach and Detach operations use different logic when handling Instances with backup offerings.
Detach fails if the Instance was associated with a backup offering but has no backups yet.
In contrast, Attach succeeds under the same conditions.

Changes done

Sorting the volumes list by deviceId before restore and also before saving the backedVolumes in the backup table.
Return proper error from LibvirtRestorebackupCommand in case of any error instead of failing silently.
Using consistent logic in Attach and Detach 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?

Verified with the test case mentioned in the Issue. Restore passed with the correct data.
Repeated the test case mentioned in the Issue with just the fix for returning proper error from restore. Restore failed with an error.
Tested backup and restore with stopped and running Instances
Tested attach and detach volume on Instance having backup offering but no backups.
Tested attach and detach volume on Instance having backups.

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

codecov · 2025-07-22T10:26:25Z

Codecov Report

Attention: Patch coverage is 12.82051% with 34 lines in your changes missing coverage. Please review.

Project coverage is 16.15%. Comparing base (ba0204f) to head (d013c2f).
Report is 26 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
...ce/wrapper/LibvirtRestoreBackupCommandWrapper.java	0.00%	28 Missing ⚠️
...rg/apache/cloudstack/backup/NASBackupProvider.java	0.00%	5 Missing ⚠️
...rg/apache/cloudstack/backup/BackupManagerImpl.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##               4.20   #11258    +/-   ##
==========================================
  Coverage     16.15%   16.15%            
+ Complexity    13277    13274     -3     
==========================================
  Files          5657     5656     -1     
  Lines        497939   497811   -128     
  Branches      60386    60372    -14     
==========================================
- Hits          80443    80436     -7     
+ Misses       408532   408423   -109     
+ Partials       8964     8952    -12

Flag	Coverage Δ
uitests	`4.00% <ø> (+<0.01%)`	⬆️
unittests	`17.00% <12.82%> (+<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.

sureshanaparti · 2025-07-22T10:41:08Z

@blueorangutan package

blueorangutan · 2025-07-22T10:42:03Z

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

.../main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapper.java

Copilot

Pull Request Overview

This PR fixes a restore issue with NAS backups where the wrong disk could be identified as the root disk during restoration, causing silent failures. The fix ensures volumes are processed in the correct order by sorting by deviceId instead of relying on database ID order.

Sort volumes by deviceId during backup creation and restore operations to maintain correct disk ordering
Improve error handling in LibvirtRestoreBackupCommandWrapper to return proper errors instead of failing silently
Standardize backup validation logic between volume attach and detach operations

Reviewed Changes

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

Show a summary per file

File	Description
BackupManagerImpl.java	Sort volumes by deviceId when creating volume info for backups
VolumeApiServiceImpl.java	Refactor backup validation logic and consistently apply to both attach/detach
NASBackupProvider.java	Sort volumes by deviceId during backup and restore operations
LibvirtRestoreBackupCommandWrapper.java	Improve error handling to return proper error messages instead of silent failures
VolumeApiServiceImplTest.java	Update test method calls to reflect refactored validation method names

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

.../main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapper.java

blueorangutan · 2025-07-22T11:54:17Z

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

sureshanaparti · 2025-07-22T12:34:25Z

@blueorangutan test

sureshanaparti

clgtm

sureshanaparti · 2025-07-22T12:42:10Z

@blueorangutan test

blueorangutan · 2025-07-22T12:44:05Z

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

DaanHoogland

clgtm @abh1sar , but can you consider CoPilot’s comments?

blueorangutan · 2025-07-23T04:22:02Z

[SF] Trillian test result (tid-13843)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 53221 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr11258-t13843-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

sureshanaparti · 2025-07-23T09:05:30Z

@blueorangutan package

blueorangutan · 2025-07-23T09:06:03Z

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

rajujith

LGTM.

The reported issue is not present anymore. I followed the steps given in the issue that is fixed.

blueorangutan · 2025-07-23T11:12:08Z

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

Fix restore when datadisk is older than the root disk.

26ed64f

boring-cyborg bot added component:backup component:kvm component:storage labels Jul 22, 2025

abh1sar requested a review from Pearl1594 July 22, 2025 10:19

rajujith self-assigned this Jul 22, 2025

sureshanaparti reviewed Jul 22, 2025

View reviewed changes

.../main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapper.java Show resolved Hide resolved

sureshanaparti requested a review from Copilot July 22, 2025 10:43

Copilot AI reviewed Jul 22, 2025

View reviewed changes

server/src/main/java/org/apache/cloudstack/backup/BackupManagerImpl.java Show resolved Hide resolved

.../main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapper.java Outdated Show resolved Hide resolved

sureshanaparti approved these changes Jul 22, 2025

View reviewed changes

sureshanaparti linked an issue Jul 22, 2025 that may be closed by this pull request

NAS backup provider: Restore fails if the data volume is created before the root volume. #11257

Closed

DaanHoogland reviewed Jul 22, 2025

View reviewed changes

address review comments

d013c2f

sureshanaparti added the status:needs-testing label Jul 23, 2025

rajujith approved these changes Jul 23, 2025

View reviewed changes

rajujith removed their assignment Jul 23, 2025

sureshanaparti removed the status:needs-testing label Jul 23, 2025

DaanHoogland merged commit 1b74c2d into apache:4.20 Jul 23, 2025
25 of 26 checks passed

DaanHoogland deleted the restore-disks-order branch July 23, 2025 10:45

DaanHoogland mentioned this pull request Jul 23, 2025

NAS backup provider: Restore fails if the data volume is created before the root volume. #11257

Closed

Fix restore from NAS backup when datadisk is older than the root disk. #11258

Fix restore from NAS backup when datadisk is older than the root disk. #11258

Uh oh!

Conversation

abh1sar commented Jul 22, 2025

Description

Changes done

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 Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sureshanaparti commented Jul 22, 2025

Uh oh!

blueorangutan commented Jul 22, 2025

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

blueorangutan commented Jul 22, 2025

Uh oh!

sureshanaparti commented Jul 22, 2025

Uh oh!

sureshanaparti left a comment

Choose a reason for hiding this comment

Uh oh!

sureshanaparti commented Jul 22, 2025

Uh oh!

blueorangutan commented Jul 22, 2025

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Jul 23, 2025

Uh oh!

sureshanaparti commented Jul 23, 2025

Uh oh!

blueorangutan commented Jul 23, 2025

Uh oh!

rajujith left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

blueorangutan commented Jul 23, 2025

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

codecov bot commented Jul 22, 2025 •

edited

Loading