Add backup file extraction feature - #13935
Open
JoaoJandre wants to merge 3 commits into
Open
Conversation
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #13935 +/- ##
==========================================
Coverage 19.65% 19.66%
- Complexity 19798 19833 +35
==========================================
Files 6368 6383 +15
Lines 574943 575857 +914
Branches 70355 70444 +89
==========================================
+ Hits 113015 113230 +215
- Misses 449658 450336 +678
- Partials 12270 12291 +21
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Contributor
Author
|
It would be nice if someone could test this using RPM, since I have not tested installing the RPM packages. |
|
This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch. |
|
Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 18962 |
GaOrtiga
approved these changes
Aug 24, 2026
|
|
||
| @APICommand(name = "downloadBackupFile", | ||
| description = "Download a file from a backup", | ||
| responseObject = ExtractResponse.class, since = "4.24.0.0") |
Collaborator
There was a problem hiding this comment.
Suggested change
| responseObject = ExtractResponse.class, since = "4.24.0.0") | |
| responseObject = ExtractResponse.class, since = "24.0.0") |
|
|
||
| @APICommand(name = "listBackupFiles", | ||
| description = "List a backup inner files", | ||
| responseObject = DataStoreObjectResponse.class, since = "4.24.0.0") |
Collaborator
There was a problem hiding this comment.
Suggested change
| responseObject = DataStoreObjectResponse.class, since = "4.24.0.0") | |
| responseObject = DataStoreObjectResponse.class, since = "24.0.0") |
|
|
||
| @APICommand(name = "listBackupFilesystems", | ||
| description = "List a backup inner file systems", | ||
| responseObject = DataStoreObjectResponse.class, since = "4.24.0.0") |
Collaborator
There was a problem hiding this comment.
Suggested change
| responseObject = DataStoreObjectResponse.class, since = "4.24.0.0") | |
| responseObject = DataStoreObjectResponse.class, since = "24.0.0") |
| private String path; | ||
|
|
||
| @Parameter(name = ApiConstants.IS_SYMLINK, type = CommandType.BOOLEAN, | ||
| description = "Path to list files in the backed-up volume.") |
Collaborator
There was a problem hiding this comment.
Suggested change
| description = "Path to list files in the backed-up volume.") | |
| description = "Indicates whether the path references a symlink.") |
| } | ||
|
|
||
| /** | ||
| * Given the directory, file list and details of those files, will populate the names, paths, canonicalPaths, isDirs, isSymlinks, sizes and modifiedList lists. |
Collaborator
There was a problem hiding this comment.
Suggested change
| * Given the directory, file list and details of those files, will populate the names, paths, canonicalPaths, isDirs, isSymlinks, sizes and modifiedList lists. | |
| * Given the directory, file list, and details of those files, will populate the names, paths, canonicalPaths, isDirs, isSymlinks, sizes and modifiedList lists. |
An oxford comma here makes it more readable IMO.
| Long vmId = backupVO.getVmId(); | ||
| VMInstanceVO vm = vmInstanceDao.findByIdIncludingRemoved(vmId); | ||
| if (vm == null) { | ||
| throw new CloudRuntimeException(String.format("Unable to find VM for backup [%s].", backupVO.getUuid())); |
Collaborator
There was a problem hiding this comment.
Suggested change
| throw new CloudRuntimeException(String.format("Unable to find VM for backup [%s].", backupVO.getUuid())); | |
| throw new CloudRuntimeException(String.format("Unable to find VM from backup [%s].", backupVO.getUuid())); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds backup file extraction feature. Currently only supported by KBOSS.
This feature must be enabled in the backup offering through the
allowextractfileparameter. If it is set totrue, it will be possible to extract files from backups created with that offering.The
listBackupFilesystemsAPI was added to allow listing file systems inside backup volumes:backupIdvolumeIdExample execution of the
listBackupFilesystemsAPIThe
listBackupFilesAPI was added to allow listing files inside backup volumes:backupIdvolumeIdfilesystempathissymlinkThe
filesystemandpathparameters expect that the files do not contain special characters such as(,|, or>, for example. Both are expected to receive values in the format/path/to/something.Example execution of the
listBackupFilesAPITo download files, the
downloadBackupFileAPI was added:backupIdvolumeIdfilesystempathgzip; if it is a directory, it will be added to atararchive and compressed usinggzipThe
filesystemandpathparameters expect that the files do not contain special characters such as(,|, or>, for example. Both are expected to receive values in the format/path/to/something.Example execution of the
downloadBackupFileAPIThe list and download file workflow was also added to the GUI.
Types of changes
Feature/Enhancement Scale or Bug Severity
Feature/Enhancement Scale
Bug Severity
Screenshots (if appropriate):
How Has This Been Tested?
Test descriptions
isSymlink=trueflagisSymlinkflagAll the tests above were executed for both Linux ROOT volumes (ext4) and Windows ROOT volumes (NTFS).