Merge pull request #2027 from jedwards4b/better_errormsg_for_compsets

Better errormsg for compsets

Improve error messages for compset match

Test suite: scripts_regression_tests.py
Test baseline:
Test namelist changes:
Test status: bit for bit
Fixes #1860
Fixes #1859
User interface changes?:

Update gh-pages html (Y/N)?:

Code review: Bill Sacks

scripts/lib/CIME/XML/component.py

@@ -162,7 +162,6 @@ def _get_description_v3(self, compsetname, comp_class):
             modifier_mode = '*'
         expect(modifier_mode in ('*','1','?','+'),
                "Invalid modifier_mode {} in file {}".format(modifier_mode, self.filename))
-
         optiondesc = {}
         if comp_class == "forcing":
             for node in desc_nodes:
@@ -176,81 +175,90 @@ def _get_description_v3(self, compsetname, comp_class):
                 desc = compsetname.split('_')[0]
             return desc
 
+
         # first pass just make a hash of the option descriptions
         for node in desc_nodes:
             option = node.get('option')
             if option is not None:
                 optiondesc[option] = node.text
+
         #second pass find a comp_class match
+        desc = ""
         for node in desc_nodes:
             compdesc = node.get(comp_class)
 
-            if compdesc is None:
-                continue
-            opt_parts = [ x.rstrip("]") for x in compdesc.split("[%") ]
-            parts = opt_parts.pop(0).split("%")
+            if compdesc is not None:
+                opt_parts = [ x.rstrip("]") for x in compdesc.split("[%") ]
+                parts = opt_parts.pop(0).split("%")
+                reqset = set(parts)
+                fullset = set(parts+opt_parts)
+                match, complist =  self._get_description_match(compsetname, reqset, fullset, modifier_mode)
+                if match:
+                    desc = node.text
+                    for opt in complist:
+                        if opt in optiondesc:
+                            desc += optiondesc[opt]
+
 
-            reqset = set(parts)
-            fullset = set(parts+opt_parts)
-            if self._get_description_match(compsetname, reqset, fullset, modifier_mode):
-                desc = node.text
-                break
         # cpl and esp components may not have a description
         if comp_class not in ['cpl','esp']:
             expect(len(desc) > 0,
-                   "No description found for comp_class {} matching compsetname {} in file {}"\
-                       .format(comp_class,compsetname, self.filename))
+                   "No description found for comp_class {} matching compsetname {} in file {}, expected match in {} % {}"\
+                       .format(comp_class,compsetname, self.filename, list(reqset), list(opt_parts)))
         return desc
 
     def _get_description_match(self, compsetname, reqset, fullset, modifier_mode):
         """
 
         >>> obj = Component('testingonly', 'ATM')
         >>> obj._get_description_match("1850_DATM%CRU_FRED",set(["DATM"]), set(["DATM","CRU","HSI"]), "*")
-        True
+        (True, ['DATM', 'CRU'])
         >>> obj._get_description_match("1850_DATM%FRED_Barn",set(["DATM"]), set(["DATM","CRU","HSI"]), "*")
-        False
+        (False, None)
         >>> obj._get_description_match("1850_DATM_Barn",set(["DATM"]), set(["DATM","CRU","HSI"]), "?")
-        True
+        (True, ['DATM'])
         >>> obj._get_description_match("1850_DATM_Barn",set(["DATM"]), set(["DATM","CRU","HSI"]), "1")
         Traceback (most recent call last):
         ...
-        SystemExit: ERROR: Expected exactly one modifer found 0
+        SystemExit: ERROR: Expected exactly one modifer found 0 in ['DATM']
         >>> obj._get_description_match("1850_DATM%CRU%HSI_Barn",set(["DATM"]), set(["DATM","CRU","HSI"]), "1")
         Traceback (most recent call last):
         ...
-        SystemExit: ERROR: Expected exactly one modifer found 2
+        SystemExit: ERROR: Expected exactly one modifer found 2 in ['DATM', 'CRU', 'HSI']
         >>> obj._get_description_match("1850_CAM50%WCCM%RCO2_Barn",set(["CAM50", "WCCM"]), set(["CAM50","WCCM","RCO2"]), "*")
-        True
+        (True, ['CAM50', 'WCCM', 'RCO2'])
 
         # The following is not allowed because the required WCCM field is missing
         >>> obj._get_description_match("1850_CAM50%RCO2_Barn",set(["CAM50", "WCCM"]), set(["CAM50","WCCM","RCO2"]), "*")
-        False
+        (False, None)
         >>> obj._get_description_match("1850_CAM50_Barn",set(["CAM50", "WCCM"]), set(["CAM50","WCCM","RCO2"]), "+")
-        False
+        (False, None)
         >>> obj._get_description_match("1850_CAM50%WCCM_Barn",set(["CAM50", "WCCM"]), set(["CAM50","WCCM","RCO2"]), "+")
-        True
+        (True, ['CAM50', 'WCCM'])
         """
         match = False
         comparts = compsetname.split('_')
+        matchcomplist = None
+
         for comp in comparts:
             complist = comp.split('%')
             cset = set(complist)
             if cset == reqset or (cset > reqset and cset <= fullset):
                 if modifier_mode == '1':
                     expect(len(complist) == 2,
-                           "Expected exactly one modifer found {}".format(len(complist)-1))
+                           "Expected exactly one modifer found {} in {}".format(len(complist)-1,complist))
                 elif modifier_mode == '+':
                     expect(len(complist) >= 2,
-                           "Expected one or more modifers found {}".format(len(complist)-1))
+                           "Expected one or more modifers found {} in {}".format(len(complist)-1, list(reqset)))
                 elif modifier_mode == '?':
                     expect(len(complist) <= 2,
-                           "Expected 0 or one modifers found {}".format(len(complist)-1))
+                           "Expected 0 or one modifers found {} in {}".format(len(complist)-1, complist))
                 expect(not match,"Found multiple matches in file {} for {}".format(self.filename,comp))
                 match = True
+                matchcomplist = complist
                 # found a match
 
-        return match
+        return match, matchcomplist