Merge pull request #3648 from ireneGonzalezRuiz/iglezruiz/cargo-migration

Cargo migration & Upgrade Gradle to version 9.0.0

Author: fhanik

README.md

@@ -16,7 +16,7 @@ clients, as well as various other management functions.
 
 The authentication service is `uaa`. It's a plain Spring MVC webapp.
 Deploy as normal in Tomcat or your container of choice, or execute
-`./gradlew run` to run it directly from `uaa` directory in the source
+`./gradlew run` (or `./gradlew bootRun`) to run it directly from `uaa` directory in the source
 tree. When running with Gradle, it listens on port 8080 and the URL is
 `http://localhost:8080/uaa`
 
@@ -90,7 +90,7 @@ UAA will log to a file called `uaa.log` which can be found using the following c
 
 which you should find under something like:-
 
-    $TMPDIR/cargo/conf/logs/
+    scripts/boot/tomcat/logs/
 
 ### Demo of command line usage on a local server
 
@@ -109,16 +109,17 @@ For complex requests it is more convenient to interact with UAA using
 
 ### Running as a Spring Boot Application
 
-Two separate Gradle tasks can be used to run the Spring Boot application
+Three separate Gradle tasks can be used to run the Spring Boot application
 
+- `./gradlew run` — alias that kills any running UAA and starts the application (recommended)
 - `./gradlew bootRun` — the built-in Spring Boot Gradle task
 - `./gradlew bootWarRun` — use a `JavaExec` Gradle task to launch the runnable .war file
 - Manual run, as show below, to be run after `./gradlew assemble`
 - Using ./scripts/boot/boot-with-tls.sh — runs http/8080 and https/8443
 
 ```text
-java -DCLOUDFOUNDRY_CONFIG_PATH=`pwd`/scripts/cargo \
-    -DSECRETS_DIR=`pwd`/scripts/cargo \
+java -DCLOUDFOUNDRY_CONFIG_PATH=`pwd`/scripts/boot \
+    -DSECRETS_DIR=`pwd`/scripts/boot \
     -Djava.security.egd=file:/dev/./urandom \
     -Dmetrics.perRequestMetrics=true \
     -Dserver.servlet.context-path=/uaa \
@@ -135,7 +136,7 @@ java -DCLOUDFOUNDRY_CONFIG_PATH=`pwd`/scripts/cargo \
 ```
 
 Running Spring Boot standalone allows us to run the integration tests against it using the
-`./gradlew -Dcargo.tests.run=false integrationTest` with the system property preventing Gradle from starting up Apache Tomcat.
+`./gradlew integrationTest` with the system property preventing Gradle from starting up Apache Tomcat.
 
 ### Debugging local server
 
@@ -158,9 +159,10 @@ or
 ```sh
 ./gradlew -Dspring.profiles.active=hsqldb,debugs run
 ```
+Note: You can also use `bootRun` instead of `run` for these commands.
 
 ## Running a local UAA server with different databases
-`./gradlew run` runs the UAA server with hsqldb database by default.
+`./gradlew run` (or `./gradlew bootRun`) runs the UAA server with hsqldb database by default.
 
 ### MySql
 1. Start the mysql server (e.g. a mysql docker container)

build.gradle

