Allow user to undo any current edit session (#731)

* Add option to undo existing edit session

* update shell script for undo current edit

* Add info message if there are outstanding edit but undo by -undo_current_edit

* undo edit also for deploy

* rename undo_current_edit to discard_current_edit

Author: jshum2479

core/src/main/python/deploy.py

@@ -62,6 +62,7 @@
     CommandLineArgUtil.ADMIN_PASS_SWITCH,
     CommandLineArgUtil.USE_ENCRYPTION_SWITCH,
     CommandLineArgUtil.PASSPHRASE_SWITCH,
+    CommandLineArgUtil.DISCARD_CURRENT_EDIT_SWITCH,
     CommandLineArgUtil.ROLLBACK_IF_RESTART_REQ_SWITCH
 ]
 
@@ -121,9 +122,11 @@ def __deploy_online(model, model_context, aliases):
 
     try:
         __wlst_helper.connect(admin_user, admin_pwd, admin_url)
-        deployer_utils.ensure_no_uncommitted_changes_or_edit_sessions()
+        deployer_utils.ensure_no_uncommitted_changes_or_edit_sessions(model_context.is_discard_current_edit())
         __wlst_helper.edit()
         __wlst_helper.start_edit()
+        if model_context.is_discard_current_edit():
+            deployer_utils.discard_current_edit()
     except BundleAwareException, ex:
         raise ex
 

core/src/main/python/update.py

@@ -65,7 +65,8 @@
     CommandLineArgUtil.USE_ENCRYPTION_SWITCH,
     CommandLineArgUtil.PASSPHRASE_SWITCH,
     CommandLineArgUtil.ROLLBACK_IF_RESTART_REQ_SWITCH,
-    CommandLineArgUtil.UPDATE_RCU_SCHEMA_PASS_SWITCH
+    CommandLineArgUtil.UPDATE_RCU_SCHEMA_PASS_SWITCH,
+    CommandLineArgUtil.DISCARD_CURRENT_EDIT_SWITCH
 ]
 
 
@@ -125,9 +126,11 @@ def __update_online(model, model_context, aliases):
 
     try:
         __wlst_helper.connect(admin_user, admin_pwd, admin_url)
-        deployer_utils.ensure_no_uncommitted_changes_or_edit_sessions()
+        deployer_utils.ensure_no_uncommitted_changes_or_edit_sessions(model_context.is_discard_current_edit())
         __wlst_helper.edit()
         __wlst_helper.start_edit()
+        if model_context.is_discard_current_edit():
+            deployer_utils.discard_current_edit()
     except BundleAwareException, ex:
         raise ex
 

core/src/main/python/wlsdeploy/tool/deploy/applications_deployer.py

@@ -71,7 +71,7 @@ def deploy(self):
             self.__add_shared_libraries()
             self.__add_applications()
         else:
-            deployer_utils.ensure_no_uncommitted_changes_or_edit_sessions()
+            deployer_utils.ensure_no_uncommitted_changes_or_edit_sessions(self.model_context.is_discard_current_edit())
             self.__online_deploy_apps_and_libs(self._base_location)
         return
 

core/src/main/python/wlsdeploy/tool/deploy/deployer_utils.py

@@ -258,7 +258,7 @@ def delete_named_element(location, delete_name, existing_names, aliases):
         _wlst_helper.delete(name, type_name)
 
 
