Fix waiting for block commit

Author: João Jandre

plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/BlockCommitListener.java

@@ -37,7 +37,8 @@ public class BlockCommitListener implements BlockJobListener {
     protected BlockCommitListener(String vmName, String logid) {
         this.vmName = vmName;
         this.logid = logid;
-        logger = LogManager.getLogger(getClass());
+        this.logger = LogManager.getLogger(getClass());
+        this.result = String.format("Failed to block commit disk of VM [%s]. Libvirt did not launch an event for it.", vmName);
     }
 
     protected String getResult() {

plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtComputingResource.java

@@ -6656,8 +6656,7 @@ protected void mergeSnapshotIntoBaseFileWithEventsAndConfigurableTimeout(Domain
             vm.addBlockJobListener(blockCommitListener);
 
             logger.info("Starting block commit of QCOW2 delta [{}] of VM [{}]. Using parameters: diskLabel [{}]; baseFilePath [{}]; topFilePath [{}]; commitFlags [{}]",
-                    snapshotName,
-                    vmName, diskLabel, baseFilePath, topFilePath, commitFlags);
+                    snapshotName, vmName, diskLabel, baseFilePath, topFilePath, commitFlags);
 
             vm.blockCommit(diskLabel, baseFilePath, topFilePath, 0, commitFlags);
 

plugins/hypervisors/kvm/src/test/java/com/cloud/hypervisor/kvm/resource/LibvirtComputingResourceTest.java

@@ -6696,9 +6696,11 @@ public void mergeSnapshotIntoBaseFileTestActiveAndDeleteFlags() throws Exception
 
             threadContextMockedStatic.when(() ->
                     ThreadContext.get(Mockito.anyString())).thenReturn("logid");
-            Mockito.doNothing().when(domainMock).addBlockJobListener(Mockito.any());
+            Mockito.doReturn(blockCommitListenerMock).when(libvirtComputingResourceSpy).getBlockCommitListener(Mockito.any());
+            Mockito.doReturn(null).when(blockCommitListenerMock).getResult();
+            Mockito.doNothing().when(domainMock).addBlockJobListener(blockCommitListenerMock);
             Mockito.doReturn(null).when(domainMock).getBlockJobInfo(Mockito.anyString(), Mockito.anyInt());
-            Mockito.doNothing().when(domainMock).removeBlockJobListener(Mockito.any());
+            Mockito.doNothing().when(domainMock).removeBlockJobListener(blockCommitListenerMock);
 
             String diskLabel = "vda";
             String baseFilePath = "/file";
@@ -6723,8 +6725,10 @@ public void mergeSnapshotIntoBaseFileTestActiveFlag() throws Exception {
 
             threadContextMockedStatic.when(() ->
                     ThreadContext.get(Mockito.anyString())).thenReturn("logid");
-            Mockito.doNothing().when(domainMock).addBlockJobListener(Mockito.any());
-            Mockito.doNothing().when(domainMock).removeBlockJobListener(Mockito.any());
+            Mockito.doReturn(blockCommitListenerMock).when(libvirtComputingResourceSpy).getBlockCommitListener(Mockito.any());
+            Mockito.doReturn(null).when(blockCommitListenerMock).getResult();
+            Mockito.doNothing().when(domainMock).addBlockJobListener(blockCommitListenerMock);
+            Mockito.doNothing().when(domainMock).removeBlockJobListener(blockCommitListenerMock);
             Mockito.doNothing().when(libvirtComputingResourceSpy).manuallyDeleteUnusedSnapshotFile(Mockito.anyBoolean(), Mockito.anyString());
 
             String diskLabel = "vda";
@@ -6748,9 +6752,11 @@ public void mergeSnapshotIntoBaseFileTestDeleteFlag() throws Exception {
             libvirtComputingResourceSpy.qcow2DeltaMergeTimeout = 10;
             libvirtUtilitiesHelperMockedStatic.when(() -> LibvirtUtilitiesHelper.isLibvirtSupportingFlagDeleteOnCommandVirshBlockcommit(Mockito.any())).thenReturn(true);
             threadContextMockedStatic.when(() -> ThreadContext.get(Mockito.anyString())).thenReturn("logid");
-            Mockito.doNothing().when(domainMock).addBlockJobListener(Mockito.any());
+            Mockito.doReturn(blockCommitListenerMock).when(libvirtComputingResourceSpy).getBlockCommitListener(Mockito.any());
+            Mockito.doReturn(null).when(blockCommitListenerMock).getResult();
+            Mockito.doNothing().when(domainMock).addBlockJobListener(blockCommitListenerMock);
             Mockito.doReturn(null).when(domainMock).getBlockJobInfo(Mockito.anyString(), Mockito.anyInt());
-            Mockito.doNothing().when(domainMock).removeBlockJobListener(Mockito.any());
+            Mockito.doNothing().when(domainMock).removeBlockJobListener(blockCommitListenerMock);
             Mockito.doNothing().when(libvirtComputingResourceSpy).manuallyDeleteUnusedSnapshotFile(Mockito.anyBoolean(), Mockito.anyString());
 
             String diskLabel = "vda";
@@ -6774,9 +6780,11 @@ public void mergeSnapshotIntoBaseFileTestNoFlags() throws Exception {
             libvirtComputingResourceSpy.qcow2DeltaMergeTimeout = 10;
             libvirtUtilitiesHelperMockedStatic.when(() -> LibvirtUtilitiesHelper.isLibvirtSupportingFlagDeleteOnCommandVirshBlockcommit(Mockito.any())).thenReturn(false);
             threadContextMockedStatic.when(() -> ThreadContext.get(Mockito.anyString())).thenReturn("logid");
-            Mockito.doNothing().when(domainMock).addBlockJobListener(Mockito.any());
+            Mockito.doReturn(blockCommitListenerMock).when(libvirtComputingResourceSpy).getBlockCommitListener(Mockito.any());
+            Mockito.doReturn(null).when(blockCommitListenerMock).getResult();
+            Mockito.doNothing().when(domainMock).addBlockJobListener(blockCommitListenerMock);
             Mockito.doReturn(null).when(domainMock).getBlockJobInfo(Mockito.anyString(), Mockito.anyInt());
-            Mockito.doNothing().when(domainMock).removeBlockJobListener(Mockito.any());
+            Mockito.doNothing().when(domainMock).removeBlockJobListener(blockCommitListenerMock);
             Mockito.doNothing().when(libvirtComputingResourceSpy).manuallyDeleteUnusedSnapshotFile(Mockito.anyBoolean(), Mockito.anyString());
 
             String diskLabel = "vda";