add finishBackupChain command

Author: JoaoJandre

api/src/main/java/com/cloud/vm/VirtualMachine.java

@@ -234,6 +234,7 @@ public enum Event {
         BackupRequested,
         BackupSucceededStopped,
         BackupSucceededRunning,
+        FinalizedBackupChain,
 
         // added for new VMSync logic
         FollowAgentPowerOnReport,

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

@@ -1415,6 +1415,7 @@ public class ApiConstants {
 
     public static final String SCHEDULED = "scheduled";
     public static final String SCHEDULED_DATE = "scheduleddate";
+    public static final String LAST_KNOWN_STATE = "last_known_state";
 
     /**
      * This enum specifies IO Drivers, each option controls specific policies on I/O.

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

@@ -37,7 +37,7 @@
 import javax.inject.Inject;
 
 @APICommand(name = "downloadValidationScreenshot", description = "Download validation screenshot of given backup.",
-        responseObject = ExtractResponse.class, since = "4.20.0.10-scclouds", requestHasSensitiveInfo = false,
+        responseObject = ExtractResponse.class, since = "4.23.0.0", requestHasSensitiveInfo = false,
         responseHasSensitiveInfo = false)
 public class DownloadValidationScreenshotCmd extends BaseAsyncCmd {
 

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

@@ -0,0 +1,86 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+package org.apache.cloudstack.api.command.user.backup;
+
+import com.cloud.exception.ConcurrentOperationException;
+import com.cloud.exception.InsufficientCapacityException;
+import com.cloud.exception.NetworkRuleConflictException;
+import com.cloud.exception.ResourceAllocationException;
+import com.cloud.exception.ResourceUnavailableException;
+import com.cloud.user.Account;
+import com.cloud.vm.VirtualMachine;
+import org.apache.cloudstack.api.ACL;
+import org.apache.cloudstack.api.APICommand;
+import org.apache.cloudstack.api.ApiConstants;
+import org.apache.cloudstack.api.BaseCmd;
+import org.apache.cloudstack.api.Parameter;
+import org.apache.cloudstack.api.ServerApiException;
+import org.apache.cloudstack.api.response.SuccessResponse;
+import org.apache.cloudstack.api.response.VirtualMachineResponse;
+import org.apache.cloudstack.backup.NativeBackupService;
+
+import javax.inject.Inject;
+
+@APICommand(name = "finishBackupChain", description = "Finish backup chain of VM.",
+        responseObject = SuccessResponse.class, since = "4.23.0.0", requestHasSensitiveInfo = false,
+        responseHasSensitiveInfo = false)
+public class FinishBackupChainCmd extends BaseCmd {
+    @Inject
+    private NativeBackupService nativeBackupService;
+
+    /////////////////////////////////////////////////////
+    //////////////// API parameters /////////////////////
+    /////////////////////////////////////////////////////
+
+    @ACL
+    @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = VirtualMachineResponse.class, required = true,
+            description = "Id of the VM to finish the chain.")
+    private Long vmId;
+
+    /////////////////////////////////////////////////////
+    /////////////////// Accessors ///////////////////////
+    /////////////////////////////////////////////////////
+
+    public Long getVmId() {
+        return vmId;
+    }
+
+    /////////////////////////////////////////////////////
+    /////////////// API Implementation///////////////////
+    /////////////////////////////////////////////////////
+
+    @Override
+    public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException, ConcurrentOperationException, ResourceAllocationException,
+            NetworkRuleConflictException {
+        boolean result = nativeBackupService.finishBackupChain(getVmId());
+        SuccessResponse response = new SuccessResponse();
+        response.setSuccess(result);
+        response.setResponseName(getCommandName());
+        response.setObjectName(getCommandName());
+        this.setResponseObject(response);
+    }
+
+    @Override
+    public long getEntityOwnerId() {
+        VirtualMachine vm = _entityMgr.findById(VirtualMachine.class, getVmId());
+        if (vm != null) {
+            return vm.getAccountId();
+        }
+
+        return Account.ACCOUNT_ID_SYSTEM;
+    }
+}

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

@@ -134,4 +134,8 @@ default Set<String> getSecondaryStorageUrls(UserVm userVm) {
      * */
     default void prepareVmForSnapshotRevert(VMSnapshot vmSnapshot, VirtualMachine virtualMachine) {
     }
+
+    default boolean finishBackupChain(VirtualMachine virtualMachine) {
+        return false;
+    }
 }

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

@@ -49,4 +49,6 @@ public interface NativeBackupService {
     boolean validateBackup(long backupId, long hostId, long zoneId);
 
     ExtractResponse downloadScreenshot(long backupId);
+
+    boolean finishBackupChain(long vmId);
 }

core/src/main/java/com/cloud/agent/api/storage/CreateDiskOnlyVmSnapshotAnswer.java

@@ -20,20 +20,19 @@
 
 import com.cloud.agent.api.Answer;
 import com.cloud.agent.api.Command;
-import com.cloud.utils.Pair;
 
 import java.util.Map;
 
 public class CreateDiskOnlyVmSnapshotAnswer extends Answer {
 
-    protected Map<String, Pair<Long, String>> mapVolumeToSnapshotSizeAndNewVolumePath;
+    protected Map<String, Long> mapVolumeToSnapshotSize;
 
-    public CreateDiskOnlyVmSnapshotAnswer(Command command, boolean success, String details, Map<String, Pair<Long, String>> mapVolumeToSnapshotSizeAndNewVolumePath) {
+    public CreateDiskOnlyVmSnapshotAnswer(Command command, boolean success, String details, Map<String, Long> mapVolumeToSnapshotSize) {
         super(command, success, details);
-        this.mapVolumeToSnapshotSizeAndNewVolumePath = mapVolumeToSnapshotSizeAndNewVolumePath;
+        this.mapVolumeToSnapshotSize = mapVolumeToSnapshotSize;
     }
 
-    public Map<String, Pair<Long, String>> getMapVolumeToSnapshotSizeAndNewVolumePath() {
-        return mapVolumeToSnapshotSizeAndNewVolumePath;
+    public Map<String, Long> getMapVolumeToSnapshotSize() {
+        return mapVolumeToSnapshotSize;
     }
 }

core/src/main/java/com/cloud/agent/api/storage/CreateDiskOnlyVmSnapshotCommand.java

@@ -21,6 +21,7 @@
 
 import com.cloud.agent.api.VMSnapshotBaseCommand;
 import com.cloud.agent.api.VMSnapshotTO;
+import com.cloud.utils.Pair;
 import com.cloud.vm.VirtualMachine;
 import org.apache.cloudstack.storage.to.VolumeObjectTO;
 
@@ -30,12 +31,19 @@ public class CreateDiskOnlyVmSnapshotCommand extends VMSnapshotBaseCommand {
 
     protected VirtualMachine.State vmState;
 
-    public CreateDiskOnlyVmSnapshotCommand(String vmName, VMSnapshotTO snapshot, List<VolumeObjectTO> volumeTOs, String guestOSType, VirtualMachine.State vmState) {
-        super(vmName, snapshot, volumeTOs, guestOSType);
+    List<Pair<VolumeObjectTO, String>> volumeTosAndNewPaths;
+
+    public CreateDiskOnlyVmSnapshotCommand(String vmName, VMSnapshotTO snapshot, List<Pair<VolumeObjectTO, String>> volumeTosAndNewPaths, String guestOSType, VirtualMachine.State vmState) {
+        super(vmName, snapshot, null, guestOSType);
         this.vmState = vmState;
+        this.volumeTosAndNewPaths = volumeTosAndNewPaths;
     }
 
     public VirtualMachine.State getVmState() {
         return vmState;
     }
+
+    public List<Pair<VolumeObjectTO, String>> getVolumeTosAndNewPaths() {
+        return volumeTosAndNewPaths;
+    }
 }

core/src/main/java/org/apache/cloudstack/backup/CleanupKnibBackupErrorAnswer.java

@@ -0,0 +1,39 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.cloudstack.backup;
+
+import com.cloud.agent.api.Answer;
+import com.cloud.agent.api.Command;
+import org.apache.cloudstack.storage.to.VolumeObjectTO;
+import org.apache.commons.collections4.CollectionUtils;
+
+import java.util.List;
+
+public class CleanupKnibBackupErrorAnswer extends Answer {
+    List<VolumeObjectTO> volumeObjectTos;
+
+    public CleanupKnibBackupErrorAnswer(Command cmd, List<VolumeObjectTO> volumeObjectTos) {
+        super(cmd, CollectionUtils.isNotEmpty(volumeObjectTos), null);
+        this.volumeObjectTos = volumeObjectTos;
+    }
+
+    public List<VolumeObjectTO> getVolumeObjectTos() {
+        return volumeObjectTos;
+    }
+}

core/src/main/java/org/apache/cloudstack/backup/CleanupKnibBackupErrorCommand.java

@@ -0,0 +1,45 @@
+package org.apache.cloudstack.backup;
+
+import com.cloud.agent.api.Command;
+import org.apache.cloudstack.storage.to.KnibTO;
+
+import java.util.List;
+
+public class CleanupKnibBackupErrorCommand extends Command {
+
+    private boolean runningVM;
+
+    private String vmName;
+
+    private String imageStoreUrl;
+
+    private List<KnibTO> knibTOs;
+
+    public CleanupKnibBackupErrorCommand(boolean runningVM, String vmName, String imageStoreUrl, List<KnibTO> knibTOs) {
+        this.runningVM = runningVM;
+        this.vmName = vmName;
+        this.imageStoreUrl = imageStoreUrl;
+        this.knibTOs = knibTOs;
+    }
+
+    public boolean isRunningVM() {
+        return runningVM;
+    }
+
+    public String getVmName() {
+        return vmName;
+    }
+
+    public String getImageStoreUrl() {
+        return imageStoreUrl;
+    }
+
+    public List<KnibTO> getKnibTOs() {
+        return knibTOs;
+    }
+
+    @Override
+    public boolean executeInSequence() {
+        return false;
+    }
+}