#22033 Creating the PruneTimeMachineBackup Class

dotCMS/src/main/java/com/dotmarketing/quartz/job/PruneTimeMachineBackupJob.java

@@ -0,0 +1,31 @@
+package com.dotmarketing.quartz.job;
+
+import com.dotcms.timemachine.business.TimeMachineAPI;
+import com.dotmarketing.business.APILocator;
+import com.dotmarketing.quartz.DotStatefulJob;
+import org.quartz.JobExecutionContext;
+import org.quartz.JobExecutionException;
+
+/**
+ * This job is responsible for removing old backup folders from the Time Machine folder path.
+ *
+ * Every time the {@link TimeMachineJob} runs, it creates a folder inside the Time Machine path (one for each language).
+ * Inside this new folder, it stores all the files produced during the Time Machine process.
+ * These files are necessary to render all the pages on the selected sites.
+ *
+ * This job is tasked with cleaning up the Time Machine Path folder by removing folders older than
+ * the value specified in the PRUNE_TIMEMACHINE_OLDER_THAN_DAYS configuration property.
+ *
+ * The Time Machine Path is set using the TIMEMACHINE_PATH property.
+ *
+ * @see TimeMachineJob
+ */
+public class PruneTimeMachineBackupJob extends DotStatefulJob {
+
+    final TimeMachineAPI timeMachineAPI = APILocator.getTimeMachineAPI();
+
+    @Override
+    public void run(JobExecutionContext jobContext) throws JobExecutionException {
+        timeMachineAPI.removeOldTimeMachineBackupsFiles();
+    }
+}

dotcms-integration/src/test/java/com/dotmarketing/quartz/job/PruneTimeMachineBackupJobTest.java

