Merge pull request #738 from NationalSecurityAgency/ticket#736/projec…

…t_expiration_locking

#736 add project expiration locking, meta data storage documenting ru…

service/src/main/java/skills/services/LockingService.groovy

@@ -64,5 +64,8 @@ class LockingService {
         return skillsDBLockRepo.findUserAttrsByUserId(userId?.toLowerCase())
     }
 
+    SkillsDBLock lockForProjectExpiration() {
+        return skillsDBLockRepo.findByLock("project_expiration_lock")
+    }
 
 }

service/src/main/java/skills/services/ProjectExpirationService.groovy

@@ -22,6 +22,7 @@ import org.springframework.stereotype.Component
 import org.springframework.transaction.annotation.Transactional
 import skills.controller.exceptions.ErrorCode
 import skills.controller.exceptions.SkillException
+import skills.controller.request.model.GlobalSettingsRequest
 import skills.controller.request.model.ProjectSettingsRequest
 import skills.controller.result.model.SettingsResult
 import skills.notify.EmailNotifier
@@ -35,6 +36,7 @@ import skills.storage.model.auth.RoleName
 import skills.storage.repos.ProjDefRepo
 import skills.storage.repos.UserRoleRepo
 
+import java.time.LocalDate
 import java.time.LocalDateTime
 import java.time.format.DateTimeFormatter
 import java.time.temporal.ChronoUnit
@@ -45,6 +47,9 @@ class ProjectExpirationService {
 
     private static final String SETTING_GROUP = "expiration"
 
+    public static final String SCHEDULED_SETTING_GROUP = "scheduled"
+    public static final String EXPIRATION_LAST_RUN_DATE = "expiration_last_run"
+
     @Value('#{"${skills.config.expireUnusedProjectsOlderThan:180}"}')
     int unusedProjectExpirationInDays
 
@@ -66,6 +71,9 @@ class ProjectExpirationService {
     @Autowired
     EmailNotifier notifier
 
+    @Autowired
+    LockingService lockingService
+
     @Transactional
     public void flagOldProjects(Date expireOlderThan) {
         List<ProjectLastTouched> lastTouchedList = projDefRepo.findProjectsNotTouchedSince(expireOlderThan)
@@ -151,4 +159,36 @@ class ProjectExpirationService {
             }
         }
     }
+
+    @Transactional
+    public void flagDeleteAndNotify() {
+        lockingService.lockForProjectExpiration()
+
+        final LocalDate todayLd = LocalDate.now()
+        final String today = todayLd.format(DateTimeFormatter.BASIC_ISO_DATE)
+
+        SettingsResult expirationLastRan = settingService.getGlobalSetting(EXPIRATION_LAST_RUN_DATE, SCHEDULED_SETTING_GROUP)
+
+        if (expirationLastRan && !LocalDate.parse(expirationLastRan.getValue(), DateTimeFormatter.BASIC_ISO_DATE).isBefore(todayLd)) {
+            log.info("project expiration was already run today (potentially by another node), will not run again today")
+            return
+        }
+
+        try {
+            log.info("identifying projects that haven't been used in [${unusedProjectExpirationInDays}] days")
+            Date expireOlderThan = new Date().minus(unusedProjectExpirationInDays)
+            flagOldProjects(expireOlderThan)
+            log.info("deleting projects whose grace period has expired")
+            Date cutoff = new Date().minus(unusedProjectExpirationGracePeriodInDays)
+            deleteUnusedProjects(cutoff)
+            log.info("sending pending deletion notifications to Project Administrators")
+            notifyGracePeriodProjectAdmins(cutoff)
+        } finally {
+            GlobalSettingsRequest lastRunSettingRequest = new GlobalSettingsRequest()
+            lastRunSettingRequest.value = today
+            lastRunSettingRequest.setting = EXPIRATION_LAST_RUN_DATE
+            lastRunSettingRequest.settingGroup = SCHEDULED_SETTING_GROUP
+            settingService.saveSetting(lastRunSettingRequest)
+        }
+    }
 }

service/src/main/java/skills/services/ScheduledProjectExpiration.groovy

