Wdt 481 write restart file (#757)

CarolynRountree · web-flow · commit d3e1f2aa0134 · 2020-10-19T11:01:12.000-05:00
* grab restart information from activate

* Add restart information

* write restart information to stdout and to restart file
diff --git a/core/src/main/java/oracle/weblogic/deploy/util/FileUtils.java b/core/src/main/java/oracle/weblogic/deploy/util/FileUtils.java
@@ -1,16 +1,18 @@
 /*
- * Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.  All rights reserved.
+ * Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.
  * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
  */
 package oracle.weblogic.deploy.util;
 
 import java.io.ByteArrayOutputStream;
 import java.io.File;
 import java.io.FileInputStream;
+import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
 import java.io.FilenameFilter;
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.PrintWriter;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 import java.nio.file.attribute.PosixFilePermission;
@@ -697,6 +699,26 @@ public static void extractZipFileContent(WLSDeployArchive archiveFile, String zi
         }
 
     }
+
+    /**
+     * Return a PrintWriter instance for the provided file name.
+     * @param fileName Name of output file
+     * @return PrintWriter instance which is automatically closed
+     * @throws IllegalArgumentException if the file is not writable
+     */
+    public static PrintWriter getPrintWriter(String fileName)  {
+        String METHOD = "getPrintWriter";
+        validateWritableFile(fileName);
+        try {
+            return new PrintWriter(new File(fileName));
+        } catch (FileNotFoundException ioe) {
+            String message = ExceptionHelper.getMessage("WLSDPLY-01103", fileName);
+            IllegalArgumentException iae  = new IllegalArgumentException(message);
+            LOGGER.throwing(CLASS, METHOD, iae);
+            throw iae;
+        }
+    }
+
     ///////////////////////////////////////////////////////////////////////////
     // Private helper methods                                                //
     ///////////////////////////////////////////////////////////////////////////
diff --git a/core/src/main/python/deploy.py b/core/src/main/python/deploy.py
@@ -62,6 +62,7 @@
     CommandLineArgUtil.ADMIN_PASS_SWITCH,
     CommandLineArgUtil.USE_ENCRYPTION_SWITCH,
     CommandLineArgUtil.PASSPHRASE_SWITCH,
+    CommandLineArgUtil.OUTPUT_DIR_SWITCH,
     CommandLineArgUtil.DISCARD_CURRENT_EDIT_SWITCH,
     CommandLineArgUtil.ROLLBACK_IF_RESTART_REQ_SWITCH
 ]
@@ -160,6 +161,7 @@ def __deploy_online(model, model_context, aliases):
             __wlst_helper.activate(model_context.get_model_config().get_activate_timeout())
             if restart_required:
                 exit_code = CommandLineArgUtil.PROG_RESTART_REQUIRED
+                deployer_utils.list_restarts(model_context)
     except BundleAwareException, ex:
         __release_edit_session_and_disconnect()
         raise ex
diff --git a/core/src/main/python/update.py b/core/src/main/python/update.py
@@ -65,6 +65,7 @@
     CommandLineArgUtil.USE_ENCRYPTION_SWITCH,
     CommandLineArgUtil.PASSPHRASE_SWITCH,
     CommandLineArgUtil.ROLLBACK_IF_RESTART_REQ_SWITCH,
+    CommandLineArgUtil.OUTPUT_DIR_SWITCH,
     CommandLineArgUtil.UPDATE_RCU_SCHEMA_PASS_SWITCH,
     CommandLineArgUtil.DISCARD_CURRENT_EDIT_SWITCH
 ]
@@ -176,6 +177,7 @@ def __update_online(model, model_context, aliases):
 
 
 def __check_update_require_domain_restart(model_context):
+    _method_name = '__check_update_require_domain_restart'
     exit_code = 0
     try:
         # First we enable the stdout again and then redirect the stdoout to a string output stream
@@ -197,6 +199,8 @@ def __check_update_require_domain_restart(model_context):
             __wlst_helper.activate(model_context.get_model_config().get_activate_timeout())
             if restart_required:
                 exit_code = CommandLineArgUtil.PROG_RESTART_REQUIRED
