add option to control whether to activate or cancel the online update (#456)

Author: jshum2479

core/src/main/python/deploy.py

@@ -7,10 +7,10 @@
 import javaos as os
 import sys
 
-from java.io import IOException
+from java.io import IOException, PrintStream
 from java.lang import IllegalArgumentException
-from java.lang import IllegalStateException
-from java.lang import String
+from java.lang import String, System
+
 
 from oracle.weblogic.deploy.deploy import DeployException
 from oracle.weblogic.deploy.exception import BundleAwareException
@@ -35,6 +35,7 @@
 from wlsdeploy.tool.deploy import model_deployer
 from wlsdeploy.tool.validate.validator import Validator
 from wlsdeploy.tool.util import filter_helper
+from wlsdeploy.tool.util.string_output_stream import StringOutputStream
 from wlsdeploy.tool.util.wlst_helper import WlstHelper
 from wlsdeploy.util import cla_helper
 from wlsdeploy.util import getcreds
@@ -73,7 +74,8 @@
     CommandLineArgUtil.ADMIN_USER_SWITCH,
     CommandLineArgUtil.ADMIN_PASS_SWITCH,
     CommandLineArgUtil.USE_ENCRYPTION_SWITCH,
-    CommandLineArgUtil.PASSPHRASE_SWITCH
+    CommandLineArgUtil.PASSPHRASE_SWITCH,
+    CommandLineArgUtil.ROLLBACK_IF_RESTART_REQ_SWITCH
 ]
 
 
@@ -216,13 +218,13 @@ def __deploy(model, model_context, aliases):
     :raises DeployException: if an error occurs
     """
     if __wlst_mode == WlstModes.ONLINE:
-        __deploy_online(model, model_context, aliases)
+        ret_code = __deploy_online(model, model_context, aliases)
     else:
-        __deploy_offline(model, model_context, aliases)
-    return
+        ret_code = __deploy_offline(model, model_context, aliases)
+    return ret_code =
 
 
-def __deploy_online(model, model_context, aliases):
+    def __deploy_online(model, model_context, aliases):
     """
     Online deployment orchestration
     :param model: the model
@@ -254,9 +256,27 @@ def __deploy_online(model, model_context, aliases):
         __release_edit_session_and_disconnect()
         raise de
 
+    exit_code = 0
+
     try:
-        __wlst_helper.save()
-        __wlst_helper.activate()
+        # 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
+        #
+        __wlst_helper.enable_stdout()
+        sostream = StringOutputStream()
+        System.setOut(PrintStream(sostream))
+        restart_required = __wlst_helper.is_restart_required()
+        is_restartreq_output = sostream.get_string()
+        __wlst_helper.silence()
+        if model_context.is_rollback_if_restart_required() and restart_required:
+            __wlst_helper.cancel_edit()
+            __logger.severe('WLSDPLY_09015', is_restartreq_output)
+            exit_code = CommandLineArgUtil.PROG_ROLLBACK_IF_RESTART_EXIT_CODE
+        else:
+            __wlst_helper.save()
+            __wlst_helper.activate()
+            if restart_required:
+                exit_code = CommandLineArgUtil.PROG_RESTART_REQUIRED
     except BundleAwareException, ex:
         __release_edit_session_and_disconnect()
         raise ex
@@ -270,7 +290,7 @@ def __deploy_online(model, model_context, aliases):
         # to indicate a failure...just log the error since the process is going to exit anyway.
         __logger.warning('WLSDPLY-09009', _program_name, ex.getLocalizedMessage(), error=ex,
                          class_name=_class_name, method_name=_method_name)
-    return
+    return exit_code
 
 
 def __deploy_offline(model, model_context, aliases):
@@ -303,7 +323,7 @@ def __deploy_offline(model, model_context, aliases):
         # a failure...just log the error since the process is going to exit anyway.
         __logger.warning('WLSDPLY-09011', _program_name, ex.getLocalizedMessage(), error=ex,
                          class_name=_class_name, method_name=_method_name)
-    return
+    return 0
 
 
 def __release_edit_session_and_disconnect():