@@ -10,13 +10,12 @@ buildscript {
         mavenCentral()
         gradlePluginPortal()
         maven {
-            url("https://plugins.gradle.org/m2/")
+            url = uri("https://plugins.gradle.org/m2/")
         }
     }
 
     dependencies {
-        classpath(libraries.cargoGradlePlugin)
-        classpath(libraries.springDependencyMangementGradlePlugin)
+        classpath(libraries.springDependencyManagementGradlePlugin)
         classpath(libraries.springBootGradlePlugin)
         classpath(libraries.gradleJcocoPlugin)
         classpath(libraries.sonarqubePlugin)
@@ -27,9 +26,6 @@ apply(from: "dependencies.gradle")
 
 def applicationPort = project.hasProperty('port') ? project.getProperty('port').toInteger() : 8080
 
-apply(plugin: "com.bmuschko.cargo")
-apply(plugin: "war")
-
 allprojects {
     apply(plugin: "io.spring.dependency-management")
     apply(plugin: "org.barfuin.gradle.jacocolog")
@@ -44,25 +40,12 @@ allprojects {
     repositories {
         mavenCentral()
         maven {
-            url("https://build.shibboleth.net/nexus/content/repositories/releases/")
+            url = uri("https://build.shibboleth.net/nexus/content/repositories/releases/")
         }
-        maven { url("https://repository.mulesoft.org/releases/") }
+        maven { url = uri("https://repository.mulesoft.org/releases/") }
     }
-
-    //set this property to false to run integration tests against an already
-    //running server on http://localhost:8080/uaa
-    ext.runCargoTests = Boolean.valueOf(System.getProperty("cargo.tests.run", "true"))
 }
 
-configurations {
-    mockitoAgent
-}
-dependencies {
-    testImplementation(libraries.mockito)
-    mockitoAgent(libraries.mockito) {
-        transitive = false
-    }
-}
 
 subprojects {
     apply(plugin: "java")
@@ -71,7 +54,7 @@ subprojects {
         targetCompatibility = JavaVersion.VERSION_21
     }
 
-    configurations.all {
+    configurations.configureEach {
         exclude(group: "org.hamcrest", module: "hamcrest-all")
         exclude(group: "org.hamcrest", module: "hamcrest-core")
         exclude(group: "org.hamcrest", module: "hamcrest-library")
@@ -128,37 +111,38 @@ subprojects {
         jvmArgs += ["-Xmx1024m",
                     "-XX:+StartAttachListener",
                     "-XX:+HeapDumpOnOutOfMemoryError",
-                    "-XX:HeapDumpPath=/var/log/uaa-tests.hprof",
-                    "-javaagent:${parent.configurations.mockitoAgent.asPath}"
+                    "-XX:HeapDumpPath=/var/log/uaa-tests.hprof"
         ]
 
         testLogging {
             events("failed")
-            exceptionFormat("full")
+            exceptionFormat = "full"
             // Uncomment the following line to see all standard output from tests (there's a ton of it!)
             //showStandardStreams = true
         }
     }
 
-    task integrationTest(type: Test) {
-        if (runCargoTests) {
-            dependsOn rootProject.cargoStartLocal
-        }
+    tasks.register('integrationTest', Test) {
         useJUnitPlatform()
 
+        // Enable JaCoCo for integration tests
+        jacoco {
+            enabled = true
+        }
+
         testLogging {
             events("failed")
-            exceptionFormat("full")
+            exceptionFormat = "full"
             // Uncomment the following line to see all standard output from tests (there's a ton of it!)
             //showStandardStreams = true
         }
     }
 
-    task generateDocs() {}
+    tasks.register('generateDocs') {}
 
-    task allDeps(type: DependencyReportTask) {}
+    tasks.register('allDeps', DependencyReportTask) {}
 
-    task writeNewPom() {
+    tasks.register('writeNewPom') {
         doLast {
             pom {
                 project {
@@ -185,81 +169,6 @@ subprojects {
     }
 }
 
-cargo {
-    containerId = "tomcat10x"
-    port = applicationPort
-
-    if (JavaVersion.current() < JavaVersion.VERSION_21) {
-        throw new GradleException("This build must be run with Java version [ " + JavaVersion.VERSION_21 + " ] or greater. Your Java version is [ " + JavaVersion.current() + " ]")
-    }
-
-    deployable {
-        file = file("uaa/build/libs/cloudfoundry-identity-uaa-" + version + ".war")
-        context = "uaa"
-    }
-
-    local {
-        configHomeDir = file(Path.of(System.getProperty("java.io.tmpdir"), "uaa-${applicationPort}"))
-        startStopTimeout = Integer.parseInt(System.getProperty("startStopTimeout", "540000"))
-        rmiPort = applicationPort + 10
-
-        jvmArgs = ""
-        jvmArgs = String.format("%s -DCLOUDFOUNDRY_CONFIG_PATH='%s'", jvmArgs, file("scripts/cargo").getAbsolutePath())
-        jvmArgs = String.format("%s -Dlogging.config='%s'", jvmArgs, file("scripts/cargo/log4j2.properties").getAbsolutePath())
-        jvmArgs = String.format("%s -Dstatsd.enabled=true", jvmArgs)
-
-        String activeSpringProfiles = System.getProperty("spring.profiles.active", "").split(',');
-        if (activeSpringProfiles.contains("debugs") || Boolean.valueOf(System.getProperty("xdebugs"))) {
-            jvmArgs = String.format("%s -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005", jvmArgs)
-        } else if (activeSpringProfiles.contains("debug") || Boolean.valueOf(System.getProperty("xdebug"))) {
-            jvmArgs = String.format("%s -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005", jvmArgs)
-        }
-        String tlsDebug = System.getProperty("javax.net.debug");
-        if (tlsDebug?.trim()) {
-            jvmArgs = String.format("%s -Djavax.net.debug=%s", jvmArgs, tlsDebug)
-        }
-
-        if (Boolean.valueOf(System.getProperty("xcoveragerun"))) {
-            copy {
-                from(zipTree(configurations.getByName('jacocoAgent')
-                        .findAll { 'runtimeClasspath' }.get(0))
-                        .matching { include 'jacocoagent.jar' }.singleFile)
-                into(layout.buildDirectory.dir("jacoco"))
-            }
-
-            String jacocoBuildPath = layout.buildDirectory.dir("jacoco").get().asFile.path
-            jvmArgs = String.format(
-                    "%s -javaagent:%s/jacocoagent.jar=destfile=%s/cargo.exec",
-                    jvmArgs, jacocoBuildPath, jacocoBuildPath)
-        }
-
-        outputFile = file("uaa/build/reports/tests/uaa-server.log")
-        configFile {
-            files = files("scripts/cargo/tomcat-conf/context.xml")
-            toDir = "conf"
-        }
-
-        systemProperties {
-            property("SECRETS_DIR", System.getProperty("SECRETS_DIR", file("scripts/cargo").getAbsolutePath()))
-            property("spring.profiles.active", System.getProperty("spring.profiles.active", "hsqldb"))
-            property("metrics.perRequestMetrics", System.getProperty("metrics.perRequestMetrics", "true"))
-            property("smtp.host", "localhost")
-            property("smtp.port", 2525)
-            property("java.security.egd", "file:/dev/./urandom")
-        }
-
-        containerProperties {
-            property('cargo.tomcat.ajp.port', applicationPort + 20)
-        }
-
-        installer {
-            installUrl = "https://repo1.maven.org/maven2/org/apache/tomcat/tomcat/" + tomcatCargoVersion + "/tomcat-" + tomcatCargoVersion + ".tar.gz"
-            downloadDir = layout.buildDirectory.dir("download").get().asFile
-            extractDir = layout.buildDirectory.dir("extract").get().asFile
-        }
-    }
-}
-
 sonarqube {
     properties {
         property "sonar.projectKey", "cloudfoundry-identity-parent"
@@ -277,19 +186,8 @@ project.gradle.taskGraph.whenReady { TaskExecutionGraph graph ->
     }
 }
 
-//task declarations
-tasks.register('killUaa', Exec) {
-    workingDir './'
-    executable = 'scripts/kill_uaa.sh'
-}
-
-tasks.register('run') {
-    dependsOn killUaa
-    dependsOn cargoRunLocal
-}
-
 tasks.register('manifests', Copy) {
-    dependsOn assemble
+    dependsOn subprojects.assemble
     from("uaa/src/test/resources/sample-manifests") {
         include("**/*.yml")
         filter(ReplaceTokens,
@@ -303,39 +201,33 @@ tasks.register('manifests', Copy) {
     into("build/sample-manifests")
 }
 
-tasks.register('cleanCargoConfDir') {
-    delete(Path.of(System.getProperty("java.io.tmpdir"), "cargo", "uaa-${applicationPort}"))
-    try {
-        Files.createDirectory(Path.of(System.getProperty("java.io.tmpdir"), "uaa-${applicationPort}"))
-    } catch (ignored) {
-    }
-}
-
 tasks.register('integrationTest', Test) {
-    if (runCargoTests) {
-        dependsOn killUaa
-    }
     dependsOn subprojects.integrationTest
-    if (runCargoTests) {
-        finalizedBy cargoStopLocal
-    }
 }
 
-// Jacoco report from cargo run
-// - To record coverage of cargo run, execute the task with
-// `-Dxcoveragerun=true` option, then use this task to generate report from it.
-// - e.g. To generate coverage report of integration test:
-//   1) ./gradlew integrationTest -Dxcoveragerun=true
-//   2) ./bin/kill_uaa.sh
-//   3) ./gradlew jacocoCargoReport
-//   4) See the Gradle console output for the test coverage summary.
-//   5) See `build/reports/jacoco/jacocoCargoReport` for the full report.
-task jacocoCargoReport(type: JacocoReport) {
+// Jacoco coverage reports:
+//
+// For unit test coverage (recommended):
+//   ./gradlew test jacocoTestReport
+//   Reports in each module: <module>/build/reports/jacoco/test/html/index.html
+//
+// For aggregated coverage across all modules:
+//   ./gradlew test jacocoAggregatedReport
+//   Report: build/reports/jacoco/jacocoAggregatedReport/html/index.html
+//
+// Note: Integration test coverage (jacocoIntegrationReport) requires running
+// integration tests which need special setup (UAA server, database, LDAP).
+// Use ./run-integration-tests.sh for that purpose.
+tasks.register('jacocoCargoReport', JacocoReport) {
     def javaProjects = subprojects.findAll {
         it.pluginManager.hasPlugin('java')
     }
 
-    executionData(fileTree(layout.buildDirectory).include("jacoco/cargo.exec"))
+    // Collect execution data from all subprojects' integration tests
+    executionData(fileTree(layout.buildDirectory).include("jacoco/*.exec"))
+    javaProjects.each { subproject ->
+        executionData.from(fileTree(subproject.layout.buildDirectory).include("jacoco/integrationTest.exec"))
+    }
 
     FileTree sourceTree = files().asFileTree
     FileTree classTree = files().asFileTree
@@ -347,13 +239,6 @@ task jacocoCargoReport(type: JacocoReport) {
     additionalClassDirs = classTree
 }
 
-// task dependencies
-assemble.dependsOn(subprojects.assemble)
-test.dependsOn(subprojects.test)
-test.mustRunAfter(integrationTest)
-cargoStartLocal.dependsOn(assemble)
-cargoRunLocal.dependsOn(cleanCargoConfDir, assemble)
-
 tasks.register('cleanBootTomcatDir') {
     String tomcatBase = file("scripts/boot/tomcat/").getAbsolutePath()
     delete(java.nio.file.Path.of(tomcatBase))
@@ -363,16 +248,29 @@ tasks.register('cleanBootTomcatDir') {
 
 tasks.register('bootWarRun', JavaExec) {
     dependsOn cleanBootTomcatDir
-    dependsOn assemble
+    dependsOn subprojects.assemble
     classpath = files(file("uaa/build/libs/cloudfoundry-identity-uaa-0.0.0.war"))
     systemProperty("server.tomcat.basedir", file("scripts/boot/tomcat/").getAbsolutePath())
-    systemProperty("SECRETS_DIR", System.getProperty("SECRETS_DIR", file("scripts/cargo").getAbsolutePath()))
+    systemProperty("SECRETS_DIR", System.getProperty("SECRETS_DIR", file("scripts/boot").getAbsolutePath()))
     systemProperty("spring.profiles.active", System.getProperty("spring.profiles.active", "hsqldb"))
     systemProperty("metrics.perRequestMetrics", System.getProperty("metrics.perRequestMetrics", "true"))
     systemProperty("smtp.host", "localhost")
     systemProperty("smtp.port", 2525)
     systemProperty("java.security.egd", "file:/dev/./urandom")
-    systemProperty("CLOUDFOUNDRY_CONFIG_PATH", file("scripts/cargo").getAbsolutePath())
+    systemProperty("CLOUDFOUNDRY_CONFIG_PATH", file("scripts/boot").getAbsolutePath())
     systemProperty("server.servlet.context-path", "/uaa")
     systemProperty("statsd.enabled", "true")
+    systemProperty("logging.config", file("scripts/boot/log4j2.properties").getAbsolutePath())
+}
+
+tasks.register('killUaa', Exec) {
+    workingDir './'
+    executable = 'scripts/kill_uaa.sh'
+}
+
+tasks.register('run') {
+    dependsOn killUaa
+    dependsOn ':cloudfoundry-identity-uaa:bootRun'
+    description = "Kills any running UAA and starts the application"
+    group = "application"
 }