buildSrc/src/main/kotlin/SourceLicenseChecker.kt
author Da Risk <da_risk@geekorum.com>
Tue, 05 May 2026 14:55:56 -0400
changeset 119 684356cd6a7d
parent 111 f42cdc67a8e7
permissions -rw-r--r--
build: update SourceLicenseChecker for AGP 9.x
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
     1
/*
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
     2
 * AboutOss is a utility library to retrieve and display
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
     3
 * opensource licenses in Android applications.
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
     4
 *
34
ce299aacc068 build: update license headers
Da Risk <da_risk@geekorum.com>
parents: 11
diff changeset
     5
 * Copyright (C) 2023-2025 by Frederic-Charles Barthelery.
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
     6
 *
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
     7
 * This file is part of AboutOss.
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
     8
 *
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
     9
 * AboutOss is free software: you can redistribute it and/or modify
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    10
 * it under the terms of the GNU General Public License as published by
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    11
 * the Free Software Foundation, either version 3 of the License, or
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    12
 * (at your option) any later version.
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    13
 *
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    14
 * AboutOss is distributed in the hope that it will be useful,
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    17
 * GNU General Public License for more details.
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    18
 *
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    19
 * You should have received a copy of the GNU General Public License
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    20
 * along with AboutOss.  If not, see <http://www.gnu.org/licenses/>.
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    21
 */
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    22
package com.geekorum.build
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    23
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    24
import com.android.build.api.dsl.AndroidSourceSet
119
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
    25
import com.android.build.api.dsl.CommonExtension
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    26
import com.android.build.gradle.BaseExtension
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    27
import com.android.build.gradle.DynamicFeaturePlugin
111
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    28
import com.android.build.gradle.TestPlugin
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    29
import com.hierynomus.gradle.license.LicenseBasePlugin
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    30
import com.hierynomus.gradle.license.tasks.LicenseCheck
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    31
import com.hierynomus.gradle.license.tasks.LicenseFormat
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    32
import nl.javadude.gradle.plugins.license.License
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    33
import nl.javadude.gradle.plugins.license.LicenseExtension
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    34
import nl.javadude.gradle.plugins.license.LicensePlugin
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    35
import org.gradle.api.NamedDomainObjectContainer
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    36
import org.gradle.api.Project
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    37
import org.gradle.api.file.FileTree
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    38
import org.gradle.api.tasks.TaskProvider
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    39
import org.gradle.kotlin.dsl.*
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    40
import org.jetbrains.kotlin.gradle.dsl.KotlinProjectExtension
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    41
import org.jetbrains.kotlin.gradle.plugin.KotlinAndroidPluginWrapper
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    42
import org.jetbrains.kotlin.gradle.plugin.KotlinJsPluginWrapper
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    43
import org.jetbrains.kotlin.gradle.plugin.KotlinMultiplatformPluginWrapper
119
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
    44
