Added test using a DDT host object to pass information

[gold2718]

Added test using a DDT host object to pass information
Fix problems so that test passes
Improve formatting for readability

User interface changes?: No

Fixes: #589

Testing:
test removed: None
unit tests: Pass
system tests: Pass, added DDT host object test
manual testing: Ran doctests, examined generated code for system tests

[gold2718]

A couple of thoughts:

• Instead of a new Fortran test, I could move the ccpp object into a different test (e.g., the advection_test).
• Another test mod I thought of but did not try is to move the error variables (and/or the loop variables) out of the host-model call strings and into module data. Is anyone interested in this feature?

[climbfuji]

Do we really need such a complex test for just making sure that errmsg and errflg can be part of a DDT? At first glance, it seems to me that we can do away with all the temp_* stuff in this ddthost_test.

[gold2718]

Do we really need such a complex test for just making sure that errmsg and errflg can be part of a DDT?

That's what I thought which is why I made this comment.

[climbfuji]

@gold2718 As discussed on Monday, we should proceed with this PR, including adding the new test, once the comment on what base_only means (minimal documentation in the code?) is addressed and the other typo is fixed. Thanks!

[mwaxmonsky]

Thanks for getting this in @gold2718! Just had a few recommendations for style and consistency (and 1 or 2 functional changes) but just let me know if any of those are problematic, otherwise nothing major.

I did notice the test logs in the runner are printing out the error message:

-- Running: /home/runner/work/ccpp-framework/ccpp-framework/scripts/ccpp_capgen.py --host-files test_host_data.meta,test_host_mod.meta,test_host.meta --scheme-files cld_suite_files.txt --suites cld_suite.xml --host-name test_host --output-root /home/runner/work/ccpp-framework/ccpp-framework/test/at_build/ccpp --debug
-- xmllint not found, could not validate file /home/runner/work/ccpp-framework/ccpp-framework/test/advection_test/cld_suite.xml

If these tests should be failing if xmllint isn't on the path, I'm torn as to how to handle that as this looks like a pre-existing issue but it should be as simple as adding libxml2-utils to the capgen yaml workflow file on the apt-get install ... line but I would have to do some more testing on that front.

If this is outside the scope of this PR, we can make an issue to address that in a different PR.

[mwaxmonsky]

Thanks for getting this in @gold2718! Just had a few recommendations for style and consistency (and 1 or 2 functional changes) but just let me know if any of those are problematic, otherwise nothing major.

I did notice the test logs in the runner are printing out the error message:

-- Running: /home/runner/work/ccpp-framework/ccpp-framework/scripts/ccpp_capgen.py --host-files test_host_data.meta,test_host_mod.meta,test_host.meta --scheme-files cld_suite_files.txt --suites cld_suite.xml --host-name test_host --output-root /home/runner/work/ccpp-framework/ccpp-framework/test/at_build/ccpp --debug
-- xmllint not found, could not validate file /home/runner/work/ccpp-framework/ccpp-framework/test/advection_test/cld_suite.xml

If these tests should be failing if xmllint isn't on the path, I'm torn as to how to handle that as this looks like a pre-existing issue but it should be as simple as adding libxml2-utils to the capgen yaml workflow file on the apt-get install ... line but I would have to do some more testing on that front.

If this is outside the scope of this PR, we can make an issue to address that in a different PR.

Regarding the xmllint dependency error, let's hold off on any changes with regard to it here and we will address it if need be in #601.

[climbfuji]

Thanks for accommodating my change requests

[mwaxmonsky]

Thanks @gold2718! One minor bug fix that I think got missed but otherwise looks good!

[mwaxmonsky]

Suggested change

	list(APPEND CAPGEN_CMD "--verbose")
	list(APPEND CAPGEN_CMD ${VERBOSE_REPEATED})

[gold2718]

😳
fixed!

[mwaxmonsky]

Whoops, my apologies again! I forgot that in cmake, the string repeat function returns a space separated string and needs an additional modification:

string(REPEAT "--verbose" ${VERBOSITY} VERBOSE_PARAMS)
separate_arguments(VERBOSE_PARAMS_SEPERATED UNIX_COMMAND "${VERBOSE_PARAMS}")
list(APPEND CAPGEN_CMD ${VERBOSE_PARAMS_SEPERATED})

https://github.com/mwaxmonsky/ccpp-framework/blob/testing-refactor/cmake/ccpp_capgen.cmake#L30

[gold2718]

@mwaxmonsky, thanks for the catch but is there a reason I could not just change line 148 to be:

string(REPEAT "--verbose;" ${VERBOSITY} VERBOSE_REPEATED)

It leads to an extra space between the last --verbose and the --debug but bash does not care.

[mwaxmonsky]

Oh, good idea. I didn't realize CMake interpreted strings like that. Approved!

[mkavulich]

@dustinswales Can you take a look at this to make sure it's fine by you?