@@ -418,7 +438,7 @@ def main(args):
 
     try:
         model = Model(model_dictionary)
-        __deploy(model, model_context, aliases)
+        exit_code = __deploy(model, model_context, aliases)
     except DeployException, ex:
         __logger.severe('WLSDPLY-09015', _program_name, ex.getLocalizedMessage(), error=ex,
                         class_name=_class_name, method_name=_method_name)

core/src/main/python/update.py

@@ -7,9 +7,9 @@
 import javaos as os
 import sys
 
-from java.io import IOException
+from java.io import IOException, PrintStream
 from java.lang import IllegalArgumentException
-from java.lang import String
+from java.lang import String, System
 
 from oracle.weblogic.deploy.deploy import DeployException
 from oracle.weblogic.deploy.exception import BundleAwareException
@@ -36,6 +36,7 @@
 from wlsdeploy.tool.validate.validator import Validator
 from wlsdeploy.tool.util import filter_helper
 from wlsdeploy.tool.util.wlst_helper import WlstHelper
+from wlsdeploy.tool.util.string_output_stream import StringOutputStream
 from wlsdeploy.util import cla_helper
 from wlsdeploy.util import dictionary_utils
 from wlsdeploy.util import getcreds
@@ -45,7 +46,6 @@
 from wlsdeploy.util.cla_utils import CommandLineArgUtil
 from wlsdeploy.util.model import Model
 from wlsdeploy.util.model_context import ModelContext
-from wlsdeploy.util.model_translator import FileToPython
 from wlsdeploy.util.weblogic_helper import WebLogicHelper
 from wlsdeploy.util import model as model_helper
 
@@ -74,7 +74,8 @@
     CommandLineArgUtil.ADMIN_USER_SWITCH,
     CommandLineArgUtil.ADMIN_PASS_SWITCH,
     CommandLineArgUtil.USE_ENCRYPTION_SWITCH,
-    CommandLineArgUtil.PASSPHRASE_SWITCH
+    CommandLineArgUtil.PASSPHRASE_SWITCH,
+    CommandLineArgUtil.ROLLBACK_IF_RESTART_REQ_SWITCH
 ]
 
 
@@ -226,14 +227,14 @@ def __update(model, model_context, aliases):
     :raises DeployException: if an error occurs
     """
     if __wlst_mode == WlstModes.ONLINE:
-        __update_online(model, model_context, aliases)
+        ret_code = __update_online(model, model_context, aliases)
     else:
-        __update_offline(model, model_context, aliases)
+        ret_code = __update_offline(model, model_context, aliases)
 
     if os.environ.has_key('__WLSDEPLOY_STORE_MODEL__'):
         model_helper.persist_model(model_context, model)
-    return
 
+    return ret_code
 
 def __update_online(model, model_context, aliases):
     """
@@ -264,15 +265,33 @@ def __update_online(model, model_context, aliases):
     try:
         topology_updater = TopologyUpdater(model, model_context, aliases, wlst_mode=WlstModes.ONLINE)
         topology_updater.update()
-
         model_deployer.deploy_resources(model, model_context, aliases, wlst_mode=__wlst_mode)
     except DeployException, de:
         __release_edit_session_and_disconnect()
         raise de
 
+    exit_code = 0
+
     try:
-        __wlst_helper.save()
-        __wlst_helper.activate()
+        # 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
+        #
+
+        __wlst_helper.enable_stdout()
+        sostream = StringOutputStream()
+        System.setOut(PrintStream(sostream))
+        restart_required = __wlst_helper.is_restart_required()
+        is_restartreq_output = sostream.get_string()
+        __wlst_helper.silence()
+        if model_context.is_rollback_if_restart_required() and restart_required:
+            __wlst_helper.cancel_edit()
+            __logger.severe('WLSDPLY_09015', is_restartreq_output)
+            exit_code = CommandLineArgUtil.PROG_ROLLBACK_IF_RESTART_EXIT_CODE
+        else:
+            __wlst_helper.save()
+            __wlst_helper.activate()
+            if restart_required:
+                exit_code = CommandLineArgUtil.PROG_RESTART_REQUIRED
     except BundleAwareException, ex:
         __release_edit_session_and_disconnect()
         raise ex