-def ensure_no_uncommitted_changes_or_edit_sessions():
+def ensure_no_uncommitted_changes_or_edit_sessions(ignoreEditSessionCheck=False):
     """
     Ensure that the domain does not contain any uncommitted changes and there is no existing edit session.
     :raises: DeployException: if there are any uncommitted changes, existing edit sessions, or a WLST error occurs
@@ -277,12 +277,12 @@ def ensure_no_uncommitted_changes_or_edit_sessions():
             _logger.throwing(ex, class_name=_class_name, method_name=_method_name)
             raise ex
 
-        if unactivated_changes:
+        if unactivated_changes and not ignoreEditSessionCheck:
             ex = exception_helper.create_deploy_exception('WLSDPLY-09103')
             _logger.throwing(ex, class_name=_class_name, method_name=_method_name)
             raise ex
 
-        if current_editor is not None:
+        if current_editor is not None and not ignoreEditSessionCheck:
             ex = exception_helper.create_deploy_exception('WLSDPLY-09104', str(current_editor))
             _logger.throwing(ex, class_name=_class_name, method_name=_method_name)
             raise ex
@@ -293,6 +293,28 @@ def ensure_no_uncommitted_changes_or_edit_sessions():
     _logger.exiting(class_name=_class_name, method_name=_method_name)
     return
 
+def discard_current_edit():
+    """
+    Undo any current edit that may have left.
+    :raises: DeployException: if there are any wlst errors
+    """
+    _method_name = 'discard_current_edit'
+
+    _logger.entering(class_name=_class_name, method_name=_method_name)
+    try:
+        cmgr = _wlst_helper.get_config_manager()
+        unactivated_changes = _wlst_helper.have_unactivated_changes(cmgr)
+
+        if unactivated_changes:
+            _logger.info("WLSDPLY-09016")
+            cmgr.undoUnactivatedChanges()
+
+    except PyWLSTException, e:
+        ex = exception_helper.create_deploy_exception('WLSDPLY-09112', e.getLocalizedMessage(), error=e)
+        _logger.throwing(ex, class_name=_class_name, method_name=_method_name)
+        raise ex
+    _logger.exiting(class_name=_class_name, method_name=_method_name)
+    return
 
 def extract_from_uri(model_context, path_value):
     """

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

@@ -47,6 +47,7 @@ class CommandLineArgUtil(object):
     ADMIN_PASS_SWITCH          = '-admin_pass'
     ARCHIVE_FILE_SWITCH        = '-archive_file'
     MODEL_FILE_SWITCH          = '-model_file'
+    DISCARD_CURRENT_EDIT_SWITCH   = '-discard_current_edit'
     OPSS_WALLET_SWITCH         = '-opss_wallet'
     OPSS_WALLET_PASSPHRASE     = '-opss_wallet_passphrase'
     PREVIOUS_MODEL_FILE_SWITCH = '-prev_model_file'
@@ -97,6 +98,7 @@ class CommandLineArgUtil(object):
         ROLLBACK_IF_RESTART_REQ_SWITCH,
         RUN_RCU_SWITCH,
         UPDATE_RCU_SCHEMA_PASS_SWITCH,
+        DISCARD_CURRENT_EDIT_SWITCH,
         USE_ENCRYPTION_SWITCH
     ]
 

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

@@ -87,6 +87,7 @@ def __init__(self, program_name, arg_map):
         self._variable_keywords_file = None
         self._variable_properties_file = None
         self._rcu_db_user = 'SYS'
+        self._discard_current_edit = False
 
         self._trailing_args = []
 
@@ -133,6 +134,9 @@ def __copy_from_args(self, arg_map):
         if CommandLineArgUtil.MODEL_FILE_SWITCH in arg_map:
             self._model_file = arg_map[CommandLineArgUtil.MODEL_FILE_SWITCH]
 
+        if CommandLineArgUtil.DISCARD_CURRENT_EDIT_SWITCH in arg_map:
+            self._discard_current_edit = arg_map[CommandLineArgUtil.DISCARD_CURRENT_EDIT_SWITCH]
+
         if CommandLineArgUtil.PREVIOUS_MODEL_FILE_SWITCH in arg_map:
             self._previous_model_file = arg_map[CommandLineArgUtil.PREVIOUS_MODEL_FILE_SWITCH]
 
@@ -267,6 +271,8 @@ def __copy__(self):
             arg_map[CommandLineArgUtil.VARIABLE_FILE_SWITCH] = self._variable_file_name
         if self._run_rcu is not None:
             arg_map[CommandLineArgUtil.RUN_RCU_SWITCH]= self._run_rcu
