Add commandline injector tool

Author: CarolynRountree

core/src/main/python/discover.py

@@ -39,7 +39,6 @@
 from wlsdeploy.tool.discover.topology_discoverer import TopologyDiscoverer
 from wlsdeploy.tool.validate.validator import Validator
 from wlsdeploy.tool.util import filter_helper
-from wlsdeploy.util import path_utils
 from wlsdeploy.util import wlst_helper
 from wlsdeploy.util import model_translator
 from wlsdeploy.util.cla_utils import CommandLineArgUtil
@@ -137,7 +136,7 @@ def __process_online_args(optional_arg_map):
                 raise ex
             optional_arg_map[CommandLineArgUtil.ADMIN_PASS_SWITCH] = String(password)
 
-        __logger.info('WLSDPLY-06020')
+        __logger.info('WLSDPLY-06020', class_name=_class_name, method_name=_method_name)
     return mode
 
 
@@ -346,7 +345,7 @@ def __persist_model(model, model_context):
             if not model_file.delete():
                 model_file.deleteOnExit()
         except (WLSDeployArchiveIOException, IllegalArgumentException), arch_ex:
-            ex = exception_helper.create_discover_exception('WLSDPLY-06009', model_file.getAbsolutePath(),
+            ex = exception_helper.create_discover_exception('WLSDPLY-20023', model_file.getAbsolutePath(),
                                                             model_file_name, arch_ex.getLocalizedMessage(),
                                                             error=arch_ex)
             __logger.throwing(ex, class_name=_class_name, method_name=_method_name)
@@ -371,8 +370,7 @@ def __check_and_customize_model(model, model_context):
         __logger.info('WLSDPLY-06014', _class_name=_class_name, method_name=_method_name)
 
     inserted, variable_model, variable_file_name = VariableInjector(model.get_model(), model_context, WebLogicHelper(
-        __logger).get_actual_weblogic_version()).inject_variables_keyword_file(
-        variable_file_name=__get_default_variable_file(model_context))
+        __logger).get_actual_weblogic_version()).inject_variables_keyword_file()
     if inserted:
         model = Model(variable_model)
     try:
@@ -386,17 +384,6 @@ def __check_and_customize_model(model, model_context):
     return model
 
 
-def __get_default_variable_file(model_context):
-    extract_file_name = model_context.get_model_file()
-    if not extract_file_name:
-        extract_file_name = model_context.get_archive_file_name()
-    default_variable_file = path_utils.get_filename_no_ext_from_path(extract_file_name)
-    if default_variable_file:
-        default_variable_file = os.path.join(path_utils.get_pathname_from_path(extract_file_name),
-                                             default_variable_file + '.properties')
-    return default_variable_file
-
-
 def __log_and_exit(exit_code, _class_name, _method_name):
     """
     Helper method to log the exiting message and call sys.exit()
@@ -456,7 +443,7 @@ def main(args):
         __persist_model(model, model_context)
 
     except TranslateException, ex:
-        __logger.severe('WLSDPLY-06012', _program_name, model_context.get_archive_file_name(), ex.getLocalizedMessage(),
+        __logger.severe('WLSDPLY-20024', _program_name, model_context.get_archive_file_name(), ex.getLocalizedMessage(),
                 error=ex, class_name=_class_name, method_name=_method_name)
         __log_and_exit(CommandLineArgUtil.PROG_ERROR_EXIT_CODE, _class_name, _method_name)
 

core/src/main/python/variable_inject.py

@@ -2,9 +2,12 @@
 Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
 The Universal Permissive License (UPL), Version 1.0
 """
+import os
 import re
 
+from java.lang import Boolean
 from java.io import BufferedReader
+from java.io import File
 from java.io import FileInputStream
 from java.io import FileOutputStream
 from java.io import FileReader
@@ -13,6 +16,7 @@
 
 from oracle.weblogic.deploy.util import PyOrderedDict as OrderedDict
 
+from wlsdeploy.util import path_utils
 from wlsdeploy.exception import exception_helper
 from wlsdeploy.logging import platform_logger
 
@@ -54,14 +58,16 @@ def load_variables(file_path):
     return variable_map
 
 
-def write_variables(variable_map, file_path):
+def write_variables(variable_map, file_path, append=False):
     """
     Write the dictionary of variables to the specified file.
     :param variable_map: the dictionary of variables
     :param file_path: the file to which to write the properties
+    :param append: defaults to False. Append properties to the end of file
     :raises VariableException if an error occurs while storing the variables in the file
     """
-    method_name = 'write_variables'
+    _method_name = 'write_variables'
+    _logger.entering(file_path, append, class_name=_class_name, method_name=_method_name)
     props = Properties()
     for key in variable_map:
         value = variable_map[key]
@@ -70,19 +76,40 @@ def write_variables(variable_map, file_path):
     comment = exception_helper.get_message('WLSDPLY-01731')
     output_stream = None
     try:
