feat: add configuration for scheduled runner cleanup task with delay customization

Author: jreynard-code

api/src/integrationTest/kotlin/com/cosmotech/api/home/runner/RunnerControllerTests.kt

@@ -636,7 +636,7 @@ class RunnerControllerTests : ControllerTestBase() {
   @Test
   fun delete_runner() {
     val expectedRunId = "run-genid12345"
-    every { eventPublisher.publishEvent(match { it is RunStart }) } answers
+    every { eventPublisher.publishEvent(any<RunStart>()) } answers
         {
           firstArg<RunStart>().response = expectedRunId
         }

api/src/main/resources/application.yml

@@ -155,6 +155,10 @@ csm:
       host: localhost:5000
       username: csmenginesdev
       password: "my_registry_password"
+    tasks:
+      cleanUpArchivedRunners:
+        enabled: true
+        delay: 300
 
 springdoc:
   # See https://springdoc.org/#properties

common/src/main/kotlin/com/cosmotech/common/config/CsmPlatformProperties.kt

@@ -43,8 +43,23 @@ data class CsmPlatformProperties(
 
     /** Persistent metrics configuration */
     val metrics: Metrics = Metrics(),
+
+    /** Tasks configuration */
+    val tasks: CsmTasks = CsmTasks(),
 ) {
 
+  data class CsmTasks(
+      /** Clean up archived runners task */
+      val cleanUpArchivedRunners: CsmTask = CsmTask()
+  ) {
+    data class CsmTask(
+        /** Enabled or disabled the task */
+        val enabled: Boolean = true,
+        /** Fixed delay in seconds (default 5min) */
+        val delay: Long = 300,
+    )
+  }
+
   data class Metrics(
       /** Enable Metrics service */
       val enabled: Boolean = true,

runner/src/integrationTest/kotlin/com/cosmotech/runner/service/RunnerServiceIntegrationTest.kt

@@ -41,7 +41,7 @@ import com.cosmotech.runner.RunnerApiServiceInterface
 import com.cosmotech.runner.domain.*
 import com.cosmotech.runner.domain.ResourceSizeInfo
 import com.cosmotech.runner.domain.RunnerRole
-import com.cosmotech.runner.scheduled.RunnerScheduledTasks
+import com.cosmotech.runner.tasks.RunnerScheduledTasks
 import com.cosmotech.solution.SolutionApiServiceInterface
 import com.cosmotech.solution.domain.*
 import com.cosmotech.workspace.WorkspaceApiServiceInterface
@@ -161,7 +161,7 @@ class RunnerServiceIntegrationTest : CsmTestBase() {
     every { getCurrentAccountGroups(any()) } returns listOf("myTestGroup")
     every { getCurrentAuthenticatedUserName(csmPlatformProperties) } returns "test.user"
     every { getCurrentAuthenticatedRoles(any()) } returns listOf(ROLE_ORGANIZATION_USER)
-    every { eventPublisher.publishEvent(match { it is RunStart }) } answers
+    every { eventPublisher.publishEvent(any<RunStart>()) } answers
         {
           firstArg<RunStart>().response = GEN_RUN_ID
         }
@@ -435,11 +435,11 @@ class RunnerServiceIntegrationTest : CsmTestBase() {
     logger.info("should delete the Runner and assert there is one less Runner left")
     runnerApiService.deleteRunner(organizationSaved.id, workspaceSaved.id, newRunnerSaved.id)
     // force trigger scheduled cleanup
-    every { eventPublisher.publishEvent(match { it is UpdateRunnerStatus }) } answers
+    every { eventPublisher.publishEvent(any<UpdateRunnerStatus>()) } answers
         {
           firstArg<UpdateRunnerStatus>().response = "Successful"
         }
-    every { eventPublisher.publishEvent(match { it is CleanUpRun }) } answers
+    every { eventPublisher.publishEvent(any<CleanUpRun>()) } answers
         {
           firstArg<CleanUpRun>().response = true
         }
@@ -994,7 +994,7 @@ class RunnerServiceIntegrationTest : CsmTestBase() {
         RunnerUpdateRequest(),
     )
 
-    every { eventPublisher.publishEvent(match { it is HasRunningRuns }) } answers
+    every { eventPublisher.publishEvent(any<HasRunningRuns>()) } answers
         {
           firstArg<HasRunningRuns>().response = true
         }
@@ -1015,11 +1015,11 @@ class RunnerServiceIntegrationTest : CsmTestBase() {
   fun `test on runner delete keep bases datasets but not parameters dataset`() {
     runnerApiService.deleteRunner(organizationSaved.id, workspaceSaved.id, runnerSaved.id)
     // force trigger scheduled cleanup
-    every { eventPublisher.publishEvent(match { it is UpdateRunnerStatus }) } answers
+    every { eventPublisher.publishEvent(any<UpdateRunnerStatus>()) } answers
         {
           firstArg<UpdateRunnerStatus>().response = "Successful"
         }
-    every { eventPublisher.publishEvent(match { it is CleanUpRun }) } answers
+    every { eventPublisher.publishEvent(any<CleanUpRun>()) } answers
         {
           firstArg<CleanUpRun>().response = true
         }
@@ -1850,7 +1850,7 @@ class RunnerServiceIntegrationTest : CsmTestBase() {
   @Test
   fun `test getRunner when runner has been stopped`() {
 
-    every { eventPublisher.publishEvent(match { it is UpdateRunnerStatus }) } answers
+    every { eventPublisher.publishEvent(any<UpdateRunnerStatus>()) } answers
         {
           firstArg<UpdateRunnerStatus>().response = "Running"
         } andThenAnswer
@@ -1871,7 +1871,7 @@ class RunnerServiceIntegrationTest : CsmTestBase() {
 
   @Test
   fun `test to stop a runner when is already finished but lastRunInfo is not updated to Successful`() {
-    every { eventPublisher.publishEvent(match { it is UpdateRunnerStatus }) } answers
+    every { eventPublisher.publishEvent(any<UpdateRunnerStatus>()) } answers
         {
           firstArg<UpdateRunnerStatus>().response = "Successful"
         }
@@ -1885,7 +1885,7 @@ class RunnerServiceIntegrationTest : CsmTestBase() {
 
   @Test
   fun `test to stop a runner when is already finished but lastRunInfo is not updated to Failed`() {
-    every { eventPublisher.publishEvent(match { it is UpdateRunnerStatus }) } answers
+    every { eventPublisher.publishEvent(any<UpdateRunnerStatus>()) } answers
         {
           firstArg<UpdateRunnerStatus>().response = "Failed"
         }

runner/src/integrationTest/kotlin/com/cosmotech/runner/service/RunnerServiceRBACTest.kt

@@ -115,7 +115,7 @@ class RunnerServiceRBACTest : CsmTestBase() {
         containerRegistryService,
     )
     every { containerRegistryService.getImageLabel(any(), any(), any()) } returns null
-    every { eventPublisher.publishEvent(match { it is RunStart }) } answers
+    every { eventPublisher.publishEvent(any<RunStart>()) } answers
         {
           firstArg<RunStart>().response = "run-gen12345"
         }

runner/src/integrationTest/resources/application-runner-test.yml

@@ -127,3 +127,6 @@ csm:
       accessKeyId: "s3_username"
       secretAccessKey: "s3_password"
       region: "dummy"
+    tasks:
+      cleanUpArchivedRunners:
+        enabled: true

runner/src/main/kotlin/com/cosmotech/runner/scheduled/RunnerScheduledTasks.kt

@@ -0,0 +1,28 @@
+// Copyright (c) Cosmo Tech.
+// Licensed under the MIT license.
+package com.cosmotech.runner.tasks
+
+import com.cosmotech.runner.service.RunnerService
+import java.util.concurrent.TimeUnit
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty
+import org.springframework.scheduling.annotation.Scheduled
+import org.springframework.stereotype.Component
+
+@Component
+@ConditionalOnProperty(
+    name = ["csm.platform.tasks.cleanUpArchivedRunners.enabled"],
+    havingValue = "true",
+    matchIfMissing = false,
+)
+class RunnerScheduledTasks(
+    private val runnerService: RunnerService,
+) {
+
+  @Scheduled(
+      timeUnit = TimeUnit.SECONDS,
+      fixedDelayString = "\${csm.platform.tasks.cleanUpArchivedRunners.delay}",
+  )
+  fun cleanupArchivedRunners() {
+    runnerService.cleanupArchived()
+  }
+}