Warning added for embedded = true mode (#1084)

venmanyarun · web-flow · commit f7eeb3050734 · 2026-05-15T10:53:24.000+05:30
* Warning added for embedded = true mode

* correcting runtime

* updating runtimeUrl to later version

* updating runtimeUrl to later version
diff --git a/docs/libertyExtensions.md b/docs/libertyExtensions.md
@@ -36,7 +36,7 @@ The following properties are supported for server configuration.
 | clean | boolean | 1.0 | Clean all cached information on server start up. It deletes every file in the `${wlp_output_dir}/logs`, `${wlp_output_dir}/workarea`, `${wlp_user_dir}/dropins` or `${wlp_user_dir}/apps`. The default value is `false`. Only used with the `libertyStart` and `libertyRun` tasks.                                                                                                                                                                                                                                                         | No |
 | configDirectory| File | 2.0 | Location of a server configuration directory to be used by the server instance. Configuration files and folder structure will be copied to the server instance. Files specified by other server extension properties will take precedence over files located in the configDirectory. The default value is `/src/main/liberty/config`.                                                                                                                                                                                                      | No|
 | defaultVar | Properties | 3.0 | Inline server variables that are written to the `configDropins/defaults/liberty-plugin-variable-config.xml` file in the server directory. The property name is used for the variable `name`, and the property value is used for the variable `defaultValue`. If you are using [dev container mode](libertyDev.md#libertydevc-task-container-mode), ensure to copy the configDropins/defaults folder into your container image.| No|
-| embedded | boolean | 2.7 | Whether the server is [embedded](https://www.ibm.com/support/knowledgecenter/SSD28V_9.0.0/com.ibm.websphere.wlp.core.doc/ae/twlp_extend_embed.html) in the Gradle JVM. If not, the server will run as a separate process. The default value is `false`. Only used with the `libertyStart`, `libertyRun` and `libertyStop` tasks.                                                                                                                                                                                                           | No |
+| embedded | boolean | 2.7 | Whether the server is [embedded](https://www.ibm.com/support/knowledgecenter/SSD28V_9.0.0/com.ibm.websphere.wlp.core.doc/ae/twlp_extend_embed.html) in the Gradle JVM. If not, the server will run as a separate process. The default value is `false`. Only used with the `libertyStart`, `libertyRun` and `libertyStop` tasks. **Note:** When using embedded mode with the Gradle daemon and `libertyRun`, the server will continue running in the daemon JVM after pressing Ctrl+C. Use `gradle libertyStop` or `gradle --stop` to stop the server. See [libertyRun](libertyRun.md#embedded-server-mode-with-gradle-daemon) for more details. | No |
 | env | Properties | 3.0 | Inline server environment variables that are written to the server.env file in the server directory. These properties take precedence over a specified server.env file.                                                                                                                                                                                                                                                                                                                                                                    | No|
 | jvmOptions| List | 2.0 | Inline `List` of jvm options that is written to the jvm.options file in the server directory. These properties take precedence over a specified jvm.options file.                                                                                                                                                                                                                                                                                                                                                                          | No|
 | jvmOptionsFile| File | 2.0 | Location of the file containing JVM options to copy to the jvm.options file in the server instance.                                                                                                                                                                                                                                                                                                                                                                                                                                        | No|
diff --git a/docs/libertyRun.md b/docs/libertyRun.md
@@ -10,9 +10,22 @@ gradle libertyRun --no-daemon
 `libertyRun` also depends on `deploy` if configured.  
 
 ### What is the Gradle Daemon and why --no-daemon?
-The Gradle Daemon is a long-running background process designed to help speed up the build process. It does so by caching project information and staying alive, avoiding constant JVM startup costs. This behavior is default until specified otherwise.  
-Gradle's current daemon design makes it difficult to use a `run` task, as a Ctrl-C would kill the daemon while simultaneously leaving the application running in the background. Therefore, we need `--no-daemon` so that the signal can be received and properly handled.  
-In the event that a user does run a `libertyRun` with a daemon (default), an external `libertyStop` must be called in order to properly shut down the server. A Ctrl-C while the Gradle process is running will not stop the server. Use `libertyStatus` to confirm the state of your server.  
+The Gradle Daemon is a long-running background process designed to help speed up the build process. It does so by caching project information and staying alive, avoiding constant JVM startup costs. This behavior is default until specified otherwise.
+Gradle's current daemon design makes it difficult to use a `run` task, as a Ctrl-C would kill the daemon while simultaneously leaving the application running in the background. Therefore, we need `--no-daemon` so that the signal can be received and properly handled.
+In the event that a user does run a `libertyRun` with a daemon (default), an external `libertyStop` must be called in order to properly shut down the server. A Ctrl-C while the Gradle process is running will not stop the server. Use `libertyStatus` to confirm the state of your server.
+
+### Embedded Server Mode with Gradle Daemon
+When using `embedded = true` in the Liberty server configuration along with the Gradle daemon, the Liberty server runs within the daemon JVM. This creates an additional complication:
+- Pressing Ctrl-C terminates the client connection but **not** the daemon JVM
+- The embedded Liberty server continues running in the daemon JVM
+- The shutdown hook registered by the plugin does not execute because the daemon JVM remains alive
+
+**Workarounds:**
+1. Use `gradle libertyStop` to stop the embedded server
+2. Use `gradle --stop` to stop the entire Gradle daemon (which will also stop the embedded server)
+3. Use `--no-daemon` flag when running `libertyRun` to avoid this issue entirely
+
+**Recommendation:** For embedded server mode, it is strongly recommended to use `--no-daemon` or avoid using embedded mode with the daemon.
 
 ### 0% or 66% Executing?
 While running this task, Gradle will show something like:  
diff --git a/src/main/groovy/io/openliberty/tools/gradle/tasks/RunTask.groovy b/src/main/groovy/io/openliberty/tools/gradle/tasks/RunTask.groovy
@@ -52,6 +52,13 @@ class RunTask extends AbstractServerTask {
             ServerTask serverTaskRun = createServerTask(project, "run");
             serverTaskRun.setUseEmbeddedServer(server.embedded)
             serverTaskRun.setClean(server.clean)
+            
+            // When using embedded mode with Gradle daemon, the shutdown hook may not execute on Ctrl+C
+            // because the daemon JVM continues running. Warn the user about this limitation.
+            logger.warn("Starting Liberty server in embedded mode. Note: When using the Gradle daemon, " +
+                       "the server may continue running after pressing Ctrl+C. " +
+                       "Use 'gradle libertyStop' to stop the server or 'gradle --stop' to stop the daemon.")
+            
             serverTaskRun.execute();
         } else {
             List<String> command = buildCommand("run")
diff --git a/src/test/groovy/io/openliberty/tools/gradle/InstallLiberty_runtimeUrl_upToDate_Test.groovy b/src/test/groovy/io/openliberty/tools/gradle/InstallLiberty_runtimeUrl_upToDate_Test.groovy
@@ -41,7 +41,7 @@ class InstallLiberty_runtimeUrl_upToDate_Test extends AbstractIntegrationTest{
 
     @Test
     public void test_installLiberty_upToDate() {
-        assert runTaskCheckForUpToDate(buildDir, 'installLiberty', "-PlibertyRuntimeUrl=https://public.dhe.ibm.com/ibmdl/export/pub/software/openliberty/runtime/release/2021-01-13_1459/openliberty-javaee8-21.0.0.1.zip")
-        assertFalse runTaskCheckForUpToDate(buildDir, 'installLiberty', "-PlibertyRuntimeUrl=https://public.dhe.ibm.com/ibmdl/export/pub/software/openliberty/runtime/release/2021-02-09_1100/openliberty-javaee8-21.0.0.2.zip")
+        assert runTaskCheckForUpToDate(buildDir, 'installLiberty', "-PlibertyRuntimeUrl=https://public.dhe.ibm.com/ibmdl/export/pub/software/openliberty/runtime/release/25.0.0.12/openliberty-javaee8-25.0.0.12.zip")
+        assertFalse runTaskCheckForUpToDate(buildDir, 'installLiberty', "-PlibertyRuntimeUrl=https://public.dhe.ibm.com/ibmdl/export/pub/software/openliberty/runtime/release/26.0.0.3/openliberty-javaee8-26.0.0.3.zip")
     }
 }
diff --git a/src/test/resources/liberty-test/installLiberty_upToDate_runtimeUrl_Test.gradle b/src/test/resources/liberty-test/installLiberty_upToDate_runtimeUrl_Test.gradle
@@ -14,7 +14,7 @@ buildscript {
 apply plugin: 'liberty'
 
 ext {
-    libertyRuntimeUrl = project.hasProperty('libertyRuntimeUrl') ? project.getProperty('libertyRuntimeUrl') : "https://public.dhe.ibm.com/ibmdl/export/pub/software/openliberty/runtime/release/2021-01-13_1459/openliberty-javaee8-21.0.0.1.zip"
+    libertyRuntimeUrl = project.hasProperty('libertyRuntimeUrl') ? project.getProperty('libertyRuntimeUrl') : "https://public.dhe.ibm.com/ibmdl/export/pub/software/openliberty/runtime/release/25.0.0.12/openliberty-javaee8-25.0.0.12.zip"
 }
 
 
diff --git a/src/test/resources/sample.springboot3/test_spring_boot_classifier_apps_30_no_feature.gradle b/src/test/resources/sample.springboot3/test_spring_boot_classifier_apps_30_no_feature.gradle
@@ -32,7 +32,7 @@ repositories {
 dependencies {
 	implementation("org.springframework.boot:spring-boot-starter-web:${springBootVersion}")
 	testImplementation('org.springframework.boot:spring-boot-starter-test')
-	libertyRuntime group: 'com.ibm.websphere.appserver.runtime', name: 'wlp-jakartaee10', version: '23.0.0.10'
+	libertyRuntime group: 'com.ibm.websphere.appserver.runtime', name: 'wlp-kernel', version: runtimeVersion
 }
 
 bootJar {

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ class InstallLiberty_runtimeUrl_upToDate_Test extends AbstractIntegrationTest{`
`41`	`41`
`42`	`42`	`@Test`
`43`	`43`	`public void test_installLiberty_upToDate() {`
`44`		`- assert runTaskCheckForUpToDate(buildDir, 'installLiberty', "-PlibertyRuntimeUrl=https://public.dhe.ibm.com/ibmdl/export/pub/software/openliberty/runtime/release/2021-01-13_1459/openliberty-javaee8-21.0.0.1.zip")`
`45`		`- assertFalse runTaskCheckForUpToDate(buildDir, 'installLiberty', "-PlibertyRuntimeUrl=https://public.dhe.ibm.com/ibmdl/export/pub/software/openliberty/runtime/release/2021-02-09_1100/openliberty-javaee8-21.0.0.2.zip")`
	`44`	`+ assert runTaskCheckForUpToDate(buildDir, 'installLiberty', "-PlibertyRuntimeUrl=https://public.dhe.ibm.com/ibmdl/export/pub/software/openliberty/runtime/release/25.0.0.12/openliberty-javaee8-25.0.0.12.zip")`
	`45`	`+ assertFalse runTaskCheckForUpToDate(buildDir, 'installLiberty', "-PlibertyRuntimeUrl=https://public.dhe.ibm.com/ibmdl/export/pub/software/openliberty/runtime/release/26.0.0.3/openliberty-javaee8-26.0.0.3.zip")`
`46`	`46`	`}`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ buildscript {`
`14`	`14`	`apply plugin: 'liberty'`
`15`	`15`
`16`	`16`	`ext {`
`17`		`- libertyRuntimeUrl = project.hasProperty('libertyRuntimeUrl') ? project.getProperty('libertyRuntimeUrl') : "https://public.dhe.ibm.com/ibmdl/export/pub/software/openliberty/runtime/release/2021-01-13_1459/openliberty-javaee8-21.0.0.1.zip"`
	`17`	`+ libertyRuntimeUrl = project.hasProperty('libertyRuntimeUrl') ? project.getProperty('libertyRuntimeUrl') : "https://public.dhe.ibm.com/ibmdl/export/pub/software/openliberty/runtime/release/25.0.0.12/openliberty-javaee8-25.0.0.12.zip"`
`18`	`18`	`}`
`19`	`19`
`20`	`20`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ repositories {`
`32`	`32`	`dependencies {`
`33`	`33`	`implementation("org.springframework.boot:spring-boot-starter-web:${springBootVersion}")`
`34`	`34`	`testImplementation('org.springframework.boot:spring-boot-starter-test')`
`35`		`- libertyRuntime group: 'com.ibm.websphere.appserver.runtime', name: 'wlp-jakartaee10', version: '23.0.0.10'`
	`35`	`+ libertyRuntime group: 'com.ibm.websphere.appserver.runtime', name: 'wlp-kernel', version: runtimeVersion`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`bootJar {`