Table of Contents

ভূমিকা

গ্র্যಾಡল প্লাগইন ডেভেলপমেন্টের সময়, ফাংশনাল টেস্টিং প্লাগইন আচরণকে একটি বাস্তব গ্র্যাডেল পরিবেশে যাচাই করার জন্য জরুরি। যাই হোক, একটি গুরুত্বপূর্ণ প্রশ্ন দ্রুত উঠে আসে:একটি কার্যকর লগিং সিস্টেম কীভাবে তৈরি করবেন যা GradleRunner সমস্যাপূর্ণ নির্ভরতা তৈরি না করে ?

এই নিবন্ধে, আমরা অনুসন্ধান করব :

  • গ্রেডল ফাংশনাল টেস্টে লগিং সমস্যা

  • SLF4J ও Logback ব্যবহার করে একটি দৃঢ় সমাধানের আর্কিটেকচার

  • সম্পূর্ণ বাস্তবায়ন বাস্তব উদাহরণসহ

  • ভালো অনুশীলন ও এড়াতে যে ফাঁস

সমস্যা : GradleRunner-এ নির্ভরতা

প্লাগইন ডেভেলপমেন্টের প্রেক্ষিত

একটি Gradle প্লাগইন উন্নয়ন করার সময়, সাধারণত এটি ব্যবহার করা হয়`GradleRunner`Gradle TestKit-এর জন্য পরীক্ষা বিল্ড চালানোর জন্য:

@Test
fun `test my plugin`() {
    val result = GradleRunner.create()
        .withProjectDir(projectDir)
        .withArguments("myTask")
        .build()

    // Comment logger efficacement ici ?
}

লগিং-এর দ্বন্দ্ব

প্রধান সমস্যা হল:লগিংকে কোনো অবজেক্টের উপর নির্ভর করা উচিত না যেটি আমরািশ্চিত নয় যে এর আরম্ভ হয়েছে.

@startuml
!define RECTANGLE class

skinparam backgroundColor #FEFEFE
skinparam componentStyle rectangle

package "সমস্যমূলক আর্কিটেকচার" {
    RECTANGLE Test {
        + runTest()
    }

    RECTANGLE GradleRunner {
        + build()
        + getLogger() ❌
    }

    RECTANGLE Logger {
        + info()
        + debug()
    }

    Test --> GradleRunner : নির্ভর করে
    Logger ..> GradleRunner : নির্ভর করće ❌
}

note right of Logger
সমস্যা: লগার
GradleRunner-ে নির্ভর করে, jota
আরম্ভ করা হবেনা পারে।
end note

@enduml

মিথ্যা ভালো ধারণা

এটা করবেন না :

// ❌ MAUVAIS: Tentative d'obtenir un logger du runner
val runner = GradleRunner.create()
val logger = runner.logger // N'existe pas !
// ❌ MAUVAIS: Logger partagé initialisé tardivement
lateinit var logger: Logger
@BeforeEach
fun setup() {
    logger = LoggerFactory.getLogger(...)
}

সমাধান: স্বাধীন লগার

প্রস্তাবিত আর্কিটেকচার

সমাধানটি একটি লগার ব্যবহার করাসম্পূর্ণভাবে স্বাধীন du GradleRunner, টেস্ট ক্লাসের স্তরে শুরু করা হয়েছে

@startuml
!define RECTANGLE class

skinparam backgroundColor #FEFEFE
skinparam componentStyle rectangle

package "সঠিক আর্কিটেকচার" {
    RECTANGLE TestClass {
        + {static} logger: Logger ✓
        + runTest()
    }

    RECTANGLE SLF4J {
        + LoggerFactory
    }

    RECTANGLE GradleRunner {
        + build()
        + forwardOutput()
    }

    RECTANGLE "কনসোল আউটপুট" as Output {
        + captured text
    }

    TestClass --> SLF4J : ব্যবহার করা ✓
    TestClass --> GradleRunner : ব্যবহার করো
    GradleRunner --> Output : উৎপন্ন করে
    TestClass --> Output : বিশ্লেষণ
}

