Secondary storage backup path GUI addition

Author: erikbocks

api/src/main/java/org/apache/cloudstack/api/ApiConstants.java

@@ -61,6 +61,7 @@ public class ApiConstants {
     public static final String BACKUP_AVAILABLE = "backupavailable";
     public static final String BACKUP_ID = "backupid";
     public static final String BACKUP_LIMIT = "backuplimit";
+    public static final String BACKUP_PATHS = "backuppaths";
     public static final String BACKUP_OFFERING_NAME = "backupofferingname";
     public static final String BACKUP_OFFERING_ID = "backupofferingid";
     public static final String BACKUP_OFFERING_DETAILS = "backupofferingdetails";

api/src/main/java/org/apache/cloudstack/api/command/admin/backup/FinalizeBackupCmd.java

@@ -79,7 +79,9 @@ public void execute() {
             throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Backup");
         }
 
-        BackupResponse response = backupManager.createBackupResponse(backup, null);
+        boolean isCallerRootAdmin = _accountService.isRootAdmin(CallContext.current().getCallingAccountId());
+
+        BackupResponse response = backupManager.createBackupResponse(backup, null, isCallerRootAdmin);
 
         response.setResponseName(getCommandName());
         setResponseObject(response);

api/src/main/java/org/apache/cloudstack/api/command/admin/backup/StartBackupCmd.java

@@ -82,7 +82,8 @@ public String getDescription() {
     public void execute() {
         try {
             Backup backup = kvmBackupExportService.startBackup(this);
-            BackupResponse response = backupManager.createBackupResponse(backup, null);
+            boolean isCallerRootAdmin = _accountService.isRootAdmin(CallContext.current().getCallingAccountId());
+            BackupResponse response = backupManager.createBackupResponse(backup, null, isCallerRootAdmin);
 
             response.setResponseName(getCommandName());
             setResponseObject(response);

api/src/main/java/org/apache/cloudstack/api/command/user/backup/ListBackupsCmd.java

@@ -148,12 +148,13 @@ public Boolean getListVmDetails() {
     /////////////////////////////////////////////////////
 
     protected void setupResponseBackupList(final List<Backup> backups, final Integer count) {
+        boolean isCallerRootAdmin = _accountService.isRootAdmin(CallContext.current().getCallingAccountId());
         final List<BackupResponse> responses = new ArrayList<>();
         for (Backup backup : backups) {
             if (backup == null) {
                 continue;
             }
-            BackupResponse backupResponse = backupManager.createBackupResponse(backup, this.getListVmDetails());
+            BackupResponse backupResponse = backupManager.createBackupResponse(backup, this.getListVmDetails(), isCallerRootAdmin);
             responses.add(backupResponse);
         }
         final ListResponse<BackupResponse> response = new ListResponse<>();

api/src/main/java/org/apache/cloudstack/api/response/BackupResponse.java

@@ -99,6 +99,10 @@ public class BackupResponse extends BaseResponse {
     @Param(description = "Backup offering name")
     private String backupOfferingName;
 
+    @SerializedName(ApiConstants.BACKUP_PATHS)
+    @Param(description = "The backups paths in the secondary storage")
+    private Map<String, String> backupPaths;
+
     @SerializedName(ApiConstants.ACCOUNT_ID)
     @Param(description = "Account id")
     private String accountId;
@@ -386,4 +390,13 @@ public void setHostId(String hostId) {
     public String getHostId() {
         return this.hostId;
     }
+
+    public Map<String, String> getBackupPaths() {
+        return backupPaths;
+    }
+
+    public void setBackupPaths(Map<String, String> backupPaths) {
+        this.backupPaths = backupPaths;
+    }
+
 }

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

@@ -259,7 +259,7 @@ public interface BackupManager extends BackupService, Configurable, PluggableSer
 
     String getBackupNameFromVM(VirtualMachine vm);
 
-    BackupResponse createBackupResponse(Backup backup, Boolean listVmDetails);
+    BackupResponse createBackupResponse(Backup backup, Boolean listVmDetails, boolean isCallerRootAdmin);
 
     Capacity getBackupStorageUsedStats(Long zoneId);
 

engine/schema/src/main/java/org/apache/cloudstack/backup/InternalBackupJoinVO.java

@@ -98,6 +98,9 @@ public class InternalBackupJoinVO {
     @Column(name = "volume_id")
     private long volumeId;
 
+    @Column(name = "volume_name")
+    private String volumeName;
+
     @Column(name = "isolated")
     private Boolean isolated;
 
@@ -175,6 +178,10 @@ public long getVolumeId() {
         return volumeId;
     }
 
+    public String getVolumeName() {
+        return volumeName;
+    }
+
     public Boolean getIsolated() {
         return BooleanUtils.isTrue(isolated);
     }

engine/schema/src/main/resources/META-INF/db/views/cloud.internal_backup_view.sql

@@ -37,11 +37,13 @@ SELECT  b.id,
         MAX(CASE WHEN bd.name = 'current' THEN bd.value END) current,
         COALESCE(MAX(CASE WHEN bd.name = 'isolated' THEN bd.value END), 'false') isolated,
         nbpr.volume_id,
+        v.name as volume_name,
         nbsr.path image_store_path
 FROM    backups b
 LEFT    JOIN backup_details bd ON b.id = bd.backup_id
 LEFT    JOIN backup_offering bo ON b.backup_offering_id = bo.id
 LEFT    JOIN internal_backup_store_ref nbsr ON b.id = nbsr.backup_id
 LEFT    JOIN internal_backup_pool_ref nbpr ON nbpr.volume_id = nbsr.volume_id
+LEFT    JOIN volumes v ON v.id = nbsr.volume_id
 WHERE   bo.provider='kboss'
 GROUP BY b.id, nbsr.volume_id;

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

@@ -85,6 +85,7 @@
 import org.apache.cloudstack.backup.dao.BackupOfferingDao;
 import org.apache.cloudstack.backup.dao.BackupOfferingDetailsDao;
 import org.apache.cloudstack.backup.dao.BackupScheduleDao;
+import org.apache.cloudstack.backup.dao.InternalBackupJoinDao;
 import org.apache.cloudstack.context.CallContext;
 import org.apache.cloudstack.framework.config.ConfigKey;
 import org.apache.cloudstack.framework.jobs.AsyncJobDispatcher;
@@ -255,6 +256,8 @@ public class BackupManagerImpl extends ManagerBase implements BackupManager {
     private DomainHelper domainHelper;
     @Inject
     ReservationDao reservationDao;
+    @Inject
+    private InternalBackupJoinDao internalBackupJoinDao;
 
     private AsyncJobDispatcher asyncJobDispatcher;
     private Timer backupTimer;
@@ -2595,7 +2598,7 @@ Map<String, String> getDetailsFromBackupDetails(Long backupId) {
     }
 
     @Override
-    public BackupResponse createBackupResponse(Backup backup, Boolean listVmDetails) {
+    public BackupResponse createBackupResponse(Backup backup, Boolean listVmDetails, boolean isCallerRootAdmin) {
         VMInstanceVO vm = vmInstanceDao.findByIdIncludingRemoved(backup.getVmId());
         AccountVO account = accountDao.findByIdIncludingRemoved(backup.getAccountId());
         DomainVO domain = domainDao.findByIdIncludingRemoved(backup.getDomainId());
@@ -2677,6 +2680,17 @@ public BackupResponse createBackupResponse(Backup backup, Boolean listVmDetails)
             response.setToCheckpointId(backup.getToCheckpointId());
         }
 
+        if (KBOSS_BACKUP_PROVIDER.equals(offering.getProvider()) && isCallerRootAdmin) {
+            List<InternalBackupJoinVO> backupJoins = internalBackupJoinDao.listById(backup.getId());
+            Map<String, String> backupVolumePaths = new HashMap<>();
+
+            backupJoins.forEach(b -> {
+                backupVolumePaths.put(b.getVolumeName(), b.getImageStorePath());
+            });
+
+            response.setBackupPaths(backupVolumePaths);
+        }
+
         response.setObjectName("backup");
         return response;
     }

server/src/test/java/org/apache/cloudstack/backup/BackupManagerTest.java

@@ -59,6 +59,7 @@
 import org.apache.cloudstack.backup.dao.BackupOfferingDao;
 import org.apache.cloudstack.backup.dao.BackupOfferingDetailsDao;
 import org.apache.cloudstack.backup.dao.BackupScheduleDao;
+import org.apache.cloudstack.backup.dao.InternalBackupJoinDao;
 import org.apache.cloudstack.context.CallContext;
 import org.apache.cloudstack.framework.config.ConfigKey;
 import org.apache.cloudstack.framework.config.impl.ConfigDepotImpl;
@@ -196,6 +197,9 @@ public class BackupManagerTest {
     @Mock
     private AlertManager alertManagerMock;
 
+    @Mock
+    private InternalBackupJoinDao internalBackupJoinDaoMock;
+
     @Mock
     private Domain domainMock;
 
@@ -1713,7 +1717,14 @@ public void testNewBackupResponse() {
 
         Mockito.when(backupDetailsDao.listDetailsKeyPairs(backup.getId(), true)).thenReturn(details);
 
-        BackupResponse response = backupManager.createBackupResponse(backup, true);
+        String backupPath = "/backup/path";
+        String volumeName = "ROOT";
+        InternalBackupJoinVO backupJoin = new InternalBackupJoinVO();
+        ReflectionTestUtils.setField(backupJoin, "imageStorePath", backupPath);
+        ReflectionTestUtils.setField(backupJoin, "volumeName", volumeName);
+        Mockito.when(internalBackupJoinDaoMock.listById(Mockito.anyLong())).thenReturn(Collections.singletonList(backupJoin));
+
+        BackupResponse response = backupManager.createBackupResponse(backup, true, true);
 
         Assert.assertEquals("backup-uuid", response.getId());
         Assert.assertEquals("test-vm", response.getVmName());
@@ -1730,6 +1741,7 @@ public void testNewBackupResponse() {
                 "nics=[{\"networkid\":\"network-uuid1\",\"networkname\":\"network1\"}], serviceofferingname=service-offering1, " +
                 "templatename=template1, templateid=template-uuid1}", response.getVmDetails().toString());
         Assert.assertEquals(true, response.getVmOfferingRemoved());
+        Assert.assertEquals(backupPath, response.getBackupPaths().get(volumeName));
     }
 
     @Test