Wdt 412 (#616)

jshum2479 · web-flow · commit 97d8ff11f357 · 2020-04-30T13:57:46.000-05:00
* fix missing return code for online update after refactoring

* rename function

* correct logic

* add return code to share.sh

* update documentation with new return code

* correct side effect after calling setServerGroups

* add doc and update script

* remove 101, 102 return code, no where is returning it

* Add online system tests

* remove unused test and increase start server time

* Remove fake network channel
diff --git a/core/src/main/python/update.py b/core/src/main/python/update.py
@@ -144,11 +144,25 @@ def __update_online(model, model_context, aliases):
         __release_edit_session_and_disconnect()
         raise de
 
-    exit_code = 0
-
+    # Server or Cluster may be added, this is to make sure they are targeted properly
     topology_updater.set_server_groups()
-    __update_online_domain(model_context)
-    model_deployer.deploy_applications(model, model_context, aliases, wlst_mode=__wlst_mode)
+
+    # Calling set_server_groups has a side effect, it throws itself out of the edit tree.
+    # If it is not in edit tree then save in
+    #  __check_update_require_domain_restart will fail
+    #  Restart the edit session to compensate
+
+    try:
+        __wlst_helper.edit()
+        __wlst_helper.start_edit()
+    except BundleAwareException, ex:
+        raise ex
+
+    exit_code = __check_update_require_domain_restart(model_context)
+    # if user requested rollback if restart required stops
+
+    if exit_code != CommandLineArgUtil.PROG_ROLLBACK_IF_RESTART_EXIT_CODE:
+        model_deployer.deploy_applications(model, model_context, aliases, wlst_mode=__wlst_mode)
 
     try:
         __wlst_helper.disconnect()
@@ -160,7 +174,8 @@ def __update_online(model, model_context, aliases):
     return exit_code
 
 
-def __update_online_domain(model_context):
+def __check_update_require_domain_restart(model_context):
+    exit_code = 0
     try:
         # First we enable the stdout again and then redirect the stdoout to a string output stream
         # call isRestartRequired to get the output, capture the string and then silence wlst output again
@@ -185,6 +200,8 @@ def __update_online_domain(model_context):
         __release_edit_session_and_disconnect()
         raise ex
 
+    return exit_code
+
 
 def __update_offline(model, model_context, aliases):
     """
diff --git a/core/src/main/python/wlsdeploy/util/cla_utils.py b/core/src/main/python/wlsdeploy/util/cla_utils.py
@@ -102,7 +102,7 @@ class CommandLineArgUtil(object):
     USAGE_ERROR_EXIT_CODE          = 99
     ARG_VALIDATION_ERROR_EXIT_CODE = 98
     PROG_RESTART_REQUIRED          = 103
-    PROG_ROLLBACK_IF_RESTART_EXIT_CODE = 3
+    PROG_ROLLBACK_IF_RESTART_EXIT_CODE = 104
     PROG_ERROR_EXIT_CODE           = 2
     PROG_WARNING_EXIT_CODE         = 1
     PROG_OK_EXIT_CODE              = 0
diff --git a/installer/src/main/bin/deployApps.cmd b/installer/src/main/bin/deployApps.cmd
@@ -77,6 +77,7 @@ ECHO              [-model_file ^<model_file^>]
 ECHO              [-variable_file ^<variable_file^>]
 ECHO              [-domain_type ^<domain_type^>]
 ECHO              [-wlst_path ^<wlst_path^>]
+ECHO              [-rollback_if_require_restart]
 ECHO              [-admin_url ^<admin_url^>
 ECHO               -admin_user ^<admin_user^>
 ECHO              ]
@@ -110,6 +111,8 @@ ECHO         admin_url       - the admin server URL (used for online deploy)
 ECHO.
 ECHO         admin_user      - the admin username (used for online deploy)
 ECHO.
+ECHO         rollback_if_require_restart      - rollback the changes if the update requires domain restart
+ECHO.
 ECHO    The -use_encryption switch tells the program that one or more of the
 ECHO    passwords in the model or variables files are encrypted.  The program will
 ECHO    prompt for the decryption passphrase to use to decrypt the passwords.
diff --git a/installer/src/main/bin/deployApps.sh b/installer/src/main/bin/deployApps.sh
@@ -38,6 +38,7 @@ usage() {
   echo "          [-variable_file <variable_file>]"
   echo "          [-domain_type <domain_type>]"
   echo "          [-wlst_path <wlst_path>]"
+  echo "          [-rollback_if_require_restart]"
   echo "          [-admin_url <admin_url>"
   echo "           -admin_user <admin_user>"
   echo "          ]"
@@ -71,6 +72,8 @@ usage() {
   echo ""
   echo "        admin_user      - the admin username (used for online deploy)"
   echo ""
+  echo "        rollback_if_require_restart      - rollback the changes if the update requires domain restart"
+  echo ""
   echo "    The -use_encryption switch tells the program that one or more of the"
   echo "    passwords in the model or variables files are encrypted.  The program will"
   echo "    prompt for the decryption passphrase to use to decrypt the passwords."
diff --git a/installer/src/main/bin/shared.cmd b/installer/src/main/bin/shared.cmd
@@ -300,19 +300,14 @@ GOTO :EOF
 
     SET RETURN_CODE=%1
 
-    IF "%RETURN_CODE%" == "103" (
+    IF "%RETURN_CODE%" == "104" (
       ECHO.
-      ECHO %SCRIPT_NAME% completed successfully but the domain requires a restart for the changes to take effect ^(exit code = %RETURN_CODE%^)
+      ECHO %SCRIPT_NAME% completed successfully but the domain changes have been rolled back because -rollback_if_require_restart is specified  ^(exit code = %RETURN_CODE%^)
       EXIT /B %RETURN_CODE%
     )
-    IF "%RETURN_CODE%" == "102" (
-      ECHO.
-      ECHO %SCRIPT_NAME% completed successfully but the affected servers require a restart ^(exit code = %RETURN_CODE%^)
-      EXIT /B %RETURN_CODE%
-    )
-    IF "%RETURN_CODE%" == "101" (
+    IF "%RETURN_CODE%" == "103" (
       ECHO.
-      ECHO %SCRIPT_NAME% was unable to complete due to configuration changes that require a domain restart.  Please restart the domain and re-invoke the %SCRIPT_NAME% script with the same arguments ^(exit code = %RETURN_CODE%^)
+      ECHO %SCRIPT_NAME% completed successfully but the domain requires a restart for the changes to take effect ^(exit code = %RETURN_CODE%^)
       EXIT /B %RETURN_CODE%
     )
     IF "%RETURN_CODE%" == "100" (
diff --git a/installer/src/main/bin/shared.sh b/installer/src/main/bin/shared.sh
@@ -274,15 +274,12 @@ checkExitCode() {
 
     returnCode=$1
 
-    if [ $returnCode -eq 103 ]; then
+    if [ $returnCode -eq 104 ]; then
       echo ""
-      echo "$scriptName completed successfully but the domain requires a restart for the changes to take effect (exit code = ${RETURN_CODE})"
-    elif [ $returnCode -eq 102 ]; then
-      echo ""
-      echo "$scriptName completed successfully but the affected servers require a restart (exit code = ${RETURN_CODE})"
-    elif [ $returnCode -eq 101 ]; then
+      echo "$scriptName completed successfully but the domain changes have been rolled back because -rollback_if_require_restart is specified (exit code = ${RETURN_CODE})"
+    elif [ $returnCode -eq 103 ]; then
       echo ""
-      echo "$scriptName was unable to complete due to configuration changes that require a domain restart.  Please restart the domain and re-invoke the $scriptName script with the same arguments (exit code = ${RETURN_CODE})"
+      echo "$scriptName completed successfully but the domain requires a restart for the changes to take effect (exit code = ${RETURN_CODE})"
     elif [ $returnCode -eq 100 ]; then
       usage `basename $0`
     elif [ $returnCode -eq 99 ]; then
diff --git a/installer/src/main/bin/updateDomain.cmd b/installer/src/main/bin/updateDomain.cmd
@@ -77,6 +77,7 @@ ECHO              [-model_file ^<model_file^>]
 ECHO              [-variable_file ^<variable_file^>]
 ECHO              [-domain_type ^<domain_type^>]
 ECHO              [-wlst_path ^<wlst_path^>]
+ECHO              [-rollback_if_require_restart]
 ECHO              [-admin_url ^<admin_url^>
 ECHO               -admin_user ^<admin_user^>
 ECHO              ]
@@ -110,6 +111,8 @@ ECHO         admin_url       - the admin server URL (used for online deploy)
 ECHO.
 ECHO         admin_user      - the admin username (used for online deploy)
 ECHO.
+ECHO         rollback_if_require_restart      - rollback the changes if the update requires domain restart
+ECHO.
 ECHO    The -use_encryption switch tells the program that one or more of the
 ECHO    passwords in the model or variables files are encrypted.  The program will
 ECHO    prompt for the decryption passphrase to use to decrypt the passwords.
diff --git a/installer/src/main/bin/updateDomain.sh b/installer/src/main/bin/updateDomain.sh
@@ -38,6 +38,7 @@ usage() {
   echo "          [-variable_file <variable_file>]"
   echo "          [-domain_type <domain_type>]"
   echo "          [-wlst_path <wlst_path>]"
+  echo "          [-rollback_if_require_restart]"
   echo "          [-admin_url <admin_url>"
   echo "           -admin_user <admin_user>"
   echo "          ]"
@@ -71,6 +72,8 @@ usage() {
   echo ""
   echo "        admin_user      - the admin username (used for online deploy)"
   echo ""
+  echo "        rollback_if_require_restart      - rollback the changes if the update requires domain restart"
+  echo ""
   echo "    The -use_encryption switch tells the program that one or more of the"
   echo "    passwords in the model or variables files are encrypted.  The program will"
   echo "    prompt for the decryption passphrase to use to decrypt the passwords."
diff --git a/site/deploy.md b/site/deploy.md
@@ -25,9 +25,8 @@ As usual, the tool will prompt for the password (it can also be supplied by pipi
 
 When running the tool in WLST online mode, the deploy operation may require server restarts or a domain restart to pick up the changes.  The deploy operation can also encounter situations where it cannot complete its operation until the domain is restarted.  To communicate these conditions to scripts that may be calling the Deploy Applications Tool, the shell scripts have three special, non-zero exit codes to communicate these states:
 
-- `101` - The domain needs to be restarted and the Deploy Applications Tool needs to be re-invoked with the same arguments.
-- `102` - The servers impacted by the deploy operation need to be restarted, in a rolling fashion, starting with the Administration Server, if applicable.
 - `103` - The entire domain needs to be restarted.
+- `104` - The domain changes have been rolled back because the changes in the model requires a domain restart and -rollback_if_require_restart is specified.
 
 ### Using Multiple Models
 
diff --git a/site/update.md b/site/update.md
@@ -20,9 +20,8 @@ The Update Domain Tool will not attempt to recreate or add schemas for the RCU d
 
 When running the tool in WLST online mode, the update operation may require server restarts or a domain restart to pick up the changes.  The update operation can also encounter situations where it cannot complete its operation until the domain is restarted.  To communicate these conditions to scripts that may be calling the Update Domain Tool, the shell scripts have three special, non-zero exit codes to communicate these states:
 
-- `101` - The domain needs to be restarted and the Update Domain Tool needs to be re-invoked with the same arguments.
-- `102` - The servers impacted by the update operation need to be restarted, in a rolling fashion, starting with the Administration Server, if applicable.
 - `103` - The entire domain needs to be restarted.
+- `104` - The domain changes have been rolled back because the changes in the model requires a domain restart and -rollback_if_require_restart is specified.
 
 ### Using Multiple Models
 
diff --git a/system-test/src/test/java/oracle/weblogic/deploy/integration/BaseTest.java b/system-test/src/test/java/oracle/weblogic/deploy/integration/BaseTest.java
@@ -155,6 +155,7 @@ protected void verifyResult(ExecResult result, String matchString) throws Except
         if(result.exitValue() != 0 || !result.stdout().contains(matchString)) {
             logger.info("DEBUG: result.exitValue=" + result.exitValue());
             logger.info("DEBUG: result.stdout=" + result.stdout());
+            System.exit(0);
             throw new Exception("result stdout does not contains the expected string: " + matchString);
         }
     }
diff --git a/system-test/src/test/java/oracle/weblogic/deploy/integration/ITWdt.java b/system-test/src/test/java/oracle/weblogic/deploy/integration/ITWdt.java
diff --git a/system-test/src/test/resources/simple-topology-onlineUpdate.yaml b/system-test/src/test/resources/simple-topology-onlineUpdate.yaml
diff --git a/system-test/src/test/resources/simple-topology-onlineUpdate2.yaml b/system-test/src/test/resources/simple-topology-onlineUpdate2.yaml
diff --git a/system-test/src/test/resources/simple-topology2.yaml b/system-test/src/test/resources/simple-topology2.yaml
