Add WebLogic version and WebLogic patch checks - fail introspector job and pod startup for unsupported versions.

Author: Tom Barnes

operator/src/main/resources/scripts/introspectDomain.sh

@@ -58,6 +58,7 @@ export MW_HOME=${MW_HOME:-/u01/oracle}
 checkEnv DOMAIN_UID \
          NAMESPACE \
          DOMAIN_HOME \
+         ORACLE_HOME \
          JAVA_HOME \
          NODEMGR_HOME \
          WL_HOME \
@@ -70,14 +71,19 @@ for script_file in "${SCRIPTPATH}/wlst.sh" \
   [ ! -f "$script_file" ] && trace "Error: missing file '${script_file}'." && exit 1 
 done 
 
-for dir_var in DOMAIN_HOME JAVA_HOME WL_HOME MW_HOME; do
+for dir_var in DOMAIN_HOME JAVA_HOME WL_HOME MW_HOME ORACLE_HOME; do
   [ ! -d "${!dir_var}" ] && trace "Error: missing ${dir_var} directory '${!dir_var}'." && exit 1
 done
 
 # check DOMAIN_HOME for a config/config.xml, reset DOMAIN_HOME if needed
 
 exportEffectiveDomainHome || exit 1
 
+# check if we're using a supported WebLogic version
+# (the check  will log a message if it fails)
+
+checkWebLogicVersion || exit 1
+
 # start node manager
 
 trace "Starting node manager"

operator/src/main/resources/scripts/startServer.sh

@@ -175,6 +175,7 @@ checkEnv \
   DOMAIN_NAME \
   DOMAIN_HOME \
   NODEMGR_HOME \
+  ORACLE_HOME \
   SERVER_NAME \
   SERVICE_NAME \
   ADMIN_NAME \
@@ -190,6 +191,7 @@ trace "JAVA_OPTIONS=${JAVA_OPTIONS}"
 #
 # check DOMAIN_HOME for a config/config.xml, reset DOMAIN_HOME if needed:
 #
+
 exportEffectiveDomainHome || exitOrLoop
 
 #
@@ -202,6 +204,15 @@ if [ ! -f /weblogic-operator/introspector/boot.properties ]; then
   exitOrLoop
 fi
 
+#
+# Check if we're using a supported WebLogic version. The check  will
+# log a message if it fails.
+#
+
+if ! checkWebLogicVersion ; then
+  exitOrLoop
+fi
+
 #
 # Copy/update domain introspector files for the domain
 #

operator/src/main/resources/scripts/traceUtils.sh

@@ -164,3 +164,107 @@ function exportEffectiveDomainHome() {
   trace "Error: More than one config.xml found at DOMAIN_HOME/config/config.xml and DOMAIN_HOME/*/config/config.xml, DOMAIN_HOME='$DOMAIN_HOME': ${found_configs}. Configure your 'domainHome' setting in your WebLogic Operator Domain resource to reference a single WebLogic domain."
   return 1
 }
