Use -variable-file argument for injector tool; update documentation

Author: rakillen

core/src/main/python/variable_inject.py

@@ -4,6 +4,7 @@
 
 The entry point for the injectVariables tool.
 """
+import os
 import sys
 
 from java.io import File
@@ -14,11 +15,13 @@
 import wlsdeploy.tool.util.variable_injector as variable_injector
 from wlsdeploy.aliases.aliases import Aliases
 from wlsdeploy.aliases.wlst_modes import WlstModes
+from wlsdeploy.exception import exception_helper
 from wlsdeploy.logging.platform_logger import PlatformLogger
 from wlsdeploy.tool.util import model_context_helper
 from wlsdeploy.tool.util.credential_injector import CredentialInjector
 from wlsdeploy.tool.util.variable_injector import VariableInjector
 from wlsdeploy.util import model_translator, cla_helper, tool_main
+from wlsdeploy.util import path_helper
 from wlsdeploy.util.cla_utils import CommandLineArgUtil
 from wlsdeploy.util.exit_code import ExitCode
 from wlsdeploy.util.model import Model
@@ -36,7 +39,7 @@
 
 __optional_arguments = [
     CommandLineArgUtil.VARIABLE_INJECTOR_FILE_SWITCH,
-    CommandLineArgUtil.VARIABLE_PROPERTIES_FILE_SWITCH,
+    CommandLineArgUtil.VARIABLE_FILE_SWITCH,
     CommandLineArgUtil.DOMAIN_TYPE_SWITCH
 ]
 
@@ -53,10 +56,26 @@ def __process_args(args):
     argument_map = cla_util.process_args(args)
 
     cla_helper.validate_required_model(_program_name, argument_map)
+    __process_variable_filename_arg(argument_map)
 
     return model_context_helper.create_context(_program_name, argument_map)
 
 
+def __process_variable_filename_arg(argument_map):
+    _method_name = '__process_variable_filename_arg'
+
+    if CommandLineArgUtil.VARIABLE_FILE_SWITCH in argument_map:
+        variable_file_name = argument_map[CommandLineArgUtil.VARIABLE_FILE_SWITCH]
+        path_helper_obj = path_helper.get_path_helper()
+        variable_dir_name = path_helper_obj.get_local_parent_directory(variable_file_name)
+        if not os.path.exists(variable_dir_name):
+            ex = exception_helper.create_cla_exception(
+                ExitCode.ARG_VALIDATION_ERROR, 'WLSDPLY-19606', CommandLineArgUtil.VARIABLE_FILE_SWITCH,
+                variable_dir_name)
+            __logger.throwing(ex, class_name=_class_name, method_name=_method_name)
+            raise ex
+
+
 def __inject(model, model_context):
     """
     Inject variables into the model file that is loaded into the model_context.

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

