implemented 06-watcher.md: non-blocking poll cycle enqueueing changed/new/auto-build branches via the async executor, startup recovery, retention/worktree pruning, JSON auto-build slot state, watcher.pollInterval config, and watcher health state
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Michael Hoennig
co-authored by
Claude Fable 5
Claude Fable 5
parent
3c9eeda5da
commit
a1db450bdb
@@ -0,0 +1,343 @@
|
||||
package de.hoennig.gittally.watcher
|
||||
|
||||
import de.hoennig.gittally.build.ArtifactKeys
|
||||
import de.hoennig.gittally.build.ArtifactStore
|
||||
import de.hoennig.gittally.build.BuildExecutor
|
||||
import de.hoennig.gittally.build.BuildResult
|
||||
import de.hoennig.gittally.build.BuildStatus
|
||||
import de.hoennig.gittally.build.FileBuildResultRepository
|
||||
import de.hoennig.gittally.build.GitWorktreeWorkspaces
|
||||
import de.hoennig.gittally.build.RunningBuild
|
||||
import de.hoennig.gittally.config.AutoBuildConfig
|
||||
import de.hoennig.gittally.config.BranchConfig
|
||||
import de.hoennig.gittally.config.ConfigLoader
|
||||
import de.hoennig.gittally.config.GitTallyConfig
|
||||
import de.hoennig.gittally.config.WatcherConfig
|
||||
import de.hoennig.gittally.git.GitService
|
||||
import io.kotest.assertions.throwables.shouldThrow
|
||||
import io.kotest.core.spec.style.FunSpec
|
||||
import io.kotest.matchers.booleans.shouldBeFalse
|
||||
import io.kotest.matchers.booleans.shouldBeTrue
|
||||
import io.kotest.matchers.collections.shouldBeEmpty
|
||||
import io.kotest.matchers.collections.shouldContainExactly
|
||||
import io.kotest.matchers.collections.shouldContainExactlyInAnyOrder
|
||||
import io.kotest.matchers.nulls.shouldBeNull
|
||||
import io.kotest.matchers.nulls.shouldNotBeNull
|
||||
import io.kotest.matchers.shouldBe
|
||||
import io.kotest.matchers.string.shouldContain
|
||||
import io.mockk.every
|
||||
import io.mockk.mockk
|
||||
import io.mockk.verify
|
||||
import java.nio.file.Files
|
||||
import java.nio.file.Path
|
||||
import java.time.Clock
|
||||
import java.time.Duration
|
||||
import java.time.Instant
|
||||
import java.time.LocalDate
|
||||
import java.time.ZoneOffset
|
||||
import java.util.concurrent.CopyOnWriteArrayList
|
||||
import java.util.concurrent.CountDownLatch
|
||||
import java.util.concurrent.TimeUnit
|
||||
|
||||
class WatcherTest : FunSpec() {
|
||||
private val noon = Instant.parse("2026-07-07T12:00:00Z")
|
||||
|
||||
private inner class Harness(
|
||||
config: GitTallyConfig = GitTallyConfig(),
|
||||
) {
|
||||
val workingDir: Path = Files.createTempDirectory("gittally-watcher-test")
|
||||
val repository = FileBuildResultRepository(workingDir.resolve(".git/gittally/build-results.json"))
|
||||
val gitService = mockk<GitService>()
|
||||
val buildExecutor = mockk<BuildExecutor>()
|
||||
val artifactStore = mockk<ArtifactStore>()
|
||||
val startedBuilds = CopyOnWriteArrayList<Pair<String, String>>()
|
||||
val configLoader = mockk<ConfigLoader>()
|
||||
val watcher =
|
||||
Watcher(
|
||||
gitService = gitService,
|
||||
buildExecutor = buildExecutor,
|
||||
repository = repository,
|
||||
artifactStore = artifactStore,
|
||||
configLoader = configLoader,
|
||||
clock = Clock.fixed(noon, ZoneOffset.UTC),
|
||||
)
|
||||
|
||||
private var seedCounter = 0L
|
||||
|
||||
init {
|
||||
every { configLoader.load(any()) } returns config
|
||||
every { gitService.fetchOrigin(any()) } returns Unit
|
||||
every { gitService.localBranches(any()) } returns emptyList()
|
||||
every { gitService.originBranches(any()) } returns emptyList()
|
||||
every { gitService.newOriginBranches(any(), any()) } returns emptyList()
|
||||
every { gitService.hasNewCommits(any(), any()) } returns false
|
||||
every { gitService.originHeadCommit(any(), any()) } returns null
|
||||
every { gitService.worktreePrune(any()) } returns Unit
|
||||
every { buildExecutor.currentBuilds() } returns emptyList()
|
||||
every { buildExecutor.startBuild(any(), any(), any()) } answers {
|
||||
val branch = firstArg<String>()
|
||||
val commit = secondArg<String>()
|
||||
startedBuilds += branch to commit
|
||||
runningBuild(branch, commit)
|
||||
}
|
||||
every { artifactStore.prune(any()) } returns emptyList()
|
||||
}
|
||||
|
||||
/** Appends a result; later seeds get later start timestamps. */
|
||||
fun seed(
|
||||
branch: String,
|
||||
status: BuildStatus,
|
||||
commit: String = "commit-0",
|
||||
): BuildResult {
|
||||
val startedAt = noon.minusSeconds(3600).plusSeconds(seedCounter++)
|
||||
val result =
|
||||
BuildResult(
|
||||
branch = branch,
|
||||
commit = commit,
|
||||
status = status,
|
||||
startedAt = startedAt,
|
||||
artifactKey = ArtifactKeys.buildKey(branch, startedAt),
|
||||
)
|
||||
repository.append(result)
|
||||
return result
|
||||
}
|
||||
|
||||
fun worktreeDir(branch: String): Path {
|
||||
val dir = workingDir.resolve(GitWorktreeWorkspaces.WORKTREES_DIR).resolve(ArtifactKeys.branchKey(branch))
|
||||
Files.createDirectories(dir)
|
||||
Files.writeString(dir.resolve("marker.txt"), branch)
|
||||
return dir
|
||||
}
|
||||
|
||||
fun autoBuildState() = FileAutoBuildState(workingDir.resolve(Watcher.AUTO_BUILDS_FILE))
|
||||
}
|
||||
|
||||
private fun runningBuild(
|
||||
branch: String,
|
||||
commit: String,
|
||||
): RunningBuild {
|
||||
val stagingDir = Files.createTempDirectory("gittally-watcher-staging")
|
||||
return RunningBuild(
|
||||
branch = branch,
|
||||
commit = commit,
|
||||
artifactKey = ArtifactKeys.buildKey(branch, Instant.now()),
|
||||
startedAt = Instant.now(),
|
||||
stagingDir = stagingDir,
|
||||
liveLogFile = stagingDir.resolve("build.log"),
|
||||
)
|
||||
}
|
||||
|
||||
private fun autoBuildConfig(vararg times: String): GitTallyConfig =
|
||||
GitTallyConfig(
|
||||
branches =
|
||||
mapOf(
|
||||
"default" to BranchConfig(),
|
||||
"main" to BranchConfig(autoBuild = AutoBuildConfig(enabled = true, times = times.toList())),
|
||||
),
|
||||
)
|
||||
|
||||
init {
|
||||
test("a fetch failure is exposed in the state and only retried next cycle") {
|
||||
val harness = Harness()
|
||||
every { harness.gitService.fetchOrigin(any()) } throws RuntimeException("origin unreachable")
|
||||
|
||||
harness.watcher.poll(harness.workingDir)
|
||||
|
||||
harness.watcher
|
||||
.state()
|
||||
.lastFetchError
|
||||
.shouldNotBeNull() shouldContain "origin unreachable"
|
||||
harness.watcher.state().lastPollAt shouldBe noon
|
||||
harness.startedBuilds.shouldBeEmpty()
|
||||
verify(exactly = 0) { harness.artifactStore.prune(any()) }
|
||||
|
||||
every { harness.gitService.fetchOrigin(any()) } returns Unit
|
||||
harness.watcher.poll(harness.workingDir)
|
||||
|
||||
harness.watcher
|
||||
.state()
|
||||
.lastFetchError
|
||||
.shouldBeNull()
|
||||
}
|
||||
|
||||
test("poll enqueues changed local branches before recent new origin branches") {
|
||||
val harness = Harness()
|
||||
every { harness.gitService.originBranches(any()) } returns listOf("main", "feature/new")
|
||||
every { harness.gitService.localBranches(any()) } returns listOf("main", "untracked-local")
|
||||
every { harness.gitService.hasNewCommits("main", any()) } returns true
|
||||
every { harness.gitService.newOriginBranches(any(), any()) } returns listOf("feature/new")
|
||||
every { harness.gitService.originHeadCommit("main", any()) } returns "commit-main"
|
||||
every { harness.gitService.originHeadCommit("feature/new", any()) } returns "commit-feature"
|
||||
|
||||
harness.watcher.poll(harness.workingDir)
|
||||
|
||||
harness.startedBuilds shouldContainExactly
|
||||
listOf("main" to "commit-main", "feature/new" to "commit-feature")
|
||||
}
|
||||
|
||||
test("poll skips a branch whose build is already pending or running") {
|
||||
val harness = Harness()
|
||||
harness.seed("main", BuildStatus.PENDING, commit = "commit-old")
|
||||
every { harness.gitService.originBranches(any()) } returns listOf("main")
|
||||
every { harness.gitService.localBranches(any()) } returns listOf("main")
|
||||
every { harness.gitService.hasNewCommits("main", any()) } returns true
|
||||
every { harness.gitService.originHeadCommit("main", any()) } returns "commit-new"
|
||||
|
||||
harness.watcher.poll(harness.workingDir)
|
||||
|
||||
harness.startedBuilds.shouldBeEmpty()
|
||||
}
|
||||
|
||||
test("a poll cycle completes while a build is running and still enqueues other branches") {
|
||||
val harness = Harness()
|
||||
harness.seed("main", BuildStatus.RUNNING, commit = "commit-1")
|
||||
every { harness.buildExecutor.currentBuilds() } returns listOf(runningBuild("main", "commit-1"))
|
||||
every { harness.gitService.originBranches(any()) } returns listOf("main", "feature/other")
|
||||
every { harness.gitService.localBranches(any()) } returns listOf("main")
|
||||
every { harness.gitService.hasNewCommits("main", any()) } returns true
|
||||
every { harness.gitService.newOriginBranches(any(), any()) } returns listOf("feature/other")
|
||||
every { harness.gitService.originHeadCommit("main", any()) } returns "commit-2"
|
||||
every { harness.gitService.originHeadCommit("feature/other", any()) } returns "commit-3"
|
||||
|
||||
harness.watcher.poll(harness.workingDir)
|
||||
|
||||
harness.startedBuilds shouldContainExactly listOf("feature/other" to "commit-3")
|
||||
harness.watcher.state().queuedBranches shouldContainExactly listOf("main")
|
||||
}
|
||||
|
||||
test("poll does not re-enqueue a commit that was already built") {
|
||||
val harness = Harness()
|
||||
harness.seed("main", BuildStatus.SUCCESS, commit = "commit-abc")
|
||||
every { harness.gitService.originBranches(any()) } returns listOf("main")
|
||||
every { harness.gitService.localBranches(any()) } returns listOf("main")
|
||||
every { harness.gitService.hasNewCommits("main", any()) } returns true
|
||||
every { harness.gitService.originHeadCommit("main", any()) } returns "commit-abc"
|
||||
|
||||
harness.watcher.poll(harness.workingDir)
|
||||
harness.startedBuilds.shouldBeEmpty()
|
||||
|
||||
every { harness.gitService.originHeadCommit("main", any()) } returns "commit-def"
|
||||
harness.watcher.poll(harness.workingDir)
|
||||
|
||||
harness.startedBuilds shouldContainExactly listOf("main" to "commit-def")
|
||||
}
|
||||
|
||||
test("poll filters new origin branches by the configured newBranchMaxAge") {
|
||||
val harness = Harness(GitTallyConfig(watcher = WatcherConfig(newBranchMaxAge = "12h")))
|
||||
|
||||
harness.watcher.poll(harness.workingDir)
|
||||
|
||||
verify { harness.gitService.newOriginBranches(Duration.ofHours(12), any()) }
|
||||
}
|
||||
|
||||
test("auto builds rebuild the already built commit once per day and slot") {
|
||||
val harness = Harness(autoBuildConfig("01:00", "11:00", "13:00"))
|
||||
harness.seed("main", BuildStatus.SUCCESS, commit = "commit-abc")
|
||||
every { harness.gitService.originBranches(any()) } returns listOf("main")
|
||||
every { harness.gitService.originHeadCommit("main", any()) } returns "commit-abc"
|
||||
|
||||
harness.watcher.poll(harness.workingDir)
|
||||
harness.watcher.poll(harness.workingDir)
|
||||
|
||||
harness.startedBuilds shouldContainExactly listOf("main" to "commit-abc")
|
||||
harness.autoBuildState().isTriggered("main", LocalDate.parse("2026-07-07"), "11:00").shouldBeTrue()
|
||||
}
|
||||
|
||||
test("an auto-build slot stays untriggered while the branch is still building") {
|
||||
val harness = Harness(autoBuildConfig("11:00"))
|
||||
harness.seed("main", BuildStatus.RUNNING, commit = "commit-abc")
|
||||
every { harness.gitService.originBranches(any()) } returns listOf("main")
|
||||
every { harness.gitService.originHeadCommit("main", any()) } returns "commit-abc"
|
||||
|
||||
harness.watcher.poll(harness.workingDir)
|
||||
|
||||
harness.startedBuilds.shouldBeEmpty()
|
||||
harness.autoBuildState().isTriggered("main", LocalDate.parse("2026-07-07"), "11:00").shouldBeFalse()
|
||||
}
|
||||
|
||||
test("startup recovery marks stale builds interrupted and re-enqueues them") {
|
||||
val harness = Harness()
|
||||
harness.seed("main", BuildStatus.RUNNING, commit = "commit-1")
|
||||
harness.seed("feature/a", BuildStatus.INTERRUPTED, commit = "commit-2")
|
||||
harness.seed("queued", BuildStatus.PENDING, commit = "commit-3")
|
||||
harness.seed("done", BuildStatus.SUCCESS, commit = "commit-4")
|
||||
every { harness.gitService.originHeadCommit("main", any()) } returns "commit-1"
|
||||
every { harness.gitService.originHeadCommit("feature/a", any()) } returns "commit-2"
|
||||
every { harness.gitService.originHeadCommit("queued", any()) } returns "commit-3"
|
||||
|
||||
harness.watcher.recoverOnStartup(harness.workingDir)
|
||||
|
||||
harness.startedBuilds shouldContainExactlyInAnyOrder
|
||||
listOf("main" to "commit-1", "feature/a" to "commit-2", "queued" to "commit-3")
|
||||
harness.repository.latestFor("main")!!.status shouldBe BuildStatus.INTERRUPTED
|
||||
harness.repository.latestFor("queued")!!.status shouldBe BuildStatus.INTERRUPTED
|
||||
harness.repository.latestFor("done")!!.status shouldBe BuildStatus.SUCCESS
|
||||
}
|
||||
|
||||
test("startup recovery skips branches gone from origin and survives a failing fetch") {
|
||||
val harness = Harness()
|
||||
every { harness.gitService.fetchOrigin(any()) } throws RuntimeException("origin unreachable")
|
||||
harness.seed("gone", BuildStatus.INTERRUPTED, commit = "commit-1")
|
||||
harness.seed("main", BuildStatus.INTERRUPTED, commit = "commit-2")
|
||||
every { harness.gitService.originHeadCommit("main", any()) } returns "commit-2"
|
||||
|
||||
harness.watcher.recoverOnStartup(harness.workingDir)
|
||||
|
||||
harness.startedBuilds shouldContainExactly listOf("main" to "commit-2")
|
||||
}
|
||||
|
||||
test("poll prunes results, artifacts, and worktrees of branches gone from origin") {
|
||||
val harness = Harness()
|
||||
harness.seed("main", BuildStatus.SUCCESS, commit = "commit-1")
|
||||
harness.seed("gone", BuildStatus.SUCCESS, commit = "commit-2")
|
||||
val keptWorktree = harness.worktreeDir("main")
|
||||
val removedWorktree = harness.worktreeDir("gone")
|
||||
every { harness.gitService.originBranches(any()) } returns listOf("main")
|
||||
|
||||
harness.watcher.poll(harness.workingDir)
|
||||
|
||||
harness.repository.history().map { it.branch } shouldContainExactly listOf("main")
|
||||
verify {
|
||||
harness.artifactStore.prune(
|
||||
match { results -> results.map { it.branch } == listOf("main") },
|
||||
)
|
||||
}
|
||||
Files.exists(keptWorktree).shouldBeTrue()
|
||||
Files.exists(removedWorktree).shouldBeFalse()
|
||||
verify { harness.gitService.worktreePrune(any()) }
|
||||
}
|
||||
|
||||
test("worktrees of queued or running builds are never pruned") {
|
||||
val harness = Harness()
|
||||
harness.seed("busy", BuildStatus.RUNNING, commit = "commit-1")
|
||||
val busyWorktree = harness.worktreeDir("busy")
|
||||
every { harness.gitService.originBranches(any()) } returns listOf("busy")
|
||||
|
||||
harness.watcher.poll(harness.workingDir)
|
||||
|
||||
Files.exists(busyWorktree).shouldBeTrue()
|
||||
}
|
||||
|
||||
test("start runs recovery plus an immediate first poll; stop halts the loop") {
|
||||
val harness = Harness()
|
||||
val fetches = CountDownLatch(2)
|
||||
every { harness.gitService.fetchOrigin(any()) } answers { fetches.countDown() }
|
||||
|
||||
harness.watcher.start(harness.workingDir)
|
||||
|
||||
fetches.await(5, TimeUnit.SECONDS).shouldBeTrue()
|
||||
harness.watcher
|
||||
.state()
|
||||
.running
|
||||
.shouldBeTrue()
|
||||
shouldThrow<IllegalStateException> { harness.watcher.start(harness.workingDir) }
|
||||
|
||||
harness.watcher.stop()
|
||||
|
||||
harness.watcher
|
||||
.state()
|
||||
.running
|
||||
.shouldBeFalse()
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user