@@ -286,7 +305,7 @@ def __update_online(model, model_context, aliases):
         # to indicate a failure...just log the error since the process is going to exit anyway.
         __logger.warning('WLSDPLY-09009', _program_name, ex.getLocalizedMessage(), error=ex,
                          class_name=_class_name, method_name=_method_name)
-    return
+    return exit_code
 
 
 def __update_offline(model, model_context, aliases):
@@ -322,7 +341,7 @@ def __update_offline(model, model_context, aliases):
         # a failure...just log the error since the process is going to exit anyway.
         __logger.warning('WLSDPLY-09011', _program_name, ex.getLocalizedMessage(), error=ex,
                          class_name=_class_name, method_name=_method_name)
-    return
+    return 0
 
 
 def __release_edit_session_and_disconnect():
@@ -437,7 +456,7 @@ def main(args):
 
     try:
         model = Model(model_dictionary)
-        __update(model, model_context, aliases)
+        exit_code = __update(model, model_context, aliases)
     except DeployException, ex:
         __logger.severe('WLSDPLY-09015', _program_name, ex.getLocalizedMessage(), error=ex,
                         class_name=_class_name, method_name=_method_name)

core/src/main/python/wlsdeploy/tool/util/string_output_stream.py

@@ -0,0 +1,25 @@
+"""
+Copyright (c) 2017, 2019, Oracle Corporation and/or its affiliates.  All rights reserved.
+Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+"""
+
+from java.io import OutputStream, ByteArrayOutputStream
+from java.lang import String
+
+"""
+ This class allows redirecting the stdout to a string array for wlst.
+"""
+class StringOutputStream(OutputStream):
+
+    def __init__(self):
+        self.stream = ByteArrayOutputStream()
+
+    def write(self,b,off,len):
+        self.stream.write(b,off,len)
+
+    def get_string(self):
+        output = String(self.stream.toByteArray())
+        if self.stream is not None:
+            self.stream.close()
+        return output
+

core/src/main/python/wlsdeploy/tool/util/wlst_helper.py

@@ -654,6 +654,9 @@ def undo(self):
             raise ex
         return
 
+    def cancel_edit(self):
+        wlst_helper.cancel_edit()
+
     def save(self):
         """
         Save the outstanding Weblogic Server configuration changes for the current edit session.
@@ -711,6 +714,15 @@ def silence(self):
         wlst_helper.silence()
         return
 
+    def enable_stdout(self):
+        """
+        Performs the wlst commands to enable stdout
+        """
+        _method_name = 'enable_stdout'
+        self.__logger.entering(class_name=self.__class_name, method_name=_method_name)
+        wlst_helper.enable_stdout()
+        return
+
     def set_if_needed(self, wlst_name, wlst_value, model_type, model_name, masked=False):
         """
         Set the WLST attribute to the specified value if the name and value are not None.
@@ -975,6 +987,13 @@ def domain_runtime(self):
             raise ex
         return
 