note top of TestClass
লগারকে GradleRunner‑এ স্বাধীনভাবে আরম্ভ করা হয়।
end note

note bottom of GradleRunner
.forwardOutput() অনুমতি দেয়
আউটপুটকে ধরা
বিশ্লেষণের জন্য
end note

@enduml

নিষ্পাদন প্রবাহ

@startuml
!theme plain
skinparam backgroundColor #FEFEFE

participant "JUnit" as junit
participant "TestClass" as test
participant "লগার (SLF4J)" as logger
participant "GradleRunner" as runner
participant "Gradle বিল্ড" as gradle

activate junit
junit -> test : load class
activate test

test -> logger : initialize (companion)
activate logger
logger --> test : logger ready ✓
deactivate logger

junit -> test : @BeforeAll
test -> logger : info("Initialisation...")

junit -> test : @BeforeEach
test -> logger : debug("সেটআপ টেস্ট...")

junit -> test : @Test
test -> logger : info("টেস্ট: শুরু হচ্ছে...")

test -> runner : create()
activate runner
test -> runner : .forwardOutput()
test -> runner : .withArguments(...)
test -> runner : .build()

runner -> gradle : execute build
activate gradle
gradle --> runner : output text
deactivate gradle

runner --> test : BuildResult + output
deactivate runner

test -> logger : debug("আউটপুট বিশ্লেষণ...")
test -> test : analyze output
test -> logger : info("✓ পরীক্ষা সফল")

test --> junit : success
deactivate test
deactivate junit

@enduml

সম্পূর্ণ বাস্তবায়ন

গ্রেডেল ডিপেন্ডেন্সি

আপনার প্রয়োজনীয় নির্ভরতাগুলি যোগ করুন`build.gradle.kts` :

dependencies {
    // Pour les tests fonctionnels
    testImplementation(gradleTestKit())
    testImplementation("org.junit.jupiter:junit-jupiter:5.10.2")

    // Pour le logging
    testImplementation("org.slf4j:slf4j-api:2.0.17")
    testRuntimeOnly("ch.qos.logback:logback-classic:1.4.14")

    // Pour les assertions
    testImplementation("org.assertj:assertj-core:3.27.6")
}

tasks.test {
    useJUnitPlatform()
}

Logback কনফিগারেশন

ফাইলটি তৈরি করুন`src/test/resources/logback-test.xml`:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- Appender console avec format lisible -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- Appender fichier pour conservation -->
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>build/test-results/functional-tests.log</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- Logger pour vos tests -->
    <logger name="com.cheroliv.bakery" level="DEBUG"/>

    <!-- Réduire le bruit de Gradle -->
    <logger name="org.gradle" level="WARN"/>

    <!-- Configuration racine -->
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="FILE"/>
    </root>
</configuration>

সম্পূর্ণ টেস্ট ক্লাস

package com.cheroliv.bakery

import org.gradle.testkit.runner.GradleRunner
import org.gradle.testkit.runner.TaskOutcome
import org.junit.jupiter.api.*
import org.junit.jupiter.api.TestInstance.Lifecycle.PER_CLASS
import org.junit.jupiter.api.io.TempDir
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import java.io.File
import kotlin.test.assertEquals
import kotlin.test.assertTrue

@TestInstance(PER_CLASS)
class BakeryPluginFunctionalTest {

    @field:TempDir
    lateinit var projectDir: File

    private val buildFile by lazy { projectDir.resolve("build.gradle.kts") }
    private val settingsFile by lazy { projectDir.resolve("settings.gradle.kts") }

    companion object {
        // ✓ Logger indépendant, initialisé au chargement de la classe
        private val logger: Logger = LoggerFactory.getLogger(
            BakeryPluginFunctionalTest::class.java
        )

        @JvmStatic
        @BeforeAll
        fun globalSetup() {
            logger.info("═".repeat(60))
            logger.info("DÉMARRAGE DE LA SUITE DE TESTS FONCTIONNELS")
            logger.info("═".repeat(60))
        }

        @JvmStatic
        @AfterAll
        fun globalTeardown() {
            logger.info("═".repeat(60))
            logger.info("FIN DE LA SUITE DE TESTS")
            logger.info("═".repeat(60))
        }
    }