@@ -0,0 +1,171 @@
+package com.dotmarketing.quartz.job;
+
+import com.dotcms.util.IntegrationTestInitService;
+import com.dotmarketing.business.APILocator;
+import com.dotmarketing.util.Config;
+import com.dotmarketing.util.FileUtil;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.quartz.JobDataMap;
+import org.quartz.JobDetail;
+import org.quartz.JobExecutionContext;
+import org.quartz.JobExecutionException;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.Calendar;
+import java.util.Collection;
+import java.util.stream.Collectors;
+
+import static com.dotcms.util.CollectionsUtils.list;
+import static org.junit.Assert.*;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+public class PruneTimeMachineBackupJobTest {
+
+    final PruneTimeMachineBackupJob pruneTimeMachineJob = new PruneTimeMachineBackupJob();
+
+    @BeforeClass
+    public static void prepare() throws Exception {
+        IntegrationTestInitService.getInstance().init();
+    }
+
+    private File createTimeMachineFolder(final File parentFolder, final String fileName,
+                                         final int howLongWasModified) throws IOException {
+        final Calendar expireDate = Calendar.getInstance();
+        expireDate.add(Calendar.DATE, (howLongWasModified * -1));
+
+        final File tmFolder = new File(parentFolder, fileName);
+        tmFolder.mkdir();
+
+        final File fileInside = new File(tmFolder, "file");
+        fileInside.createNewFile();
+
+        final File folderInside = new File(tmFolder, "folder");
+        folderInside.mkdir();
+
+        final File fileInsideFolderInside = new File(folderInside, "file");
+        fileInsideFolderInside.createNewFile();
+
+        tmFolder.setLastModified(expireDate.toInstant().toEpochMilli());
+
+        return tmFolder;
+    }
+
+    /**
+     * Method to test: {@link PruneTimeMachineBackupJob#run(JobExecutionContext)}
+     * When: In the directory for the Time Machine, there are two folders with the following names and corresponding "Last Modified" days:
+     *
+     * Folder: timeMachineBundle_[current_millis]_1, Last Modified: 95 days ago
+     * Folder: timeMachineBundle_[current_millis]_2, Last Modified: 45 days ago
+     *
+     * Should: Remove the folder named timeMachineBundle_1715638200156_1
+     */
+    @Test
+    public void runRemoveFolder() throws IOException, JobExecutionException {
+        final File tmTestingFolder = FileUtil.createTemporaryDirectory("tm_testing");
+        final String timeMachinePathPreviousValue = Config.getStringProperty("TIMEMACHINE_PATH", null);
+
+        try {
+            Config.setProperty("TIMEMACHINE_PATH", tmTestingFolder.toPath().toAbsolutePath().toString());
+
+            final String expireFolderName = "timeMachineBundle_" + System.currentTimeMillis() + "_1";
+            final File expireFolder = createTimeMachineFolder(tmTestingFolder, expireFolderName, 95);
+
+            final String noExpireFolderName = "timeMachineBundle_" + System.currentTimeMillis() + "_2";
+            final File noExpireFolder = createTimeMachineFolder(tmTestingFolder, noExpireFolderName, 45);
+
+            assertFileSystem(tmTestingFolder, noExpireFolderName, expireFolderName);
+
+            pruneTimeMachineJob.run(getJobExecutionContext());
+
+            assertFileSystem(tmTestingFolder, noExpireFolderName);
+        } finally {
+            cleanUp(timeMachinePathPreviousValue);
+        }
+    }
+
+    private JobExecutionContext getJobExecutionContext() {
+        return mock(JobExecutionContext.class);
+    }
+
+    private static void assertFileSystem(final File folder, String... folderNames) {
+        final Collection<String> filesPath = Arrays.stream(folder.listFiles()).map(File::getName)
+                .collect(Collectors.toList());
+        assertEquals(folderNames.length, filesPath.size());
+
+        Arrays.stream(folderNames).forEach(folderName -> assertTrue(filesPath.contains(folderName)));
+    }
+
+    /**
+     * Method to test: {@link PruneTimeMachineBackupJob#run(JobExecutionContext)}
+     * When: In the directory for the Time Machine, there are two folders with the following names and corresponding "Last Modified" days:
+     *
+     * Folder: timeMachineBundle_1715638200156_1, Last Modified: 95 days ago
+     * Folder: timeMachineBundle_1715638200156_2, Last Modified: 97 days ago
+     *
+     * Should: Remove both folders
+     */
+    @Test
+    public void runRemoveAll() throws IOException, JobExecutionException {
+        final File tmTestingFolder = FileUtil.createTemporaryDirectory("tm_testing");
+        final String timeMachinePathPreviousValue = Config.getStringProperty("TIMEMACHINE_PATH", null);
+
+        try {
+            Config.setProperty("TIMEMACHINE_PATH", tmTestingFolder.toPath().toAbsolutePath().toString());
+
+            final String expireFolderName_1 = "timeMachineBundle_" + System.currentTimeMillis() + "_1";
+            final File expireFolder_1 = createTimeMachineFolder(tmTestingFolder, expireFolderName_1, 95);
+
+            final String expireFolderName_2 = "timeMachineBundle_" + System.currentTimeMillis() + "_2";
+            final File expireFolder_2 = createTimeMachineFolder(tmTestingFolder, expireFolderName_2, 97);
+
+            assertFileSystem(tmTestingFolder, expireFolderName_1, expireFolderName_2);
+
+            pruneTimeMachineJob.run(getJobExecutionContext());
+            assertEquals(0, tmTestingFolder.listFiles().length);
+        } finally {
+            cleanUp(timeMachinePathPreviousValue);
+        }
+    }
+
+    private void cleanUp(String timeMachinePathPreviousValue) {
+        Config.setProperty("TIMEMACHINE_PATH", timeMachinePathPreviousValue);
+        APILocator.getTimeMachineAPI().removeQuartzJob();
+    }
+
+    /**
+     * Method to test: {@link PruneTimeMachineBackupJob#run(JobExecutionContext)}
+     * When: In the directory for the Time Machine, there are two folders with the following names and corresponding "Last Modified" days:
+     *
+     * Folder: timeMachineBundle_[current_millis]_1, Last Modified: 55 days ago
+     * Folder: timeMachineBundle_[current_millis]_2, Last Modified: 45 days ago
+     *
+     * Should: Remove nothing
+     */
+    @Test
+    public void runRemoveNothing() throws IOException, JobExecutionException {
+        final File tmTestingFolder = FileUtil.createTemporaryDirectory("tm_testing");
+        final String timeMachinePathPreviousValue = Config.getStringProperty("TIMEMACHINE_PATH", null);
+
+        try {
+            Config.setProperty("TIMEMACHINE_PATH", tmTestingFolder.toPath().toAbsolutePath().toString());
+
+            final String noExpireFolderName_1 = "timeMachineBundle_" + System.currentTimeMillis() + "_1";
+            final File noExpireFolder_1 = createTimeMachineFolder(tmTestingFolder, noExpireFolderName_1, 55);
+
+            final String noExpireFolderName_2 = "timeMachineBundle_" + System.currentTimeMillis() + "_2";
+            final File noExpireFolder_2 = createTimeMachineFolder(tmTestingFolder, noExpireFolderName_2, 45);
+
+            assertFileSystem(tmTestingFolder, noExpireFolderName_1, noExpireFolderName_2);
+
+            pruneTimeMachineJob.run(getJobExecutionContext());
+
+            assertFileSystem(tmTestingFolder, noExpireFolderName_1, noExpireFolderName_2);
+        } finally {
+            cleanUp(timeMachinePathPreviousValue);
+        }
+    }
+}