Оптимизация управления задачами Gradle с помощью Kotlin DSL и buildSrc

// 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]

package com.yourpackage

абстрактный класс ReportUnitTestsTask : OpenTestReportTask() { инициализация { Открывает отчёт о юнит-тестах в Firefox. reportPath = "build/reports/tests/test/index.html } }

пакет com.yourpackage

## abstract class ReportFunctionalTestsTask : OpenTestReportTask() { init { description = "Открывает отчёт о функциональном тестировании в Firefox." 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 monochrome true

абстрактный класс DefaultTask { }

abstract class Exec { \+ commandLine(args: String...) \+ exec() }

abstract class OpenTestReportTask extends DefaultTask { \+ group: String = "verification \+ описание: String \+ dependsOn("check") + abstract reportPath: String \+ openReport() : void }

абстрактный класс AbstractJbakeExecTask extends Exec { \+ group: String = "проверка \+ описание: Строка \+ dependsOn("check") \+ абстрактный reportRelativePath: String \+ exec() : void }

class ReportUnitTestsTask extends OpenTestReportTask { \+ reportPath: String = "build/reports/tests/test/index.html }

class 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`)

Если ваша задача сводится в основном к выполнению внешней команды с переменными аргументами, наследовать напрямую от**Exec**более прямой.

## [source,kotlin]

пакет com.yourpackage

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

abstract class 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() { инициализация { description = "Открывает отчёт о юнит-тестах Jbake в Firefox. reportRelativePath = "build/reports/tests/test/index.html } }

пакет com.yourpackage

## abstract class ReportJbakeFunctionalTestsTask : AbstractJbakeExecTask() { init { description = "Открывает отчет о функциональных тестах в Firefox." reportRelativePath = "build/reports/tests/functionalTest/index.html" } }

\== Видимость задач`buildSrc`

Задачи и классы, которые вы определяете в**buildSrc**являются:

***Видимы и пригодны**для всех проектов вашей основной сборки (корень и подпроекты). Поэтому вы можете использовать`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() reports.html.outputLocation.set(layout.buildDirectory.dir("reports/tests")) }

import com.yourpackage.ReportJbakeTestsTask // Импортируйте ваш класс задачи

tasks.register<ReportJbakeTestsTask>("reportBuildSrcTests") { // Путь уже определён в классе, он будет указывать на отчёты buildSrc }

Вы сможете затем выполнить :`./gradlew :buildSrc:test`за которым следует`./gradlew :buildSrc:reportBuildSrcTests`.

Применяя эти практики, вы создадите системы сборки Gradle на Kotlin DSL, которые не только мощны, но и невероятно модульны, поддерживаемы и легко понятны.
----

## }

\=== Конкретные реализации

Эти классы наследуются от абстрактной задачи и определяют конкретный путь отчета.

## [источник,kotlin]

package com.yourpackage

abstract class ReportUnitTestsTask : OpenTestReportTask() { init { description = "Открывает отчет о модульных тестах в Firefox. reportPath = "build/reports/tests/test/index.html } }

package com.yourpackage

## abstract class ReportFunctionalTestsTask : OpenTestReportTask() { init { description = "Открывает отчет о функциональном тестировании в Firefox." reportPath = "build/reports/tests/functionalTest/index.html" } }

\=== Регистрация задач

В`build.gradle.kts`вашего корневого проекта:

## [источник,kotlin]

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

\=== UML-диаграмма задач отчета (код PlantUML)

Скопируйте приведенный ниже код и вставьте его в инструмент с поддержкой PlantUML.

## [источник,plantuml]

@startuml skinparam handwritten true skinparam monochrome true

abstract class DefaultTask { }

abstract class Exec { \+ commandLine(args: String...) \+ exec() }

abstract class OpenTestReportTask extends DefaultTask { \+ group: String = "verification \+ description: String \+ зависит от ("check") \+ abstract reportPath: String \+ openReport() : void }

abstract class AbstractJbakeExecTask extends Exec { \+ group: String = "verification \+ description: String \+ зависит от ("check") \+ abstract reportRelativePath: String \+ exec() : void }

class ReportUnitTestsTask extends OpenTestReportTask { \+ reportPath: String = "build/reports/tests/test/index.html }

class 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`)

Если ваша задача сводится в основном к выполнению внешней команды с переменными аргументами, наследуйтесь напрямую от**Выполнить**более прямой.

## [источник,kotlin]

package com.yourpackage

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

abstract class 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
}