Add debug mode with -Pdebug and -Pdebugs

Author: duanemay

README.md

@@ -142,24 +142,23 @@ Running Spring Boot standalone allows us to run the integration tests against it
 
 To load JDWP agent for UAA jvm debugging, start the server as follows:
 ```sh
-./gradlew run -Dxdebug=true
-```
-or
-```sh
-./gradlew -Dspring.profiles.active=hsqldb,debug run
+./gradlew run -Pdebug
 ```
+
 You can then attach your debugger to port 5005 of the jvm process.
 
 To suspend the server start-up until the debugger is attached (useful for
 debugging start-up code), start the server as follows:
 ```sh
-./gradlew run -Dxdebugs=true
-```
-or
-```sh
-./gradlew -Dspring.profiles.active=hsqldb,debugs run
+./gradlew run -Pdebugs
 ```
+
 Note: You can also use `bootRun` instead of `run` for these commands.
+To change the port that the debug command listens on, set the `debugPort` property, as follows:
+
+```bash
+./gradlew run -Pdebug -PdebugPort=5006
+```
 
 ## Running a local UAA server with different databases
 `./gradlew run` (or `./gradlew bootRun`) runs the UAA server with hsqldb database by default.

build.gradle

@@ -244,6 +244,6 @@ tasks.register('killUaa', Exec) {
 tasks.register('run') {
     dependsOn killUaa
     dependsOn ':cloudfoundry-identity-uaa:bootRun'
-    description = "Kills any running UAA and starts the application"
+    description = "Kills any running UAA and starts the application. Use -Pdebug to enable debug mode (starts immediately) or -Pdebugs to enable debug mode with suspend (waits for debugger). Default port 5005, configurable with -PdebugPort=<port>"
     group = "application"
 }

scripts/debug_uaa.sh

@@ -4,23 +4,23 @@ export ORG_GRADLE_PROJECT_port=${PORT:-8080}
 echo "PORT: ${ORG_GRADLE_PROJECT_port}"
 
 if [ "${1:-}" == "-h" ]; then
-  echo USAGE: $0 [-h] [-s] [args]
+  echo "USAGE: $0 [-h] [-s] [-r] [-PdebugPort=<port>] [args]"
   echo "Run UAA in debug mode"
   echo "  -h: help"
   echo "  -s: suspend startup for debugging"
   echo "  -r: run UAA without debug mode"
+  echo "  -PdebugPort=<port>: set debug port, default 5005"
   exit 0
 fi
 
-DEBUG_FLAG="-Dxdebug=true"
+debug_flag="-Pdebug"
 if [ "${1:-}" == "-s" ]; then
-  DEBUG_FLAG="-Dxdebugs=true"
+  debug_flag="-Pdebugs"
   shift
 elif [ "${1:-}" == "-r" ]; then
-  DEBUG_FLAG=""
+  debug_flag=""
   shift
 fi
 
 cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd
-## scripts/kill_uaa.sh && \
-./gradlew run ${DEBUG_FLAG} "${@}"
+./gradlew run ${debug_flag} "${@}"

uaa/build.gradle

@@ -306,4 +306,16 @@ bootRun {
     systemProperty("CLOUDFOUNDRY_CONFIG_PATH", file("../scripts/boot").getAbsolutePath())
     systemProperty("server.servlet.context-path", "/uaa")
     systemProperty("statsd.enabled", "true")
+
+    // Enable debug mode if -Pdebug or -Pdebugs flag is provided
+    if (project.hasProperty('debug') || project.hasProperty('debugs')) {
+        def debugPort = project.findProperty('debugPort') ?: '5005'
+        // debugs = suspend and wait for debugger, debug = start immediately
+        def suspend = project.hasProperty('debugs') ? 'y' : 'n'
+        jvmArgs += [
+                "-agentlib:jdwp=transport=dt_socket,server=y,suspend=${suspend},address=*:${debugPort}"
+        ]
+        def mode = suspend == 'y' ? 'Suspended debug' : 'Debug'
+        logger.lifecycle("${mode} mode enabled. Listening on port ${debugPort}")
+    }
 }