changes for review suggestions

Author: CarolynRountree

core/src/main/python/discover.py

@@ -25,6 +25,7 @@
 
 sys.path.append(os.path.dirname(os.path.realpath(sys.argv[0])))
 
+import wlsdeploy.tool.util.variable_injector as variable_injector
 from wlsdeploy.aliases.wlst_modes import WlstModes
 from wlsdeploy.exception import exception_helper
 from wlsdeploy.logging.platform_logger import PlatformLogger
@@ -60,6 +61,7 @@
     # Used by shell script to locate WLST
     CommandLineArgUtil.MODEL_FILE_SWITCH,
     CommandLineArgUtil.DOMAIN_TYPE_SWITCH,
+    CommandLineArgUtil.VARIABLE_PROPERTIES_FILE_SWITCH,
     CommandLineArgUtil.ADMIN_URL_SWITCH,
     CommandLineArgUtil.ADMIN_USER_SWITCH,
     CommandLineArgUtil.ADMIN_PASS_SWITCH
@@ -80,6 +82,7 @@ def __process_args(args):
     __verify_required_args_present(required_arg_map)
     __wlst_mode = __process_online_args(optional_arg_map)
     __process_archive_filename_arg(required_arg_map)
+    __process_variable_filename_arg(optional_arg_map)
 
     combined_arg_map = optional_arg_map.copy()
     combined_arg_map.update(required_arg_map)
@@ -159,6 +162,28 @@ def __process_archive_filename_arg(required_arg_map):
     return
 
 
