Kotlin DSL과 buildSrc를 사용한 Gradle 작업 관리 최적화

// build.gradle.kts (projet racine)
plugins {
    base // Appliqué au projet racine
}

allprojects {
    group = "com.example"
    version = "1.0.0"

    repositories {
        mavenCentral()
    }

    tasks.withType<org.gradle.api.tasks.testing.Test> {
        useJUnitPlatform() // Configuration commune des tests pour tous les projets
    }
}

subprojects {
    apply(plugin = "java")
    apply(plugin = "org.jetbrains.kotlin.jvm")

    dependencies {
        implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
    }

}

----
----
init {
    group = "verification"
    description = "Opens a test report in Firefox."
    dependsOn("check") // Assure que les rapports sont générés
}

@get:Input
abstract var reportPath: String

@TaskAction
fun openReport() {
    val separator = File.separator
    val reportFile = project.layout.projectDirectory.asFile.toPath()
        .resolve(reportPath.replace("/", separator))
        .toAbsolutePath()
        .toFile()

    if (!reportFile.exists()) {
        logger.warn("Report file does not exist: $reportFile. Ensure 'check' ran.")
        return
    }

    project.exec {
        commandLine("firefox", "--new-tab", reportFile.absolutePath)
    }
    logger.lifecycle("Opened test report: ${reportFile.absolutePath}")
}
----

## }

구체적인 구현

이 클래스들은 추상 작업을 상속받고 보고서의 특정 경로를 정의합니다.

## [source,kotlin]

패키지 com.yourpackage

