Решите изазов Gradle-ових једнотестова са `gradle.properties
Објављено 13 July 2025
Problem: Izolovanje jediničnih testova Gradle plugina
Pri pisanju jediničnih testova za Gradle plugin, jedni od čestih izazova je upravljanje zavisnostima od konfiguracije projekta, kao što su svojstva definisana u fajlu`gradle.properties`. У нашем случају, плагин`jbake.ghpages`Trebalo je da pročita svojstvo`site_config_path`За да функционира правилно. Јединични тест за задатак`initialize`trebalo je da proveri ponašanje plugina u prisustvu ove osobine.
Osnovni problem je da su jedinični testovi, po dizajnu, moraju da budu izolirani. Korišćenje de`ProjectBuilder`Gradle kreira instancu od`Project`у меморији, потпуно одвојена од стварног пројекта на файл системе. Следоватно, оva тест инстанца аутоматски не чита датотеку.gradle.properties`i dakle ne poznaje svojstvo`site_config_path.
Arhitektura problema
Sledi dijagram ilustruje razdvojenost između okruženja za testiranje i sistema datoteka :
@startuml
!define RECTANGLE class
package "Produkcijsko okruženje" {
RECTANGLE ProjectReal {
+ build.gradle.kts
+ gradle.properties
+ src/
}
RECTANGLE GradleProperties {
site_config_path=src/jbake/settings/site.yml
}
RECTANGLE JbakePlugin {
- readProperty(name: String)
+ initialize()
}
ProjectReal --> GradleProperties : lit au démarrage
JbakePlugin --> GradleProperties : accède via project.properties
}
package "Testno okruženje" {
RECTANGLE ProjectTest {
+ Créé par ProjectBuilder
+ En mémoire uniquement
+ Pas de gradle.properties
}
RECTANGLE JbakePluginTest {
+ testInitialize()
}
ProjectTest -[#red]x GradleProperties : ❌ Pas d'accès
JbakePluginTest --> ProjectTest : utilise
}
note right of ProjectTest : Isolation = Pas d'accès\nau système de fichiers
@enduml
Iskušenje lažne dobre ideje
Jedna od mogućih pristupa je da se kreira fajl`gradle.properties`štaično u resursima testa.
// src/test/resources/gradle.properties
site_config_path=src/jbake/settings/site.ymlМеђувише, ову метода је осужена на неуспех јер`ProjectBuilder`Није дизајниран за скенирање файловног система у тражењу конфигурационих фајлова. Тест би остао изолисан и игнорисао ову датотеку.
Решение : Симулирајте својство са `ExtraPropertiesExtension
Eleгантно решење овог проблема није čitanje datoteke, već simulacija prisustva svojstva direktno u objektu.`Project`testa. Gradle nudi moćan mehanizam za ovo: dodatna svojstva (Dodatna svojstva).
Korak 1: Razumeti ExtraPropertiesExtension
`ExtraPropertiesExtension`Je kontejner ključ-vrednost pridružen svakom objektu Gradle modela. Omogućava dinamičko dodavanje svojstava projektu, zadatku ili bilo drugom proširenju Gradle.
@startuml
!define RECTANGLE class
RECTANGLE Project {
+ name: String
+ version: String
+ extensions: ExtensionContainer
+ properties: Map<String, ?>
}
RECTANGLE ExtensionContainer {
+ getByType(Class<T>): T
+ add(String, Object): void
}
RECTANGLE ExtraPropertiesExtension {
+ set(String, Object): void
+ get(String): Object
+ has(String): boolean
+ getProperties(): Map<String, Object>
}
Project --> ExtensionContainer : contient
ExtensionContainer --> ExtraPropertiesExtension : gère
ExtraPropertiesExtension --> Project : synchronise avec\nproject.properties
note right of ExtraPropertiesExtension : Point d'entrée pour\ninjecter des propriétés
@enduml
Korak 2: Postavljanje testa - Priprema
Počnimo sa kreiranjem osnovne strukture našeg jediničnog testa:
class JbakeGhPagesPluginTest {
@TempDir
lateinit var testProjectDir: File
@Test
fun `check initialize and config yaml file if not existing`() {
// Étape 1 : Créer un projet de test isolé
val project = ProjectBuilder.builder()
.withProjectDir(testProjectDir)
.build()
// Suite des étapes...
}
}Корак 3: Инјекција својства
Ovo je detaljni proces za injektovanje svojstva u testnom projektu:
@Test
fun `check initialize and config yaml file if not existing`() {
// Étape 1 : Créer un projet de test isolé en mémoire
val project = ProjectBuilder.builder()
.withProjectDir(testProjectDir)
.build()
// Étape 2 : Récupérer le gestionnaire de propriétés supplémentaires
val extra = project.extensions.getByType(ExtraPropertiesExtension::class.java)
// Étape 3 : Définir la propriété requise pour ce test
extra.set("site_config_path", "src/jbake/settings/site.yml")
// Étape 4 : Vérifier que la propriété est bien injectée
assertTrue(project.hasProperty("site_config_path"))
// Étape 5 : Appliquer le plugin qui pourra maintenant accéder à la propriété
project.plugins.apply("jbake.ghpages")
// Étape 6 : Exécuter la tâche et vérifier son comportement
val task: Task = project.tasks.findByName("initialize")
.apply(::assertNotNull)!!
// Étape 7 : Exécuter les actions de la tâche
task.actions.forEach { it.execute(task) }
// Étape 8 : Assertions finales
assertEquals(
"src/jbake/settings/site.yml",
project.properties["site_config_path"],
"La propriété devrait être accessible dans le projet"
)
}Корак 4: Дијаграм тока решења
@startuml
start
:Créer ProjectBuilder;
:Obtenir ExtraPropertiesExtension;
:Injecter la propriété\nvia extra.set();
partition "Proverke" {
:Vérifier project.hasProperty();
:Appliquer le plugin;
:Récupérer la tâche;
}
partition "Извршење" {
:Exécuter les actions\nde la tâche;
:Le plugin lit\nproject.properties;
}
partition "Utvrde" {
:Vérifier la propriété\nest accessible;
:Valider le comportement\nattendues;
}
stop
@enduml
Корак 5: Пре/После упоређење
@startuml
!define RECTANGLE class
package "PRIJE - Problematika" {
RECTANGLE TestProject1 {
+ ProjectBuilder.build()
+ Pas de propriétés
}
RECTANGLE Plugin1 {
+ initialize()
+ ❌ project.properties["putanja_do_konfiguracije_sajta"] = null
}
TestProject1 --> Plugin1 : échec
note right of Plugin1 : Test échoue car\nla propriété n'existe pas
}
package "NAKON - Rešenje" {
RECTANGLE TestProject2 {
+ ProjectBuilder.build()
+ ExtraPropertiesExtension
}
RECTANGLE ExtraProps {
+ set("putanja_do_konfiguracije_sajta", "...")
}
RECTANGLE Plugin2 {
+ initialize()
+ ✅ project.properties["putanja_do_konfiguracije_sajta"] = "src/jbake/settings/site.yml"
}
TestProject2 --> ExtraProps : configure
ExtraProps --> Plugin2 : propriété disponible
note right of Plugin2 : Test réussit car\nla propriété est simulée
}
@enduml
Korak 6: Upravljanje više test slučajeva
Da testiramo različite scenarije, napravimo više testova sa raznim konfiguracijama:
class JbakeGhPagesPluginTest {
@TempDir
lateinit var testProjectDir: File
private fun createProjectWithProperty(propertyValue: String?): Project {
val project = ProjectBuilder.builder()
.withProjectDir(testProjectDir)
.build()
// Injection conditionnelle de la propriété
propertyValue?.let { value ->
val extra = project.extensions.getByType(ExtraPropertiesExtension::class.java)
extra.set("site_config_path", value)
}
return project
}
@Test
fun `should work with valid property`() {
val project = createProjectWithProperty("src/jbake/settings/site.yml")
project.plugins.apply("jbake.ghpages")
val task = project.tasks.findByName("initialize")!!
task.actions.forEach { it.execute(task) }
// Assertions pour le cas normal
assertEquals("src/jbake/settings/site.yml", project.properties["site_config_path"])
}
@Test
fun `should handle missing property gracefully`() {
val project = createProjectWithProperty(null) // Pas de propriété
project.plugins.apply("jbake.ghpages")
val task = project.tasks.findByName("initialize")!!
// Le plugin devrait gérer l'absence de propriété
assertDoesNotThrow {
task.actions.forEach { it.execute(task) }
}
}
@Test
fun `should handle invalid property path`() {
val project = createProjectWithProperty("invalid/path/to/config.yml")
project.plugins.apply("jbake.ghpages")
val task = project.tasks.findByName("initialize")!!
// Test du comportement avec un chemin invalide
assertThrows<FileNotFoundException> {
task.actions.forEach { it.execute(task) }
}
}
}Konačna arhitektura rešenja
@startuml
!define RECTANGLE class
package "Testno okruženje" {
RECTANGLE TestClass {
+ createProjectWithProperty()
+ testValidProperty()
+ testMissingProperty()
+ testInvalidProperty()
}
RECTANGLE ProjectBuilder {
+ builder()
+ withProjectDir()
+ build()
}
RECTANGLE TestProject {
+ extensions
+ properties
+ plugins
+ tasks
}
RECTANGLE ExtraPropertiesExtension {
+ set(key, value)
+ get(key)
+ has(key)
}
RECTANGLE JbakePlugin {
+ apply(project)
+ createInitializeTask()
+ readSiteConfigPath()
}
}
TestClass --> ProjectBuilder : utilise
ProjectBuilder --> TestProject : crée
TestProject --> ExtraPropertiesExtension : contient
TestClass --> ExtraPropertiesExtension : configure
ExtraPropertiesExtension --> TestProject : synchronise properties
TestProject --> JbakePlugin : applique
JbakePlugin --> TestProject : lit properties
note right of ExtraPropertiesExtension : Point de contrôle\npour l'injection
note bottom of TestProject : Environnement\ncontrôlé et isolé
@enduml
Prednosti ovog pristupa
-
potpuna izolacija: Test ne зависи од ниједnog vanjskog fajla. On je samostajan i može se izvršiti pouzdano u bilo kom okruženju (lokalno, CI/CD i t.d.).
-
Jasnoća i namera: Test izričito navodi uslove koji su potrebni za njegovo izvođenje. Ko god pročita test odmah vidi da je plugin zahteva svojstvo.`site_config_path`da funkcioniše.
-
одржајностАко се промени име својства, довољно је да ga ажурирате на једној позицији у тесту, без манипуловања тестним конфигурационим датотекама.
-
fleksibilnost: Postaje trivijalno testirati različite scenarije jednostavno menjajući vrednost injektovane svojstva u svakom testu (validna vrednost, nevalidna, odsutna i sl.).
-
Извршеност: Ne čitanje fajlova, sve se dešava u memoriji, što ubržava testove.
-
ponovljivostTestovi su deterministički jer ne zavise od stanja datotečnog sistema.
Dobre prakse i saveti
Kreirati utilitarnu metodu
class GradleTestUtils {
companion object {
fun createProjectWithProperties(
projectDir: File,
properties: Map<String, String>
): Project {
val project = ProjectBuilder.builder()
.withProjectDir(projectDir)
.build()
val extra = project.extensions.getByType(ExtraPropertiesExtension::class.java)
properties.forEach { (key, value) ->
extra.set(key, value)
}
return project
}
}
}Validacija Svojstva
@Test
fun `should validate property injection`() {
val project = createProjectWithProperty("test-value")
// Vérifications multiples
assertTrue(project.hasProperty("site_config_path"))
assertEquals("test-value", project.property("site_config_path"))
assertNotNull(project.properties["site_config_path"])
// Vérification que la propriété est accessible par le plugin
project.plugins.apply("jbake.ghpages")
// ... reste du test
}Zaključak
Umesto da se trudite da konfiguracione fajlove budu čitani u okruženju unitarnog testiranja, najbolja praksa je da simulišete potrebno stanje. Korišćenje`ExtraPropertiesExtension`Програмско podešavanje Gradle svojstava je najčistiji i najpouzdaniji način za izvođenje efikasnih i pouzdanih unit testova pluginova.
Ova tehnika transformiše problem vanjskog zavisnosti u jednostavnu injekciju zavisnosti, u samom srcu filozofije Test-Driven Development (TDD). Nudi potpunu kontrolu nad test okruženjem, čuvajući izoljaciju potrebnu za kvalitetne unit testove.
Dijagrami i primeri prikazani u ovom članku pokazuju kako se ovaj pristup može primeniti postupno i sistemski, omogućavajući kreiranje jakog i održivog paketa testova za vaše Gradle pluginove.