Change command line to not require -path argument (#593)

* JIRA WDT-388 Change command line to not require -path argument

* JIRA WDT-388 Remove unused variable

Author: rakillen

core/src/main/python/model_help.py

@@ -24,8 +24,7 @@
 __logger = PlatformLogger('wlsdeploy.modelhelp')
 
 __required_arguments = [
-    CommandLineArgUtil.ORACLE_HOME_SWITCH,
-    CommandLineArgUtil.PATH_SWITCH
+    CommandLineArgUtil.ORACLE_HOME_SWITCH
 ]
 
 __optional_arguments = [
@@ -50,7 +49,7 @@ def __process_args(args):
     _method_name = '__process_args'
 
     cla_util = CommandLineArgUtil(_program_name, __required_arguments, __optional_arguments)
-    required_arg_map, optional_arg_map = cla_util.process_args(args)
+    required_arg_map, optional_arg_map = cla_util.process_args(args, trailing_arg_count=1)
 
     cla_helper.verify_required_args_present(_program_name, __required_arguments, required_arg_map)
 
@@ -125,7 +124,7 @@ def main(args):
         sys.exit(exit_code)
 
     try:
-        model_path = model_context.get_path()
+        model_path = model_context.get_trailing_argument(0)
         exit_code = print_help(model_path, model_context)
     except CLAException, ve:
         __logger.severe('WLSDPLY-10112', _program_name, ve.getLocalizedMessage(), error=ve,

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

@@ -45,7 +45,6 @@ class CommandLineArgUtil(object):
     MODEL_FILE_SWITCH          = '-model_file'
     OPSS_WALLET_SWITCH         = '-opss_wallet'
     OPSS_WALLET_PASSPHRASE     = '-opss_wallet_passphrase'
-    PATH_SWITCH                = '-path'
     PREVIOUS_MODEL_FILE_SWITCH = '-prev_model_file'
     VARIABLE_FILE_SWITCH       = '-variable_file'
     RCU_DB_SWITCH              = '-rcu_db'
@@ -64,6 +63,8 @@ class CommandLineArgUtil(object):
     RUN_RCU_SWITCH             = '-run_rcu'
     TARGET_VERSION_SWITCH      = '-target_version'
     TARGET_MODE_SWITCH         = '-target_mode'
+    # phony arg used as a key to store the trailing (non-switched) arguments
+    TRAILING_ARGS_SWITCH       = '-trailing_arguments'
     ATTRIBUTES_ONLY_SWITCH     = '-attributes_only'
     FOLDERS_ONLY_SWITCH        = '-folders_only'
     RECURSIVE_SWITCH           = '-recursive'
@@ -131,12 +132,13 @@ def set_allow_multiple_models(self, allow_multiple_models):
         """
         self._allow_multiple_models = allow_multiple_models
 
-    def process_args(self, args, tool_type=TOOL_TYPE_DEFAULT):
+    def process_args(self, args, tool_type=TOOL_TYPE_DEFAULT, trailing_arg_count=0):
         """
         This method parses the command-line arguments and returns dictionaries of the required and optional args.
 
         :param args: sys.argv
         :param tool_type: optional, type of tool for special argument processing
+        :param trailing_arg_count: optional, the number of trailing (no switch) arguments
         :return: the required and optional argument dictionaries
         :raises CLAException: if argument processing encounters a usage or validation exception
         """
@@ -156,6 +158,9 @@ def process_args(self, args, tool_type=TOOL_TYPE_DEFAULT):
             ex.setExitCode(self.HELP_EXIT_CODE)
             raise ex
 
+        args = self._check_trailing_arguments(args, trailing_arg_count)
+        args_len = len(args)
+
         idx = 1
         while idx < args_len:
             key = args[idx]
@@ -280,9 +285,6 @@ def process_args(self, args, tool_type=TOOL_TYPE_DEFAULT):
                 value, idx = self._get_arg_value(args, idx, key)
                 full_path = self._validate_domain_resource_file_arg(value)
                 self._add_arg(key, full_path, True)
-            elif self.is_path_key(key):
-                value, idx = self._get_arg_value(args, idx, key)
-                self._add_arg(key, value)
             elif self.is_boolean_switch(key):
                 self._add_arg(key, True)
             else:
@@ -314,6 +316,38 @@ def _get_arg_value(self, args, index, key):
             raise ex
         return args[index], index
 
+    def _check_trailing_arguments(self, args, trailing_arg_count):
+        """
+        Remove any trailing (no switch) arguments from the argument list and add them to the required result.
+          example:
+            command.sh -oracle_home /oracle file1 file2
+            file1 and file2 are trailing arguments
+
+        :param args: the arguments to be examined
+        :param trailing_arg_count: the number of trailing arguments that are expected
+        :return: the argument list, with the trailing arguments removed
+        :raises CLAException: if there are not enough arguments present
+        """
+        method_name = '_check_trailing_arguments'
+        args_len = len(args)
+
+        # verify there are enough arguments for any trailing (no switch) args
+        if args_len < trailing_arg_count + 1:
+            ex = exception_helper.create_cla_exception('WLSDPLY-01639', trailing_arg_count)
+            ex.setExitCode(self.ARG_VALIDATION_ERROR_EXIT_CODE)
+            self._logger.throwing(ex, class_name=self._class_name, method_name=method_name)
+            raise ex
+
+        # set required_result['TRAILING_ARGS'] to list of trailing args (such as ['file1', 'file2'])
+        trailing_args = []
+        for index in range(args_len - trailing_arg_count, args_len):
+            arg = args[index]
+            trailing_args.append(arg)
+        self._required_result[self.TRAILING_ARGS_SWITCH] = trailing_args
+
+        # remove trailing args from the list and return revised list
+        return args[0:(args_len - trailing_arg_count)]
+
     def get_help_key(self):
         return self.HELP_SWITCH
 
@@ -930,9 +964,6 @@ def _validate_domain_resource_file_arg(self, value):
             raise ex
         return variables.getAbsolutePath()
 
-    def is_path_key(self, key):
-        return self.PATH_SWITCH == key
-
     def is_boolean_switch(self, key):
         return key in self.BOOLEAN_SWITCHES
 

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

@@ -75,7 +75,7 @@ def __init__(self, program_name, arg_map):
         self._validation_method = None
         self._rollback_if_restart_required = None
         self._domain_resource_file = None
-        self._path = None
+        self._trailing_args = []
 
         if CommandLineArgUtil.ORACLE_HOME_SWITCH in arg_map:
             self._oracle_home = arg_map[CommandLineArgUtil.ORACLE_HOME_SWITCH]
@@ -178,8 +178,8 @@ def __init__(self, program_name, arg_map):
         if CommandLineArgUtil.DOMAIN_RESOURCE_FILE_SWITCH in arg_map:
             self._domain_resource_file = arg_map[CommandLineArgUtil.DOMAIN_RESOURCE_FILE_SWITCH]
 
-        if CommandLineArgUtil.PATH_SWITCH in arg_map:
-            self._path = arg_map[CommandLineArgUtil.PATH_SWITCH]
+        if CommandLineArgUtil.TRAILING_ARGS_SWITCH in arg_map:
+            self._trailing_args = arg_map[CommandLineArgUtil.TRAILING_ARGS_SWITCH]
 
         if CommandLineArgUtil.TARGET_MODE_SWITCH in arg_map:
             wlst_mode_string = arg_map[CommandLineArgUtil.TARGET_MODE_SWITCH]
@@ -467,12 +467,13 @@ def get_target_wlst_mode(self):
         """
         return self._wlst_mode
 
-    def get_path(self):
+    def get_trailing_argument(self, index):
         """
-        Get the model path (modelHelp).
-        :return: the model path
+        Get the trailing argument at index.
+        :param index: the index of the trailing argument
+        :return: the trailing argument
         """
-        return self._path
+        return self._trailing_args[index]
 
     def is_wlst_online(self):
         """

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

@@ -269,6 +269,7 @@ WLSDPLY-01635=Specified Model Variable Injector File {0} is not a valid file : {
 WLSDPLY-01636=Specified Model Variable Keywords File {0} is not a valid file : {1}
 WLSDPLY-01637=Specified domain resource file {0} is not a valid file: {1}
 WLSDPLY-01638=The argument {0} must be followed by a value
+WLSDPLY-01639=At least {0} arguments are required
 
 # wlsdeploy/util/cla_helper.py
 WLSDPLY-01650=Saving the model to file {0}
@@ -1047,7 +1048,7 @@ WLSDPLY-10105=Path: {0}
 WLSDPLY-10106=Section: {0}
 WLSDPLY-10107=Valid Folders:
 WLSDPLY-10108={0} does not adhere to [<model_section>[:]][/<section_folder>]... pattern \
-  for the -path option. For example: domainInfo, resources:, topology:/Server, \
+  for the path argument. For example: domainInfo, resources:, topology:/Server, \
   topology:/Server/ServerStart, /Server/ServerStart
 WLSDPLY-10109={0} is not a recognized top level section name. The recognized top level section names are {1}
 WLSDPLY-10110=Model section {0} has no folder {1} beneath it. Valid folders are: {2}

installer/src/main/bin/modelHelp.cmd

@@ -70,7 +70,7 @@ ECHO Usage: %SCRIPT_NAME%
 ECHO         [-help]
 ECHO         -oracle_home ^<oracle_home^>
 ECHO         [-attributes_only ^| -folders_only ^| -recursive]
-ECHO         -path ^<model_path^>
+ECHO         ^<model_path^>
 ECHO.
 ECHO     where:
 ECHO         oracle_home - an existing Oracle Home directory

installer/src/main/bin/modelHelp.sh

@@ -35,7 +35,7 @@ usage() {
   echo "Usage: $1 [-help]"
   echo "          -oracle_home <oracle_home>"
   echo "          [-attributes_only | -folders_only | -recursive]"
-  echo "          -path <model_path>"
+  echo "          <model_path>"
   echo ""
   echo "    where:
   echo "        oracle_home - an existing Oracle Home directory"