+        if self._discard_current_edit is not None:
+            arg_map[CommandLineArgUtil.DISCARD_CURRENT_EDIT_SWITCH]= self._discard_current_edit
         if self._rcu_database is not None:
             arg_map[CommandLineArgUtil.RCU_DB_SWITCH] = self._rcu_database
         if self._rcu_prefix is not None:
@@ -435,6 +441,13 @@ def is_rollback_if_restart_required(self):
         """
         return self._rollback_if_restart_required
 
+    def is_discard_current_edit(self):
+        """
+        Get the discard current edit value.
+        :return: true or false
+        """
+        return self._discard_current_edit
+
     def get_opss_wallet(self):
         """
         Get the opss wallet.

core/src/main/resources/oracle/weblogic/deploy/messages/wlsdeploy_rb.properties

@@ -994,6 +994,8 @@ WLSDPLY-09014={0} was unable to load the model from {1} due to a translation err
 WLSDPLY-09015={0} deployment failed: {1}
 WLSDPLY_09015=Online update has been rollback because the flag rollback_if_require_restart is set and the update requires \
   restart: {0}
+WLSDPLY-09016=There are outstanding changes but -discard_current_edit has been specified, all changes have been \
+  discarded before processing update.
 # wlsdeploy/tool/deploy/deployer_utils.py
 WLSDPLY-09100=Existing object names are {0}
 WLSDPLY-09101=Creating MBean type {1} with name {0}
@@ -1008,7 +1010,7 @@ WLSDPLY-09108=Model attribute {0} at model location {1} with value {2} reference
 WLSDPLY-09109=Unable to delete {0} {1}, name does not exist
 WLSDPLY-09110=Deleting {0} {1}
 WLSDPLY-09111=Unable to get delete item name for {0}
-
+WLSDPLY-09112=Failed to discard current edit session: {0}
 # wlsdeploy/tool/deploy/deployer.py
 WLSDPLY-09200=Error setting attribute {0} for {1} {2}: {3}
 WLSDPLY-09201=Failed to get existing WLST value for model attribute {0} at location {1} because the \

installer/src/main/bin/deployApps.cmd

@@ -78,6 +78,7 @@ ECHO              [-variable_file ^<variable_file^>]
 ECHO              [-domain_type ^<domain_type^>]
 ECHO              [-wlst_path ^<wlst_path^>]
 ECHO              [-rollback_if_require_restart]
+ECHO              [-discard_current_edit]
 ECHO              [-admin_url ^<admin_url^>
 ECHO               -admin_user ^<admin_user^>
 ECHO              ]
@@ -115,6 +116,8 @@ 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         discard_current_edit      - discard all existing changes before starting update
+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.

installer/src/main/bin/deployApps.sh

@@ -39,6 +39,7 @@ usage() {
   echo "          [-domain_type <domain_type>]"
   echo "          [-wlst_path <wlst_path>]"
   echo "          [-rollback_if_require_restart]"
+  echo "          [-discard_current_edit]"
   echo "          [-admin_url <admin_url>"
   echo "           -admin_user <admin_user>"
   echo "          ]"
@@ -76,6 +77,8 @@ usage() {
   echo ""
   echo "        rollback_if_require_restart      - rollback the changes if the update requires domain restart"
   echo ""
+  echo "        discard_current_edit  - discard all existing changes before starting update"
+  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."

installer/src/main/bin/updateDomain.cmd

@@ -78,6 +78,7 @@ ECHO              [-variable_file ^<variable_file^>]
 ECHO              [-domain_type ^<domain_type^>]
 ECHO              [-wlst_path ^<wlst_path^>]
 ECHO              [-rollback_if_require_restart]
+ECHO              [-discard_current_edit]
 ECHO              [-admin_url ^<admin_url^>
 ECHO               -admin_user ^<admin_user^>
 ECHO              ]
@@ -115,6 +116,8 @@ 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         discard_current_edit      - discard all existing changes before starting update
+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.