Merge pull request #369 from jmtd/OPENJDK-2009-JAVA_OPTS

[OPENJDK-2009] let JAVA_OPTS override all tuning parameters (ubi8)

Author: jmtd

modules/jvm/api/module.yaml

@@ -1,4 +1,5 @@
 schema_version: 1
+
 name: jboss.container.java.jvm.api
 version: '1.0'
 description: ^
@@ -7,12 +8,15 @@ description: ^
   variables listed within this module to configure the JVM appropriately.
 
 envs:
-- name: JAVA_OPTS
-  description: JVM options passed to the `java` command.
-  example: "-verbose:class"
-- name: JAVA_OPTS_APPEND
-  description: User specified Java options to be appended to generated options in JAVA_OPTS.
-  example: "-Dsome.property=foo"
+- name:         JAVA_OPTS
+  description:  If set, this prevents all default and generated options (such
+    as JVM and GC tuning, proxy settings, etc.) from being applied. Instead the
+    user should specify exactly the `java` options they want in this variable.
+  example:      "-verbose:class"
+- name:         JAVA_OPTS_APPEND
+  description:  User specified Java options to be appended to the generated options.
+    This variable has no effect if `JAVA_OPTS` has been defined.
+  example:      "-Dsome.property=foo"
 - name: JAVA_MAX_MEM_RATIO
   description:
     Specify the maximum heap memory. Corresponds to the JVM argument
@@ -69,8 +73,3 @@ envs:
 - name: GC_CONTAINER_OPTIONS
   description: specify Java GC to use. The value of this variable should contain the necessary JRE command-line options to specify the required GC, which will override the default of `-XX:+UseParallelGC`.
   example: -XX:+UseG1GC
-# deprecated
-- name: JAVA_OPTIONS
-  description: JVM options passed to the `java` command.  Use **JAVA_OPTS**.
-  example: "-verbose:class"
-

modules/run/artifacts/opt/jboss/container/java/run/run-java.sh

@@ -139,10 +139,12 @@ run_java_options() {
 
 # Combine all java options
 get_java_options() {
-  local java_opts
+  local jvm_opts
   local debug_opts
+  local proxy_opts
+  local opts
   if [ -f "${JBOSS_CONTAINER_JAVA_JVM_MODULE}/java-default-options" ]; then
-    java_opts=$(${JBOSS_CONTAINER_JAVA_JVM_MODULE}/java-default-options)
+    jvm_opts=$(${JBOSS_CONTAINER_JAVA_JVM_MODULE}/java-default-options)
   fi
   if [ -f "${JBOSS_CONTAINER_JAVA_JVM_MODULE}/debug-options" ]; then
     debug_opts=$(${JBOSS_CONTAINER_JAVA_JVM_MODULE}/debug-options)
@@ -151,8 +153,11 @@ get_java_options() {
     source "${JBOSS_CONTAINER_JAVA_PROXY_MODULE}/proxy-options"
     proxy_opts="$(proxy_options)"
   fi
-  # Normalize spaces with awk (i.e. trim and elimate double spaces)
-  echo "${JAVA_OPTS} $(run_java_options) ${debug_opts} ${proxy_opts} ${java_opts} ${JAVA_OPTS_APPEND}" | awk '$1=$1'
+
+  # S2I_RUN_OPTS may have been set externally, e.g. in s2i/run
+  opts=${JAVA_OPTS-$(run_java_options) ${S2I_RUN_OPTS} ${debug_opts} ${proxy_opts} ${jvm_opts} ${JAVA_OPTS_APPEND}}
+  # Normalize spaces with awk (i.e. trim and eliminate double spaces)
+  echo "${opts}" | awk '$1=$1'
 }
 
 # Read in a classpath either from a file with a single line, colon separated

modules/s2i/bash/artifacts/usr/local/s2i/run

@@ -17,14 +17,19 @@ if test -r "${JBOSS_CONTAINER_MAVEN_DEFAULT_MODULE}/scl-enable-maven"; then
     source "${JBOSS_CONTAINER_MAVEN_DEFAULT_MODULE}/scl-enable-maven"
 fi
 
-JAVA_OPTS="${JAVA_OPTS:-${JAVA_OPTIONS}}"
+if [ -z "${JAVA_OPTS+isunset}" ] && [ -n "${JAVA_OPTIONS+isset}" ]; then
+    JAVA_OPTS="$JAVA_OPTIONS"
+fi
+
 if [ -f "${JBOSS_CONTAINER_JOLOKIA_MODULE}/jolokia-opts" ]; then
     # Always include jolokia-opts, which can be empty if switched off via env
-    JAVA_OPTS="${JAVA_OPTS} $(${JBOSS_CONTAINER_JOLOKIA_MODULE}/jolokia-opts)"
+    S2I_RUN_OPTS="${S2I_RUN_OPTS} $(${JBOSS_CONTAINER_JOLOKIA_MODULE}/jolokia-opts)"
 fi
 if [ -f "${JBOSS_CONTAINER_PROMETHEUS_MODULE}/prometheus-opts" ]; then
-    JAVA_OPTS="${JAVA_OPTS} $(source ${JBOSS_CONTAINER_PROMETHEUS_MODULE}/prometheus-opts && get_prometheus_opts)"
+    S2I_RUN_OPTS="${S2I_RUN_OPTS} $(source ${JBOSS_CONTAINER_PROMETHEUS_MODULE}/prometheus-opts && get_prometheus_opts)"
 fi
+
+export S2I_RUN_OPTS
 export JAVA_OPTS
 export JAVA_OPTIONS="$JAVA_OPTS"
 

modules/s2i/bash/module.yaml

@@ -6,6 +6,14 @@ description: Customization of common Maven S2I for Java S2I image.
 envs:
 - name: JBOSS_CONTAINER_JAVA_S2I_MODULE
   value: /opt/jboss/container/java/s2i
+# deprecated
+- name: JAVA_OPTIONS
+  description:
+    If defined and `JAVA_OPTS` is not defined, use this value to
+    populate `JAVA_OPTS`, overriding any JVM tuning parameters
+    generated by the container run scripts.
+    Deprecated. Please use `JAVA_OPTS` instead.
+  example: "-verbose:class"
 
 execute:
 - script: configure.sh

tests/features/java/runtime.feature

@@ -42,3 +42,28 @@ Feature: Openshift OpenJDK Runtime tests
     | variable         | value   |
     | JAVA_APP_NAME    | foo bar |
   Then container log should not contain exec: bar': not found
+
+  @ubi8
+  Scenario: Check JAVA_OPTS overrides defaults (OPENJDK-2009)
+    Given container is started with env
+    | variable  | value          |
+    | JAVA_OPTS | --show-version |
+    Then container log should not contain -XX:MaxRAMPercentage
+
+  @ubi8
+  Scenario: Check empty JAVA_OPTS overrides defaults (OPENJDK-2009)
+    Given container is started with env
+    | variable  | value          |
+    | JAVA_OPTS |                |
+    Then container log should not contain -XX:MaxRAMPercentage
+
+  # builder images only
+  @ubi8/openjdk-8
+  @ubi8/openjdk-11
+  @ubi8/openjdk-17
+  Scenario: JAVA_OPTIONS sets JAVA_OPTS and overrides defaults (OPENJDK-2009)
+    Given container is started with env
+    | variable     | value          |
+    | JAVA_OPTIONS | --show-version |
+    Then container log should not contain -XX:MaxRAMPercentage
+    And  container log should contain --show-version