Merge pull request #307 from oracle/issue-300-server-start-value-args

Issue #300 - Parse server start value args correctly; fixed server te…

Author: rakillen

core/src/main/python/wlsdeploy/aliases/alias_jvmargs.py

@@ -18,11 +18,18 @@ class JVMArguments(object):
 
     _class_name = 'JVMArguments'
     __client_server_regex = re.compile('-client|-server')
+
+    # examples: -Xmx200m -Xms100K
     __x_args_size_regex = re.compile('(-X(ms|mx|ss|mn) ?)([0-9]+[kmgKMG]? ?)')
+
+    # example: -Xrunjdwp:transport=dt_socket,address=8888,server=y,suspend=y
     __x_args_value_regex = re.compile('(-X[a-zS]+(/[ap])? ?):([\S]+ ?)')
+
     __x_args_other_regex = re.compile('(-X[a-z]+ ?)(=([0-9]+[kmgKMG]? ?))?')
     __xx_args_switch_regex = re.compile('-XX:([+-] ?)([a-zA-Z0-9]+ ?)')
     __xx_args_value_regex = re.compile('-XX:([a-zA-Z0-9]+ ?)=([\S]+ ?)')
+
+    # examples: -Dabc -Dxyz=jkl,fdr,jdk -Drak=xyz
     __sys_props_regex = re.compile('-D([a-zA-Z0-9-_.]+ ?)(=([\S]+ ?))?')
 
     __size_regex = re.compile('([0-9]+ ?)([kmgKMG]? ?)')
@@ -256,6 +263,8 @@ def __parse_args(self):
                     self.__client_server_args.append(argument)
                 elif self.__x_args_size_regex.match(argument):
                     self.__process_x_size_arg(argument)
+                elif self.__x_args_value_regex.match(argument):
+                    self.__process_x_value_arg(argument)
                 elif self.__x_args_other_regex.match(argument):
                     self.__process_x_other_arg(argument)
                 elif self.__xx_args_switch_regex.match(argument):
@@ -310,7 +319,7 @@ def __process_x_other_arg(self, argument):
         add it to the internal map.
         :param argument: the argument string
         """
-        _method_name = '__process_x_value_arg'
+        _method_name = '__process_x_other_arg'
 
         match = self.__x_args_other_regex.match(argument)
         xarg = match.group(1)

core/src/main/python/wlsdeploy/aliases/alias_utils.py

@@ -24,7 +24,6 @@
 from oracle.weblogic.deploy.aliases import VersionUtils
 
 from wlsdeploy.aliases.alias_constants import ChildFoldersTypes
-from wlsdeploy.aliases.alias_jvmargs import JVMArguments
 from wlsdeploy.exception import exception_helper
 from wlsdeploy.logging.platform_logger import PlatformLogger
 
@@ -52,14 +51,9 @@
 from wlsdeploy.aliases.alias_constants import WLST_READ_TYPE
 from wlsdeploy.aliases.alias_constants import WLST_TYPE
 from wlsdeploy.aliases.alias_constants import WLST_SUBFOLDERS_PATH
-from wlsdeploy.aliases.model_constants import ARGUMENTS
-from wlsdeploy.aliases.model_constants import SERVER
-from wlsdeploy.aliases.model_constants import SERVER_START
 
 _class_name = 'alias_utils'
 _logger = PlatformLogger('wlsdeploy.aliases')
-_server_start_location_folder_path = '/' + SERVER + '/' + SERVER_START
-_server_start_argument_attribute_name = ARGUMENTS
 _windows_path_regex = re.compile(r'^[a-zA-Z]:[\\/].*')
 
 
@@ -149,30 +143,6 @@ def merge_model_and_existing_properties(model_props, existing_props, string_prop
     return result
 
 
-def merge_server_start_argument_values(model_args, existing_args):
-    """
-    Merge the two arguments strings.
-    :param model_args: the new string or list from the model
-    :param existing_args: the old string (e.g., from WLST)
-    :return: the resulting merged string
-    """
-    _method_name = 'merge_server_start_argument_values'
-
-    _logger.entering(model_args, existing_args, class_name=_class_name, method_name=_method_name)
-    if model_args is None or len(model_args) == 0:
-        result = existing_args
-    elif existing_args is None or len(existing_args) == 0:
-        new_args = JVMArguments(_logger, model_args)
-        result = new_args.get_arguments_string()
-    else:
-        new_args = JVMArguments(_logger, model_args)
-        merged_args = JVMArguments(_logger, existing_args)
-        merged_args.merge_jvm_arguments(new_args)
-        result = merged_args.get_arguments_string()
-    _logger.exiting(class_name=_class_name, method_name=_method_name, result=result)
-    return result
-
-
 def count_substring_occurrences(substring, string):
     """
     Count the number of occurrences of a substring in a string