+def __process_variable_filename_arg(optional_arg_map):
+    """
+    If the variable filename argument is present, the required model variable injector json file must exist in
+    the WLSDEPLOY lib directory.
+    :param optional_arg_map: containing the variable file name
+    :raises: CLAException: if this argument is present but the model variable injector json does not exist
+    """
+    _method_name = '__process_variable_filename_arg'
+
+    if CommandLineArgUtil.VARIABLE_PROPERTIES_FILE_SWITCH in optional_arg_map:
+        variable_injector_file_name = variable_injector.get_default_variable_injector_file_name()
+        try:
+            FileUtils.validateExistingFile(variable_injector_file_name)
+        except IllegalArgumentException, ie:
+            ex = exception_helper.create_cla_exception('WLSDPLY-06021', optional_arg_map[
+                CommandLineArgUtil.VARIABLE_PROPERTIES_FILE_SWITCH], variable_injector_file_name,
+                                                       ie.getLocalizedMessage(), error=ie)
+            __logger.throwing(ex, class_name=_class_name, method_name=_method_name)
+            raise ex
+    return
+
+
 def __discover(model_context):
     """
     Populate the model from the domain.

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

@@ -34,7 +34,7 @@
 VARIABLE_KEYWORDS_FILE_NAME_ARG = 'variable_keywords_file_name'
 VARIABLE_INJECTOR_FILES_PATH_ARG = 'variable_injector_files_path_name'
 VARIABLE_FILE_NAME_ARG = 'variable_file_name'
-VARIABLE_FILE_NAME = 'variables.json'
+VARIABLE_FILE_NAME = 'variable.properties'
 VARIABLE_FILE_APPEND_ARG = 'append_to_variables'
 VARIABLE_FILE_APPEND = 'append'
 VARIABLE_FILE_UPDATE = 'update'
@@ -123,7 +123,7 @@ def inject_variables_keyword_file(self, **kwargs):
         return_model = self.__original
         variable_file_location = None
         if variables_injector_dictionary and keywords_dictionary:
-            variable_file_location = self._get_variable_file_name(variables_injector_dictionary, **kwargs)
+            variable_file_location = self._get_variable_file_name(**kwargs)
             if not variable_file_location:
                 _logger.warning('WLSDPLY-19520', variable_injector_location_file, class_name=_class_name,
                                 method_name=_method_name)
@@ -471,17 +471,11 @@ def _log_mbean_not_found(self, mbean, replacement, location):
             _logger.finer('WLSDPLY-19516', mbean, replacement, location.get_folder_path(),
                           class_name=_class_name, method_name=_method_name)
 
-    def _get_variable_file_name(self, variables_injector_dictionary, **kwargs):
+    def _get_variable_file_name(self, **kwargs):
         _method_name = '_get_variable_file_name'
         if VARIABLE_FILE_NAME_ARG in kwargs:
             variable_file_location = kwargs[VARIABLE_FILE_NAME_ARG]
             _logger.finer('WLSDPLY-19522', variable_file_location, class_name=_class_name, method_name=_method_name)
-            if VARIABLE_FILE_NAME_ARG in variables_injector_dictionary:
-                del variables_injector_dictionary[VARIABLE_FILE_NAME_ARG]
-        elif VARIABLE_FILE_NAME_ARG in variables_injector_dictionary:
-            variable_file_location = variables_injector_dictionary[VARIABLE_FILE_NAME_ARG]
-            del variables_injector_dictionary[VARIABLE_FILE_NAME_ARG]
-            _logger.finer('WLSDPLY-19521', variable_file_location, class_name=_class_name, method_name=_method_name)
         else:
             variable_file_location = variables.get_default_variable_file_name(self.__model_context)
         if variable_file_location:
@@ -554,6 +548,15 @@ def _check_replace_variable_value(self, location, attribute, variable_value, inj
         return variable_value
 
 
+def get_default_variable_injector_file_name(variable_injector_file_name=VARIABLE_INJECTOR_FILE_NAME):
+    """
+    Return the default name and location of the model variable injector json file
+    :param variable_injector_file_name: if different than the default name
+    :return: file path in the wlsdeploy location and file name
+    """
+    return os.path.join(_wlsdeploy_location, DEFAULT_FILE_LOCATION, variable_injector_file_name)
+
+
 def _load_variable_file(variable_file_location, **kwargs):
     _method_name = '_load_variable_file'
     append = False
@@ -581,7 +584,7 @@ def _get_variable_injector_file_name(**kwargs):
     if VARIABLE_INJECTOR_PATH_NAME_ARG in kwargs:
         return os.path.join(kwargs[VARIABLE_INJECTOR_PATH_NAME_ARG], variable_injector_file_name)
     else:
-        return os.path.join(_wlsdeploy_location, DEFAULT_FILE_LOCATION, variable_injector_file_name)
+        return get_default_variable_injector_file_name(variable_injector_file_name)
 
 
 def _get_variable_keywords_file_name(**kwargs):

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

@@ -421,6 +421,8 @@ WLSDPLY-06018=Please enter the WebLogic administrator password
 WLSDPLY-06019=Failed to read the WebLogic administrator password input from the user: {0}
 WLSDPLY-06020=Discover of domain is not currently supported in online mode. Ignoring Admin credential arguments which \
    are present for FUTURE TBD release.
+WLSDPLY-06021=The variables file command line argument {0} was used but the model variables injector file \
+  {1} does not exist : {2}
 
 # discoverer.py
 WLSDPLY-06100=Find attributes at location {0}
@@ -1133,13 +1135,12 @@ WLSDPLY-19512=CUSTOM keyword was found in variables injector list but no files w
   keyword
 WLSDPLY-19513=Variables were located and inserted in the model using injector file {0}
 WLSDPLY-19514=Located mbean {0} in the model file
-WLSDPLY-19515=Invalid mbean {0} found in replacement property {1} at location {2}
-WLSDPLY-19516=MBean {0} not found in the model for replacement property {1} at location (2}
-WLSDPLY-19517=Attribute {0} not found in the model for replacement property {1} at location {2}
+WLSDPLY-19515=Invalid mbean {0} found in injector directive {1} at location {2}
+WLSDPLY-19516=MBean {0} not found in the model for injector directive {1} at location {2}
+WLSDPLY-19517=Attribute {0} not found in the model for injector directive {1} at location {2}
 WLSDPLY-19518=Variables were inserted into the model and written to the variables file {0}
 WLSDPLY-19519=No variables were inserted into the model during variable replacement
 WLSDPLY-19520=Variable injector file was found at location {0} but no variable properties file name was provided
-WLSDPLY-19521=Variables property file name {0} extracted from model injector json file
 WLSDPLY-19522=Variables property file name {0} was passed as an argument to the variable injector
 WLSDPLY-19523=MBean {0} from injector path represents a named MBean folder at location {1}
 WLSDPLY-19524=Segment {0} for attribute {1} not found in model value {2} at location {3}

core/src/test/python/variable_injector_test.py

@@ -239,6 +239,7 @@ def testWithVariableHelperKeywords(self):
         expected['Machine.machine1.NodeManager.PasswordEncrypted'] = '--FIX ME--'
         expected['Machine.machine1.NodeManager.UserName'] = 'admin'
         inserted, model, variable_file_name = self._helper.inject_variables_keyword_file(
+            variable_file_name=self._variable_file,
             variable_injector_path_name=self._resources_dir,
             variable_injector_file_name=self._variable_injector_keyword,
             variable_keywords_path_name=self._resources_dir, variable_keywords_file_name=self._keywords_file)

core/src/test/resources/variable_injector_keyword.json

@@ -1,5 +1,4 @@
 {
-  "variable_file_name": "../../test-classes/variable.injector.test.properties",
   "PORT": {},
   "URL": {},
   "CREDENTIALS": {}

installer/src/main/bin/discoverDomain.cmd

@@ -115,6 +115,13 @@ IF %JVM_VERSION% LSS 7 (
   ECHO JDK version is %JVM_FULL_VERSION%, setting JAVA_VENDOR to Sun...
   SET JAVA_VENDOR=Sun
 )
+@rem
+@rem Check to see if no args were given and print the usage message
+@rem
+IF "%~1" == "" (
+  SET RETURN_CODE=0
+  GOTO usage
+)
 
 @rem
 @rem Find the args required to determine the WLST script to run
@@ -125,6 +132,10 @@ SET DOMAIN_TYPE=
 SET WLST_PATH_DIR=
 
 :arg_loop
+IF "%1" == "-help" (
+  SET RETURN_CODE=0
+  GOTO usage
+)
 IF "%1" == "-oracle_home" (
   SET ORACLE_HOME=%2
   SHIFT
@@ -295,8 +306,6 @@ ECHO.
 ECHO discoverDomain.cmd failed ^(exit code = %RETURN_CODE%^) >&2
 GOTO exit_script
 
-:usage
-ECHO.
 :usage
 ECHO.
 ECHO Usage: %~nx0 -oracle_home ^<oracle-home^>

installer/src/main/bin/injectVariables.cmd

@@ -312,45 +312,40 @@ GOTO exit_script
 ECHO.
 ECHO Usage: %~nx0 [-help]
 ECHO              -oracle_home ^<oracle-home^>
-ECHO              -model_file ^<model-file^> | -archive_file ^<archive-file^>
+ECHO              [-model_file ^<model-file^>]
+ECHO              [-archive_file ^<archive-file^>]
 ECHO              [-variable_injector_file ^<variable-injector-file^>]
-ECHO              [-variable_keywords_file ^<variable-keywords-file^>]
 ECHO              [-variable_properties_file ^<variable-file^>]
 ECHO              [-domain_type ^<domain-type^>]
 ECHO              [-wlst_path ^<wlst-path^>]
 ECHO.
 ECHO     where:
-ECHO         oracle-home     - the existing Oracle Home directory with the correct version for the model
+ECHO         oracle-home            - the existing Oracle Home directory with the correct version for the model
 ECHO.
-ECHO         model-file      - the location of the model file in which variables will be injected.
-ECHO                           If not specified, the tool will look for the model
-ECHO                           in the archive file. Either the model_file or the archive_file argument must be provided.
+ECHO         model-file             - the location of the model file in which variables will be injected.
+ECHO                                  If not specified, the tool will look for the model
+ECHO                                  in the archive file. Either the model_file or the archive_file argument
+ECHO                                  must be provided.
 ECHO.
-ECHO         archive-file    - the path to the archive file that contains a model in which the variables
-ECHO                           will be injected. If the model-file argument is used, this argument will be
-ECHO                           ignored. The archive file must contain a valid model.
+ECHO         archive-file           - the path to the archive file that contains a model in which the variables
+ECHO                                  will be injected. If the model-file argument is used, this argument will be
+ECHO                                  ignored. The archive file must contain a valid model.
 ECHO.
-ECHO         variable-injector-file  - the location of the variable injector file which contains the variable
-ECHO                           injector keywords for this model injection run. If this argument is not provided,
-ECHO                           the model_variable_injector.json file must exist in the lib directory in the
-ECHO                           WLSDEPLOY_HOME location.
+ECHO         variable_properties_file - the location of the property file in which to store any variable names injected
+ECHO                                    into the model. If this command line argument is not specified, the variable
+ECHO                                    will be located and named based on the model file or archive file name and
+ECHO                                    location. If the file exists, the file will be updated with new variable values.
 ECHO.
-ECHO         variable-keywords-file   - this argument overrides the INSTALLED version of the allowed variable keywords
-ECHO                           for the variable injector. This argument is for advanced usage only. The installed
-ECHO                           keywords file is located in the lib directory of WLSDEPLOY_HOME location.
+ECHO         variable-injector-file - the location of the variable injector file which contains the variable
+ECHO                                  injector keywords for this model injection run. If this argument is not provided,
+ECHO                                  the model_variable_injector.json file must exist in the lib directory in the
+ECHO                                  WLSDEPLOY_HOME location.
 ECHO.
-ECHO         variable-file   - the location of the property file in which to store any variable names injected
-ECHO                           into the model. This argument overrides the value in the model injector file.
-ECHO                           If the variable file is not listed in the model injector file, and this command
-ECHO                           line argument is not used, the variable properties will be located and named
-ECHO                           based on the model file or archive file name and location.
-ECHO                           If the variable file exists, new variable values will be appended to the file.
+ECHO         domain-type            - the type of domain (e.g., WLS, JRF).
+ECHO                                  Used to locate wlst.cmd if wlst-path not specified
 ECHO.
-ECHO         domain-type     - the type of domain (e.g., WLS, JRF).
-ECHO                           Used to locate wlst.cmd if wlst-path not specified
-ECHO.
-ECHO         wlst-path       - the Oracle Home subdirectory of the wlst.cmd
-ECHO                           script to use (e.g., ^<ORACLE_HOME^>\soa)
+ECHO         wlst-path              - the Oracle Home subdirectory of the wlst.cmd
+ECHO                                  script to use (e.g., ^<ORACLE_HOME^>\soa)
 ECHO.
 
 :exit_script

installer/src/main/samples/model_variable_injector.json

@@ -1,5 +1,4 @@
 {
-	"variable_file_name": "@@WLSDEPLOY@@/samples/variables.properties",
 	"CREDENTIALS": {},
 	"CUSTOM": {
 		"file-list": [ "@@WLSDEPLOY@@/samples/custom_injector.json" ]