-
Notifications
You must be signed in to change notification settings - Fork 462
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(content cleanup) : Automatically prune File Asset versions excee…
…ding a configurable limit #26188 (#26350) * fix(content cleanup) : Automatically prune File Asset versions exceeding a configurable limit #26188 * Implementing SonarQube feedback. * Implementing SonarQube feedback. * Fixing test class name.
- Loading branch information
1 parent
457dccf
commit 64ac9bd
Showing
13 changed files
with
736 additions
and
162 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
154 changes: 154 additions & 0 deletions
154
.../src/integration-test/java/com/dotmarketing/quartz/job/DropOldContentVersionsJobTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| package com.dotmarketing.quartz.job; | ||
|
|
||
| import com.dotcms.contenttype.model.type.ContentType; | ||
| import com.dotcms.datagen.ContentletDataGen; | ||
| import com.dotcms.datagen.TestDataUtils; | ||
| import com.dotcms.util.IntegrationTestInitService; | ||
| import com.dotmarketing.business.APILocator; | ||
| import com.dotmarketing.business.Versionable; | ||
| import com.dotmarketing.business.VersionableAPI; | ||
| import com.dotmarketing.exception.DotDataException; | ||
| import com.dotmarketing.exception.DotSecurityException; | ||
| import com.dotmarketing.portlets.contentlet.business.ContentletAPI; | ||
| import com.dotmarketing.portlets.contentlet.model.Contentlet; | ||
| import com.dotmarketing.util.Config; | ||
| import com.dotmarketing.util.DateUtil; | ||
| import com.liferay.portal.model.User; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.junit.BeforeClass; | ||
| import org.junit.Test; | ||
| import org.quartz.JobExecutionContext; | ||
| import org.quartz.JobExecutionException; | ||
|
|
||
| import java.time.Instant; | ||
| import java.time.LocalDate; | ||
| import java.time.LocalDateTime; | ||
| import java.time.ZoneId; | ||
| import java.util.Date; | ||
| import java.util.List; | ||
|
|
||
| import static org.junit.Assert.assertEquals; | ||
|
|
||
| /** | ||
| * Verifies that the {@link DropOldContentVersionsJob} Quartz Job is working as expected. | ||
| * | ||
| * @author Jose Castro | ||
| * @since Oct 2nd, 2023 | ||
| */ | ||
| public class DropOldContentVersionsJobTest { | ||
|
|
||
| private static User SYSTEM_USER = null; | ||
| private static ContentletDataGen contentletDataGen = null; | ||
| private final VersionableAPI versionableAPI = APILocator.getVersionableAPI(); | ||
| private final ContentletAPI contentletAPI = APILocator.getContentletAPI(); | ||
|
|
||
| @BeforeClass | ||
| public static void prepare() throws Exception { | ||
| // Setting up the web app environment | ||
| IntegrationTestInitService.getInstance().init(); | ||
| final ContentType webPageContentContentType = | ||
| APILocator.getContentTypeAPI(APILocator.systemUser()).find("webPageContent"); | ||
| contentletDataGen = new ContentletDataGen(webPageContentContentType.id()); | ||
| SYSTEM_USER = APILocator.getUserAPI().getSystemUser(); | ||
| } | ||
|
|
||
| /** | ||
| * <ul> | ||
| * <li><b>Method to Test:</b> | ||
| * {@link DropOldContentVersionsJob#execute(JobExecutionContext)}</li> | ||
| * <li><b>Given Scenario:</b> Create 4 versions of a 2-year-old piece of Content, and | ||
| * create 105 versions of another one-year-old Content so that the | ||
| * Drop Old Content Versions Job can analyze them. The default rules are: Dropping | ||
| * versions OLDER than 365 days, and keeping NO MORE than 100 versions per language</li> | ||
| * <li><b>Expected Result:</b> For the two-year-old Contentlet, there will only be 1 | ||
| * version as it is the Published version. For the one-year-old Contentlet, 5 versions will | ||
| * be deleted so that only 100 versions are kept.</li> | ||
| * </ul> | ||
| */ | ||
| @Test | ||
| public void deleteOldContentlets() throws DotDataException, DotSecurityException, | ||
| JobExecutionException { | ||
| final int olderThan = | ||
| Config.getIntProperty(DropOldContentVersionsJob.OLDER_THAN_DAYS_PROP, 365); | ||
| final Date oneYearAgo = localDateToDate(olderThan); | ||
| final Date twoYearsAgo = localDateToDate(olderThan * 2); | ||
|
|
||
| Contentlet veryOldContentlet = TestDataUtils.getGenericContentContent(false, 1); | ||
| // Create first version in English from two years ago | ||
| veryOldContentlet = createContentlet(veryOldContentlet, "VERY Old Contentlet", twoYearsAgo); | ||
| // Create three more versions | ||
| veryOldContentlet = createContentletVersions(veryOldContentlet, "VERY Old Contentlet", twoYearsAgo, 2, 4); | ||
| contentletAPI.unlock(veryOldContentlet, SYSTEM_USER, false); | ||
| ContentletDataGen.publish(veryOldContentlet); | ||
|
|
||
| Contentlet contentWithManyVersions = TestDataUtils.getGenericContentContent(false, 1); | ||
| // Create first version in English form one year ago | ||
| contentWithManyVersions = createContentlet(contentWithManyVersions, "Old Contentlet Version", oneYearAgo); | ||
| // Create 100 more versions | ||
| contentWithManyVersions = createContentletVersions(contentWithManyVersions, "Old Contentlet Version", oneYearAgo, 2, 101); | ||
| // Create three more versions with the current date | ||
| contentWithManyVersions = createContentletVersions(contentWithManyVersions, "Old Contentlet Version", new Date(), 102, 105); | ||
| contentletAPI.unlock(contentWithManyVersions, SYSTEM_USER, false); | ||
| ContentletDataGen.publish(contentWithManyVersions); | ||
|
|
||
| final DropOldContentVersionsJob oldContentVersionsJob = new DropOldContentVersionsJob(); | ||
| oldContentVersionsJob.execute(null); | ||
|
|
||
| // The two-year-old Contentlet should have all of its versions removed, except for the | ||
| // published one | ||
| final List<Versionable> allVersions = | ||
| versionableAPI.findAllVersions(veryOldContentlet.getIdentifier()); | ||
| // The one-year-old Contentlet should have 5 versions removed, so that only 100 are kept | ||
| final List<Versionable> contentletVersions = | ||
| versionableAPI.findAllVersions(contentWithManyVersions.getIdentifier()); | ||
|
|
||
| assertEquals("There should only be 1 version of the two-year-old Contentlet!" + allVersions.size(), 1, allVersions.size()); | ||
| assertEquals("There must be only 100 versions of the one-year-old Contentlet!" + contentletVersions.size(), 100, contentletVersions.size()); | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Initial creation of a test Contentlet. | ||
| */ | ||
| private Contentlet createContentlet(final Contentlet contentlet, final String title, | ||
| final Date modDate) { | ||
| contentlet.setProperty("title", title); | ||
| contentlet.setProperty("_use_mod_date", modDate); | ||
| contentlet.setModDate(modDate); | ||
| return contentletDataGen.persist(contentlet); | ||
| } | ||
|
|
||
| /** | ||
| * Creates several versions of the specified Contentlet. If {@code startIndex} equals 1 and | ||
| * {@code endIndex} equals 3, then 3 versions will be created with each index value appended to | ||
| * the title. | ||
| */ | ||
| @NotNull | ||
| private Contentlet createContentletVersions(Contentlet contentlet, String title, final Date modDate, | ||
| final int startIndex, final int endIndex) throws DotDataException, DotSecurityException { | ||
| if (null == title) { | ||
| title = contentlet.getTitle(); | ||
| } | ||
| for (int i = startIndex; i <= endIndex; i++) { | ||
| contentlet = contentletAPI.checkout(contentlet.getInode(), SYSTEM_USER, false); | ||
| contentlet.setProperty("title", title + " " + i); | ||
| contentlet.setProperty("_use_mod_date", modDate); | ||
| contentlet.setModDate(modDate); | ||
| contentlet = contentletDataGen.persist(contentlet); | ||
| } | ||
| return contentlet; | ||
| } | ||
|
|
||
| /** | ||
| * Utility method used to get the current date minus a specific number of days. | ||
| */ | ||
| private Date localDateToDate(final int olderThan) { | ||
| final LocalDate currentDate = LocalDate.now(ZoneId.of(DateUtil.UTC)); | ||
| final LocalDate localDate = currentDate.minusDays(olderThan); | ||
| // Convert LocalDate to LocalDateTime by adding midnight time (00:00:00) | ||
| final LocalDateTime localDateTime = localDate.atStartOfDay(); | ||
| final Instant instant = localDateTime.atZone(ZoneId.of(DateUtil.UTC)).toInstant(); | ||
| return Date.from(instant); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.