Add dataSize, backupSize to Backup.RestorePoint for all providers

Author: abh1sar

api/src/main/java/com/cloud/event/EventTypes.java

@@ -604,6 +604,7 @@ public class EventTypes {
     public static final String EVENT_VM_BACKUP_IMPORT_OFFERING = "BACKUP.IMPORT.OFFERING";
     public static final String EVENT_VM_BACKUP_OFFERING_ASSIGN = "BACKUP.OFFERING.ASSIGN";
     public static final String EVENT_VM_BACKUP_OFFERING_REMOVE = "BACKUP.OFFERING.REMOVE";
+    public static final String EVENT_VM_BACKUP_DELETE_LAST_POST_OFFERING_REMOVE = "BACKUP.DELETE.LAST.POST.OFFERING.REMOVE";
     public static final String EVENT_VM_BACKUP_CREATE = "BACKUP.CREATE";
     public static final String EVENT_VM_BACKUP_RESTORE = "BACKUP.RESTORE";
     public static final String EVENT_VM_BACKUP_RESTORE_TO_VM = "BACKUP.RESTORE.TO.VM";

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

@@ -86,13 +86,21 @@ class RestorePoint {
         private String id;
         private Date created;
         private String type;
+        private Long backupSize = 0L;
+        private Long dataSize = 0L;
 
         public RestorePoint(String id, Date created, String type) {
             this.id = id;
             this.created = created;
             this.type = type;
         }
 
+        public RestorePoint(String id, Date created, String type, Long backupSize, Long dataSize) {
+            this(id, created, type);
+            this.backupSize = backupSize;
+            this.dataSize = dataSize;
+        }
+
         public String getId() {
             return id;
         }
@@ -116,6 +124,22 @@ public String getType() {
         public void setType(String type) {
             this.type = type;
         }
+
+        public Long getBackupSize() {
+            return backupSize;
+        }
+
+        public void setBackupSize(Long backupSize) {
+            this.backupSize = backupSize;
+        }
+
+        public Long getDataSize() {
+            return dataSize;
+        }
+
+        public void setDataSize(Long dataSize) {
+            this.dataSize = dataSize;
+        }
     }
 
     class VolumeInfo {

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

@@ -17,7 +17,6 @@
 package org.apache.cloudstack.backup;
 
 import java.util.List;
-import java.util.Map;
 
 import com.cloud.utils.Pair;
 import com.cloud.vm.VirtualMachine;
@@ -97,12 +96,10 @@ public interface BackupProvider {
     Pair<Boolean, String> restoreBackedUpVolume(Backup backup, String volumeUuid, String hostIp, String dataStoreUuid, Pair<String, VirtualMachine.State> vmNameAndState);
 
     /**
-     * Returns backup metrics for a list of VMs in a zone
+     * Syncs backup metrics (backup size, protected size) from the plugin and stores it within the provider
      * @param zoneId the zone for which to return metrics
-     * @param vms a list of machines to get measurements for
-     * @return a map of machine -> backup metrics
      */
-    Map<VirtualMachine, Backup.Metric> getBackupMetrics(Long zoneId, List<VirtualMachine> vms);
+    void syncBackupMetrics(Long zoneId);
 
     /**
      * This method should TODO
@@ -112,11 +109,11 @@ public interface BackupProvider {
 
     /**
      * This method should TODO
+     *
      * @param restorePoint the restore point to create a backup for
-     * @param vm The machine for which to create a backup
-     * @param metric the metric object to update with the new backup data
+     * @param vm           The machine for which to create a backup
      */
-    Backup createNewBackupEntryForRestorePoint(Backup.RestorePoint restorePoint, VirtualMachine vm, Backup.Metric metric);
+    Backup createNewBackupEntryForRestorePoint(Backup.RestorePoint restorePoint, VirtualMachine vm);
 
     /**
      * Returns if the backup provider supports creating new instance from backup

engine/schema/src/main/java/com/cloud/usage/dao/UsageBackupDao.java

@@ -24,7 +24,7 @@
 import com.cloud.utils.db.GenericDao;
 
 public interface UsageBackupDao extends GenericDao<UsageBackupVO, Long> {
-    void updateMetrics(Long vmId, Long size, Long virtualSize);
-    void removeUsage(Long accountId, Long vmId, Date eventDate);
+    void updateMetrics(Long vmId, Long backupOfferingId, Long size, Long virtualSize);
+    void removeUsage(Long accountId, Long vmId, Long backupOfferingId, Date eventDate);
     List<UsageBackupVO> getUsageRecords(Long accountId, Date startDate, Date endDate);
 }

engine/schema/src/main/java/com/cloud/usage/dao/UsageBackupDaoImpl.java

@@ -36,16 +36,17 @@
 
 @Component
 public class UsageBackupDaoImpl extends GenericDaoBase<UsageBackupVO, Long> implements UsageBackupDao {
-    protected static final String UPDATE_DELETED = "UPDATE usage_backup SET removed = ? WHERE account_id = ? AND vm_id = ? and removed IS NULL";
+    protected static final String UPDATE_DELETED = "UPDATE usage_backup SET removed = ? WHERE account_id = ? AND vm_id = ? and backup_offering_id = ? and removed IS NULL";
     protected static final String GET_USAGE_RECORDS_BY_ACCOUNT = "SELECT id, zone_id, account_id, domain_id, vm_id, backup_offering_id, size, protected_size, created, removed FROM usage_backup WHERE " +
             " account_id = ? AND ((removed IS NULL AND created <= ?) OR (created BETWEEN ? AND ?) OR (removed BETWEEN ? AND ?) " +
             " OR ((created <= ?) AND (removed >= ?)))";
 
     @Override
-    public void updateMetrics(final Long vmId, final Long size, final Long virtualSize) {
+    public void updateMetrics(final Long vmId, Long backupOfferingId, final Long size, final Long virtualSize) {
         try (TransactionLegacy txn = TransactionLegacy.open(TransactionLegacy.USAGE_DB)) {
             SearchCriteria<UsageBackupVO> sc = this.createSearchCriteria();
             sc.addAnd("vmId", SearchCriteria.Op.EQ, vmId);
+            sc.addAnd("backupOfferingId", SearchCriteria.Op.EQ, backupOfferingId);
             UsageBackupVO vo = findOneBy(sc);
             if (vo != null) {
                 vo.setSize(size);
@@ -58,7 +59,7 @@ public void updateMetrics(final Long vmId, final Long size, final Long virtualSi
     }
 
     @Override
-    public void removeUsage(Long accountId, Long vmId, Date eventDate) {
+    public void removeUsage(Long accountId, Long vmId, Long backupOfferingId, Date eventDate) {
         TransactionLegacy txn = TransactionLegacy.open(TransactionLegacy.USAGE_DB);
         try {
             txn.start();
@@ -67,6 +68,7 @@ public void removeUsage(Long accountId, Long vmId, Date eventDate) {
                     pstmt.setString(1, DateUtil.getDateDisplayString(TimeZone.getTimeZone("GMT"), eventDate));
                     pstmt.setLong(2, accountId);
                     pstmt.setLong(3, vmId);
+                    pstmt.setLong(3, backupOfferingId);
                     pstmt.executeUpdate();
                 }
             } catch (SQLException e) {

engine/schema/src/main/java/com/cloud/vm/dao/VMInstanceDao.java

@@ -118,7 +118,7 @@ public interface VMInstanceDao extends GenericDao<VMInstanceVO, Long>, StateDao<
 
     List<VMInstanceVO> listVmsMigratingFromHost(Long hostId);
 
-    List<VMInstanceVO> listByZoneWithBackups(Long zoneId, Long backupOfferingId);
+    List<VMInstanceVO> listByZoneAndBackupOffering(Long zoneId, Long backupOfferingId);
 
     public Long countActiveByHostId(long hostId);
 

engine/schema/src/main/java/com/cloud/vm/dao/VMInstanceDaoImpl.java

@@ -651,7 +651,7 @@ public List<VMInstanceVO> listVmsMigratingFromHost(Long hostId) {
     }
 
     @Override
-    public List<VMInstanceVO> listByZoneWithBackups(Long zoneId, Long backupOfferingId) {
+    public List<VMInstanceVO> listByZoneAndBackupOffering(Long zoneId, Long backupOfferingId) {
         SearchCriteria<VMInstanceVO> sc = BackupSearch.create();
         sc.setParameters("zone_id", zoneId);
         if (backupOfferingId != null) {

plugins/backup/dummy/src/main/java/org/apache/cloudstack/backup/DummyBackupProvider.java

@@ -18,7 +18,6 @@
 
 import java.util.Arrays;
 import java.util.Date;
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
@@ -28,7 +27,6 @@
 import com.cloud.storage.dao.VolumeDao;
 
 import org.apache.cloudstack.backup.dao.BackupDao;
-import org.apache.commons.collections.CollectionUtils;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
@@ -91,26 +89,7 @@ public Pair<Boolean, String> restoreBackedUpVolume(Backup backup, String volumeU
         throw new CloudRuntimeException("Dummy plugin does not support this feature");
     }
 
-    @Override
-    public Map<VirtualMachine, Backup.Metric> getBackupMetrics(Long zoneId, List<VirtualMachine> vms) {
-        final Map<VirtualMachine, Backup.Metric> metrics = new HashMap<>();
-        if (CollectionUtils.isEmpty(vms)) {
-            LOG.warn("Unable to get VM Backup Metrics because the list of VMs is empty.");
-            return metrics;
-        }
-
-        for (final VirtualMachine vm : vms) {
-            Long vmBackupSize = 0L;
-            Long vmBackupProtectedSize = 0L;
-            for (final Backup backup: backupDao.listByVmId(null, vm.getId())) {
-                vmBackupSize += backup.getSize();
-                vmBackupProtectedSize += backup.getProtectedSize();
-            }
-            Backup.Metric vmBackupMetric = new Backup.Metric(vmBackupSize,vmBackupProtectedSize);
-            LOG.debug("Metrics for VM {} is [backup size: {}, data size: {}].", vm, vmBackupMetric.getBackupSize(), vmBackupMetric.getDataSize());
-            metrics.put(vm, vmBackupMetric);
-        }
-        return metrics;
+    public void syncBackupMetrics(Long zoneId) {
     }
 
     @Override
@@ -119,7 +98,7 @@ public List<Backup.RestorePoint> listRestorePoints(VirtualMachine vm) {
     }
 
     @Override
-    public Backup createNewBackupEntryForRestorePoint(Backup.RestorePoint restorePoint, VirtualMachine vm, Backup.Metric metric) {
+    public Backup createNewBackupEntryForRestorePoint(Backup.RestorePoint restorePoint, VirtualMachine vm) {
         return null;
     }
 

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

@@ -55,7 +55,6 @@
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
-import java.util.HashMap;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.Random;
@@ -394,30 +393,7 @@ public boolean deleteBackup(Backup backup, boolean forced) {
         return false;
     }
 
-    @Override
-    public Map<VirtualMachine, Backup.Metric> getBackupMetrics(Long zoneId, List<VirtualMachine> vms) {
-        final Map<VirtualMachine, Backup.Metric> metrics = new HashMap<>();
-        if (CollectionUtils.isEmpty(vms)) {
-            LOG.warn("Unable to get VM Backup Metrics because the list of VMs is empty.");
-            return metrics;
-        }
-
-        for (final VirtualMachine vm : vms) {
-            Long vmBackupSize = 0L;
-            Long vmBackupProtectedSize = 0L;
-            for (final Backup backup: backupDao.listByVmId(null, vm.getId())) {
-                if (Objects.nonNull(backup.getSize())) {
-                    vmBackupSize += backup.getSize();
-                }
-                if (Objects.nonNull(backup.getProtectedSize())) {
-                    vmBackupProtectedSize += backup.getProtectedSize();
-                }
-            }
-            Backup.Metric vmBackupMetric = new Backup.Metric(vmBackupSize,vmBackupProtectedSize);
-            LOG.debug("Metrics for VM {} is [backup size: {}, data size: {}].", vm, vmBackupMetric.getBackupSize(), vmBackupMetric.getDataSize());
-            metrics.put(vm, vmBackupMetric);
-        }
-        return metrics;
+    public void syncBackupMetrics(Long zoneId) {
     }
 
     @Override
@@ -426,7 +402,7 @@ public List<Backup.RestorePoint> listRestorePoints(VirtualMachine vm) {
     }
 
     @Override
-    public Backup createNewBackupEntryForRestorePoint(Backup.RestorePoint restorePoint, VirtualMachine vm, Backup.Metric metric) {
+    public Backup createNewBackupEntryForRestorePoint(Backup.RestorePoint restorePoint, VirtualMachine vm) {
         return null;
     }
 

plugins/backup/nas/src/test/java/org/apache/cloudstack/backup/NASBackupProviderTest.java

@@ -51,7 +51,6 @@
 import com.cloud.storage.dao.VolumeDao;
 import com.cloud.utils.Pair;
 import com.cloud.vm.VMInstanceVO;
-import com.cloud.vm.VirtualMachine;
 import com.cloud.vm.dao.VMInstanceDao;
 
 @RunWith(MockitoJUnitRunner.class)
@@ -113,26 +112,6 @@ public void testDeleteBackup() throws OperationTimedoutException, AgentUnavailab
         Assert.assertTrue(result);
     }
 
-    @Test
-    public void testGetBackupMetrics() {
-        VMInstanceVO vm = mock(VMInstanceVO.class);
-        Mockito.when(vm.getId()).thenReturn(1L);
-
-        Backup backup1 = mock(Backup.class);
-        Mockito.when(backup1.getSize()).thenReturn(100L);
-        Mockito.when(backup1.getProtectedSize()).thenReturn(50L);
-        Backup backup2 = mock(Backup.class);
-        Mockito.when(backup2.getSize()).thenReturn(200L);
-        Mockito.when(backup2.getProtectedSize()).thenReturn(50L);
-
-        Mockito.when(backupDao.listByVmId(null, 1L)).thenReturn(List.of(backup1, backup2));
-
-        Map<VirtualMachine, Backup.Metric> result = nasBackupProvider.getBackupMetrics(1L, Collections.singletonList(vm));
-        Assert.assertEquals(1, result.size());
-        Assert.assertEquals(300L, result.get(vm).getBackupSize().longValue());
-        Assert.assertEquals(100L, result.get(vm).getDataSize().longValue());
-    }
-
     @Test
     public void testSyncBackupStorageStats() throws AgentUnavailableException, OperationTimedoutException {
         BackupRepositoryVO backupRepository = new BackupRepositoryVO(1L, "nas", "test-repo",