Add SystemTest for FATES functional tests.

Author: samsrabin

.gitmodules

@@ -28,7 +28,7 @@
 [submodule "fates"]
 path = src/fates
 url = https://github.com/samsrabin/fates
-fxtag = c6ad0e63bcad0d0ab0ce8e19d04d812c584ad970
+fxtag = 4c334ac44f731d6922d10dd3fbc1339c077bf5ad
 fxrequired = AlwaysRequired
 # Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed
 fxDONOTUSEurl = https://github.com/NGEET/fates

cime_config/SystemTests/functionalfates.py

@@ -0,0 +1,39 @@
+"""
+Implementation of the FATES functional tests.
+
+This "system" test runs FATES's Fortran functional tests. We're abusing the system test
+infrastructure to run these, so that a run of the test suite can result in the unit tests
+being run as well.
+
+Grid and compset are irrelevant for this test type.
+"""
+
+import os
+import sys
+from CIME.SystemTests.funit import FUNIT
+from CIME.XML.standard_module_setup import *
+import systemtest_utils as stu
+
+_FATES_TESTING_PYTHON = os.path.join(
+    os.path.dirname(os.path.realpath(__file__)), os.pardir, os.pardir, "src", "fates", "testing"
+)
+
+logger = logging.getLogger(__name__)
+
+
+class FUNCTIONALFATES(FUNIT):
+    def __init__(self, case):
+        FUNIT.__init__(self, case)
+
+    def run_phase(self):
+        tool_path = os.path.join(_FATES_TESTING_PYTHON, "run_functional_tests.py")
+        build_dir = os.path.join("bld", "fates_unit_tests")
+        run_dir = "run"
+        cmd = f"{tool_path} -b {build_dir} -r {run_dir} --save-figs"
+
+        stu.run_python_script(
+            self._get_caseroot(),
+            "ctsm_pylib",
+            cmd,
+            tool_path,
+        )

cime_config/config_tests.xml

@@ -24,6 +24,15 @@ This defines various CTSM-specific system tests
     <DOUT_S>FALSE</DOUT_S>
   </test>
 
+  <test NAME="FUNCTIONALFATES">
+    <DESC>Run FATES's Fortran functional tests. Grid and compset (and most case settings) are ignored.</DESC>
+    <INFO_DBUG>1</INFO_DBUG>
+    <STOP_OPTION>ndays</STOP_OPTION>
+    <STOP_N>11</STOP_N>
+    <CHECK_TIMING>FALSE</CHECK_TIMING>
+    <DOUT_S>FALSE</DOUT_S>
+  </test>
+
   <test NAME="MKSURFDATAESMF">
     <DESC>Build and run the mksurfdata_esmf tool to generate a new fsurdat; then run the CTSM with this fsurdat</DESC>
     <INFO_DBUG>1</INFO_DBUG>

cime_config/testdefs/testlist_clm.xml

@@ -4151,7 +4151,22 @@
     </machines>
     <options>
       <option name="wallclock">00:30:00</option>
-      <option name="comment">This test runs FATES's Fortran unit tests. We're abusing the system test infrastructure to run these, so that a run of the test suite results in the unit tests being run as well. Grid and compset are irrelevant here, except that compset must be one that includes FATES in order for CIME to find the test definition.</option>
+      <option name="comment">This test runs FATES's Fortran unit tests. We're abusing the system test infrastructure to run these, so that a run of the test suite results in the unit tests being run as well. Grid and compset are irrelevant here, except that compset must be one that includes CTSM in order for CIME to find the test definition.</option>
+    </options>
+  </test>
+
+  <test name="FUNCTIONALFATES_P1x1" grid="f10_f10_mg37" compset="I2000Clm50Sp">
+    <machines>
+      <machine name="derecho" compiler="intel" category="aux_clm"/>
+      <machine name="izumi" compiler="intel" category="aux_clm"/>
+      <machine name="derecho" compiler="intel" category="fates"/>
+      <machine name="izumi" compiler="intel" category="fates"/>
+      <machine name="derecho" compiler="intel" category="unit_tests"/>
+      <machine name="izumi" compiler="intel" category="unit_tests"/>
+    </machines>
+    <options>
+      <option name="wallclock">00:30:00</option>
+      <option name="comment">This test runs FATES's Fortran functional tests. We're abusing the system test infrastructure to run these, so that a run of the test suite results in the unit tests being run as well. Grid and compset are irrelevant here, except that compset must be one that includes CTSM in order for CIME to find the test definition.</option>
     </options>
   </test>
 

python/ctsm/run_sys_tests.py

@@ -749,13 +749,13 @@ def _check_py_env(test_attributes):
         except ModuleNotFoundError as err:
             raise ModuleNotFoundError("modify_fsurdat" + err_msg) from err
 
-    # Check requirements for FUNITFATES, if needed
-    if any("FUNITFATES" in t for t in test_attributes):
+    # Check requirements for FUNCTIONALFATES, if needed
+    if any("FUNCTIONALFATES" in t for t in test_attributes):
         add_fates_testing_to_path()
         try:
-            import run_unit_tests
+            import run_functional_tests
         except ModuleNotFoundError as err:
-            raise ModuleNotFoundError("FATES run_unit_tests" + err_msg) from err
+            raise ModuleNotFoundError("FATES run_functional_tests" + err_msg) from err
 
     # Check requirements for RXCROPMATURITY, if needed
     if any("RXCROPMATURITY" in t for t in test_attributes):