JBake と JGit を使用した設定可能な Kotlin Gradle プラグインの TDD
公開日: 09 July 2025
Sommaire
この記事は、Kotlin DSLで書かれたGradleプラグインの設計とテスト（TDD）の全体的なアプローチを紹介します。このプラグインは、*JBake*を使った静的サイトの生成と、*JGit*を介した*Gitデプロイ*を、YAML設定ファイルから自動化します。
目的
Gradle プラグインを作成 :
-
Kotlin DSL で設定可能な ;
-
できる :
-
JBake から静的サイトを生成する ;
-
JGit を使ってリモートの Git リポジトリにデプロイする ;
-
CI/CDワークフローに組み込める ;
-
TDDのアプローチに従ってテスト済みです。
宣言的設定
以下は、私たちのDSLでモデリングされるYAML設定の例：
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"この構成は、Kotlin DSL で宣言可能な Gradle 拡張機能を介して表現されます。
プラグインのアーキテクチャ
@startuml
package "エンジンプラグイン" {
class WorkspaceEngineExtension
class GenerateSiteTask
interface GitAdapter
class JGitAdapter
WorkspaceEnginePlugin --> WorkspaceEngineExtension
WorkspaceEnginePlugin --> GenerateSiteTask
GenerateSiteTask --> GitAdapter
JGitAdapter ..|> GitAdapter
}
@enduml
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"
}カスタムタスクの定義
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())
}
}GitAdapterインターフェイス
interface GitAdapter {
fun cloneRepository(uri: String, directory: File): Repository
fun commitAndPush(repo: Repository, branch: String, message: String)
}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()
}
}
}設定 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")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 "開発者" as Dev participant "Gradle ProjectBuilder" as Project participant "GenerateSiteTask" as Task participant "Gitアダプター (モック)" 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`Gradle プラグインの開発において TDD を十分に適用できるようになる:
-
Gitの呼び出しは抽象的でテスト可能で、
-
DSLの設定はきれいでわかりやすい。
-
プラグインは実際の実装に依存しません。
このアプローチは高いテスト容易性とGitHub API、GitLabなどへの拡張性を保証します。
次のステップ
-
JBakeの生成を作为统合する`BakeAdapter`
-
統合テストを追加して`GradleRunner`
-
ファイルの自動読み込みをサポート`site.yml`SnakeYAML経由で
関連記事
HyperFrames-Gradle : AsciiDocをMP4動画に変換
31 May 2026
31 May 2026
プラグイン独立＋コンシューマー ルート アーキテクチャ：なぜ私のGradleビルドが重複するのか
14 May 2026
14 May 2026