    @BeforeEach
    fun setup() {
        logger.info("─".repeat(60))
        logger.info("Préparation de l'environnement de test")
        logger.debug("Répertoire de test: ${projectDir.absolutePath}")

        settingsFile.writeText("""
            rootProject.name = "test-bakery-project"
        """.trimIndent())

        logger.debug("✓ settings.gradle.kts créé")
    }

    @AfterEach
    fun teardown(testInfo: TestInfo) {
        logger.info("✓ Test terminé: ${testInfo.displayName}")
        logger.info("─".repeat(60))
    }

    @Test
    fun `plugin can be applied successfully`() {
        logger.info("TEST: Application du plugin Bakery")

        buildFile.writeText("""
            plugins {
                id("com.cheroliv.bakery")
            }
        """.trimIndent())

        logger.debug("Fichier build.gradle.kts créé")
        logger.debug("Lancement du build Gradle...")

        val startTime = System.currentTimeMillis()

        val result = GradleRunner.create()
            .forwardOutput() // ← Important : capture la sortie
            .withPluginClasspath()
            .withArguments("tasks", "--group=bakery", "--stacktrace")
            .withProjectDir(projectDir)
            .build()

        val duration = System.currentTimeMillis() - startTime
        logger.info("Build terminé en ${duration}ms")

        // Analyse de la sortie
        logger.debug("Analyse de la sortie Gradle...")
        val outputLines = result.output.lines()
        logger.debug("Nombre de lignes capturées: ${outputLines.size}")

        // Validation
        val expectedTasks = listOf("bake", "printConfigPath", "printJBakeClasspath")
        logger.info("Vérification des tâches attendues:")

        expectedTasks.forEach { task ->
            val found = result.output.contains(task)
            logger.debug("  ${if (found) "✓" else "✗"} $task")
            assertTrue(found, "Task '$task' should be available")
        }

        logger.info("✓ Plugin appliqué avec succès - ${expectedTasks.size} tâches trouvées")
    }

    @Test
    fun `bake task executes and prints version`() {
        logger.info("TEST: Exécution de la tâche 'bake'")

        buildFile.writeText("""
            plugins {
                id("com.cheroliv.bakery")
            }
        """.trimIndent())

        logger.debug("Exécution de 'gradle bake'...")

        val result = GradleRunner.create()
            .forwardOutput()
            .withPluginClasspath()
            .withArguments("bake", "--info") // --info pour plus de détails
            .withProjectDir(projectDir)
            .build()

        // Extraction d'informations depuis la sortie
        logger.debug("Recherche du message 'Baking site'...")
        val hasBakingMessage = result.output.contains("Baking site with Bakery Plugin!")

        logger.debug("Recherche de la version JBake...")
        val hasVersionMessage = result.output.contains("Using JBake version:")

        // Extraction de la version (si présente)
        val versionRegex = Regex("Using JBake version: (.+)")
        val versionMatch = versionRegex.find(result.output)
        if (versionMatch != null) {
            val version = versionMatch.groupValues[1]
            logger.info("Version JBake détectée: $version")
        }

        // Validation
        assertTrue(hasBakingMessage, "Message 'Baking site' attendu")
        assertTrue(hasVersionMessage, "Message de version attendu")
        assertEquals(TaskOutcome.SUCCESS, result.task(":bake")?.outcome)

        logger.info("✓ Tâche 'bake' exécutée avec succès")
    }