@@ -555,17 +525,6 @@ def convert_boolean(value):
     return result
 
 
-def is_attribute_server_start_arguments(location, model_attribute_name):
-    """
-    Is the location and attribute the Server/ServerStart folder's Argument attribute
-    :param location: location
-    :param model_attribute_name: attribute name
-    :return: True if so, False otherwise
-    """
-    return location.get_folder_path() == _server_start_location_folder_path and \
-           model_attribute_name == _server_start_argument_attribute_name
-
-
 def compute_delimiter_from_data_type(data_type, value):
     """
     Compute the delimiter from the data type

core/src/main/python/wlsdeploy/aliases/aliases.py

@@ -43,7 +43,6 @@
 from wlsdeploy.aliases.alias_constants import RESTART_REQUIRED
 from wlsdeploy.aliases.alias_constants import SET_MBEAN_TYPE
 from wlsdeploy.aliases.alias_constants import SET_METHOD
-from wlsdeploy.aliases.alias_constants import STRING
 from wlsdeploy.aliases.alias_constants import USES_PATH_TOKENS
 from wlsdeploy.aliases.alias_constants import VALUE
 from wlsdeploy.aliases.alias_constants import WLST_NAME
@@ -411,18 +410,11 @@ def get_wlst_attribute_name_and_value(self, location, model_attribute_name, mode
                     raise ex
             else:
                 if data_type in ALIAS_LIST_TYPES or data_type in ALIAS_MAP_TYPES:
-                    to_type = data_type
-
                     merge = True
                     if MERGE in attribute_info:
                         merge = alias_utils.convert_boolean(attribute_info[MERGE])
 
-                    if alias_utils.is_attribute_server_start_arguments(location, model_attribute_name):
-                        # convert to string, even if no existing value to merge
-                        merged_value = \
-                            alias_utils.merge_server_start_argument_values(model_attribute_value, existing_wlst_value)
-                        to_type = STRING
-                    elif merge and data_type in ALIAS_MAP_TYPES:
+                    if merge and data_type in ALIAS_MAP_TYPES:
                         model_val = TypeUtils.convertToType(PROPERTIES, model_attribute_value)
                         existing_val = TypeUtils.convertToType(PROPERTIES, existing_wlst_value)
                         merged_value = alias_utils.merge_model_and_existing_properties(model_val, existing_val)
@@ -442,10 +434,10 @@ def get_wlst_attribute_name_and_value(self, location, model_attribute_name, mode
                         subtype = 'java.lang.String'
                         if SET_MBEAN_TYPE in attribute_info:
                             subtype = attribute_info[SET_MBEAN_TYPE]
-                        wlst_attribute_value = alias_utils.convert_to_type(to_type, merged_value, subtype=subtype,
+                        wlst_attribute_value = alias_utils.convert_to_type(data_type, merged_value, subtype=subtype,
                                                                            delimiter=MODEL_LIST_DELIMITER)
                     else:
-                        wlst_attribute_value = alias_utils.convert_to_type(to_type, merged_value,
+                        wlst_attribute_value = alias_utils.convert_to_type(data_type, merged_value,
                                                                            delimiter=MODEL_LIST_DELIMITER)
                 else:
                     wlst_attribute_value = alias_utils.convert_to_type(data_type, model_attribute_value,

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

@@ -11,7 +11,6 @@
 from oracle.weblogic.deploy.util import PyWLSTException
 from oracle.weblogic.deploy.util import WLSDeployArchive
 
-from wlsdeploy.aliases.location_context import LocationContext
 from wlsdeploy.aliases.wlst_modes import WlstModes
 from wlsdeploy.exception import exception_helper
 from wlsdeploy.exception.expection_types import ExceptionType
@@ -26,34 +25,6 @@
 _wlst_helper = WlstHelper(_logger, ExceptionType.DEPLOY)
 
 
-def set_attribute(location, model_key, model_value, alias_helper, use_raw_value=False):
-    """
-    Set a single attribute to the specified value.
-    :param location: the location of the attribute to be set
-    :param model_key: the key of the attribute to be set
-    :param model_value: the value of the attribute to be set
-    :param alias_helper: the alias helper to use for name resolution
-    :param use_raw_value: apply passed value directly if true (example: mbean)
-    """
-    method_name = 'set_attribute'
-
-    if use_raw_value:
-        wlst_param = alias_helper.get_wlst_attribute_name(location, model_key)
-        wlst_value = model_value
-    else:
-        wlst_param, wlst_value = alias_helper.get_wlst_attribute_name_and_value(location, model_key, model_value)
-
-    if wlst_param is None:
-        _logger.info('WLSDPLY-20011', model_key, class_name=_class_name, method_name=method_name)
-        return
-
-    if wlst_value is None:
-        _logger.info('WLSDPLY-20012', model_key, str(model_value), class_name=_class_name, method_name=method_name)
-        return
-
-    _wlst_helper.set(wlst_param, wlst_value)
-
-
 def get_existing_object_list(location, alias_helper):
     """
     Get a list of the existing names at the specified location.

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