+
+
+# versionCmp
+#   Compares two wl versions $1 $2 up to the length of $2
+#     Expects form N.N.N.N
+#     Uses '0' for an N in $1 if $1 is shorter than $2
+#   echo "1"  if v1 >  v2
+#   echo "-1" if v1 <  v2
+#   echo "0"  if v1 == v2
+versionCmp()
+{
+  IFS='.' read -r -a v1_arr <<< "`echo $1`"
+  IFS='.' read -r -a v2_arr <<< "`echo $2`"
+
+  for i in "${!v2_arr[@]}"
+  do
+    [ ${v1_arr[i]:-0} -gt ${v2_arr[i]:-0} ] && echo "1" && return
+    [ ${v1_arr[i]:-0} -lt ${v2_arr[i]:-0} ] && echo "-1" && return
+  done
+  echo "0"
+}
+
+# versionGE
+#   return success if WL v1 >= v2
+versionGE()
+{
+  [ `versionCmp "$1" "$2"` -ge 0 ] && return 0
+  return 1
+}
+
+# versionEQ
+#   return success if v1 == v2
+versionEQ()
+{
+  [ `versionCmp "$1" "$2"` -eq 0 ] && return 0
+  return 1
+}
+
+# hasWebLogicPatches
+#   check for the given patch numbers in the install inventory, 
+#   and return 1 if not found
+#   - if we can't find the install inventory then we 
+#     assume the patch is there...
+#   - we parse the install inventory as this is far faster than
+#     using opatch or weblogic.version
+hasWebLogicPatches()
+{
+  local reg_file=$ORACLE_HOME/inventory/registry.xml
+  [ ! -f $reg_file ] && return 0
+  for pnum in "$@"; do
+    grep --silent "patch-id=\"$1\"" $reg_file || return 1
+  done
+}
+
+# getWebLogicVersion
+#   parse wl version from install inventory
+#   - if we can't get a version number then we return
+#     a high dummy version number that's sufficient
+#     to pass version checks "9999.9999.9999.9999"
+#   - we parse the install inventory as this is far faster than
+#     using opatch or weblogic.version
+getWebLogicVersion()
+{
+  local reg_file=$ORACLE_HOME/inventory/registry.xml
+
+  [ ! -f $reg_file ] && echo "9999.9999.9999.9999" && return
+
+  local wlver="`grep 'name="WebLogic Server".*version=' $reg_file \
+               | sed 's/.*version="\([0-9.]*\)".*/\1/g'`"
+
+  echo ${wlver:-"9999.9999.9999.9999"}
+}
+
+
+# checkWebLogicVersion
+#   check if the WL version is supported by the Operator
+#   - skip check if SKIP_WL_VERSION_CHECK = "true"
+#   - log an error if WL version < 12.2.1.3
+#   - log an error if WL version == 12.2.1.3 && patch 29135930 is missing
+#     - you can override the required 12.2.1.3 patches by exporting
+#       global WL12213REQUIREDPATCHES to an empty string or to other
+#       patch number(s)
+#   - return 1 if logged an error
+#   - return 0 otherwise
+checkWebLogicVersion()
+{
+  [ "$SKIP_WL_VERSION_CHECK" = "true" ] && return 0
+  local cur_wl_ver="`getWebLogicVersion`"
+  local exp_wl_ver="12.2.1.3" 
+  local exp_wl_12213_patches="${WL12213REQUIREDPATCHES:-"29135930"}"
+  if versionEQ "$cur_wl_ver" "12.2.1.3" ; then
+    if ! hasWebLogicPatches $exp_wl_12213_patches ; then
+      trace "Error: The Operator requires that WebLogic version '12.2.1.3' have patch '$exp_wl_12213_patches'. To bypass this check, set env var SKIP_WL_VERSION_CHECK to 'true'."
+      return 1
+    fi
+  fi
+  if versionGE "$cur_wl_ver" "${exp_wl_ver}" ; then
+    trace "Info: WebLogic version='$cur_wl_ver'. Version check passed. (The Operator requires WebLogic version '${exp_wl_ver}' or higher)."
+  else
+    trace "Error: WebLogic version='$cur_wl_ver' and the Operator requires WebLogic version '${exp_wl_ver}' or higher. To bypass this check, set env var SKIP_WL_VERSION_CHECK to 'true'."
+    return 1
+  fi
+  return 0
+}

src/integration-tests/introspector/introspectTest.sh

@@ -596,6 +596,54 @@ function checkOverrides() {
   fi
 }
 
+#############################################################################
+#
+# Check if wl version checks are working on the admin pod
+#
+
+function checkWLVersionChecks() {
+
+  trace "Info: Checking pod log for 'error' strings."
+
+  # Check for exactly 0 occurances of 'Error:' lines.
+  #   a version issue is reported as an 'error:' to the log
+  #   the awk expression below gets the tail of the log, everything after the last occurance of 'Starting WebLogic...'
+
+  linecount="`kubectl -n ${NAMESPACE} logs ${DOMAIN_UID}-${ADMIN_NAME} | awk '/.*Starting WebLogic server with command/ { buf = "" } { buf = buf "\n" $0 } END { print buf }' | grep -ci 'error:'`"
+  logstatus=0
+
+  if [ ! "$linecount" == "0" ]; then
+    trace "Error: The latest boot in 'kubectl -n ${NAMESPACE} logs ${DOMAIN_UID}-${ADMIN_NAME}' contains lines with the keyword 'error'."
+    logstatus=1
+  fi
+
+  # Copy version test file up to admin server and run it
+
+  local testscript="util_testwlversion.sh"
+  local outfile="$test_home/${testscript}.out"
+
+  trace "Info: Running version checks on admin-server, output file '$outfile'."
+
+  kubectl -n ${NAMESPACE} \
+    cp ${SCRIPTPATH}/${testscript} \
+       ${DOMAIN_UID}-${ADMIN_NAME}:/shared/${testscript} \
+    || exit 1
+
+  rm -f ${outfile}
+  kubectl exec -it ${DOMAIN_UID}-${ADMIN_NAME} \
+      /shared/${testscript} \
+      > ${outfile} 2>&1
+  status=$?
+
+  if [ $status -ne 0 ]; then
+    trace "Error: The version checks failed, see '${outfile}'."
+  fi
+
+  if [ $status -ne 0 ] || [ $logstatus -ne 0 ]; then
+    exit 1
+  fi
+}
+
 #############################################################################
 #
 # Check if datasource is working
@@ -675,6 +723,11 @@ deployPod ${MANAGED_SERVER_NAME_BASE?}1
 deploySinglePodService ${MANAGED_SERVER_NAME_BASE?}1 ${MANAGED_SERVER_PORT?} 30801
 waitForPod ${DOMAIN_UID}-${MANAGED_SERVER_NAME_BASE?}1
 
+# Check admin-server pod log for wl version errors and run some
+# tests on the life-cycle WL version checking code.
+
+checkWLVersionChecks
+
 # Check admin-server pod log and also call on-line WLST to check if
 # automatic and custom overrides are taking effect in the bean tree: