Online update fix for JIRA 576 (#991)

* Fix some logic errors in online app deployment

* fix error message

* minor cleanup

* Removed optimizing logic trying to determine shared library referenced apps and automate undeploy process for now.
Add missing deploy commands output to the error message

* minor update

* update documentation and code comments

* doc update

* doc update

* remove unused variable

* Remove unused method

Author: jshum2479

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

@@ -230,7 +230,7 @@ def __online_deploy_apps_and_libs(self, base_location):
         # stop the app if the referenced shared library is newer or if the source path changes
         stop_app_list = list()
 
-        # applications and libraries (?) to be stopped and undeployed
+        # applications to be stopped and undeployed
         stop_and_undeploy_app_list = list()
 
         # libraries to be undeployed
@@ -240,27 +240,33 @@ def __online_deploy_apps_and_libs(self, base_location):
         # Go through the model libraries and find existing libraries that are referenced
         # by applications and compute a processing strategy for each library.
         self.__build_library_deploy_strategy(lib_location, model_shared_libraries, existing_lib_refs,
-                                             stop_app_list, update_library_list, stop_and_undeploy_app_list)
+                                             stop_app_list, update_library_list)
+
 
         # Go through the model applications and compute the processing strategy for each application.
         app_location = LocationContext(base_location).append_location(APPLICATION)
         self.__build_app_deploy_strategy(app_location, model_applications, existing_app_refs,
                                          stop_and_undeploy_app_list)
 
         # deployed_app_list is list of apps that has been deployed and started again
-        # redeploy_app_list is list of apps that needs to be redeployed
         deployed_app_list = []
-        redeploy_app_list = []
 
-        # shared library updated, app referenced must be stopped, redeployed, and started so stop the app first
-        for app in stop_app_list:
-            self.__stop_app(app)
-            # add the referenced app to the redeploy list
-            redeploy_app_list.append(app)
-            # add the referenced app to the start list
-            deployed_app_list.append(app)
+        #  For in-place update of shared libraries (i.e. impl/spec versions are not updated in the MANIFEST.MF for
+        #   update), trying to do so will result in error just like the console.
+        #
+        # we will not automatically detect the referencing app and try to figure out the dependency graph and orders
+        # for undeploying apps.
+        #
+        #   1.  It needs to be fully undeploy shared library referenced apps
+        #   2.  But if the user only provides a sparse model for library update,  the sparse model will not have the
+        #   original app and it will not be deployed again
+        #   3.  There maybe transitive references by shared library and it will be difficult to handle processing order
+        #    the full dependency graph
+        #   4.  Console will result in error and ask user to undeploy the app first, so we are not trying to add new
+        #   functionalities in wls.
+        #
 
-        # app is updated, it must be stopped and undeployed first
+        # user provide new versioned app, it must be stopped and undeployed first
         for app in stop_and_undeploy_app_list:
             self.__stop_app(app)
             self.__undeploy_app(app)
@@ -272,9 +278,6 @@ def __online_deploy_apps_and_libs(self, base_location):
         self.__deploy_model_libraries(model_shared_libraries, lib_location)
         self.__deploy_model_applications(model_applications, app_location, deployed_app_list)
 
-        for app in redeploy_app_list:
-            self.__redeploy_app(app)
-
         self.__start_all_apps(deployed_app_list, base_location)
         self.logger.exiting(class_name=self._class_name, method_name=_method_name)
         return
@@ -506,15 +509,14 @@ def __get_library_references(self, base_location):
         return existing_libraries
 
     def __build_library_deploy_strategy(self, location, model_libs, existing_lib_refs, stop_app_list,
-                                        update_library_list, stop_and_undeploy_app_list):
+                                        update_library_list):
         """
         Update maps and lists to control re-deployment processing.
         :param location: the location of the libraries
         :param model_libs: a copy of libraries from the model, attributes may be revised
         :param existing_lib_refs: map of information about each existing library
         :param stop_app_list: a list to update with dependent apps to be stopped and undeployed
         :param update_library_list: a list to update with libraries to be stopped before deploying
-        :param stop_and_undeploy_app_list: a list to update with libraries to be stopped and undeployed
         """
         _method_name = '__build_library_deploy_strategy'
 