    @Test
    fun `analyze output with structured logging`() {
        logger.info("TEST: Analyse structurée de la sortie")

        buildFile.writeText("""
            plugins {
                id("com.cheroliv.bakery")
            }

            task("diagnostics") {
                doLast {
                    println("[DIAG] Project: ${'$'}{project.name}")
                    println("[DIAG] Build dir: ${'$'}{project.buildDir}")
                    println("[DIAG] Plugin applied: true")

                    val config = configurations.findByName("jbakeRuntime")
                    println("[DIAG] JBake config exists: ${'$'}{config != null}")

                    if (config != null) {
                        println("[DIAG] Dependencies count: ${'$'}{config.dependencies.size}")
                    }
                }
            }
        """.trimIndent())

        logger.debug("Exécution de la tâche diagnostics...")

        val result = GradleRunner.create()
            .forwardOutput()
            .withPluginClasspath()
            .withArguments("diagnostics", "--quiet")
            .withProjectDir(projectDir)
            .build()

        // Analyse structurée
        logger.info("Extraction des informations de diagnostic:")

        val diagLines = result.output.lines()
            .filter { it.startsWith("[DIAG]") }

        logger.debug("Nombre de lignes de diagnostic: ${diagLines.size}")

        diagLines.forEach { line ->
            logger.info("  $line")

            // Analyse spécifique par type de ligne
            when {
                line.contains("Project:") -> {
                    val projectName = line.substringAfter("Project:").trim()
                    logger.debug("    → Nom du projet extrait: '$projectName'")
                }
                line.contains("Dependencies count:") -> {
                    val count = line.substringAfter("count:").trim()
                    logger.debug("    → Nombre de dépendances: $count")
                }
            }
        }

        assertTrue(diagLines.isNotEmpty(), "Des lignes de diagnostic devraient être présentes")
        logger.info("✓ Analyse structurée terminée - ${diagLines.size} lignes analysées")
    }

    @Test
    fun `test with error handling`() {
        logger.info("TEST: Gestion d'erreurs avec logging")

        buildFile.writeText("""
            plugins {
                id("com.cheroliv.bakery")
            }
        """.trimIndent())

        try {
            logger.debug("Tentative d'exécution...")

            val result = GradleRunner.create()
                .forwardOutput()
                .withPluginClasspath()
                .withArguments("printJBakeClasspath")
                .withProjectDir(projectDir)
                .build()

            val outcome = result.task(":printJBakeClasspath")?.outcome
            logger.info("Outcome: $outcome")

            if (outcome == TaskOutcome.SUCCESS) {
                logger.info("✓ Exécution réussie")
            } else {
                logger.warn("⚠ Outcome inattendu: $outcome")
            }

            assertEquals(TaskOutcome.SUCCESS, outcome)

        } catch (e: Exception) {
            logger.error("✗ Échec du test", e)
            logger.error("Type d'exception: ${e.javaClass.simpleName}")
            logger.error("Message: ${e.message}")

            // Log de la stack trace si nécessaire
            if (logger.isDebugEnabled) {
                logger.debug("Stack trace complète:", e)
            }

            throw e
        }
    }
}

মাল্টি-লেভেল লগিং স্কিমা

@startuml
!theme plain
skinparam backgroundColor #FEFEFE

package "লগের স্টরের_groups" {

    rectangle "TRACE" #E8E8E8 {
        note
খুব সূক্ষ্ম কর্মরত্যের বিস্তার
• ভ্যারিয়েবলের মান
• অন্তরিক পদ্ধতির আহবান
        end note
    }

    rectangle "DEBUG" #D0E8FF {
        note
ডিবাগিং তথ্য
• মধ্যবর্তী পদক্ষেপ
• নিম্নতম ফাইলের কন্টেন্ট
• আউটপুট Gradle বিশ্লেষণ
        end note
    }

    rectangle "INFO" #C8FFC8 {
        note
মূল তথ্য
• শুরু/fin পরীক্ষা
• ব্যালিডেশনের ফলাফল
• সম্পাদনার সময়
        end note
    }

    rectangle "WARN" #FFFFC8 {
        note
সতর্কবার্তা
• অপ্রত্যাশিত আচরণ
• অস্বাভাবিক ফলাফল
        end note
    }

    rectangle "ERROR" #FFC8C8 {
        note
ত্রুটি
• টেস্ট ব্যর্থতা
• এক্সেপশন
• স্ট্যাক ট্রেস
        end note
    }
}

@enduml

ভালো অনুশীলন

সুপারিশ করা লগিং গঠন

