TDD de um Plugin Gradle Kotlin configurável com JBake e JGit
Publié le 09 July 2025
Este post apresenta a abordagem completa de projeto e teste (TDD) de um plugin Gradle escrito em Kotlin DSL. Este plugin automatiza a geração de sites estáticos com JBake e a implantação Git via JGit, tudo a partir de um arquivo YAML de configuração.
Objetivo
Criar um plugin Gradle :
-
configurável em Kotlin DSL ;
-
capaz de :
-
gerar um site estático a partir do JBake ;
-
implantar em um repositório Git remoto via JGit ;
-
integrabel em um fluxo de trabalho CI/CD ;
-
testado segundo uma abordagem TDD.
Configuração declarativa
Aqui está um exemplo de configuração YAML para modelar na nossa 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"Esta configuração é representada via uma extensão Gradle declarável em Kotlin DSL.
Arquitetura do plugin
Definição da extensão DSL
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"
}Definição da tarefa personalizada
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)
}Implementação concreta com 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()
}
}
}Configuração DSL Kotlin
workspaceEngine {
outputDir = "build/out"
template = "freemarker"
repoUrl = "https://github.com/cheroliv/trainings.git"
branch = "main"
message = "deploy from plugin"
}Testes unitários com Mockito
dependências
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")Teste do comportamento 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"))
}
}
Conclusão
A separação das responsabilidades via`GitAdapter`permite aplicar completamente o TDD no desenvolvimento de plugin Gradle:
-
as chamadas Git são abstratas e testáveis;
-
A configuração DSL é limpa e clara;
-
O plugin permanece agnóstico em relação à implementação real.
Esta abordagem garante alta testabilidade e extensibilidade (para GitHub API, GitLab, etc.).
Próximas etapas
-
Integrar a geração JBake como um`BakeAdapter`
-
Adicionar testes de integração com`GradleRunner`
-
Suportar o carregamento automático de arquivos`site.yml`via SnakeYAML