+                deployer_utils.list_restarts(model_context)
+
     except BundleAwareException, ex:
         __release_edit_session_and_disconnect()
         raise ex
diff --git a/core/src/main/python/wlsdeploy/tool/deploy/deployer_utils.py b/core/src/main/python/wlsdeploy/tool/deploy/deployer_utils.py
@@ -1,22 +1,33 @@
 """
-Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.  All rights reserved.
+Copyright (c) 2017, 2020, Oracle Corporation and/or its affiliates.
 Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 """
+import os
+
 from sets import Set
 
 from java.io import IOException
 from java.net import URI
 from java.security import NoSuchAlgorithmException
 
+from oracle.weblogic.deploy.deploy import DeployException
 from oracle.weblogic.deploy.util import FileUtils
+from oracle.weblogic.deploy.util import StringUtils
 from oracle.weblogic.deploy.util import PyWLSTException
 from oracle.weblogic.deploy.util import WLSDeployArchive
 
 from wlsdeploy.aliases.location_context import LocationContext
+from wlsdeploy.aliases.model_constants import CLUSTER
+from wlsdeploy.aliases.model_constants import DYNAMIC_CLUSTER_SIZE
+from wlsdeploy.aliases.model_constants import DYNAMIC_SERVERS
 from wlsdeploy.aliases.model_constants import FILE_URI
 from wlsdeploy.aliases.model_constants import JDBC_DRIVER_PARAMS
 from wlsdeploy.aliases.model_constants import JDBC_RESOURCE
 from wlsdeploy.aliases.model_constants import JDBC_SYSTEM_RESOURCE
+from wlsdeploy.aliases.model_constants import SERVER
+from wlsdeploy.aliases.model_constants import SERVER_NAME_PREFIX
+from wlsdeploy.aliases.model_constants import SERVER_NAME_START_IDX
+from wlsdeploy.aliases.validation_codes import ValidationCodes
 from wlsdeploy.aliases.wlst_modes import WlstModes
 from wlsdeploy.exception import exception_helper
 from wlsdeploy.exception.expection_types import ExceptionType
@@ -415,3 +426,143 @@ def get_file_hash(file_name):
         raise ex
     _logger.exiting(class_name=_class_name, method_name=_method_name, result=result)
     return result