@@ -533,11 +535,9 @@ def __build_library_deploy_strategy(self, location, model_libs, existing_lib_ref
                         lib_name = model_helper.get_delete_item_name(lib)
                         if lib_name in existing_libs:
                             model_libs.pop(lib)
-                            _add_ref_apps_to_stoplist(stop_app_list, existing_lib_refs, lib_name)
-                            stop_and_undeploy_app_list.append(lib_name)
+                            update_library_list.append(lib_name)
                         else:
                             model_libs.pop(lib)
-                            stop_and_undeploy_app_list.append(lib_name)
                     continue
 
                 # determine the versioned name of the library from the library's MANIFEST
@@ -593,8 +593,8 @@ def __build_library_deploy_strategy(self, location, model_libs, existing_lib_ref
                         if lib_dict['SourcePath'] is None and existing_src_path is not None:
                             lib_dict['SourcePath'] = existing_src_path
 
-                        _add_ref_apps_to_stoplist(stop_app_list, existing_lib_refs, versioned_name)
-                        update_library_list.append(versioned_name)
+                        if versioned_name not in update_library_list:
+                            update_library_list.append(versioned_name)
                     else:
                         # If the hashes match, assume that the library did not change so there is no need
                         # to redeploy them ot the referencing applications unless the targets are different.
@@ -611,6 +611,7 @@ def __build_library_deploy_strategy(self, location, model_libs, existing_lib_ref
                                 lib_dict['SourcePath'] = existing_src_path
         return
 
+
     def __build_app_deploy_strategy(self, location, model_apps, existing_app_refs, stop_and_undeploy_app_list):
         """
         Update maps and lists to control re-deployment processing.
@@ -697,13 +698,16 @@ def __build_app_deploy_strategy(self, location, model_apps, existing_app_refs, s
                             else:
                                 self.logger.info('WLSDPLY-09336', src_path,
                                                  class_name=self._class_name, method_name=_method_name)
-                                stop_and_undeploy_app_list.append(versioned_name)
+                                if versioned_name not in stop_and_undeploy_app_list:
+                                    stop_and_undeploy_app_list.append(versioned_name)
                         else:
                             # updated deployment plan
-                            stop_and_undeploy_app_list.append(versioned_name)
+                            if versioned_name not in stop_and_undeploy_app_list:
+                                stop_and_undeploy_app_list.append(versioned_name)
                     else:
                         # updated app
-                        stop_and_undeploy_app_list.append(versioned_name)
+                        if versioned_name not in stop_and_undeploy_app_list:
+                            stop_and_undeploy_app_list.append(versioned_name)
         return
 
     def __remove_delete_targets(self, model_dict, existing_ref):
@@ -834,7 +838,7 @@ def __handle_builtin_libraries(self, targets_not_changed, model_libs, lib,
         return
 
     def __remove_app_from_deployment(self, model_dict, app_name):
-        self.logger.info('WLSDPLY-09311', app_name,
+        self.logger.info('WLSDPLY-09337', app_name,
                          class_name=self._class_name, method_name='remove_app_from_deployment')
         model_dict.pop(app_name)
         return
@@ -889,14 +893,6 @@ def __undeploy_app(self, application_name, library_module='false', partition_nam
                                               targets=targets)
         return
 
-    def __redeploy_app(self, application_name):
-        _method_name = '__redeploy_app'
-
-        self.logger.info('WLSDPLY-09315', application_name, class_name=self._class_name, method_name=_method_name)
-        self.wlst_helper.redeploy_application(application_name,
-                                              timeout=self.model_context.get_model_config().get_redeploy_timeout())
-        return
-
     def __deploy_model_libraries(self, model_libs, lib_location):
         if model_libs is not None and len(model_libs) > 0:
             uses_path_tokens_attribute_names = self.__get_uses_path_tokens_attribute_names(lib_location)
@@ -1200,17 +1196,18 @@ def _find_deployorder_list(apps_dict, ordered_list, order):
             result.append(app_name)
     return result
 
-def _add_ref_apps_to_stoplist(stop_applist, lib_refs, lib_name):
+def _add_ref_apps_to_stoplist(stop_and_undeploy_applist, lib_refs, lib_name):
     """
     Add the referencing apps for the specified shared library to the stop list.
-    :param stop_applist: the stop list
+    :param stop_and_undeploy_applist: the stop list
     :param lib_refs: the library references
     :param lib_name: the library name
     """
     if lib_refs[lib_name].has_key('referencingApp'):
         apps = lib_refs[lib_name]['referencingApp'].keys()
         for app in apps:
-            stop_applist.append(app)
+            if app not in stop_and_undeploy_applist:
+                stop_and_undeploy_applist.append(app)
     return
 
 def _update_ref_dictionary(ref_dictionary, lib_name, absolute_sourcepath, lib_hash, configured_targets,

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

@@ -1129,6 +1129,7 @@ WLSDPLY-09333=Library {0} not found. Please specify a valid library for deletion
 WLSDPLY-09334=Application {0} not found. Please specify a valid application for deletion
 WLSDPLY-09335=Undeploying {0} {1} from targets: {2}
 WLSDPLY-09336=Redeployed application {0} because the old and the new binary have the same path.
+WLSDPLY-09337=Removing {0} from model deployment because it is started with a delete notation. It will be undeployed.
 
 # wlsdeploy/tool/deploy/common_resources_deployer.py
 WLSDPLY-09400=ResourceGroup was specified in the test file but are not supported in WebLogic Server version {0}

documentation/2.0/content/userguide/tools/update.md

@@ -30,6 +30,22 @@ When running the tool in WLST online mode, the update operation may require serv
 - `103` - The entire domain needs to be restarted.
 - `104` - The domain changes have been canceled because the changes in the model requires a domain restart and `-cancel_changes_if_restart_required` is specified.
 
+### Online update for shared libraries
+
+- When updating shared library online, it is recommended to deploy a new version of the library by updating the 
+  version(s) in the MANIFEST.MF file and update the deployment descriptor of any application that wants to upgrade to 
+  use the new library, this avoids complicated issues like in-place update of shared 
+  library.
+
+- In-place update of shared library online is not supported - if you only 
+  update the library contents without updating the version(s) of the library in the MANIFEST.MF file.  You will get an error 
+  from WebLogic Server indicating the library is referenced by applications and cannot be undeployed. You must undeploy 
+  all applications referencing the shared library first before proceeding; this is the same behavior when using the 
+  WebLogic Server console. Also, a shared library can potentially be referenced by another 
+  shared library module which in turns used by other applications, currently there is no capability within 
+  WebLogic Server to handle automating undeploy and deploy of an application that uses shared library when the library is 
+  updated in-place.  
+
 ### Using an encrypted model
 
 If the model or variables file contains passwords encrypted with the WDT Encryption tool, decrypt the passwords during create with the `-use_encryption` flag on the command line to tell the Update Domain Tool that encryption is being used and to prompt for the encryption passphrase.  As with the database passwords, the tool can also read the passphrase from standard input (for example, `stdin`) to allow the tool to run without any user input. You can bypass the stdin prompt with two other options. Store the passphrase in an environment variable, and use the environment variable name with command-line option `-passphrase_env`. Another option is to create a file containing the passphrase value. Pass this filename with the command-line option `-passphrase_file`.