@Test
fun `mon test`() {
    // 1. LOG: Début du test
    logger.info("TEST: Description du test")

    // 2. LOG: Préparation
    logger.debug("Préparation des fichiers...")
    buildFile.writeText("...")
    logger.debug("✓ Fichiers préparés")

    // 3. LOG: Exécution
    logger.debug("Lancement du build...")
    val startTime = System.currentTimeMillis()

    val result = GradleRunner.create()
        .forwardOutput()
        .withArguments("task")
        .build()

    val duration = System.currentTimeMillis() - startTime
    logger.info("Build terminé en ${duration}ms")

    // 4. LOG: Analyse
    logger.debug("Analyse des résultats...")
    // ... validations ...

    // 5. LOG: Conclusion
    logger.info("✓ Test réussi")
}

পঠনযোগ্যতার জন্য দৃশ্য চিহ্ন

লগের পাঠযোগ্যতা উন্নত করার জন্য ইউনিকোড সিম্বল ব্যবহার করুন :

logger.info("✓ Succès")
logger.info("✗ Échec")
logger.info("⚠ Attention")
logger.info("→ Étape suivante")
logger.info("═".repeat(60)) // Séparateur principal
logger.info("─".repeat(60)) // Séparateur secondaire

আউটপুট থেকে তথ্য বের করা

// Recherche simple
val hasMessage = result.output.contains("Expected message")

// Extraction avec regex
val versionRegex = Regex("Version: (.+)")
val version = versionRegex.find(result.output)?.groupValues?.get(1)

// Filtrage de lignes
val errorLines = result.output.lines()
    .filter { it.contains("ERROR") }

errorLines.forEach { logger.error("Gradle error: $it") }

পূর্ব/পরবর্তী তুলনা

পূর্বে : সমস্যামূলক পদ্ধতি

class MyTest {
    lateinit var logger: Logger // ❌ Initialisé tardivement

    @BeforeEach
    fun setup() {
        logger = LoggerFactory.getLogger(...) // ❌ Dépendance
    }

    @Test
    fun test() {
        val runner = GradleRunner.create()
        logger.info("Testing...") // ⚠ Peut échouer
    }
}

পরে : দৃঢ় পদ্ধতি

class MyTest {
    companion object {
        private val logger = LoggerFactory.getLogger(...) // ✓ Indépendant
    }

    @Test
    fun test() {
        logger.info("TEST: Starting...") // ✓ Toujours disponible

        val result = GradleRunner.create()
            .forwardOutput() // ✓ Capture la sortie
            .build()

        logger.debug("Output: ${result.output}") // ✓ Analyse
    }
}

সারাংশ ডায়াগ্রাম

@startuml
!theme plain
skinparam backgroundColor #FEFEFE

title ফাংশনাল টেস্টে সম্পূর্ণ লগিং प्रवाह
actor "ডেভেলপার" as dev
participant "JUnit" as junit
participant "TestClass" as test
participant "Logger\n(SLF4J)" as logger
participant "Logback" as logback
participant "GradleRunner" as runner
participant "Console/File" as output

dev -> junit : পরীক্ষা চালাও

activate junit
junit -> test : ক্লাসটি লোড করুন
activate test

test -> logger : প্রারম্ভ করা (সহযোগী)
activate logger
logger -> logback : কনফিগার
activate logback
logback --> logger : প্রস্তুত
deactivate logback
logger --> test : ✓
deactivate logger

== Phase de Setup ==

junit -> test : @BeforeAll
test -> logger : info("প্রারম্ভ")
logger -> output : [INFO] প্রারম্ভ

junit -> test : @BeforeEach
test -> logger : debug("টেস্ট সেটআপ")
logger -> output : [DEBUG] সেটআপ পরীক্ষা

== Phase de Test ==

junit -> test : @Test
test -> logger : info("TEST: শুরু")
logger -> output : [INFO] TEST: শুরু

test -> runner : create()
activate runner

test -> runner : .forwardOutput()
test -> runner : .build()

runner -> runner : নিষ্পাদন কর Gradle
runner --> test : BuildResult + output text
deactivate runner

test -> logger : debug("আউটপুট বিশ্লেষণ")
logger -> output : [DEBUG] আউটপুট বিশ্লেষণ করা

