TDD van een configureerbare Kotlin-Gradle-plugin met JBake en JGit
Gepubliceerd op 09 July 2025
Dit bericht beschrijft het volledige ontwerpproces en testen (TDD) van een Gradle-plugin geschreven in Kotlin DSL. Dit plugin automatiseert de generatie van statische sites met JBake en de Git-implementatie via JGit, allemaal vanaf een YAML-configuratiebestand.
doel
Een Gradle-plugin maken:
-
configureerbaar in Kotlin DSL;
-
in staat om
-
genereer een statische site vanuit JBake ;
-
implementeren op een externe Git-opslagplaats via JGit ;
-
integreerbaar in een CI/CD-workflow;
-
getest volgens een TDD-aanpak.
Declaratieve configuratie
Hier is een voorbeeld van een YAML-configuratie om te modelleren in onze DSL :
bake:
srcPath: "./site/jbake"
destDirPath: "bake"
pushPage:
from: "bake"
to: "cvs"
repo:
name: "trainings"
repository: "https://github.com/pages-content/trainings.git"
credentials:
username: "USERNAME"
password: "SECRET_TOKEN"
branch: "main"
message: "cheroliv.com"Deze configuratie wordt weergegeven via een declareerbare Gradle-extensie in Kotlin DSL.
Architectuur van de plugin
@startuml
package "engine-plugin" {
class WorkspaceEngineExtension
class GenerateSiteTask
interface GitAdapter
class JGitAdapter
WorkspaceEnginePlugin --> WorkspaceEngineExtension
WorkspaceEnginePlugin --> GenerateSiteTask
GenerateSiteTask --> GitAdapter
JGitAdapter ..|> GitAdapter
}
@enduml
Definitie van de DSL-extensie
open class WorkspaceEngineExtension {
var outputDir: String = "build/site"
var template: String = "freemarker"
var repoUrl: String = ""
var branch: String = "main"
var message: String = "Generated by engine"
}Definitie van de aangepaste taak
abstract class GenerateSiteTask : DefaultTask() {
lateinit var gitAdapter: GitAdapter
@get:Input abstract val repoUrl: Property<String>
@get:InputDirectory abstract val outputDir: DirectoryProperty
@get:Input abstract val branch: Property<String>
@get:Input abstract val message: Property<String>
@TaskAction
fun run() {
val repo = gitAdapter.cloneRepository(repoUrl.get(), outputDir.get().asFile)
gitAdapter.commitAndPush(repo, branch.get(), message.get())
}
}Interface GitAdapter
interface GitAdapter {
fun cloneRepository(uri: String, directory: File): Repository
fun commitAndPush(repo: Repository, branch: String, message: String)
}Concrete implementatie met JGit
class JGitAdapter : GitAdapter {
override fun cloneRepository(uri: String, directory: File): Repository {
return Git.cloneRepository()
.setURI(uri)
.setDirectory(directory)
.call()
.repository
}
override fun commitAndPush(repo: Repository, branch: String, message: String) {
Git(repo).use {
it.add().addFilepattern(".").call()
it.commit().setMessage(message).call()
it.push().call()
}
}
}Configuratie DSL Kotlin
workspaceEngine {
outputDir = "build/out"
template = "freemarker"
repoUrl = "https://github.com/cheroliv/trainings.git"
branch = "main"
message = "deploy from plugin"
}Eenheidstests met Mockito
Afhankelijkheden
testImplementation("org.mockito:mockito-core:5.12.0")
testImplementation("org.mockito.kotlin:mockito-kotlin:5.2.1")
testImplementation("org.junit.jupiter:junit-jupiter:5.10.0")Test van het gedrag van Git
class GenerateSiteTaskMockitoTest {
@TempDir
lateinit var tempDir: File
@Test
fun `task should call clone and commitAndPush`() {
val project = ProjectBuilder.builder().build()
val task = project.tasks.create("generateSite", GenerateSiteTask::class.java)
val mockGitAdapter = mock<GitAdapter>()
val mockRepo = mock<Repository>()
whenever(mockGitAdapter.cloneRepository(any(), any())).thenReturn(mockRepo)
task.gitAdapter = mockGitAdapter
task.repoUrl.set("https://github.com/cheroliv/test.git")
task.outputDir.set(project.layout.projectDirectory.dir(tempDir.name))
task.branch.set("main")
task.message.set("test commit")
task.run()
verify(mockGitAdapter).cloneRepository(eq("https://github.com/cheroliv/test.git"), any())
verify(mockGitAdapter).commitAndPush(eq(mockRepo), eq("main"), eq("test commit"))
}
}@startuml actor "Ontwikkelaar" as Dev participant "Gradle ProjectBuilder" as Project participant "GenerateSiteTask" as Task participant "GitAdapter (Mock)" as Adapter participant "JGitAdapter / Mockito" as Impl Dev -> Project : bouw project Gradle Dev -> Task : Configureer de eigenschappen Task -> Adapter : cloneRepository() Adapter -> Impl : gesimuleerd door Mockito Task -> Adapter : commitAndPush() @enduml
Conclusie
Scheiding van verantwoordelijkheden via`GitAdapter`Hiermee kan TDD volledig worden toegepast bij de ontwikkeling van Gradle-plugins :
-
De Git-aanroepen zijn geabstraheerd en testbaar;
-
De DSL-configuratie is netjes en overzichtelijk;
-
het plugin blijft agnostisch ten opzichte van de werkelijke implementatie
Deze aanpak garandeert een hoge testbaarheid en uitbreidbaarheid (naar GitHub API, GitLab, enz.).
Volgende stappen
-
De JBake-generatie integreren als een`BakeAdapter`
-
Voeg integratietests toe met`GradleRunner`
-
Ondersteun het automatisch laden van bestanden`site.yml`via SnakeYAML