+
+
+def get_cluster_for_server(server_name, aliases):
+    """
+    Get the Cluster name for the existing server name for additional information to mine for the update action.
+    :param server_name: name of the server
+    :param aliases: alias context instance
+    :return: cluster name: name of the cluster the server belongs to, or None if stand-alone or server does not exist
+    """
+    _method_name = 'get_cluster_for_server'
+    _logger.entering(server_name, class_name=_class_name, method_name=_method_name)
+    location = LocationContext()
+    location.append_location(SERVER)
+    name_token = aliases.get_name_token(location)
+    location.add_name_token(name_token, server_name)
+    attr_path = aliases.get_wlst_attributes_path(location)
+    cluster_name = None
+    try:
+        _wlst_helper.cd(attr_path)
+        cluster_name = _wlst_helper.get(CLUSTER)
+    except DeployException, de:
+        _logger.fine('WLSDPLY-09205', server_name, str(location), de.getLocalizedMessage,
+                     SERVER, class_name=_class_name, method_name=_method_name)
+    _logger.exiting(result=cluster_name, class_name=_class_name, method_name=_method_name)
+    return cluster_name
+
+
+def list_restarts(model_context):
+    """
+    Get the list of restarts and save this list in format to restart.file
+    in the -output_dirs location. If the output_dirs is not included, bypass
+    writing to the restart file.
+    :param model_context: instance of the tool model context
+    """
+    _method_name = 'list_restarts'
+    _logger.entering(model_context.get_output_dir(), class_name=_class_name, method_name=_method_name)
+    restart_list = get_list_of_restarts()
+    output_dirs = model_context.get_output_dir()
+    if output_dirs is not None:
+        file_name = os.path.join(output_dirs, 'restart.file')
+        pw = FileUtils.getPrintWriter(file_name)
+        for entry in restart_list:
+            line = '%s:%s:%s:%s' % (entry[0], entry[1], entry[2], entry[3])
+            _logger.finer('WLSDPLY-09208', line, class_name=_class_name, method_name=_method_name)
+            pw.println(line)
+        pw.close()
+    _logger.exiting(class_name=_class_name, method_name=_method_name)
+
+
+def get_list_of_restarts():
+    """
+    Return the restart checklist from the online domain instance. Log each instance of the restart checklist
+    :return: String buffer of restart information
+    """
+    _method_name = 'get_list_of_restarts'
+    restart_list = []
+    _wlst_helper.cd('/')
+    cmo = _wlst_helper.get_cmo()
+    for server in _wlst_helper.get_server_runtimes():
+        resources = server.getPendingRestartSystemResources()
+        is_restart = server.isRestartRequired()
+        if len(resources) > 0 or is_restart:
+            server_name = server.getName()
+            cluster = server.getClusterRuntime()
+            cluster_name = ''
+            if cluster is not None:
+                cluster_name = cluster.getName()
+            prt_cluster = cluster_name
+            if cluster_name == '':
+                prt_cluster = 'standalone'
+            for resource in server.getPendingRestartSystemResources():
+                line = list()
+                line.append(cluster_name)
+                line.append(server_name)
+                line.append(resource)
+                value = cmo.lookupSystemResource(resource)
+                res_type = ''
+                if value is not None:
+                    res_type = value.getType()
+                line.append(res_type)
+                restart_list.append(line)
+                _logger.warning('WLSDPLY-09207', resource, res_type, server_name, prt_cluster,
+                                class_name=_class_name, method_name=_method_name)
+            if is_restart:
+                line = list()
+                line.append(cluster_name)
+                line.append(server_name)
+                line.append('')
+                line.append('')
+                restart_list.append(line)
+                _logger.warning('WLSDPLY-09206', server_name, prt_cluster,
+                                class_name=_class_name, method_name=_method_name)
+    return restart_list
+
+
+def check_if_dynamic_cluster(server_name, cluster_name, aliases):
+    """
+    Determine if the server is part of a dynamic cluster.
+    :param server_name: Name of the server to check
+    :param cluster_name: Name of the cluster the server belongs to, or None if stand-alone
+    :param aliases: aliases context instance
+    :return: True if part of a dynamic cluster
+    """
+    _method_name = 'check_if_dynamic_cluster'
+    # check wls version first either here or before caller. preferably here
+    location = LocationContext()
+    location.append_location(CLUSTER)
+    location.add_name_token(aliases.get_name_token(location), cluster_name)
+    attr_path = aliases.get_wlst_attributes_path(location)
+
+    try:
+        _wlst_helper.cd(attr_path)
+    except DeployException, de:
+        _logger.fine('WLSDPLY-09205', cluster_name, str(location), de.getLocalizedMessage,
+                     CLUSTER, class_name=_class_name, method_name=_method_name)
+        return True
+    location.append_location(DYNAMIC_SERVERS)
+    location.add_name_token(aliases.get_name_token(location), cluster_name)
+    attr_path = aliases.get_wlst_attributes_path(location)
+    try:
+        _wlst_helper.cd(attr_path)
+    except DeployException:
+        return False
+    attr_name = aliases.get_wlst_attribute_name(location, DYNAMIC_CLUSTER_SIZE)
+    dynamic_size = _wlst_helper.get(attr_name)
+    attr_name = aliases.get_wlst_attribute_name(location, SERVER_NAME_PREFIX)
+    prefix = _wlst_helper.get(attr_name)
+    starting = 1
+    present, __ = aliases.is_valid_model_attribute_name(location, SERVER_NAME_START_IDX)
+    if present == ValidationCodes.VALID:
+        attr_name = aliases.get_model_attribute_name(location, SERVER_NAME_START_IDX)
+        starting = _wlst_helper.get(attr_name)
+    if dynamic_size > 0 and prefix is not None and server_name.startswith(prefix):
+        split_it = server_name.split(prefix)
+        if len(split_it) == 2:
+            number = StringUtils.stringToInteger(split_it[1].strip())
+            if number is not None and starting <= number < (dynamic_size + starting):
+                return True
+    return False
+
diff --git a/core/src/main/python/wlsdeploy/tool/discover/discoverer.py b/core/src/main/python/wlsdeploy/tool/discover/discoverer.py
@@ -279,11 +279,13 @@ def _find_names_in_folder(self, location):
                          class_name=_class_name, method_name=_method_name)
         else:
             folder_path = self._aliases.get_wlst_list_path(location)