test -> test : অভিযোগ
test -> logger : info("✓ টেস্ট পاس হয়েছে")
logger -> output : [INFO] ✓ পরীক্ষা সফল

== Phase de Cleanup ==

junit -> test : @AfterEach
test -> logger : debug("পরিষ্কারীকরণ")
logger -> output : [DEBUG] পরিষ্কার

junit -> test : @AfterAll
test -> logger : info("টেস্ট শেষ")
logger -> output : [INFO] টেস্টের শেষ

test --> junit : ✓ সমস্ত টেস্ট পাস হয়েছে
deactivate test
deactivate junit

dev <-- junit : পরীক্ষা প্রতিবেদন

@enduml

পরিহার্য পাঁচ

প্রথম ভুল: .forwardOutput() ভульে যাওয়া

// MAUVAIS: La sortie Gradle n'est pas capturée
val result = GradleRunner.create()
    .withArguments("task")
    .build()

// result.output sera vide !
// BON: La sortie est capturée
val result = GradleRunner.create()
    .forwardOutput() // ✓
    .withArguments("task")
    .build()

❌ ফাঁস নম্বর ২ : লগার অইনিশিয়ালাইজ করা হয়নি

// MAUVAIS
class Test {
    lateinit var logger: Logger // Peut ne pas être initialisé
}
// BON
class Test {
    companion object {
        private val logger = LoggerFactory.getLogger(...) // Toujours initialisé
    }
}

❌ ফাঁদ ৩ : অতি লগিং

// MAUVAIS: Trop de logs DEBUG en production
logger.debug("Variable a = $a")
logger.debug("Variable b = $b")
logger.debug("Variable c = $c")
// ... 100 lignes de logs
// BON: Logging ciblé
logger.info("Traitement de ${items.size} éléments")
logger.debug("Détails: ${items.take(5)}...") // Échantillon seulement

ফলাফল এবং মেট্রিক্স

এই পদ্ধতির মাধ্যমে, আপনি পাবেন:

মেট্রিক আগে পরে

কোডের লাইন

~50 লাইন

প্রায় ৮০ লাইন (+৬০%)

ডিবাগিং সময়

~30 মিনিট

প্রায় ৫ মিনিট (-83%)

সনাক্ত ত্রুটি

মৌলিক

বिस्तারিত

সমরক্ষণ

কষ্টকর

সহজ

স্বাধীনতা

�❌ যুক্ত

✓ স্বাধীন

উপসংহার

গ্র্যাডল প্লাগইনের ফাংশনাল টেস্টে একটি শক্তিশালী লগিং সিস্টেমের স্থাপন একটি সহজ নীতির ভিত্তি করে:স্বাধীনতা.

মূল পয়েন্টগুলো :

  1. স্বতন্ত্র লগার: একটি প্রারম্ভিত`companion object`

  2. SLF4J এবং Logbackপ্রমাণিত এবং কনফিগারযোগ্য স্ট্যাক

  3. .forwardOutput()Gradle আউটপুট ক্যাপচার

  4. স্ট্রাকচার্ড লগিং: INFO ধাপের জন্য, DEBUG বিস্তারিতের জন্য

  5. আউটপুট বিশ্লেষণতথ্য নিষ্কাশন থেকে`result.output`

এই পদ্ধতি পরীক্ষা নিশ্চিত করেবজায় রাখা যায়, ডিবাগযোগ্য et শক্তিশালী, গाढ় ডিজাইন নীতিগুলোকে মেনে চলা।

আगे আরও যাওয়া

একটি আগামী নিবন্ধে, আমরা অনুসন্ধান করব:

  • সতত ইন্টিগ্রেশন সঙ্গে সংগঠিত লগিং

  • এম্বেডেড লগস সহ HTML পরীক্ষা প্রতিবেদন

  • JVM.attach সহ উন্নত ডিবাগিং

  • লগিংয়ের কর্মক্ষমতা এবং অপ্টিমাইজেশন

এই অনুচ্ছেদটি "Gradle প্ল্যাগইন উন্নয়ন" সিরিজের অংশ আমার টেকনিক্যাল ব্লগে.

সম্পর্কিত নিবন্ধ