import java.io.File
111
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    45
import java.util.Locale
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    46
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    47
internal fun Project.configureSourceLicenseChecker() {
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    48
    apply<LicensePlugin>()
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    49
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    50
    configure<LicenseExtension> {
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    51
        header = file("$rootDir/config/license/header.txt")
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    52
        mapping("java", "SLASHSTAR_STYLE")
119
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
    53
        mapping("json", "SLASHSTAR_STYLE")
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    54
        mapping("kt", "SLASHSTAR_STYLE")
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    55
119
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
    56
        excludes(listOf("**/*.webp", "**/*.png", "**/*.jpeg", "**/*.jpg"))
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    57
    }
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    58
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    59
    // the LicensePlugin doesn't configure itself properly on DynamicFeaturePlugin
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    60
    // Copied the code to configure it
119
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
    61
    plugins.withType<DynamicFeaturePlugin> {
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    62
        configureAndroid()
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    63
    }
111
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    64
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    65
    // the LicensePlugin doesn't configure itself properly on Android Test plugin
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    66
    // Copied the code to configure it
119
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
    67
    plugins.withType<TestPlugin> {
111
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    68
        configureAndroid()
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    69
    }
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    70
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    71
    // make the license tasks looks for kotlin files in an Android project
119
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
    72
    plugins.withType<KotlinAndroidPluginWrapper> {
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    73
        configureKotlinAndroid()
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    74
    }
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    75
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    76
    // make the license tasks for kotlin js project
119
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
    77
    plugins.withType<KotlinJsPluginWrapper> {
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    78
        configureKotlin()
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    79
    }
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    80
119
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
    81
    plugins.withType<KotlinMultiplatformPluginWrapper> {
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    82
        configureKotlin()
119
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
    83
        configureComposeResources()
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
    84
    }
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
    85
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
    86
    tasks.withType<License>().configureEach {
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
    87
        notCompatibleWithConfigurationCache("License tasks calls getProject() at execution time")
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    88
    }
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    89
}
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    90
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    91
private fun Project.configureKotlin() {
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    92
    val kotlin = the<KotlinProjectExtension>()
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    93
    val taskInfix = ""
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    94
    kotlin.sourceSets.configureEach {
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    95
        val kotlinSource = this
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    96
        val sourceSetTaskName =
11
c028b38c3bdf build: remove a few warnings
Da Risk <da_risk@geekorum.com>
parents: 0
diff changeset
    97
            "${LicenseBasePlugin.getLICENSE_TASK_BASE_NAME()}${taskInfix}${name.capitalize()}"
111
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    98
        if (name.startsWith("generated")) {
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
    99
            logger.info("Skip sourceSet $name because it's generated code")
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   100
            return@configureEach
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   101
        }
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   102
        val configureLicenseCheckTaskLambda: LicenseCheck.() -> Unit = {
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   103
            source(kotlinSource.kotlin)
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   104
            exclude {
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   105
                // exclude generated files, notably protobuf, ksp, hilt
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   106
                "/generated/" in it.file.path
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   107
            }
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   108
        }
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   109
        if (sourceSetTaskName in tasks.names) {
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   110
            // tasks may have already been added by configuration for the Android plugin
111
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   111
            logger.info("Tasks $sourceSetTaskName already exists. configure it")
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   112
            tasks.named(sourceSetTaskName, LicenseCheck::class.java, configureLicenseCheckTaskLambda)
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   113
        } else {
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   114
            logger.info("Adding ${project.name}:$sourceSetTaskName task for sourceSet ${kotlinSource.name}")
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   115
            tasks.register(sourceSetTaskName, LicenseCheck::class.java, configureLicenseCheckTaskLambda)
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   116
        }
111
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   117
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   118
        val configureLicenseFormatTaskLambda: LicenseFormat.() -> Unit = {
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   119
            source(kotlinSource.kotlin)
111
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   120
            exclude {
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   121
                // exclude generated files, notably protobuf, ksp, hilt
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   122
                "/generated/" in it.file.path
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   123
            }
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   124
        }
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   125
        val sourceSetFormatTaskName =
11
c028b38c3bdf build: remove a few warnings
Da Risk <da_risk@geekorum.com>
parents: 0
diff changeset
   126
            "${LicenseBasePlugin.getFORMAT_TASK_BASE_NAME()}${taskInfix}${name.capitalize()}"
111
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   127
        if (sourceSetFormatTaskName in tasks.names) {
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   128
            // tasks may have already been added by configuration for the Android plugin
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   129
            logger.info("Tasks $sourceSetFormatTaskName already exists. configure it")
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   130
            tasks.named(sourceSetFormatTaskName, LicenseFormat::class.java, configureLicenseFormatTaskLambda)
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   131
        } else {
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   132
            logger.info("Adding ${project.name}:$sourceSetFormatTaskName task for sourceSet ${kotlinSource.name}")
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   133
            tasks.register(sourceSetFormatTaskName, LicenseFormat::class.java, configureLicenseFormatTaskLambda)
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   134
        }
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   135
    }
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   136
}
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   137
119
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   138
private fun Project.configureComposeResources() {
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   139
    val kotlin = the<KotlinProjectExtension>()
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   140
    val taskInfix = "ComposeResources"
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   141
    kotlin.sourceSets.configureEach {
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   142
        val kotlinSource = this
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   143
        val sourceSetTaskName =
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   144
            "${LicenseBasePlugin.getLICENSE_TASK_BASE_NAME()}${taskInfix}${name.capitalize()}"
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   145
        if (name.startsWith("generated")) {
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   146
            logger.info("Skip sourceSet $name because it's generated code")
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   147
            return@configureEach
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   148
        }
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   149
        val resourceDir = kotlinSource.resources.sourceDirectories.files.first()
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   150
        val composeResourceDir = File(resourceDir, "../composeResources")
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   151
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   152
        val configureLicenseCheckTaskLambda: LicenseCheck.() -> Unit = {
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   153
            source(composeResourceDir)
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   154
        }
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   155
        if (sourceSetTaskName in tasks.names) {
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   156
            // tasks may have already been added by configuration for the Android plugin
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   157
            logger.info("Tasks $sourceSetTaskName already exists. configure it")
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   158
            tasks.named(sourceSetTaskName, LicenseCheck::class.java, configureLicenseCheckTaskLambda)
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   159
        } else {
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   160
            logger.info("Adding ${project.name}:$sourceSetTaskName task for sourceSet ${kotlinSource.name}")
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   161
            tasks.register(sourceSetTaskName, LicenseCheck::class.java, configureLicenseCheckTaskLambda)
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   162
        }
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   163
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   164
        val configureLicenseFormatTaskLambda: LicenseFormat.() -> Unit = {
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   165
            source(composeResourceDir)
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   166
        }
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   167
        val sourceSetFormatTaskName =
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   168
            "${LicenseBasePlugin.getFORMAT_TASK_BASE_NAME()}${taskInfix}${name.capitalize()}"
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   169
        if (sourceSetFormatTaskName in tasks.names) {
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   170
            // tasks may have already been added by configuration for the Android plugin
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   171
            logger.info("Tasks $sourceSetFormatTaskName already exists. configure it")
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   172
            tasks.named(sourceSetFormatTaskName, LicenseFormat::class.java, configureLicenseFormatTaskLambda)
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   173
        } else {
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   174
            logger.info("Adding ${project.name}:$sourceSetFormatTaskName task for sourceSet ${kotlinSource.name}")
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   175
            tasks.register(sourceSetFormatTaskName, LicenseFormat::class.java, configureLicenseFormatTaskLambda)
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   176
        }
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   177
    }
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   178
}
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   179
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   180
@OptIn(ExperimentalStdlibApi::class)
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   181
private fun Project.configureKotlinAndroid() {
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   182
    val kotlin = the<KotlinProjectExtension>()
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   183
    val android = the<BaseExtension>()
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   184
    val taskInfix = "Android"
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   185
    android.sourceSets.configureEach {
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   186
        val kotlinSource = kotlin.sourceSets[name]
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   187
        logger.info("Adding kotlin sources from sourceSet $name to License plugin tasks")
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   188
        val sourceSetTaskName =
11
c028b38c3bdf build: remove a few warnings
Da Risk <da_risk@geekorum.com>
parents: 0
diff changeset
   189
            "${LicenseBasePlugin.getLICENSE_TASK_BASE_NAME()}${taskInfix}${name.capitalize()}"
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   190
        tasks.named(sourceSetTaskName, LicenseCheck::class.java) {
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   191
            source(kotlinSource.kotlin, manifest.srcFile)
111
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   192
            exclude {
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   193
                // exclude generated files, notably protobuf
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   194
                "/generated/" in it.file.path
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   195
            }
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   196
        }
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   197
        val sourceSetFormatTaskName =
11
c028b38c3bdf build: remove a few warnings
Da Risk <da_risk@geekorum.com>
parents: 0
diff changeset
   198
            "${LicenseBasePlugin.getFORMAT_TASK_BASE_NAME()}${taskInfix}${name.capitalize()}"
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   199
        tasks.named(sourceSetFormatTaskName, LicenseFormat::class.java) {
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   200
            source(kotlinSource.kotlin, manifest.srcFile)
111
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   201
            exclude {
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   202
                // exclude generated files, notably protobuf
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   203
                "/generated/" in it.file.path
f42cdc67a8e7 build: SourceLicenseChecker exclude checks on generated files
Da Risk <da_risk@geekorum.com>
parents: 34
diff changeset
   204
            }
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   205
        }
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   206
    }
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   207
}
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   208
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   209
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   210
private fun Project.configureAndroid() {
119
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   211
    val android = the<CommonExtension>()
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   212
    configureSourceSetRule(android.sourceSets, "Android") { ss ->
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   213
        @Suppress("DEPRECATION")
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   214
        when (ss) {
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   215
            // the dsl.AndroidSourceSet don't expose any getter, so we still need to cast it
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   216
            is com.android.build.gradle.api.AndroidSourceSet -> {
119
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   217
                val kotlinFileTrees  = ss.kotlin.directories.foldIndexed(fileTree() as FileTree) { index, acc, n ->
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   218
                    if (index == 0) { // skip first as it's an empty tree created for typing
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   219
                        fileTree(n)
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   220
                    } else {
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   221
                        acc + fileTree(n)
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   222
                    }
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   223
                }
684356cd6a7d build: update SourceLicenseChecker for AGP 9.x
Da Risk <da_risk@geekorum.com>
parents: 111
diff changeset
   224
                ss.java.getSourceFiles() + ss.res.getSourceFiles() + fileTree(ss.manifest.srcFile) + kotlinFileTrees
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   225
            }
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   226
            else -> fileTree()
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   227
        }
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   228
    }
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   229
}
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   230
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   231
/**
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   232
 * Dynamically create a task for each sourceSet, and register with check
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   233
 */
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   234
@Suppress("DefaultLocale")
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   235
private fun Project.configureSourceSetRule(androidSourceSetContainer: NamedDomainObjectContainer<out AndroidSourceSet>,
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   236
                                           taskInfix: String, sourceSetSources: (AndroidSourceSet) -> FileTree) {
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   237
    // This follows the other check task pattern
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   238
    androidSourceSetContainer.configureEach {
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   239
        val sourceSetTaskName = "${LicenseBasePlugin.getLICENSE_TASK_BASE_NAME()}${taskInfix}${name.capitalize()}"
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   240
        logger.info("Adding $sourceSetTaskName task for sourceSet $name")
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   241
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   242
        val checkTask = tasks.register(sourceSetTaskName, LicenseCheck::class.java)
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   243
        configureForSourceSet(this, checkTask, sourceSetSources)
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   244
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   245
        // Add independent license task, which will perform format
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   246
        val sourceSetFormatTaskName = "${LicenseBasePlugin.getFORMAT_TASK_BASE_NAME()}${taskInfix}${name.capitalize()}"
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   247
        val formatTask = tasks.register(sourceSetFormatTaskName, LicenseFormat::class.java)
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   248
        configureForSourceSet(this, formatTask, sourceSetSources)
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   249
    }
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   250
}
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   251
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   252
private fun configureForSourceSet(sourceSet: AndroidSourceSet, task: TaskProvider<out License>, sourceSetSources: (AndroidSourceSet) -> FileTree) {
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   253
    task.configure {
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   254
        // Explicitly set description
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   255
        description = "Scanning license on ${sourceSet.name} files"
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   256
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   257
        // Default to all source files from SourceSet
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   258
        source = sourceSetSources(sourceSet)
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   259
    }
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
   260
}
11
c028b38c3bdf build: remove a few warnings
Da Risk <da_risk@geekorum.com>
parents: 0
diff changeset
   261
c028b38c3bdf build: remove a few warnings
Da Risk <da_risk@geekorum.com>
parents: 0
diff changeset
   262
private fun String.capitalize() = replaceFirstChar {
c028b38c3bdf build: remove a few warnings
Da Risk <da_risk@geekorum.com>
parents: 0
diff changeset
   263
    if (it.isLowerCase()) it.titlecase(
c028b38c3bdf build: remove a few warnings
Da Risk <da_risk@geekorum.com>
parents: 0
diff changeset
   264
        Locale.ROOT
c028b38c3bdf build: remove a few warnings
Da Risk <da_risk@geekorum.com>
parents: 0
diff changeset
   265
    ) else it.toString()
c028b38c3bdf build: remove a few warnings
Da Risk <da_risk@geekorum.com>
parents: 0
diff changeset
   266
}