-            _logger.finest('WLSDPLY-06111', folder_path, class_name=_class_name, method_name=_method_name)
+            _logger.fine('WLSDPLY-06111', folder_path, class_name=_class_name, method_name=_method_name)
             if self._wlst_helper.path_exists(folder_path):
                 self.wlst_cd(folder_path, location)
                 names = self._wlst_helper.lsc()
-                _logger.finest('WLSDPLY-06146', names, location, class_name=_class_name, method_name=_method_name)
+                _logger.fine('WLSDPLY-06146', names, location, class_name=_class_name, method_name=_method_name)
+            else:
+                _logger.fine('Path {0} does not exist', folder_path, class_name=_class_name, method_name=_method_name)
         return names
 
     def _find_singleton_name_in_folder(self, location):
diff --git a/core/src/main/python/wlsdeploy/tool/discover/topology_discoverer.py b/core/src/main/python/wlsdeploy/tool/discover/topology_discoverer.py
@@ -16,6 +16,7 @@
 from wlsdeploy.aliases.location_context import LocationContext
 from wlsdeploy.aliases.model_constants import MODEL_LIST_DELIMITER
 from wlsdeploy.aliases.model_constants import KSS_KEYSTORE_FILE_INDICATOR
+from wlsdeploy.aliases.validation_codes import ValidationCodes
 from wlsdeploy.aliases.wlst_modes import WlstModes
 from wlsdeploy.exception import exception_helper
 from wlsdeploy.exception.expection_types import ExceptionType
@@ -772,8 +773,8 @@ def _dynamic_server(self, server, location):
                     prefix = self._wlst_helper.get(attr_name)
                     starting = 1
                     present, __ = self._aliases.is_valid_model_attribute_name(location,
-                                                                              model_constants.SERVER_NAME_PREFIX)
-                    if present:
+                                                                              model_constants.SERVER_NAME_START_IDX)
+                    if present == ValidationCodes.VALID:
                         attr_name = self._aliases.get_model_attribute_name(cluster_location,
                                                                            model_constants.SERVER_NAME_START_IDX)
                         starting = self._wlst_helper.get(attr_name)
diff --git a/core/src/main/python/wlsdeploy/tool/util/wlst_helper.py b/core/src/main/python/wlsdeploy/tool/util/wlst_helper.py
@@ -892,18 +892,20 @@ def activate(self, timeout):
         """
         Activate changes saved during the current edit session but not yet deployed.
         :param timeout: Timeout for the activate command
+        :return ActivationTaskMBean: with the state of the changes, and the server status for the activated changes
         :raises: Exception for the specified tool type: if a WLST error occurs
         """
         _method_name = 'activate'
         self.__logger.entering(timeout, class_name=self.__class_name, method_name=_method_name)
         try:
-            self.__load_global('activate')(timeout)
+            activate_status = self.__load_global('activate')(timeout)
         except self.__load_global('WLSTException'), e:
             pwe = exception_helper.create_exception(self.__exception_type, 'WLSDPLY-00053',
                                                     _format_exception(e), error=e)
             self.__logger.throwing(class_name=self.__class_name, method_name=_method_name, error=pwe)
             raise pwe
         self.__logger.exiting(class_name=self.__class_name, method_name=_method_name)