@@ -12,6 +12,7 @@
 
 from oracle.weblogic.deploy.aliases import TypeUtils
 
+from wlsdeploy.aliases.alias_jvmargs import JVMArguments
 from wlsdeploy.aliases.location_context import LocationContext
 from wlsdeploy.aliases.wlst_modes import WlstModes
 from wlsdeploy.exception import exception_helper
@@ -590,6 +591,29 @@ def set_resource_manager_mbean(self, location, key, value, wlst_value):
         self.set_attribute(location, key, mbean, wlst_merge_value=wlst_value, use_raw_value=True)
         return
 
+    def set_jvm_args(self, location, key, value, wlst_value):
+        """
+        Set the server start args string. The new arguments are merged and re-sorted with existing arguments.
+        :param location: the location
+        :param key: the attribute name
+        :param value: the string value
+        :param wlst_value: the existing value of the attribute from WLST
+        :raises BundleAwareException of the specified type: if target is not found
+        """
+        if value is None or len(value) == 0:
+            result = value
+        elif wlst_value is None or len(wlst_value) == 0:
+            new_args = JVMArguments(self.__logger, value)
+            result = new_args.get_arguments_string()
+        else:
+            new_args = JVMArguments(self.__logger, value)
+            merged_args = JVMArguments(self.__logger, wlst_value)
+            merged_args.merge_jvm_arguments(new_args)
+            result = merged_args.get_arguments_string()
+
+        self.set_attribute(location, key, result, wlst_merge_value=wlst_value, use_raw_value=True)
+        return
+
     #
     # public set_attribute convenience methods
     #

core/src/main/resources/oracle/weblogic/deploy/aliases/category_modules/Server.json