+    def is_restart_required(self):
+        """
+        Return if the update changes require restart of the domain or servers.
+        :return: true if the changes require restart
+        """
+        return wlst_helper.is_restart_required()
+
     def is_connected(self):
         """
         Determine if the wlst session is currently connected to the admin server.

core/src/main/python/wlsdeploy/util/cla_utils.py

@@ -57,6 +57,7 @@ class CommandLineArgUtil(object):
     ENCRYPT_MANUAL_SWITCH      = '-manual'
     # phony arg used as a key to store the password
     ONE_PASS_SWITCH            = '-password'
+    ROLLBACK_IF_RESTART_REQ_SWITCH = '-rollback_if_require_restart'
     USE_ENCRYPTION_SWITCH      = '-use_encryption'
     RUN_RCU_SWITCH             = '-run_rcu'
     TARGET_VERSION_SWITCH      = '-target_version'
@@ -80,6 +81,8 @@ class CommandLineArgUtil(object):
     HELP_EXIT_CODE                 = 100
     USAGE_ERROR_EXIT_CODE          = 99
     ARG_VALIDATION_ERROR_EXIT_CODE = 98
+    PROG_RESTART_REQUIRED          = 103
+    PROG_ROLLBACK_IF_RESTART_EXIT_CODE = 3
     PROG_ERROR_EXIT_CODE           = 2
     PROG_WARNING_EXIT_CODE         = 1
     PROG_OK_EXIT_CODE              = 0
@@ -410,6 +413,8 @@ def process_args(self, args, for_domain_create=False):
                     ex = self._get_out_of_args_exception(key)
                     self._logger.throwing(ex, class_name=self._class_name, method_name=method_name)
                     raise ex
+            elif self.is_rollback_if_restart_required_key(key):
+                self._add_arg(key, True)
             else:
                 ex = exception_helper.create_cla_exception('WLSDPLY-01601', self._program_name, key)
                 ex.setExitCode(self.USAGE_ERROR_EXIT_CODE)
@@ -1073,6 +1078,9 @@ def _validate_variable_properties_file_arg(self, value):
             raise ex
         return variables.getAbsolutePath()
 
+    def is_rollback_if_restart_required_key(self, key):
+        return self.ROLLBACK_IF_RESTART_REQ_SWITCH == key
+
     ###########################################################################
     # Helper methods                                                          #
     ###########################################################################

core/src/main/python/wlsdeploy/util/model_context.py

@@ -64,6 +64,7 @@ def __init__(self, program_name, arg_map):
         self._opss_wallet_passphrase = None
         self._opss_wallet = None
         self._validation_method = None
+        self._rollback_if_restart_required = None
 
         if CommandLineArgUtil.ORACLE_HOME_SWITCH in arg_map:
             self._oracle_home = arg_map[CommandLineArgUtil.ORACLE_HOME_SWITCH]
@@ -142,6 +143,9 @@ def __init__(self, program_name, arg_map):
         if CommandLineArgUtil.ONE_PASS_SWITCH in arg_map:
             self._encrypt_one_pass = arg_map[CommandLineArgUtil.ONE_PASS_SWITCH]
 
+        if CommandLineArgUtil.ROLLBACK_IF_RESTART_REQ_SWITCH in arg_map:
+            self._rollback_if_restart_required = arg_map[CommandLineArgUtil.ROLLBACK_IF_RESTART_REQ_SWITCH]
+
         if CommandLineArgUtil.USE_ENCRYPTION_SWITCH in arg_map:
             self._use_encryption = arg_map[CommandLineArgUtil.USE_ENCRYPTION_SWITCH]
 
@@ -277,6 +281,13 @@ def get_archive_file_name(self):
         """
         return self._archive_file_name
 
+    def is_rollback_if_restart_required(self):
+        """
+        Get the rollback if restart required
+        :return: true or false
+        """
+        return self._rollback_if_restart_required
+
     def get_opss_wallet(self):
         """
         Get the opss wallet.

core/src/main/python/wlsdeploy/util/wlst_helper.py

@@ -440,6 +440,18 @@ def get_cmo():
         _logger.exiting(class_name=_class_name, method_name=_method_name, result=wlst.cmo)
     return wlst.cmo
 
+def is_restart_required():
+    """
+    Return if the update changes require restart of the domain or servers.
+    :return: true if the changes require restart
+    """
+    return wlst.isRestartRequired()
+
+def cancel_edit():
+    """
+    Cancel current edit session
+    """
+    wlst.cancelEdit('y')
 
 def is_connected():
     """
@@ -694,6 +706,15 @@ def silence():
     wlst.WLS.getCommandExceptionHandler().setSilent(True)
 
 
+def enable_stdout():
+    """
+    Performs the wlst commands to enable stdout
+    """
+    wlst.WLS.setLogToStdOut(True)
+    wlst.WLS.setShowLSResult(True)
+    wlst.WLS_ON.setlogToStandardOut(True)
+
+
 def connect(username, password, url):
     """
     Connect WLST to a Weblogic Server instance at the provided url with the provided credentials.