Fail rocoto realize if XML contains unrendered expressions. (#805)

If any unrendered Jinja2 expressions remain in the Rocoto XML, report which values are needed and raise an error.

Author: christinaholtNOAA

src/uwtools/rocoto.py

@@ -14,14 +14,16 @@
 from time import sleep
 from typing import TYPE_CHECKING, Any
 
+from jinja2 import Environment, StrictUndefined, meta
 from lxml import etree
 from lxml.builder import E  # type: ignore[import-not-found]
 from lxml.etree import Element, SubElement, _Element
 
 from uwtools.config.formats.yaml import YAMLConfig
+from uwtools.config.jinja2 import unrendered
 from uwtools.config.validator import validate_external as validate_yaml
-from uwtools.exceptions import UWConfigError, UWError
-from uwtools.logging import log
+from uwtools.exceptions import UWConfigError, UWConfigRealizeError, UWError
+from uwtools.logging import INDENT, log
 from uwtools.utils.file import readable, resource_path, writable
 from uwtools.utils.processing import run_shell_cmd
 
@@ -58,6 +60,15 @@ def realize(config: YAMLConfig | Path | None, output_file: Path | None = None) -
     """
     rxml = _RocotoXML(config)
     xml = str(rxml).strip()
+    if unrendered(xml):
+        log.error(xml)
+        log.error("Value(s) needed to render this XML are:")
+        for var in meta.find_undeclared_variables(
+            Environment(undefined=StrictUndefined).parse(xml)
+        ):
+            log.error("%s%s", INDENT, var)
+        msg = "Rocoto XML could not be totally realized"
+        raise UWConfigRealizeError(msg)
     if not validate_string(xml):
         msg = "Internal error: Invalid Rocoto XML"
         raise UWError(msg)

src/uwtools/tests/test_rocoto.py

@@ -13,7 +13,7 @@
 
 from uwtools import rocoto
 from uwtools.config.formats.yaml import YAMLConfig
-from uwtools.exceptions import UWConfigError, UWError
+from uwtools.exceptions import UWConfigError, UWConfigRealizeError, UWError
 from uwtools.tests.support import fixture_path, schema_validator
 
 # Fixtures
@@ -88,6 +88,19 @@ def test_rocoto_realize__invalid_xml(assets):
             rocoto.realize(config=cfgfile, output_file=outfile)
 
 
+def test_rocoto_realize__unrendered_xml(assets, logged):
+    cfgfile, outfile = assets
+    template = "Hello {{ world }}."
+    with (
+        patch.object(rocoto, "_RocotoXML", return_value=template),
+        raises(UWConfigRealizeError, match=r"Rocoto XML could not be totally realized"),
+    ):
+        rocoto.realize(config=cfgfile, output_file=outfile)
+    assert logged(template)
+    assert logged("Value(s) needed to render this XML are:")
+    assert logged("world")
+
+
 def test_rocoto_validate__file_fail(validation_assets):
     xml_file_bad, _, _, _ = validation_assets
     assert rocoto.validate_file(xml_file=xml_file_bad) is False