delete payload files for successful trivial actions

Signed-off-by: Abhishek Kumar <[email protected]>

Author: shwstppr

plugins/hypervisors/external/src/main/java/org/apache/cloudstack/hypervisor/external/provisioner/ExternalPathPayloadProvisioner.java

@@ -29,6 +29,7 @@
 import java.nio.file.StandardCopyOption;
 import java.nio.file.StandardOpenOption;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Comparator;
 import java.util.HashMap;
 import java.util.List;
@@ -124,6 +125,9 @@ public class ExternalPathPayloadProvisioner extends ManagerBase implements Exter
     private String extensionsDataDirectory;
     private ExecutorService payloadCleanupExecutor;
     private ScheduledExecutorService payloadCleanupScheduler;
+    private static final List<String> TRIVIAL_ACTIONS = Arrays.asList(
+            "status"
+    );
 
     @Override
     public String getName() {
@@ -728,6 +732,7 @@ public Pair<Boolean, String> executeExternalCommand(String extensionName, String
                 logger.warn("{}: External API execution failed with exit code {}", errorLogPrefix, exitCode);
                 return new Pair<>(false, "Exit code: " + exitCode + ", Output: " + output.toString().trim());
             }
+            deleteExtensionPayloadFile(extensionName, action, dataFile);
             return new Pair<>(true, output.toString().trim());
 
         } catch (IOException | InterruptedException e) {
@@ -736,6 +741,15 @@ public Pair<Boolean, String> executeExternalCommand(String extensionName, String
         }
     }
 
+    protected void deleteExtensionPayloadFile(String extensionName, String action, String payloadFileName) {
+        if (!TRIVIAL_ACTIONS.contains(action)) {
+            return;
+        }
+        logger.trace("Deleting payload file: {} for extension: {}, action: {}, file: {}",
+                payloadFileName, extensionName, action);
+        FileUtil.deletePath(payloadFileName);
+    }
+
     protected void scheduleExtensionPayloadDirectoryCleanup(String extensionName) {
         try {
             Future<?> future = payloadCleanupExecutor.submit(() -> {

plugins/hypervisors/external/src/test/java/org/apache/cloudstack/hypervisor/external/provisioner/ExternalPathPayloadProvisionerTest.java

@@ -79,6 +79,7 @@
 import com.cloud.hypervisor.HypervisorGuru;
 import com.cloud.hypervisor.HypervisorGuruManager;
 import com.cloud.template.VirtualMachineTemplate;
+import com.cloud.utils.FileUtil;
 import com.cloud.utils.Pair;
 import com.cloud.utils.PropertiesUtil;
 import com.cloud.utils.script.Script;
@@ -590,4 +591,35 @@ public void testExecuteExternalCommandFileNotExecutable() {
         assertFalse(result.first());
         assertEquals("File is not executable", result.second());
     }
+
+    @Test
+    public void deleteExtensionPayloadFile_DeletesFile_WhenActionIsTrivial() {
+        String extensionName = "test-extension";
+        String action = "status"; // in TRIVIAL_ACTIONS
+        String payloadFileName = "/tmp/test-payload.json";
+
+        try (MockedStatic<FileUtil> fileUtilMock = Mockito.mockStatic(FileUtil.class)) {
+            provisioner.deleteExtensionPayloadFile(extensionName, action, payloadFileName);
+
+            fileUtilMock.verify(() -> FileUtil.deletePath(payloadFileName));
+            Mockito.verify(logger).trace(
+                    "Deleting payload file: {} for extension: {}, action: {}, file: {}",
+                    payloadFileName, extensionName, action
+            );
+        }
+    }
+
+    @Test
+    public void deleteExtensionPayloadFile_DoesNothing_WhenActionIsNotTrivial() {
+        String extensionName = "test-extension";
+        String action = "start";
+        String payloadFileName = "/tmp/test-payload.json";
+
+        try (MockedStatic<FileUtil> fileUtilMock = Mockito.mockStatic(FileUtil.class)) {
+            provisioner.deleteExtensionPayloadFile(extensionName, action, payloadFileName);
+
+            fileUtilMock.verifyNoInteractions();
+            Mockito.verify(logger, Mockito.never()).trace(anyString(), any(), any(), any(), any());
+        }
+    }
 }