Check that templates do not contain placeholders (#398)

Co-authored-by: github-actions <github-actions@github.com>

Author: jonasjucker

.gitignore

@@ -104,3 +104,6 @@ venv.bak/
 
 # Page deployment
 site/
+
+# Pytest folders of tests
+.pytest_rundir

python/WrapExtpar.py

@@ -16,7 +16,7 @@
 except ImportError:  # package not installed -> use PYTHONPATH
     from grid_def import CosmoGrid, IconGrid
     from utilities import launch_shell
-    DATA_DIR = ".."
+    DATA_DIR = os.path.join(os.path.dirname(__file__), '..')
 
 
 def main():
@@ -179,12 +179,13 @@ def run_extpar(args):
     logging.info("job finished")
 
 
-def prepare_sandbox(args, namelist, runscript):
+def prepare_sandbox(args, namelist, runscript, test_run=False):
 
     os.makedirs(args['run_dir'], exist_ok=True)
     write_namelist(args, namelist)
     write_runscript(args, runscript)
-    copy_required_files(args, runscript['extpar_executables'])
+    if not test_run:
+        copy_required_files(args, runscript['extpar_executables'])
 
 
 def write_runscript(args, runscript):
@@ -305,6 +306,9 @@ def setup_oro_namelist_cosmo(args):
                                                   ord('p') + 1)))
             ]
             namelist['lpreproc_oro'] = ".FALSE."
+        else:
+            namelist['lpreproc_oro'] = ".FALSE."
+            namelist['sgsl_files'] = 'placeholder_file'
 
         if tg.dlon < 0.02 and tg.dlat < 0.02:
             namelist['lscale_separation'] = ".FALSE."
@@ -795,6 +799,13 @@ def replace_placeholders(args, templates, dir, actual_values):
                 all_templates[template] = all_templates[template].replace(
                     key, str(value))
 
+    # check that no @PLACEHOLDERS@ are left
+    for template in templates:
+        if '@' in all_templates[template]:
+            logging.error(f'Not all placeholders in {template} were replaced')
+            raise ValueError(
+                f'Not all placeholders in {template} were replaced')
+
     # write complete template to file
     for template in templates:
         # special case for namelist.py, which is a python file but not valid with placeholders

test/pytest/test_wrap_extpar.py

@@ -1,7 +1,16 @@
-from extpar.WrapExtpar import *
 import os
 import pytest
 
+try:
+    from extpar.WrapExtpar import *
+except ImportError:
+    import sys
+    sys.path.append(
+        os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
+    sys.path.append(
+        os.path.join(os.path.dirname(__file__), '..', '..', 'python/lib'))
+    from WrapExtpar import *
+
 
 def test_setup_flake_namelist():
     args = {'raw_data_path': '/path/to/raw/data'}
@@ -808,3 +817,38 @@ def test_setup_edgar_namelist():
         'edgar_buffer_file': 'edgar_buffer.nc'
     }
     assert setup_edgar_namelist(args) == expected_namelist
+
+
+def test_all_placeholders_replaced_cosmo():
+    args = {
+        "igrid_type": 2,
+        "input_grid": 'test/testsuite/data/clm/12km_globe/INPUT_COSMO_GRID',
+        "iaot_type": 1,
+        "ilu_type": 1,
+        "ialb_type": 1,
+        "isoil_type": 1,
+        "itopo_type": 1,
+        "it_cl_type": 1,
+        "iera_type": 1,
+        "iemiss_type": 1,
+        "enable_cdnc": False,
+        "enable_edgar": False,
+        "enable_art": False,
+        "use_array_cache": False,
+        "radtopo_radius": 40000.0,
+        "raw_data_path": '/dummy/raw_data_path',
+        "run_dir": './.pytest_rundir',
+        "account": 'dummy_account',
+        "host": 'docker',
+        "no_batch_job": True,
+        "lurban": False,
+        "lsgsl": False,
+        "lfilter_oro": False,
+        "lradtopo": False
+    }
+
+    namelist = setup_namelist(args)
+    runscript = setup_runscript(args)
+    # in this function all placeholders from the template are replaced,
+    # it raises an error if there are any placeholders left
+    prepare_sandbox(args, namelist, runscript, test_run=True)