Skip to content

Allow different ordering in Fortran scheme and associated metadata #666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mkavulich merged 1 commit into from
Jul 24, 2025
Merged

Allow different ordering in Fortran scheme and associated metadata #666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion scripts/ccpp_capgen.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
_EXTRA_VARIABLE_TABLE_TYPES = ['module', 'host', 'ddt']

## Metadata table types where order is significant
_ORDERED_TABLE_TYPES = [SCHEME_HEADER_TYPE]
_ORDERED_TABLE_TYPES = []
Copy link
Copy Markdown
Collaborator

@climbfuji climbfuji Jul 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we still need _ORDERED_TABLE_TYPES? I assume the answer is yes ...


## CCPP Framework supported DDT types
_CCPP_FRAMEWORK_DDT_TYPES = ["ccpp_hash_table_t",
Expand Down Expand Up @@ -309,6 +309,17 @@ def compare_fheader_to_mheader(meta_header, fort_header, logger):
if not list_match:
errmsg = 'Variable mismatch in {}, variables missing from {}.'
errors_found = add_error(errors_found, errmsg.format(title, etype))
if etype == "metadata header":
Comment thread
peverwhee marked this conversation as resolved.
# Look for missing metadata variables
for fvar in flist:
lname = fvar.get_prop_value('local_name')
_, find = find_var_in_list(lname, mlist)
if (find < 0) and (not fvar.get_prop_value('optional')):
errmsg = f"Fortran variable, {lname}, not in metadata"
errors_found = add_error(errors_found, errmsg)
# end if
# end for
# end if
# end if
for mind, mvar in enumerate(mlist):
lname = mvar.get_prop_value('local_name')
Expand Down
2 changes: 1 addition & 1 deletion test/unit_tests/sample_scheme_files/temp_adjust.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ MODULE temp_adjust
!> \section arg_table_temp_adjust_register Argument Table
!! \htmlinclude arg_table_temp_adjust_register.html
!!
subroutine temp_adjust_register(config_var, dyn_const, errmsg, errflg)
subroutine temp_adjust_register(config_var, dyn_const, errflg, errmsg)
logical, intent(in) :: config_var
type(ccpp_constituent_properties_t), allocatable, intent(out) :: dyn_const
character(len=512), intent(out) :: errmsg
Expand Down
29 changes: 10 additions & 19 deletions test/unit_tests/test_metadata_scheme_file.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,15 +215,13 @@ def test_ccpp_notset_var_missing_in_meta(self):
# Exercise
with self.assertRaises(CCPPError) as context:
parse_scheme_files(scheme_files, self._run_env)
# Verify 3 correct error messages returned
# Verify 2 correct error messages returned
emsg = "Variable mismatch in CCPPnotset_var_missing_in_meta_run, " + \
"variables missing from metadata header."
self.assertTrue(emsg in str(context.exception))
emsg = "Out of order argument, errmsg in CCPPnotset_var_missing_in_meta_run"
self.assertTrue(emsg in str(context.exception))
emsg = "Out of order argument, errflg in CCPPnotset_var_missing_in_meta_run"
emsg = "Fortran variable, bar, not in metadata"
self.assertTrue(emsg in str(context.exception))
self.assertTrue("3 errors found comparing" in str(context.exception))
self.assertTrue("2 errors found comparing" in str(context.exception))

def test_ccpp_eq1_var_missing_in_fort(self):
"""Test for correct detection of a variable that IS REMOVED the
Expand All @@ -236,16 +234,14 @@ def test_ccpp_eq1_var_missing_in_fort(self):
# Exercise
with self.assertRaises(CCPPError) as context:
parse_scheme_files(scheme_files, self._run_env_ccpp)
# Verify 3 correct error messages returned
# Verify 2 correct error messages returned
emsg = "Variable mismatch in CCPPeq1_var_missing_in_fort_run, " + \
"variables missing from Fortran scheme."
self.assertTrue(emsg in str(context.exception))
emsg = "Variable mismatch in CCPPeq1_var_missing_in_fort_run, " + \
"no Fortran variable bar."
self.assertTrue(emsg in str(context.exception))
emsg = "Out of order argument, errmsg in CCPPeq1_var_missing_in_fort_run"
self.assertTrue(emsg in str(context.exception))
self.assertTrue("3 errors found comparing" in str(context.exception))
self.assertTrue("2 errors found comparing" in str(context.exception))

def test_ccpp_eq1_var_in_fort_meta(self):
"""Test positive case of a variable that IS PRESENT the
Expand Down Expand Up @@ -305,16 +301,14 @@ def test_ccpp_gt1_var_in_fort_meta2(self):
# Exercise
with self.assertRaises(CCPPError) as context:
_, _ = parse_scheme_files(scheme_files, self._run_env_ccpp)
# Verify 3 correct error messages returned
# Verify 2 correct error messages returned
emsg = "Variable mismatch in CCPPgt1_var_in_fort_meta_init, " + \
"variables missing from Fortran scheme."
self.assertTrue(emsg in str(context.exception))
emsg = "Variable mismatch in CCPPgt1_var_in_fort_meta_init, " + \
"no Fortran variable bar."
self.assertTrue(emsg in str(context.exception))
emsg = "Out of order argument, errmsg in CCPPgt1_var_in_fort_meta_init"
self.assertTrue(emsg in str(context.exception))
self.assertTrue("3 errors found comparing" in str(context.exception))
self.assertTrue("2 errors found comparing" in str(context.exception))

def test_ccpp_eq1_var_missing_in_meta(self):
"""Test correct detection of a variable that
Expand All @@ -327,15 +321,13 @@ def test_ccpp_eq1_var_missing_in_meta(self):
# Exercise
with self.assertRaises(CCPPError) as context:
_, _ = parse_scheme_files(scheme_files, self._run_env_ccpp)
# Verify 3 correct error messages returned
# Verify 2 correct error messages returned
emsg = "Variable mismatch in CCPPeq1_var_missing_in_meta_finalize, "+ \
"variables missing from metadata header."
self.assertTrue(emsg in str(context.exception))
emsg = "Out of order argument, errmsg in CCPPeq1_var_missing_in_meta_finalize"
emsg = "Fortran variable, bar, not in metadata"
self.assertTrue(emsg in str(context.exception))
emsg = "Out of order argument, errflg in CCPPeq1_var_missing_in_meta_finalize"
self.assertTrue(emsg in str(context.exception))
self.assertTrue("3 errors found comparing" in str(context.exception))
self.assertTrue("2 errors found comparing" in str(context.exception))

def test_scheme_ddt_only(self):
"""Test correct detection of a "scheme" file which contains only
Expand Down Expand Up @@ -363,4 +355,3 @@ def test_mismatch_hdim(self):

if __name__ == "__main__":
unittest.main()