Allow kubernetes section of model to use "named object list" format

Author: rakillen

core/src/main/python/wlsdeploy/tool/extract/domain_resource_extractor.py

@@ -50,6 +50,12 @@
 DEFAULT_IMAGE_PULL_SECRETS = PASSWORD_TOKEN
 DEFAULT_SOURCE_TYPE = 'Image'
 
+# deprecated - used for "named object list" format
+OBJECT_NAME_ATTRIBUTES = {
+    'spec/adminServer/adminService/channels': 'channelName',
+    'spec/clusters': 'clusterName'
+}
+
 _secret_pattern = re.compile("@@SECRET:([\\w.-]+):[\\w.-]+@@")
 
 
@@ -146,6 +152,23 @@ def _process_object_array(self, model_value, item_info, schema_path):
         :param schema_path: the path of schema elements, used for supported check
         """
         child_list = list()
+
+        # deprecated "named object list" format - warning was issued in validator
+        if isinstance(model_value, dict):
+            for name in model_value:
+                object_map = model_value[name]
+                next_target_dict = PyOrderedDict()
+                self._process_object(object_map, item_info, next_target_dict, schema_path)
+
+                # see if the model name should become an attribute in the target dict
+                mapped_name = get_mapped_key(schema_path)
+                properties = wko_schema_helper.get_properties(item_info)
+                if (mapped_name in properties.keys()) and (mapped_name not in next_target_dict.keys()):
+                    _add_to_top(next_target_dict, mapped_name, name)
+                child_list.append(next_target_dict)
+            return child_list
+        # end deprecated
+
         for object_map in model_value:
             next_target_dict = PyOrderedDict()
             self._process_object(object_map, item_info, next_target_dict, schema_path)
@@ -309,6 +332,22 @@ def _add_secrets(folder, secrets, domain_uid):
                     secrets.append(secret_name)
 
 
+# deprecated
+def get_mapped_key(schema_path):
+    """
+    For the deprecated "named object list format", the name of each item in a
+    multiple folder sometimes corresponds to one of its attributes, usually "name".
+    If a different attribute name is used for the path, return that name.
+    If the default 'name' is returned, caller should verify that it is an available attribute.
+    :param schema_path: the slash-delimited path of the elements (no multi-element names)
+    :return: the attribute key to be used
+    """
+    mapped_key = dictionary_utils.get_element(OBJECT_NAME_ATTRIBUTES, schema_path)
+    if mapped_key is not None:
+        return mapped_key
+    return 'name'
+
+
 def _add_to_top(dictionary, key, item):
     """
     Add an item to the beginning of an ordered dictionary.

core/src/main/python/wlsdeploy/tool/validate/kubernetes_validator.py

@@ -109,14 +109,25 @@ def _validate_object_array(self, model_value, property_map, schema_path, model_p
         :param model_path: the path of model elements (including array indices), used for logging
         """
         _method_name = '_validate_object_array'
+
+        # deprecated "named object list" format
+        if isinstance(model_value, dict):
+            self._logger.warning("WLSDPLY-05091", model_path, class_name=self._class_name, method_name=_method_name)
+            for name in model_value:
+                object_map = model_value[name]
+                next_model_path = model_path + "/" + name
+                self.validate_folder(object_map, property_map, schema_path, next_model_path)
+            return
+        # end deprecated
+
         if not isinstance(model_value, list):
             self._logger.severe("WLSDPLY-05040", model_path, class_name=self._class_name, method_name=_method_name)
             return
 
         index = 0
-        for name_map in model_value:
+        for object_map in model_value:
             index_path = '%s[%s]' % (model_path, index)
-            self.validate_folder(name_map, property_map, schema_path, index_path)
+            self.validate_folder(object_map, property_map, schema_path, index_path)
             index += 1
 
     def _validate_simple_map(self, model_value, property_name, model_path):

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

@@ -487,6 +487,7 @@ WLSDPLY-05040=Expected a list of objects in model location {0}
 
 # wlsdeploy/tool/validate/kubernetes_validator.py
 WLSDPLY-05090=Model folder {0} is not supported, will be skipped
+WLSDPLY-05091=Model folder {0} uses deprecated "named object list" format, should be a hyphenated object list
 
 # wlsdeploy/tools/validate/validation_utils.py
 WLSDPLY-05300={0} variable is referenced in the value of the {1} variable, but is not defined in {2}

core/src/test/python/wlsdeploy/tool/extract/extract_test.py

@@ -22,8 +22,13 @@ def __init__(self, *args):
 
     def setUp(self):
         BaseTestCase.setUp(self)
+        self._suspend_logs('wlsdeploy.extract')
         self._establish_directory(self.EXTRACT_OUTPUT_DIR)
 
+    def tearDown(self):
+        BaseTestCase.tearDown(self)
+        self._restore_logs()
+
     def testDefaultModel(self):
         """
         Test that default values and information from the model
@@ -58,12 +63,32 @@ def testKubernetesModel(self):
         self._match_values("Cluster 0 clusterName", cluster_list[0]['clusterName'], 'CLUSTER_1')
         self._match_values("Cluster 1 clusterName", cluster_list[1]['clusterName'], 'CLUSTER_2')
 
-        # secrets from the model should be in the domain resource file
+        # secrets from the kubernetes section should be in the domain resource file
         secret_list = self._traverse(resource, 'spec', 'configuration', 'secrets')
         self._match_values("Secret count", len(secret_list), 2)
         self._match_values("Secret 0", secret_list[0], 'secret-1')
         self._match_values("Secret 1", secret_list[1], 'secret-2')
 
+    # deprecated
+    def testNamedObjectListModel(self):
+        """
+        Test that fields using the deprecated "named object list" in the kubernetes section of the model
+        are transferred to the resulting domain resource file
+        """
+        resource = self._extract_domain_resource('3')
+
+        # serverPod/env from the kubernetes section should be in the domain resource file
+        env_list = self._traverse(resource, 'spec', 'serverPod', 'env')
+        self._match_values("Env count", len(env_list), 2)
+        self._match_values("Env 0", env_list[0]['name'], 'JAVA_OPTIONS')
+        self._match_values("Env 1", env_list[1]['name'], 'USER_MEM_ARGS')
+
+        # clusters from kubernetes section should be in the domain resource file
+        cluster_list = self._traverse(resource, 'spec', 'clusters')
+        self._match_values("Cluster count", len(cluster_list), 2)
+        self._match_values("Cluster 0 clusterName", cluster_list[0]['clusterName'], 'CLUSTER_1')
+        self._match_values("Cluster 1 clusterName", cluster_list[1]['clusterName'], 'CLUSTER_2')
+
     def _extract_domain_resource(self, suffix):
         model_file = os.path.join(self.MODELS_DIR, 'model-' + suffix + '.yaml')
         translator = FileToPython(model_file, use_ordering=True)

core/src/test/resources/extract/model-3.yaml

@@ -0,0 +1,21 @@
+# Copyright (c) 2021, Oracle Corporation and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+
+# Test model for extractDomainResource.
+# This will test that the deprecated "named object list" format is still supported in WDT 2.0
+
+kubernetes:
+    spec:
+        serverPod:
+            env:
+                JAVA_OPTIONS:
+                    value: -good_java
+                USER_MEM_ARGS:
+                    value: '-XX:+UseContainerSupport -Djava.security.egd=file:/dev/./urandom '
+        clusters:
+            CLUSTER_1:
+                serverStartState: RUNNING
+                replicas: 1
+            CLUSTER_2:
+                serverStartState: RUNNING
+                replicas: 4