-        output_stream = FileOutputStream(file_path)
+        output_stream = FileOutputStream(File(file_path), Boolean(append))
         props.store(output_stream, comment)
         output_stream.close()
     except IOException, ioe:
         ex = exception_helper.create_variable_exception('WLSDPLY-20007', file_path,
                                                         ioe.getLocalizedMessage(), error=ioe)
-        _logger.throwing(ex, class_name=_class_name, method_name=method_name)
+        _logger.throwing(ex, class_name=_class_name, method_name=_method_name)
         if output_stream is not None:
             output_stream.close()
         raise ex
+    _logger.exiting(class_name=_class_name, method_name=_method_name)
     return
 
 
+def get_default_variable_file_name(model_context):
+    """
+    Generate location and file name for the variable file.
+    If model file is present, use the model file name and location;
+    else, use the archive file name and location.
+    :param model_context: contains the model and archive file arguments
+    :return: location and file name of variable properties file.
+    """
+    _method_name = 'get_default_variable_file_name'
+    extract_file_name = model_context.get_model_file()
+    if not extract_file_name:
+        extract_file_name = model_context.get_archive_file_name()
+    default_variable_file = path_utils.get_filename_no_ext_from_path(extract_file_name)
+    if default_variable_file:
+        default_variable_file = os.path.join(path_utils.get_pathname_from_path(extract_file_name),
+                                             default_variable_file + '.properties')
+        _logger.finer('WLSDPLY-01736', default_variable_file, class_name=_class_name, method_name=_method_name)
+    return default_variable_file
+
+
 def get_variable_names(text):
     """
     Get the list of variable names in the supplied text.

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

@@ -247,11 +247,12 @@ WLSDPLY-01720=to_boolean() method called with non-boolean value {0} so returning
 
 # wlsdeploy/util/variables.py
 WLSDPLY-01730=Failed to load variables file {0}: {1}
-WLSDPLY-01731=Variables updated after encryption
+WLSDPLY-01731=Variables updated
 WLSDPLY-01732=Variable {0} is not found in properties file
 WLSDPLY-01733=Variable file {0} cannot be read: {1}
 WLSDPLY-01734=No value in variable file {0}
 WLSDPLY-01735=Variable substitution for {0} is deprecated, use @@PROP:{1}@@
+WLSDPLY-01736=Default variable file name {0}
 
 # wlsdeploy/util/weblogic_helper.py
 WLSDPLY-01740=Encryption failed: Unable to locate SerializedSystemIni
@@ -414,10 +415,10 @@ WLSDPLY-06005=Unable to clear the existing archive file. Correct the problem bef
 WLSDPLY-06006=Disconnect from the administration server failed: {0}
 WLSDPLY-06007=Closing the domain failed: {0}
 WLSDPLY-06008=Unable to create temporary file for writing the model: {0}
-WLSDPLY-06009=Unable to add model file {0} to archive as {1}: {2}
+
 WLSDPLY-06010={0} failed to clear the existing archive file at {1} of binaries: {2}
 WLSDPLY-06011={0} failed to discover domain {1} at {2} : {3}
-WLSDPLY-06012={0} failed to persist the model to the archive file {1}: {2}
+
 WLSDPLY-06013={0} failed to create the archive file at {1}: {2}
 WLSDPLY-06014=Filters applied to the model
 WLSDPLY-06015=Unable to run validation against the discovered model :  {0}
@@ -1163,6 +1164,12 @@ WLSDPLY-19532=No model variable injector file {0}
 WLSDPLY-19533=Will inject variable replacement strings into model using keyword directions found in model \
   variable injector file {0}
 
+# wlsdeploy/tool/variable_inject.py
+WLSDPLY-19600=Use model variable injector file {0} from command line arguments
+WLSDPLY-19601=Use variable injector keywords file {0} from command line arguments
+WLSDPLY-19602=Use variable properties file {0} from command line arguments
+WLSDPLY-19603=Archive file {0} was provided but does not contain a model file
+WLSDPLY-19604=Update model with injected variables
 
 # Common tooling messages used by multiple tools
 WLSDPLY-20000={0} encountered an unexpected validation error: {1}
@@ -1188,3 +1195,5 @@ WLSDPLY-20019=Filter entry in {0} has neither ID or path
 WLSDPLY-20020=Filter ID {0} is invalid
 WLSDPLY-20021=Filter path {0} does not exist
 WLSDPLY-20022=Error loading filter path {0}
+WLSDPLY-20023={0} unable to add model file {1} to archive as {2}: {3}
+WLSDPLY-20024={0} failed to persist the model to the archive file {1}: {2}

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

@@ -52,7 +52,7 @@
 
 SETLOCAL
 
-SET WLSDEPLOY_PROGRAM_NAME=validateModel
+SET WLSDEPLOY_PROGRAM_NAME=injectVariables
 
 SET SCRIPT_PATH=%~dp0
 FOR %%i IN ("%SCRIPT_PATH%") DO SET SCRIPT_PATH=%%~fsi