@@ -40,7 +40,7 @@ class ScheduledProjectExpiration {
     @Value('#{"${skills.config.expirationGracePeriod:7}"}')
     int unusedProjectExpirationGracePeriodInDays
 
-    @Scheduled(cron='#{"${skills.config.projectExpirationSchedule:* 4 0 * * *}"}')
+    @Scheduled(cron='#{"${skills.config.projectExpirationSchedule:0 4 0 * * *}"}')
     public void flagUnusedProjectsForDeletion(){
         if (!unusedProjectDeletionEnabled) {
             log.debug("skills.config.unusedProjectDeletionEnabled is set to false, unused project deletion will not occur")
@@ -50,14 +50,8 @@ class ScheduledProjectExpiration {
             log.debug("Email Settings have not configured for this instance, unused project deletion will not occur")
             return
         }
-        log.info("identifying projects that haven't been used in [${unusedProjectExpirationInDays}] days")
-        Date expireOlderThan = new Date().minus(unusedProjectExpirationInDays)
-        projectExpirationService.flagOldProjects(expireOlderThan)
-        log.info("deleting projects whose grace period has expired")
-        Date cutoff = new Date().minus(unusedProjectExpirationGracePeriodInDays)
-        projectExpirationService.deleteUnusedProjects(cutoff)
-        log.info("sending pending deletion notifications to Project Administrators")
-        projectExpirationService.notifyGracePeriodProjectAdmins(cutoff)
+
+        projectExpirationService.flagDeleteAndNotify()
     }
 
 }

service/src/main/resources/application.yml

@@ -86,7 +86,7 @@ skills:
     unusedProjectDeletionEnabled: true
     expireUnusedProjectsOlderThan: 180
     expirationGracePeriod: 7
-    projectExpirationSchedule: "* 4 0 * * *"
+    projectExpirationSchedule: "0 4 0 * * *"
     ui:
       dashboardVersion: @pom.version@
       buildTimestamp: @maven.build.timestamp@

service/src/main/resources/db/changelog/db.changelog-master.xml

@@ -1306,4 +1306,10 @@
         </sql>
     </changeSet>
 
+    <changeSet id="10" author="skills team" context="migration10">
+        <insert tableName="skills_db_locks">
+            <column name="lock" type="varchar(255)" value="project_expiration_lock" />
+        </insert>
+    </changeSet>
+
 </databaseChangeLog>

service/src/test/java/skills/intTests/UnusedProjectExpirationSpecs.groovy

@@ -15,11 +15,15 @@
  */
 package skills.intTests
 
+import org.junit.Rule
 import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.system.OutputCaptureRule
 import org.springframework.transaction.PlatformTransactionManager
 import org.springframework.transaction.TransactionStatus
 import org.springframework.transaction.support.TransactionCallback
 import org.springframework.transaction.support.TransactionTemplate
+import skills.controller.request.model.GlobalSettingsRequest
+import skills.controller.result.model.SettingsResult
 import skills.intTests.utils.DefaultIntSpec
 import skills.intTests.utils.EmailUtils
 import skills.intTests.utils.SkillsFactory
@@ -29,9 +33,15 @@ import skills.services.UserEventService
 import skills.services.settings.SettingsService
 import skills.storage.model.UserAttrs
 import skills.storage.repos.SkillDefRepo
+import skills.utils.LoggerHelper
 import skills.utils.WaitFor
 import spock.lang.IgnoreRest
 
+import java.time.LocalDate
+import java.time.format.DateTimeFormatter
+import java.util.concurrent.Callable
+import java.util.concurrent.ExecutorService
+import java.util.concurrent.Executors
 import java.util.concurrent.TimeUnit
 import java.util.regex.Pattern
 
@@ -55,6 +65,7 @@ class UnusedProjectExpirationSpecs extends DefaultIntSpec{
     @Autowired
     ProjectErrorService errorService
 
+
     def setup() {
         startEmailServer()
     }
@@ -218,4 +229,22 @@ class UnusedProjectExpirationSpecs extends DefaultIntSpec{
         emails.find { p3.matcher(it.html).find() }
     }
 
+    def "only one run per day" () {
+        LoggerHelper loggerHelper = new LoggerHelper(ProjectExpirationService)
+
+        when:
+
+        expirationService.flagDeleteAndNotify()
+
+        expirationService.flagDeleteAndNotify()
+        expirationService.flagDeleteAndNotify()
+        expirationService.flagDeleteAndNotify()
+
+        then:
+        loggerHelper.logEvents.each { println it.message }
+        loggerHelper.logEvents.findAll { it.message.contains("identifying projects that haven't been used in") }.size() == 1
+        loggerHelper.logEvents.findAll { it.message.contains("project expiration was already run today (potentially by another node), will not run again today")}.size() == 3
+
+    }
+
 }

service/src/test/java/skills/services/LockingServiceSpec.groovy

@@ -61,4 +61,14 @@ class LockingServiceSpec extends DefaultIntSpec {
         lock
     }
 
+    @Transactional
+    def "lock project expiration"() {
+        when:
+        SkillsDBLock lock = lockingService.lockForProjectExpiration()
+
+        then:
+        lock
+    }
+
+
 }