search

ESMCI / cime

Common Infrastructure for Modeling the Earth
http://esmci.github.io/cime
Other
162 stars 209 forks source link

Add back append_testlog to CIME/utils.py #4703

Open ekluzek opened 3 weeks ago

ekluzek commented 3 weeks ago

The function append_testlog was removed from CIME/utils.py in 1fa26aa59af2e51ec15e50760fd09e493a2444b2. I didn't see a reason for it in the log, but assume it likely was just because it might not have been referenced elsewhere in cime? However, CTSM relies on this function for the LILACSMOKE and SSPMATRIXCN SystemTest tests. In general this is something useful to have in order to have tests add extra output to the TestLog. So keeping it around allows SystemTests to easily add to the TestLog output which in principle is an important thing to allow.

ekluzek commented 3 weeks ago

@jedwards4b and @billsacks if this sounds acceptable, I'll do a PR for this shortly. It doesn't hurt anything, just adds some code currently only used for example in the CTSM LILAC tests.

To prevent this kind of thing in the future, I'll add a comment about this in the code for where it's needed. It would also be good to have a unit test for it in the cime testing. The latter is a little more involved -- but is the best thing for preventing this type of removal.

jedwards4b commented 3 weeks ago

No - it was moved from utils.py to status.py as noted in the PR. The correct action is to update from import CIME.utils to import CIME.status

ekluzek commented 3 weeks ago

Awesome, thanks @jedwards4b I missed that comment. But, see it now

https://github.com/ESMCI/cime/pull/4660#issuecomment-2278008196

Thanks for letting me know. I'll close this after I test it out.