추상 클래스 ReportUnitTestsTask : OpenTestReportTask() init { Firefox에서 단위 테스트 보고서를 엽니다. reportPath = "build/reports/tests/test/index.html } }

패키지 com.yourpackage

## abstract class ReportFunctionalTestsTask : OpenTestReportTask() { init { description = "파이어폭스에서 기능 테스트 보고서를 엽니다." reportPath = "build/reports/tests/functionalTest/index.html" } }

\=== 작업 기록

안에`build.gradle.kts`당신의 루트 프로젝트:

## [source,kotlin]

tasks.register<com.yourpackage.ReportUnitTestsTask>("reportTests") {} tasks.register<com.yourpackage.ReportFunctionalTestsTask>("reportFunctionalTests") {}

\=== 보고서 작업의 UML 다이어그램 (PlantUML 코드)

아래 코드를 복사하여 PlantUML을 지원하는 도구에 붙여넣으세요.

## [source,plantuml]

@startuml skinparam handwritten true skinparam 단색 true

추상 클래스 DefaultTask { }

추상 클래스 Exec { \+ commandLine(args: String...) \+ exec() }

추상 클래스 OpenTestReportTask 확장 DefaultTask { \+ group: String = "검증 \+ 설명: 문자열 \+ dependsOn("check") \+ abstract reportPath: String \+ openReport() : void }

추상 클래스 AbstractJbakeExecTask는 Exec를 확장합니다 { \+ group: String = "검증 \+ 설명: 문자열 \+ dependsOn("check") \+ 추상 보고상대경로: 문자열 \+ exec() : void }

클래스 ReportUnitTestsTask는 OpenTestReportTask를 확장합니다 { \+ reportPath: String = "build/reports/tests/test/index.html }

클래스 ReportFunctionalTestsTask extends OpenTestReportTask { \+ reportPath: String = "build/reports/tests/functionalTest/index.html }

class ReportJbakeTestsTask extends AbstractJbakeExecTask { \+ reportRelativePath: String = "build/reports/tests/test/index.html }

class ReportJbakeFunctionalTestsTask extends AbstractJbakeExecTask { \+ reportRelativePath: String = "build/reports/tests/functionalTest/index.html }

OpenTestReportTask \<-- ReportUnitTestsTask OpenTestReportTask \<-- ReportFunctionalTestsTask

AbstractJbakeExecTask \<-- ReportJbakeTestsTask AbstractJbakeExecTask \<-- ReportJbakeFunctionalTestsTask

DefaultTask \<|-- OpenTestReportTask Exec \<|-- AbstractJbakeExecTask DefaultTask \<|-- Exec

## @enduml

\== 추상적인 작업`AbstractJbakeExecTask`(상속받는`Exec`)

주로 외부 명령에 변수 인자를 실행하는 작업이라면, 직접 상속받는**실행**더 직접적입니다.

## [source,kotlin]

패키지 com.yourpackage

import org.gradle.api.tasks.Exec import org.gradle.api.tasks.Input import java.io.File

추상 클래스 AbstractJbakeExecTask : Exec() {

----

init { group = "verification" description = "Opens a Jbake project report in Firefox." dependsOn("check") }

@get:Input abstract var reportRelativePath: String

override fun exec() { val separator = File.separator val reportFile = project.layout.projectDirectory.asFile.toPath() .resolve(reportRelativePath.replace("/", separator)) .toAbsolutePath() .toFile()

if (!reportFile.exists()) { logger.warn("Report file does not exist: $reportFile. Ensure 'check' ran.") return }

commandLine("firefox", "--new-tab", reportFile.absolutePath) logger.lifecycle("Attempting to open report: ${reportFile.absolutePath}") super.exec() // Appelle la méthode exec() de la super-classe Exec }

## }

\=== 구체적인 구현을 위한`Exec`

## [source,kotlin]

package com.yourpackage

추상 클래스 ReportJbakeTestsTask : AbstractJbakeExecTask() { init { description = "Firefox에서 Jbake 단위 테스트 보고서를 엽니다. reportRelativePath = "build/reports/tests/test/index.html } }

package com.yourpackage

abstract class ReportJbakeFunctionalTestsTask : AbstractJbakeExecTask() { init { description = "파이어폭스에서 기능 테스트 보고서를 엽니다." reportRelativePath = "build/reports/tests/functionalTest/index.html" } }

\== 작업 가시성`buildSrc`

당신이 정의하는 작업 및 클래스는**buildSrc**이다 :

***보이고 사용 가능한**votre 메인 빌드의 모든 프로젝트(루트 및 하위 프로젝트)에서. 따라서 사용할 수 있습니다`com.yourpackage.ReportUnitTestsTask`안에`allprojects { ... }`. ***실행 불가능한**직접 buildSrc 작업으로서 (예를 들어,`gradle :buildSrc:reportTests`작업이 특정하게 기록되지 않으면 작동하지 않을 것입니다`buildSrc/build.gradle.kts`).`buildSrc`컴파일 모듈일 뿐, 이 메인 빌드 작업에 사용되는 실행 가능한 애플리케이션 모듈이 아닙니다.

테스트를 위한 보고서 실행`buildSrc`자기

Si `buildSrc`자신만의 테스트를 수행하고 보고서를 생성하면, 보고 작업을 직접 기록할 수 있습니다`buildSrc/build.gradle.kts`:

## [source,kotlin]

plugins { `kotlin-jvm` }

저장소 { mavenCentral() }

tasks.withType\<Test\> { useJUnitPlatform() 보고서.html.출력위치.set(레이아웃.빌드디렉터리.dir("보고서/테스트")) }

import com.yourpackage.ReportJbakeTestsTask // 작업 클래스를 가져옵니다

tasks.register\<ReportJbakeTestsTask\>("reportBuildSrcTests") { // Le chemin est déjà défini dans la classe, il pointera vers les rapports de buildSrc }

그 다음에 실행할 수 있습니다 :`./gradlew :buildSrc:test`다음에`./gradlew :buildSrc:reportBuildSrcTests`.

이러한 관행을 채택함으로써 Kotlin DSL을 사용한 Gradle 빌드 시스템을 구축하게 되며, 이는 단순히 강력할 뿐만 아니라 놀랍도록 모듈화 가능하고 유지 보수가 쉬우며 이해하기 쉽습니다.