@@ -938,7 +938,7 @@
             "default_name_value": "${NO_NAME_0:%SERVER%}",
             "folders": {},
             "attributes": {
-                "Arguments":          [ {"version": "[10,)",       "wlst_mode": "both",   "wlst_name": "Arguments",          "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "delimited_string[space]"           } ],
+                "Arguments":          [ {"version": "[10,)",       "wlst_mode": "both",   "wlst_name": "Arguments",          "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "delimited_string[space]",          "set_method": "MBEAN.set_jvm_args" } ],
                 "BeaHome":            [ {"version": "[10,)",       "wlst_mode": "both",   "wlst_name": "BeaHome",            "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "string",                           "uses_path_tokens": "true"} ],
                 "BootProperties":     [ {"version": "[10,)",       "wlst_mode": "online", "wlst_name": "BootProperties",     "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "properties",                       "get_method": "GET", "preferred_model_type": "list", "access": "RO"} ],
                 "ClassPath":          [ {"version": "[10,)",       "wlst_mode": "both",   "wlst_name": "ClassPath",          "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "delimited_string[path_separator]", "preferred_model_type": "delimited_string", "uses_path_tokens": "true"} ],

core/src/main/resources/oracle/weblogic/deploy/aliases/category_modules/ServerTemplate.json

@@ -948,7 +948,7 @@
             "attributes": {
                 "BeaHome":            [ {"version": "[12.1.2,)", "wlst_mode": "both",    "wlst_name": "BeaHome",            "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "string",                           "uses_path_tokens": "true"} ],
                 "BootProperties":     [ {"version": "[12.1.2,)", "wlst_mode": "online",  "wlst_name": "BootProperties",     "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "properties",                       "get_method": "GET", "access": "RO", "restart_required": "true" } ],
-                "ClassPath":          [ {"version": "[12.1.2,)", "wlst_mode": "both",    "wlst_name": "ClassPath",          "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "delimited_string[path_separator]", "uses_path_tokens": "true"} ],
+                "ClassPath":          [ {"version": "[12.1.2,)", "wlst_mode": "both",    "wlst_name": "ClassPath",          "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "delimited_string[path_separator]", "preferred_model_type": "delimited_string", "uses_path_tokens": "true"} ],
                 "JavaHome":           [ {"version": "[12.1.2,)", "wlst_mode": "both",    "wlst_name": "JavaHome",           "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "string",                           "uses_path_tokens": "true"} ],
                 "JavaVendor":         [ {"version": "[12.1.2,)", "wlst_mode": "both",    "wlst_name": "JavaVendor",         "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "string"                            } ],
                 "Arguments":          [ {"version": "[12.1.2,)", "wlst_mode": "both",    "wlst_name": "Arguments",          "wlst_path": "WP001", "value": {"default": "None" }, "wlst_type": "delimited_string[space]"           } ],

core/src/test/python/aliases_test.py

@@ -1321,20 +1321,6 @@ def testListGetToList(self):
         actual_attr, actual_value = self.aliases.get_wlst_attribute_name_and_value(location, actual_attr, actual_value)
         self.assertEqual(wlst_list, actual_value)
 
-    # server start args can be a list in the model, merge values and become a string for WLST
-    def testServerStartArgs(self):
-        location = LocationContext().append_location(FOLDERS.SERVER)
-        location.add_name_token(self.aliases.get_name_token(location), 'AdminServer')
-        location = location.append_location(FOLDERS.SERVER_START)
-        location.add_name_token(self.aliases.get_name_token(location), 'AdminServer')
-        attribute = FOLDERS.ARGUMENTS
-        value = ['-Dxyz=123,456,789']
-        existing_value = '-Dxyz=123,555,789'
-
-        dummy_attr, wlst_value = self.aliases.get_wlst_attribute_name_and_value(location, attribute, value,
-                                                                                existing_value)
-        self.assertEqual('-Dxyz=123,456,789', wlst_value)
-
     def testGetJTA(self):
         location = LocationContext()
         location.append_location(FOLDERS.JTA)

core/src/test/python/attributes_type_test.py

@@ -0,0 +1,59 @@
+"""
+Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
+The Universal Permissive License (UPL), Version 1.0
+"""
+import unittest
+
+from wlsdeploy.aliases.aliases import Aliases
+from wlsdeploy.aliases.wlst_modes import WlstModes
+from wlsdeploy.aliases.location_context import LocationContext
+from wlsdeploy.util.model_context import ModelContext
+
+
+class AttributesTypeTestCase(unittest.TestCase):
+    """
+       1) Unit tests must be a class that extends unittest.TestCase
+       2) Class methods with names starting with 'test' will be executed by the framework (all others skipped)
+    """
+    wls_version = '12.2.1.3'
+
+    def testDelimitedAttributes(self):
+        # This test ensures that delimited attributes are always comma-delimited for the model.
+        # Space-delimited attributes are allowed to bypass this rule.
+
+        model_context = ModelContext("test", {})
+        aliases = Aliases(model_context=model_context, wlst_mode=WlstModes.OFFLINE, wls_version=self.wls_version)
+
+        location = LocationContext()
+        self._check_folder(location, aliases)
+
+        for folder_name in aliases.get_model_top_level_folder_names():
+            location = LocationContext()
+            location.append_location(folder_name)
+            self._check_folder(location, aliases)
+
+    def _check_folder(self, location, aliases):
+        test_value = ['one', 'two']
+        expected_value = ','.join(test_value)
+
+        attr_infos = aliases.get_model_attribute_names_and_types(location)
+        for key in attr_infos.keys():
+            model_type = attr_infos[key]
+            if model_type.startswith("delimited_string") and not model_type.endswith("[space]"):
+
+                wlst_name = aliases.get_wlst_attribute_name(location, key)
+                if wlst_name is not None:
+                    model_name, value = aliases.get_model_attribute_name_and_value(location, wlst_name, test_value)
+                    message = "Value for attribute " + key + " in location " + str(location.get_folder_path()) + \
+                        " should be comma-delimited"
+                    self.assertEqual(expected_value, value, message)
+
+        folder_names = aliases.get_model_subfolder_names(location)
+        for folder_name in folder_names:
+            new_location = LocationContext(location).append_location(folder_name)
+            self._check_folder(new_location, aliases)
+        return
+
+
+if __name__ == '__main__':
+    unittest.main()