+        return activate_status
 
     def get_existing_object_list(self, wlst_objects_path):
         """
@@ -1432,6 +1434,30 @@ def get_quoted_name_for_wlst(self, name):
         self.__logger.finest('WLSDPLY-0098', class_name=self.__class_name, method_name=_method_name)
         return result
 
+    def get_server_runtimes(self):
+        """
+        Return the ServerRuntimeMBeans instances for the domain
+        :return: list of server runtimes
+        """
+        return self.get_domain_runtime_service().getServerRuntimes()
+
+    def get_domain_runtime_service(self):
+        """
+        Return the DomainRuntimeServiceMBean instance.
+        :return: DomainRuntimeServiceMBean for the domain
+        """
+        _method_name = 'get_domain_runtime_service'
+        self.__logger.entering(class_name=self.__class_name, method_name=_method_name)
+        try:
+            drs = self.__load_global('domainRuntimeService')
+        except self.__load_global('WLSTException'), e:
+            pwe = exception_helper.create_exception(self.__exception_type, 'WLSDPLY-00127',
+                                                    _format_exception(e), error=e)
+            self.__logger.throwing(class_name=self.__class_name, method_name=_method_name, error=pwe)
+            raise pwe
+        self.__logger.exiting(class_name=self.__class_name, method_name=_method_name, result=drs)
+        return drs
+
     def __ls(self, method_name, ls_type, path=None, log_throwing=True):
         """
         Private helper method shared by various API methods
diff --git a/core/src/main/resources/oracle/weblogic/deploy/messages/wlsdeploy_rb.properties b/core/src/main/resources/oracle/weblogic/deploy/messages/wlsdeploy_rb.properties
@@ -109,6 +109,7 @@ WLSDPLY-00123=Setting the server group {0} on dynamic cluster {1} failed : {2}
 WLSDPLY-00124=Entering is_set({0}) method
 WLSDPLY-00125=is_set({0}) in {1} mode failed: {2}
 WLSDPLY-00126=Exiting is_set({0}) method
+WLSDPLY-00127=Unable to load the DomainRuntimeService from the WLST globals : {0}
 
 
 ###############################################################################
@@ -1005,6 +1006,7 @@ WLSDPLY_09015=Online update has been rollback because the flag rollback_if_requi
   restart: {0}
 WLSDPLY-09016=There are outstanding changes but -discard_current_edit has been specified, all changes have been \
   discarded before processing update.
+WLSDPLY-09017=Server {0} in 
 # wlsdeploy/tool/deploy/deployer_utils.py
 WLSDPLY-09100=Existing object names are {0}
 WLSDPLY-09101=Creating MBean type {1} with name {0}
@@ -1028,6 +1030,10 @@ WLSDPLY-09202=Set method {0} not implemented for attribute {1} in location {2}
 WLSDPLY-09203=The model element {0} is not valid for WLS version {1}, so it will be omitted from deployment
 WLSDPLY-09204=Model attribute {0} at model location {1} with value {2} references a location inside \
   the archive file {3} that does not exist
+WLSDPLY-09205=Unable to locate the indicated {3} {0} at location {1} : {2}
+WLSDPLY-09206=Server {0} ({1}) requires a restart
+WLSDPLY-09207=Domain resource {0} ({1}) on server {2} ({3}) requires a restart
+WLSDPLY-09208=Formatted restart line : {0}
 
 # wlsdeploy/tool/deploy/application_deployer.py
 WLSDPLY-09300=No shared libraries found in {0} with name {1}
diff --git a/installer/src/main/bin/deployApps.cmd b/installer/src/main/bin/deployApps.cmd
@@ -79,6 +79,7 @@ ECHO              [-domain_type ^<domain_type^>]
 ECHO              [-wlst_path ^<wlst_path^>]
 ECHO              [-rollback_if_require_restart]
 ECHO              [-discard_current_edit]
+ECHO              [-output_dir]
 ECHO              [-admin_url ^<admin_url^>
 ECHO               -admin_user ^<admin_user^>
 ECHO              ]
@@ -118,6 +119,8 @@ ECHO         rollback_if_require_restart      - rollback the changes if the upda
 ECHO.
 ECHO         discard_current_edit      - discard all existing changes before starting update
 ECHO.
+ECHO         output_dir      - if present, write restart information to this directory as restart.file
+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
diff --git a/installer/src/main/bin/updateDomain.cmd b/installer/src/main/bin/updateDomain.cmd
diff --git a/installer/src/main/bin/updateDomain.sh b/installer/src/main/bin/updateDomain.sh
