Update to Gradle 9 and make more progress toward configuration cache compatibility (#234)

Author: labkey-susanh

.idea/misc.xml

@@ -13,11 +13,29 @@ on how to do that, including how to develop and test locally and the versioning
 
 ## Release Notes
 
-### TBD
-*Released*: TBD
-(Earliest compatible LabKeyversion: 25.2)
+### 7.0.0
+*Released*: 22 September 2025
+(Earliest compatible LabKey version: 25.10)
 - Update `PurgeArtifacts` task to be compatible with configuration cache and to work with input files so archived projects can be kept up to date
 - Update dependency versions
+- Update DoThenSetup and its relatives to be compatible with configuration cache
+- Update DeployApp for better configuration cache compatibility
+- Replace usages of project.javaexc with JavaExc task types or injected ExecOperations
+- Update CompressClientLibs, StopLabKey to work better with configuration cache
+- Remove `listNodeModules` task defined by `NpmRun` plugin
+- Remove `cleanOut` task defined by `FileModule` plugin
+- Remove `cleanAndDeploy` task from `ServerDeploy` plugin
+- Update `CopyAndInstallRPackage` Task class to use injected FileSystem instead of `project.copy`
+- Update `GzipAction` task to use task logger and ant builder objects
+- Update `StopLabKey` and `StartLabKey` with appropriate dependencies to mirror the deprecated `StopTomcat` and `StartTomcat`
+- Remove deprecated `getServerDeployDirectory` from `ServerDeployExtension`
+- Remove `createNlpConfig` task from `TeamCity` plugin since that module is no longer in use
+- Remove `setup` task from `ServerDeploy` plugin.
+- Update `DeployDistribution` and `StageDistribution` for configuration cache compatibility
+- Some updates for `ModuleDistribution` for better configuration cache compatibility
+- Update `PropertiesUtils` to remove code for supporting `labkey.xml`
+- Relocate the `.restartTriggerFile` to prevent creation of empty `build/deploy/modules` directory for embedded distribution deployment
+- Fix `bootstrap` task so it will update `application.properties`
 
 ### 6.3.0
 *Released*: 3 July 2025

README.md

@@ -30,6 +30,7 @@ repositories {
 dependencies {
     implementation gradleApi()
     implementation localGroovy()
+    implementation "org.apache.groovy:groovy-sql:${groovySqlVersion}"
     api "org.apache.commons:commons-lang3:${commonsLang3Version}"
     api "org.apache.commons:commons-text:${commonsTextVersion}"
     api "commons-io:commons-io:${commonsIoVersion}"
@@ -42,7 +43,7 @@ dependencies {
 }
 
 group = 'org.labkey.build'
-project.version = "6.4.0-SNAPSHOT"
+project.version = "7.1.0-SNAPSHOT"
 
 gradlePlugin {
     plugins {

build.gradle

@@ -1,6 +1,6 @@
 artifactory_contextUrl=https://labkey.jfrog.io/artifactory
 
-artifactoryPluginVersion=5.2.5
+artifactoryPluginVersion=6.0.0
 
 commonsIoVersion=2.20.0
 commonsLang3Version=3.18.0
@@ -9,6 +9,8 @@ commonsTextVersion=1.14.0
 grgitGradleVersion=5.3.2
 graphqlJavaVersion=24.2
 
+groovySqlVersion=4.0.27
+
 httpclientVersion=5.5
 httpcoreVersion=5.3.4
 

gradle.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.0.0-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradle/wrapper/gradle-wrapper.properties

@@ -26,6 +26,7 @@ import org.labkey.gradle.util.GroupNames
 
 /**
  * Used to compile antlr grammars into Java classes using the antlr executable.
+ * TODO: This could be converted to using the Antlr plugin https://docs.gradle.org/9.1.0/userguide/antlr_plugin.html
  */
 class Antlr implements Plugin<Project>
 {

src/main/groovy/org/labkey/gradle/plugin/Antlr.groovy

@@ -96,8 +96,9 @@ class ApplyLicenses implements Plugin<Project>
             }
 
             project.tasks.register('verifyLicensePatch') {
-                dependsOn(patchApiTask)
-                doLast {
+                it.group = GroupNames.TEST
+                it.dependsOn(patchApiTask)
+                it.doLast {
                     [project.configurations.extJs3Commercial, project.configurations.extJs4Commercial].forEach {
                         def commercialLicense = project.zipTree(it.singleFile).matching {
                             include '*/license.txt'
@@ -110,6 +111,7 @@ class ApplyLicenses implements Plugin<Project>
                         }
                     }
                 }
+                it.notCompatibleWithConfigurationCache("Needs to inject ArtifactOperations for zipTree usage")
             }
         }
     }

src/main/groovy/org/labkey/gradle/plugin/ApplyLicenses.groovy

@@ -51,6 +51,7 @@ class ClientLibraries
                     task.dependsOn(project.tasks.processResources)
                     task.dependsOn(project.project(minProjectPath).tasks.named("npmInstall"))
                     task.xmlFiles = getLibXmlFiles(project)
+                    task.notCompatibleWithConfigurationCache("Class ClientLibsCompress needs more input and output properties declared")
             }
 
             project.evaluationDependsOn(minProjectPath)

src/main/groovy/org/labkey/gradle/plugin/ClientLibraries.groovy

@@ -52,6 +52,7 @@ class Database implements Plugin<Project>
                 task.group = GroupNames.DATABASE
                 task.description = "Switch to SQL Server configuration"
                 task.dbType = "mssql"
+                task.driverFiles.setFrom(project.configurations.driver)
         }
     }
 
@@ -62,6 +63,7 @@ class Database implements Plugin<Project>
                 task.group = GroupNames.DATABASE
                 task.description = "Switch to SQL Server configuration using jTDS driver"
                 task.dbType = "jtds"
+                task.driverFiles.setFrom(project.configurations.driver)
         }
     }
 