@@ -172,15 +172,12 @@ def inject_variables_from_configuration(self, model_dictionary, append_option=No
 
         injector_file_list, injector_config_location = self._load_injector_file_list()
 
-        # discover may have passed -variable_file; inject variables may have passed -variable_properties_file
+        # discover or injector tool may have passed -variable_file
         variable_file_override = self._model_context.get_variable_file()
-        properties_file_override = self._model_context.get_variable_properties_file()
 
         if variable_file_override is not None:
             variable_file_location = variable_file_override
-        elif properties_file_override is not None:
-            variable_file_location = properties_file_override
-            _logger.info('WLSDPLY-19602', properties_file_override,
+            _logger.info('WLSDPLY-19602', variable_file_override,
                          class_name=_class_name, method_name=_method_name)
         else:
             variable_file_location = variables.get_default_variable_file_name(self._model_context)

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

@@ -89,7 +89,6 @@ class CommandLineArgUtil(object):
     REMOTE_SWITCH              = '-remote'
     # overrides for the variable injector
     VARIABLE_INJECTOR_FILE_SWITCH   = '-variable_injector_file'
-    VARIABLE_PROPERTIES_FILE_SWITCH = '-variable_properties_file'
     OUTPUT_DIR_SWITCH          = "-output_dir"
     WAIT_FOR_EDIT_LOCK_SWITCH  = "-wait_for_edit_lock"
     TARGET_SWITCH              = '-target'
@@ -314,10 +313,6 @@ def process_args(self, args, tool_type=TOOL_TYPE_DEFAULT, trailing_arg_count=0):
                 value, idx = self._get_arg_value(args, idx)
                 full_path = self._validate_variable_injector_file_arg(value)
                 self._add_arg(key, full_path, True)
-            elif self.is_variable_properties_file_key(key):
-                value, idx = self._get_arg_value(args, idx)
-                full_path = self._validate_variable_properties_file_arg(value)
-                self._add_arg(key, full_path, True)
             elif self.is_boolean_switch(key):
                 self._add_arg(key, True)
             elif self.is_compare_model_output_dir_switch(key):
@@ -975,25 +970,6 @@ def _validate_variable_injector_file_arg(self, value):
             raise ex
         return injector.getAbsolutePath()
 
-    # use this argument switch for the injector as the variables file does not have to exist
-    def get_variable_properties_file_key(self):
-        return self.VARIABLE_PROPERTIES_FILE_SWITCH
-
-    def is_variable_properties_file_key(self, key):
-        return self.VARIABLE_PROPERTIES_FILE_SWITCH == key
-
-    def _validate_variable_properties_file_arg(self, value):
-        method_name = '_validate_variable_properties_file_arg'
-
-        try:
-            variables = JFileUtils.validateFileName(value)
-        except JIllegalArgumentException, iae:
-            ex = create_cla_exception(ExitCode.ARG_VALIDATION_ERROR,
-                                      'WLSDPLY-01620', value, iae.getLocalizedMessage(), error=iae)
-            _logger.throwing(ex, class_name=self._class_name, method_name=method_name)
-            raise ex
-        return variables.getAbsolutePath()
-
     def is_boolean_switch(self, key):
         return key in self.BOOLEAN_SWITCHES
 

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

@@ -99,7 +99,6 @@ def __init__(self, program_name, arg_map=None):
         self._target = None
         self._target_configuration = None  # lazy load
         self._variable_injector_file = None
-        self._variable_properties_file = None
         self._discard_current_edit = False
         self._wait_for_edit_lock = False
         self._remote = False
@@ -314,9 +313,6 @@ def __copy_from_args(self, arg_map):
         if CommandLineArgUtil.VARIABLE_INJECTOR_FILE_SWITCH in arg_map:
             self._variable_injector_file = arg_map[CommandLineArgUtil.VARIABLE_INJECTOR_FILE_SWITCH]
 
-        if CommandLineArgUtil.VARIABLE_PROPERTIES_FILE_SWITCH in arg_map:
-            self._variable_properties_file = arg_map[CommandLineArgUtil.VARIABLE_PROPERTIES_FILE_SWITCH]
-
     def __copy__(self):
         arg_map = dict()
         if self._oracle_home is not None:
@@ -418,8 +414,6 @@ def __copy__(self):
             arg_map[CommandLineArgUtil.OUTPUT_DIR_SWITCH] = self._output_dir
         if self._variable_injector_file is not None:
             arg_map[CommandLineArgUtil.VARIABLE_INJECTOR_FILE_SWITCH] = self._variable_injector_file
-        if self._variable_properties_file is not None:
-            arg_map[CommandLineArgUtil.VARIABLE_PROPERTIES_FILE_SWITCH] = self._variable_properties_file
 
         new_context = ModelContext(self._program_name, arg_map)
         if not new_context.is_initialization_complete():
@@ -835,13 +829,6 @@ def get_variable_injector_file(self):
         """
         return self._variable_injector_file
 
-    def get_variable_properties_file(self):
-        """
-        Get the variable properties file override.
-        :return: the variable properties file
-        """
-        return self._variable_properties_file
-
     def get_trailing_arguments(self):
         """
         Return an array of trailing arguments.

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

@@ -129,8 +129,7 @@ def write_sorted_variables(program_name, variable_map, file_path, append=False):
 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.
+    Use the model file name and location.
     :param model_context: contains the model and archive file arguments
     :return: location and file name of variable properties file.
     """
@@ -146,8 +145,6 @@ def get_default_variable_file_name(model_context):
                       class_name=_class_name, method_name=_method_name)
     else:
         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_helper.get_local_filename_no_ext_from_path(extract_file_name)
         _logger.finer('WLSDPLY-01748', extract_file_name, default_variable_file,
                       class_name=_class_name, method_name=_method_name)

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

@@ -1985,10 +1985,11 @@ WLSDPLY-19547=Unrecognized key {0} in injector configuration file {1}, valid key
 
 # wlsdeploy/tool/variable_inject.py
 WLSDPLY-19600=Use model variable injector file {0} from command line arguments
-WLSDPLY-19602=Use variable properties file {0} from command line arguments
+WLSDPLY-19602=Use variable 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
 WLSDPLY-19605=
+WLSDPLY-19606=Directory for {0} argument {1} does not exist
 
 # wlsdeploy/tool/util/credential_injector.py
 WLSDPLY-19650=Unused credential variables will not be filtered for target credentials method {0}

core/src/test/python/variable_injector_test.py

@@ -15,6 +15,7 @@
 from wlsdeploy.aliases.model_constants import ADMIN_PASSWORD
 from wlsdeploy.tool.util.variable_injector import STANDARD_PASSWORD_INJECTOR
 from wlsdeploy.tool.util.variable_injector import VariableInjector
+from wlsdeploy.util.cla_utils import CommandLineArgUtil
 from wlsdeploy.util.model_context import ModelContext
 from wlsdeploy.util.model_translator import FileToPython
 
@@ -33,7 +34,9 @@ def setUp(self):
         BaseTestCase.setUp(self)
         self.name = 'VariableFileHelperTest'
         self._model = FileToPython(self._model_file).parse()
-        self._model_context = ModelContext(self.name, {})
+        self._model_context = ModelContext(self.name, {
+            CommandLineArgUtil.VARIABLE_FILE_SWITCH: self._variable_file
+        })
         aliases = Aliases(self._model_context, wls_version='12.2.1.3')
         self._helper = VariableInjector(self.name, self._model_context, aliases)
 
@@ -264,7 +267,6 @@ def testWithVariableHelperKeywords(self):
         expected[short_name + '.machine1.ListenPort'] = '5557'
 
         self._establish_directory(self.OUTPUT_DIR)
-        self._model_context._variable_properties_file = self._variable_file
 
         # Define custom configuration path for WDT, with custom injector files
         config_dir = self._set_custom_config_dir('injector-wdt-config')

documentation/4.0/content/userguide/tools/variable_injection.md

@@ -21,4 +21,4 @@ In addition to variable injector processing, the tool will automatically tokeniz
 | `-model_file` | The location of the model file in which variables will be injected. If not specified, the tool will look for the model in the archive file. Either the `-model_file` or the `-archive_file` argument must be provided.                                                                                                   |    |
 | `-oracle_home` | Home directory for the Oracle WebLogic installation. This is required unless the `ORACLE_HOME` environment variable is set.                                                                                                                                                                                              |    |
 | `-variable_injector_file` | The location of the variable injector file which contains the variable injector list for this model injection run. If this argument is not provided, the `model_variable_injector.json` file must exist in the `lib` directory in the `$WLSDEPLOY_HOME` location.                                                        |    |
-| `-variable_properties_file` | The location of the property file in which to store any variable names injected into the model. If this command-line argument is not specified, the variable will be located and named based on the model file or archive file name and location. If the file exists, the file will be updated with new variable values. |    |
+| `-variable_file` | The location of the property file in which to store any variable names injected into the model. If this command-line argument is not specified, the variable will be located and named based on the model file name and location. If the file exists, the file will be updated with new variable values. |    |

installer/src/main/bin/injectVariables.cmd

@@ -81,14 +81,12 @@ ECHO                           the model_variable_injector.json file must exist
 ECHO                           the lib directory in the WLSDEPLOY_HOME location.
 ECHO.
 ECHO         variable_file   - the location of the property file in which to store
-ECHO                           any variable names injected into the model. This
-ECHO                           argument overrides the value in the model injector
-ECHO                           file.  If the variable file is not listed in the
-ECHO                           model injector file, and this command-line argument
-ECHO                           is not used, the variable properties will be located
-ECHO                           and named based on the model file or archive file name
-ECHO                           and location.  If the variable file exists, new
-ECHO                           variable values will be appended to the file.
+ECHO                           any variable names injected into the model.
+ECHO                           If this command-line argument is not used,
+ECHO                           the variable properties will be located and named
+ECHO                           based on the model file name and location.
+ECHO                           If the variable file exists, new variable values
+ECHO                           will be appended to the file.
 ECHO.
 
 :exit_script

installer/src/main/bin/injectVariables.sh

@@ -47,14 +47,12 @@ usage() {
   echo "                          the lib directory in the WLSDEPLOY_HOME location."
   echo ""
   echo "        variable_file   - the location of the property file in which to store"
-  echo "                          any variable names injected into the model. This"
-  echo "                          argument overrides the value in the model injector"
-  echo "                          file.  If the variable file is not listed in the"
-  echo "                          model injector file, and this command-line argument"
-  echo "                          is not used, the variable properties will be located"
-  echo "                          and named based on the model file or archive file name"
-  echo "                          and location.  If the variable file exists, new"
-  echo "                          variable values will be appended to the file."
+  echo "                          any variable names injected into the model."
+  echo "                          If this command-line argument is not used,"
+  echo "                          the variable properties will be located and named"
+  echo "                          based on the model file name and location."
+  echo "                          If the variable file exists, new variable values"
+  echo "                          will be appended to the file."
   echo ""
 }