TDD konfigurovanog Kotlin Gradle plugina sa JBake i JGit
Објављено 09 July 2025
Овај чланак приказыва комплетан приступ дизајна и тестирања (TDD) Gradle додатка написаног на Kotlin DSL. Овај додатак аутоматизује генерисање статичких сајтова са JBake и Гит деплојмент преко JGit, све из једног YAML конфигурационог фајла.
cilj
Kreirati Gradle plugin:
-
конфигуриран у Kotlin DSL ;
-
sposoban da :
-
генериши статички сајт из JBake ;
-
разгледати на удалени Гит репозиторијум преко JGit ;
-
integrabilno u CI/CD radnom toku ;
-
testirano prema TDD pristupu.
Декларативна конфигурација
Ovo je primer konfiguracije YAML koji treba da se modelira u našem 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"Ova konfiguracija se prikazuje putem deklarativne Gradle ekstenzije u Kotlin DSL-u.
Arhitektura plugina
@startuml
package "plugin motora" {
class WorkspaceEngineExtension
class GenerateSiteTask
interface GitAdapter
class JGitAdapter
WorkspaceEnginePlugin --> WorkspaceEngineExtension
WorkspaceEnginePlugin --> GenerateSiteTask
GenerateSiteTask --> GitAdapter
JGitAdapter ..|> GitAdapter
}
@enduml
Definicija DSL ekstenzije
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"
}Definicija prilagođenog zadatka
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())
}
}Interfejs GitAdapter
interface GitAdapter {
fun cloneRepository(uri: String, directory: File): Repository
fun commitAndPush(repo: Repository, branch: String, message: String)
}Konkreta implementacija sa 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()
}
}
}Konfiguracija DSL Kotlin
workspaceEngine {
outputDir = "build/out"
template = "freemarker"
repoUrl = "https://github.com/cheroliv/trainings.git"
branch = "main"
message = "deploy from plugin"
}Једноставни тестови са Mockito
зависност
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 ponašanja 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 "Razvijalac" as Dev participant "Gradle graditelj projekata" as Project participant "GenerateSiteTask" as Task participant "GitAdapter (Mock)" as Adapter participant "JGitAdapter / Mockito" as Impl Dev -> Project : construit projet Gradle Dev -> Task : configure les propriétés Task -> Adapter : cloneRepository() Adapter -> Impl : simulé par Mockito Task -> Adapter : commitAndPush() @enduml
Закључак
Разделење одговорности преко`GitAdapter`umožava primenu TDD u razvoju Gradle plugina :
-
pozivi Git-a su apstraktni i testni;
-
Konfiguracija DSL je čista i jasna;
-
plugin ostaje agnostičan prema stvarnu implementaciju.
Овај приступ обезбеђује високий ниво тестирања и проширивости (кон GitHub API, GitLab и др.).
Следни кораци
-
Uključiti generisanje JBake kao`BakeAdapter`
-
Додај интеграционе тестове са`GradleRunner`
-
Podržati automatsko učitavanje fajlova`site.yml`putem SnakeYAML