@@ -71,6 +73,9 @@ class Database implements Plugin<Project>
             Bootstrap task ->
                 task.group = GroupNames.DATABASE
                 task.description = "Switch to bootstrap database properties as defined in current db.config file"
+                task.driverFiles.setFrom(project.configurations.driver)
+                task.dbPropertiesChanged = true
+                task.outputs.upToDateWhen({ return false })
         }
     }
 }

src/main/groovy/org/labkey/gradle/plugin/Database.groovy

@@ -23,15 +23,11 @@ import org.gradle.api.artifacts.ModuleDependency
 import org.gradle.api.artifacts.ProjectDependency
 import org.gradle.api.file.DeleteSpec
 import org.gradle.api.internal.artifacts.dependencies.DefaultProjectDependency
-import org.gradle.api.publish.maven.MavenPublication
 import org.gradle.api.tasks.Delete
 import org.labkey.gradle.plugin.extension.DistributionExtension
-import org.labkey.gradle.plugin.extension.LabKeyExtension
 import org.labkey.gradle.plugin.extension.TeamCityExtension
-import org.labkey.gradle.task.ModuleDistribution
 import org.labkey.gradle.util.BuildUtils
 import org.labkey.gradle.util.GroupNames
-import org.labkey.gradle.util.PomFileHelper
 import org.labkey.gradle.util.TaskUtils
 
 class Distribution implements Plugin<Project>
@@ -62,10 +58,6 @@ class Distribution implements Plugin<Project>
         addDependencies(project)
         addTasks(project)
         addTaskDependencies(project)
-
-        // commented out until we start publishing distribution artifacts, and then we'll examine the publications more closely
-//        if (BuildUtils.shouldPublishDistribution(project))
-//            addArtifacts(project)
     }
 
     private void addConfigurations(Project project)
@@ -169,74 +161,6 @@ class Distribution implements Plugin<Project>
                     project.dependencies.add("distribution", dep)
         }
     }
-
-    private void addArtifacts(Project project)
-    {
-        project.apply plugin: 'maven-publish'
-
-        // TODO this is really only an approximation of what's needed. We don't currently publish distribution artifacts
-        // to artifactory
-        project.afterEvaluate {
-            String artifactId = getArtifactId(project)
-            Properties pomProperties = LabKeyExtension.getApiPomProperties(artifactId, project.dist.description, project)
-            project.publishing {
-                publications {
-                    distributions(MavenPublication) { pub ->
-                        pub.artifactId(artifactId)
-                        project.tasks.each {
-                            if (it instanceof ModuleDistribution)
-                            {
-                                it.outputs.files.each {File file ->
-                                    pub.artifact(file)
-                                    {
-                                        String fileName = file.getName()
-                                        if (fileName.endsWith("gz"))
-                                            extension "tar.gz"
-                                        if (fileName.contains("-src."))
-                                            classifier "src"
-                                    }
-                                }
-                            }
-                        }
-                        pom {
-                            name = project.name
-                            description = pomProperties.getProperty("Description")
-                            url = PomFileHelper.LABKEY_ORG_URL
-                            developers PomFileHelper.getLabKeyTeamDevelopers()
-                            // TODO this should probably not always be Apache license
-//                            licenses pomUtil.getLicense()
-                            organization PomFileHelper.getLabKeyOrganization()
-//                            scm PomFileHelper.getLabKeyScm()
-                            // doesn't seem like these pom files will have any dependencies
-                        }
-                    }
-                }
-
-                project.artifactoryPublish {
-                    project.tasks.each {
-                        if (it instanceof ModuleDistribution)
-                        {
-                            dependsOn it
-                        }
-                    }
-                    publications('distributions')
-                }
-            }
-        }
-    }
-
-    static String getArtifactId(Project project)
-    {
-        if (project.dist.artifactId != null)
-            return project.dist.artifactId
-        else
-        {
-            return TaskUtils.getOptionalTask(project, "distribution")
-                    .filter(task -> task.get() instanceof ModuleDistribution)
-                    .map(task -> ((ModuleDistribution)task.get()).getArtifactId())
-                    .orElse(project.name)
-        }
-    }
 }