plugins-external: improve payload path

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

Author: shwstppr

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

@@ -35,6 +35,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Properties;
+import java.util.UUID;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.concurrent.Future;
@@ -784,8 +785,7 @@ protected void scheduleExtensionPayloadDirectoryCleanup(String extensionName) {
 
     protected String prepareExternalPayload(String extensionName, Map<String, Object> details) throws IOException {
         String json = GsonHelper.getGson().toJson(details);
-        long epochMillis = System.currentTimeMillis();
-        String fileName = epochMillis + ".json";
+        String fileName = UUID.randomUUID() + ".json";
         String extensionPayloadDir = extensionsDataDirectory + File.separator + extensionName;
         Path payloadDirPath = Paths.get(extensionPayloadDir);
         if (!Files.exists(payloadDirPath)) {

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

@@ -28,6 +28,8 @@
 import static org.mockito.ArgumentMatchers.anyLong;
 import static org.mockito.ArgumentMatchers.anyMap;
 import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.doNothing;
 import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
@@ -36,6 +38,8 @@
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.nio.file.StandardOpenOption;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
@@ -622,4 +626,53 @@ public void deleteExtensionPayloadFile_DoesNothing_WhenActionIsNotTrivial() {
             Mockito.verify(logger, Mockito.never()).trace(anyString(), any(), any(), any(), any());
         }
     }
+
+    @Test
+    public void prepareExternalPayloadCreatesFileInNewDirectory() throws IOException {
+        String extensionName = "test-extension";
+        Map<String, Object> details = Map.of("key", "value");
+        String result = provisioner.prepareExternalPayload(extensionName, details);
+        assertNotNull(result);
+        Path payloadFile = Paths.get(result);
+        assertTrue(Files.exists(payloadFile));
+        assertTrue(Files.isRegularFile(payloadFile));
+        assertEquals("{\"key\":\"value\"}", Files.readString(payloadFile));
+    }
+
+    @Test
+    public void prepareExternalPayloadCreatesFileInExistingDirectory() throws IOException {
+        String extensionName = "test-extension";
+        Map<String, Object> details = Map.of("key", "value");
+        Path existingDir = Paths.get(tempDataDir.getAbsolutePath(), extensionName);
+        Files.createDirectories(existingDir);
+        doNothing().when(provisioner).scheduleExtensionPayloadDirectoryCleanup(extensionName);
+        String result = provisioner.prepareExternalPayload(extensionName, details);
+        assertNotNull(result);
+        Path payloadFile = Paths.get(result);
+        assertTrue(Files.exists(payloadFile));
+        assertTrue(Files.isRegularFile(payloadFile));
+        assertEquals("{\"key\":\"value\"}", Files.readString(payloadFile));
+    }
+
+    @Test
+    public void prepareExternalPayloadSchedulesCleanupForExistingDirectory() throws IOException {
+        String extensionName = "test-extension";
+        Map<String, Object> details = Map.of("key", "value");
+        Path existingDir = Paths.get(tempDataDir.getAbsolutePath(), extensionName);
+        Files.createDirectories(existingDir);
+        doNothing().when(provisioner).scheduleExtensionPayloadDirectoryCleanup(extensionName);
+        provisioner.prepareExternalPayload(extensionName, details);
+    }
+
+    @Test(expected = IOException.class)
+    public void prepareExternalPayloadThrowsExceptionWhenFileCannotBeWritten() throws IOException {
+        String extensionName = "test-extension";
+        Map<String, Object> details = Map.of("key", "value");
+        Path existingDir = Paths.get(tempDataDir.getAbsolutePath(), extensionName);
+        Files.createDirectories(existingDir);
+        try (MockedStatic<Files> filesMock = Mockito.mockStatic(Files.class)) {
+            filesMock.when(() -> Files.writeString(any(Path.class), anyString(), eq(StandardOpenOption.CREATE_NEW))).thenThrow(IOException.class);
+            provisioner.prepareExternalPayload(extensionName, details);
+        }
+    }
 }