Improve error reporting for modelHelp (#641)

* Add folder to UNRESOLVED_FOLDERS_MAP if invalid for WLS version/mode

* Check for valid location in get_wlst_mbean_type_for_location for existing calls

* Check for valid locations in path and display detailed message

* Revised comment

Author: rakillen

core/src/main/python/wlsdeploy/aliases/alias_entries.py

@@ -685,6 +685,11 @@ def get_wlst_mbean_type_for_location(self, location):
         """
         _method_name = 'get_wlst_mbean_type_for_location'
 
+        # some callers use this method to check for location valid.
+        # they should call is_model_location_valid(location) directly instead.
+        if not self.is_model_location_valid(location):
+            return None
+
         _logger.entering(str(location), class_name=_class_name, method_name=_method_name)
         folder_dict = self.__get_dictionary_for_location(location, False)
         if folder_dict is None:
@@ -907,6 +912,21 @@ def is_valid_model_attribute_name_for_location(self, location, model_attribute_n
         _logger.exiting(class_name=_class_name, method_name=_method_name, result=[result, valid_version_range])
         return result, valid_version_range
 
+    def is_model_location_valid(self, location):
+        """
+        Determine if the specified location is valid, including version/mode checks.
+        Returns a boolean answer instead of the (ValidationCode, message) tuple used elsewhere.
+        :param location: the location to be checked
+        :return: True if the location is valid, false otherwise
+        """
+        if len(location.get_model_folders()) > 0:
+            parent_location = LocationContext(location)
+            folder = parent_location.pop_location()
+            code, message = self.is_valid_model_folder_name_for_location(parent_location, folder)
+            if code != ValidationCodes.VALID:
+                return False
+        return True
+
     def get_folder_short_name_for_location(self, location):
         """
         Retrieve the shortened name for the model folder at the provided location.
@@ -1141,10 +1161,10 @@ def __apply_wlst_context_changes(self, path_name, alias_dict, parent_dict):
         """
         _method_name = '__apply_wlst_context_changes'
 
-        #
-        # First, determine if this dictionary is even relevant to the current WLS version.
-        #
         self.__resolve_folder_params(path_name, alias_dict)
+
+        # if folder is not valid for this version/mode of WLS,
+        # add folder to parent_dict UNRESOLVED_FOLDERS_MAP and return None
         if not self.__use_alias_dict(path_name, alias_dict, parent_dict):
             return None
 
@@ -1153,8 +1173,10 @@ def __apply_wlst_context_changes(self, path_name, alias_dict, parent_dict):
             result_folders = dict()
             folders = alias_dict[FOLDERS]
             for folder in folders:
-                folder_dict = self.__apply_wlst_context_changes(path_name + '/' + folder, folders[folder], alias_dict)
-                result_folders[folder] = folder_dict
+                folder_dict = self.__apply_wlst_context_changes(path_name + '/' + folder, folders[folder], result)
+                # if folder_dict is None, this folder was invalid for this version/mode of WLS
+                if folder_dict is not None:
+                    result_folders[folder] = folder_dict
             result[FOLDERS] = result_folders
 
         if FLATTENED_FOLDER_DATA in alias_dict:

core/src/main/python/wlsdeploy/tool/modelhelp/model_help_printer.py

@@ -7,6 +7,7 @@
 from oracle.weblogic.deploy.exception import ExceptionHelper
 from wlsdeploy.aliases.location_context import LocationContext
 from wlsdeploy.aliases.model_constants import KNOWN_TOPLEVEL_MODEL_SECTIONS
+from wlsdeploy.aliases.validation_codes import ValidationCodes
 from wlsdeploy.tool.modelhelp import model_help_utils
 from wlsdeploy.tool.modelhelp.model_help_utils import ControlOptions
 from wlsdeploy.tool.modelhelp.model_sample_printer import ModelSamplePrinter
@@ -219,6 +220,8 @@ def _print_model_folder_help(self, model_path_tokens, valid_section_folder_keys,
                             str(model_path_tokens), ControlOptions.from_value(control_option),
                             str(valid_section_folder_keys), class_name=_class_name, method_name=_method_name)
 
+        print
+
         section_name = model_path_tokens[0]
         top_folder = model_path_tokens[1]
         if top_folder not in valid_section_folder_keys:
@@ -230,6 +233,12 @@ def _print_model_folder_help(self, model_path_tokens, valid_section_folder_keys,
         # Populate the location context using model_path_tokens[1:]
         model_location = LocationContext()
         for folder_key in model_path_tokens[1:]:
+            code, message = self._alias_helper.is_valid_model_folder_name(model_location, folder_key)
+            if code != ValidationCodes.VALID:
+                ex = exception_helper.create_cla_exception("WLSDPLY-05027", message)
+                self._logger.throwing(ex, class_name=_class_name, method_name=_method_name)
+                raise ex
+
             model_location.append_location(folder_key)
             name_token = self._alias_helper.get_name_token(model_location)
             if name_token is not None:
@@ -245,7 +254,6 @@ def _print_model_folder_help(self, model_path_tokens, valid_section_folder_keys,
             model_path += " (" + type_name + ")"
 
         # Print 'Path: <model_section>' header
-        print
         _print_indent(model_path, 0)
 
         if model_help_utils.show_attributes(control_option):

core/src/main/python/wlsdeploy/tool/modelhelp/model_sample_printer.py

@@ -4,6 +4,7 @@
 """
 from wlsdeploy.aliases.location_context import LocationContext
 from wlsdeploy.aliases.model_constants import KNOWN_TOPLEVEL_MODEL_SECTIONS
+from wlsdeploy.aliases.validation_codes import ValidationCodes
 from wlsdeploy.tool.modelhelp import model_help_utils
 from wlsdeploy.tool.modelhelp.model_help_utils import ControlOptions
 from wlsdeploy.exception import exception_helper
@@ -100,6 +101,11 @@ def _print_model_folder_sample(self, model_path_tokens, valid_section_folder_key
         model_location = LocationContext()
         for token in model_path_tokens:
             if indent > 0:
+                code, message = self._alias_helper.is_valid_model_folder_name(model_location, token)
+                if code != ValidationCodes.VALID:
+                    ex = exception_helper.create_cla_exception("WLSDPLY-05027", message)
+                    self._logger.throwing(ex, class_name=_class_name, method_name=_method_name)
+                    raise ex
                 model_location.append_location(token)
 
             _print_indent(token + ":", indent)
@@ -134,9 +140,6 @@ def _print_subfolders_sample(self, model_location, control_option, indent_level)
 
         valid_subfolder_keys = self._alias_helper.get_model_subfolder_names(model_location)
 
-        if not valid_subfolder_keys:
-            return
-
         valid_subfolder_keys.sort()
         self._print_subfolder_keys_sample(model_location, valid_subfolder_keys, control_option, indent_level)