Create operator resource file for WKO target (#756)

* JIRA WDT-461 - Add model output for wko target; expose template files in lib/targets directory

* JIRA WDT-461 - Correct exception handling for reading file template

* JIRA WDT-461 - Added some comments from WKO template

* JIRA WDT-461 - Added new lines at end of JSON files

* JIRA WDT-461 - Combine two output dir getters for the same value

* JIRA WDT-461 - Added a comment for "replicas"

Author: rakillen

core/src/main/python/compare_model.py

@@ -642,7 +642,7 @@ def main():
 
     try:
         model_context = __process_args(sys.argv)
-        _outputdir = model_context.get_compare_model_output_dir()
+        _outputdir = model_context.get_output_dir()
         model1 = model_context.get_trailing_argument(0)
         model2 = model_context.get_trailing_argument(1)
 

core/src/main/python/prepare_model.py

@@ -379,7 +379,7 @@ def main():
 
     try:
         model_context = __process_args(sys.argv)
-        _outputdir = model_context.get_kubernetes_output_dir()
+        _outputdir = model_context.get_output_dir()
         model1 = model_context.get_model_file()
         # for f in [ model1 ]:
         #     if not os.path.exists(f):

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

@@ -96,7 +96,7 @@ def create_default_init_file(self, default_mapping_nodes):
 
         self._logger.info('WLSDPLY-01790', output_file, class_name=self._class_name, method_name=_method_name)
 
-        file_template_helper.create_file(template_path, template_hash, output_file, self._exception_type)
+        file_template_helper.create_file_from_resource(template_path, template_hash, output_file, self._exception_type)
 
     def _build_default_template_hash(self, mapping_section_nodes):
         """

core/src/main/python/wlsdeploy/tool/util/targets/vz_config_helper.py renamed to core/src/main/python/wlsdeploy/tool/util/targets/additional_output_helper.py

@@ -18,13 +18,12 @@
 from wlsdeploy.tool.util import k8s_helper
 from wlsdeploy.tool.util.targets import file_template_helper
 from wlsdeploy.util import dictionary_utils
+from wlsdeploy.util import path_utils
 from wlsdeploy.util import target_configuration_helper
 
 __class_name = 'vz_config_helper'
 __logger = PlatformLogger('wlsdeploy.tool.util')
 
-TEMPLATE_PATH = 'oracle/weblogic/deploy/targets/vz'
-
 # substitution keys used in the templates
 CLUSTER_NAME = 'clusterName'
 CLUSTERS = 'clusters'
@@ -43,42 +42,46 @@
 WEBLOGIC_CREDENTIALS_SECRET = 'webLogicCredentialsSecret'
 
 
-def create_vz_configuration(model, model_context, aliases, exception_type):
+def create_additional_output(model, model_context, aliases, exception_type):
     """
-    Create and write the Kubernetes resource configuration files for Verrazzano.
-    :param model: Model object, used to derive some values in the configurations
-    :param model_context: used to determine location and content for the configurations
+    Create and write additional output for the configured target type.
+    :param model: Model object, used to derive some values in the output
+    :param model_context: used to determine location and content for the output
     :param aliases: used to derive secret names
     :param exception_type: the type of exception to throw if needed
     """
 
     # -output_dir argument was previously verified
-    output_dir = model_context.get_kubernetes_output_dir()
+    output_dir = model_context.get_output_dir()
 
+    # all current output types use this hash, and process a set of template files
     template_hash = _build_template_hash(model, model_context, aliases)
 
-    _create_file('model.yaml', template_hash, output_dir, exception_type)
-
-    _create_file('binding.yaml', template_hash, output_dir, exception_type)
+    file_names = model_context.get_target_configuration().get_additional_output_types()
+    for file_name in file_names:
+        _create_file(file_name, template_hash, model_context, output_dir, exception_type)
 
 
-def _create_file(template_name, template_hash, output_dir, exception_type):
+def _create_file(template_name, template_hash, model_context, output_dir, exception_type):
     """
     Read the template from the resource stream, perform any substitutions,
     and write it to a file with the same name in the output directory.
     :param template_name: the name of the template file, and the output file
     :param template_hash: a dictionary of substitution values
+    :param model_context: used to determine location and content for the output
     :param output_dir: the directory to write the output file
     :param exception_type: the type of exception to throw if needed
     """
     _method_name = '_create_file'
 
-    template_path = TEMPLATE_PATH + '/' + template_name
+    target_key = model_context.get_target()
+    template_subdir = "targets/" + target_key + "/" + template_name
+    template_path = path_utils.find_config_path(template_subdir)
     output_file = File(output_dir, template_name)
 
     __logger.info('WLSDPLY-01662', output_file, class_name=__class_name, method_name=_method_name)
 
-    file_template_helper.create_file(template_path, template_hash, output_file, exception_type)
+    file_template_helper.create_file_from_file(template_path, template_hash, output_file, exception_type)
 
 
 def _build_template_hash(model, model_context, aliases):

core/src/main/python/wlsdeploy/tool/util/targets/file_template_helper.py

@@ -7,7 +7,9 @@
 import re
 
 from java.io import BufferedReader
+from java.io import IOException
 from java.io import InputStreamReader
+from java.lang import IllegalArgumentException
 from oracle.weblogic.deploy.util import FileUtils
 
 from wlsdeploy.exception import exception_helper
@@ -22,7 +24,7 @@
 _block_end_pattern = re.compile("({{/(.*)}})")
 
 
-def create_file(resource_path, template_hash, output_file, exception_type):
+def create_file_from_resource(resource_path, template_hash, output_file, exception_type):
     """
     Read the template from the resource stream, perform any substitutions,
     and write it to the output file.
@@ -31,17 +33,41 @@ def create_file(resource_path, template_hash, output_file, exception_type):
     :param output_file: the file to write
     :param exception_type: the type of exception to throw if needed
     """
-    _method_name = 'create_file'
+    _method_name = 'create_file_from_resource'
 
-    file_writer = open(output_file.getPath(), "w")
-
-    template_stream = FileUtils.getResourceAsStream(resource_path)
+    template_stream = FileUtils.getFileAsStream(resource_path)
     if template_stream is None:
         ex = exception_helper.create_exception(exception_type, 'WLSDPLY-01661', resource_path)
         __logger.throwing(ex, class_name=__class_name, method_name=_method_name)
         raise ex
 
-    template_reader = BufferedReader(InputStreamReader(FileUtils.getResourceAsStream(resource_path)))
+    _create_file_from_stream(template_stream, template_hash, output_file, exception_type)
+
+
+def create_file_from_file(file_path, template_hash, output_file, exception_type):
+    """
+    Read the template from the template file, perform any substitutions,
+    and write it to the output file.
+    :param file_path: the absolute file path of the source template
+    :param template_hash: a dictionary of substitution values
+    :param output_file: the file to write
+    :param exception_type: the type of exception to throw if needed
+    """
+    _method_name = 'create_file_from_file'
+
+    try:
+        template_stream = FileUtils.getFileAsStream(file_path)
+        if template_stream is not None:
+            _create_file_from_stream(template_stream, template_hash, output_file, exception_type)
+    except (IOException, IllegalArgumentException), ie:
+        ex = exception_helper.create_exception(exception_type, 'WLSDPLY-01666', file_path, ie)
+        __logger.throwing(ex, class_name=__class_name, method_name=_method_name)
+        raise ex
+
+
+def _create_file_from_stream(template_stream, template_hash, output_file, exception_type):
+    template_reader = BufferedReader(InputStreamReader(template_stream))
+    file_writer = open(output_file.getPath(), "w")
 
     current_block_key = None
     block_lines = []

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

@@ -594,16 +594,9 @@ def get_encryption_passphrase(self):
         """
         return self._encryption_passphrase
 
-    def get_compare_model_output_dir(self):
+    def get_output_dir(self):
         """
-        Return the compare model output dir
-        :return: output dir for compare models tool
-        """
-        return self._output_dir
-
-    def get_kubernetes_output_dir(self):
-        """
-        Return the output directory for generated k8s target.
+        Return the output directory.
         :return: output directory
         """
         return self._output_dir

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

@@ -17,7 +17,7 @@
 from wlsdeploy.logging.platform_logger import PlatformLogger
 from wlsdeploy.tool.util import k8s_helper
 from wlsdeploy.tool.util import variable_injector_functions
-from wlsdeploy.tool.util.targets import vz_config_helper
+from wlsdeploy.tool.util.targets import additional_output_helper
 from wlsdeploy.util import dictionary_utils
 from wlsdeploy.util.cla_utils import CommandLineArgUtil
 
@@ -103,7 +103,7 @@ def generate_k8s_script(model_context, token_dictionary, model_dictionary):
     domain_uid = k8s_helper.get_domain_uid(domain_name)
 
     nl = '\n'
-    file_location = model_context.get_kubernetes_output_dir()
+    file_location = model_context.get_output_dir()
     k8s_file = os.path.join(file_location, "create_k8s_secrets.sh")
     k8s_script = open(k8s_file, 'w')
 
@@ -239,13 +239,7 @@ def create_additional_output(model, model_context, aliases, exception_type):
     """
     _method_name = 'create_additional_output'
 
-    output_types = model_context.get_target_configuration().get_additional_output_types()
-    for output_type in output_types:
-        if output_type == VZ_EXTRA_CONFIG:
-            vz_config_helper.create_vz_configuration(model, model_context, aliases, exception_type)
-        else:
-            __logger.warning('WLSDPLY-01660', output_type, model_context.get_target(), class_name=__class_name,
-                             method_name=_method_name)
+    additional_output_helper.create_additional_output(model, model_context, aliases, exception_type)
 
 
 def create_secret_name(variable_name, suffix=None):

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

@@ -301,7 +301,7 @@ WLSDPLY-01662=Creating target configuration file {0}
 WLSDPLY-01663=Update {0} for {1}
 WLSDPLY-01664=Update {0} and {1} for {2}
 WLSDPLY-01665=Edit these values to change the namespace or domain UID
-
+WLSDPLY-01666=Unable to open file template {0}: {1}
 
 # wlsdeploy/util/enum.py
 WLSDPLY-01700=The value {0} is not a valid value of the Enum type {1}

core/src/main/targetconfigs/k8s/target.json

@@ -7,4 +7,4 @@
   "variable_injectors" : {"PORT": {},"HOST": {},"URL": {}},
   "validation_method" : "lax",
   "credentials_method" : "secrets"
-}
+}