document testing

[mvertens]

clearer documentation is needed in CIME regarding both the use of create_test AND the use of scripts-regressions-test. For the latter, it is not clear at all how to understand and fix failures.

[rljacob]

This is a partly a duplicate of #1060

[billsacks]

Currently documentation of unit testing (http://esmci.github.io/cime/doc/build/html/misc_tools/unit_testing.html) is under "Misc tools". To me it feels like it would fit better under "CIME User’s Guide Part 2: CIME internals, Porting, Testing and Use Cases". How do others feel about that?

[mvertens]

I agree with you - it should go under testing.

…

On Fri, Apr 21, 2017 at 1:38 PM, Bill Sacks ***@***.***> wrote: Currently documentation of unit testing (http://esmci.github.io/cime/ doc/build/html/misc_tools/unit_testing.html) is under "Misc tools". To me it feels like it would fit better under "CIME User’s Guide Part 2: CIME internals, Porting, Testing and Use Cases". How do others feel about that? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#1295 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AHlxE-5YVdtkis1bjWSGnvyvD57hlHQcks5ryOmigaJpZM4Mw9tc> .

[gold2718]

I am in favor of the move. As long as CIME is monolithic (no 'optional' or 'external' pieces), I think there should be one place for documentation.

[rljacob]

The "testing" in part 2 is a placeholder for documentation of create_test. "Misc tools" is for everything in the cime/tools directory.

[rljacob]

And everything in cime/tools is "optional" in the sense you don't need it for the core functioning of cime.

[mvertens]

I think that unit testing belongs with testing in the documentation and therefore should accompany the part 2 documentation.

…

On Fri, Apr 21, 2017 at 8:47 PM, Robert Jacob ***@***.***> wrote: And everything in cime/tools is "optional" in the sense you don't need it for the core functioning of cime. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#1295 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AHlxE9exrp9cIPqAiDTEsOVt83HFzpZsks5ryWpEgaJpZM4Mw9tc> .

[billsacks]

@rljacob - I made a new section in Part 2 - after "Testing with create_test" I added "Fortran unit testing" - see http://esmci.github.io/cime/doc/build/html/users_guide/index.html#users-guide2 . My rationale was that unit testing is (or should be) no more of an "optional" tool than system testing is.

[rljacob]

I agree unit testing should be encouraged. But "tools" is still for optional parts of CIME so if unit testing is now as crucial a part of CIME as the system tests, we should move tools/unit_testing somewhere else. If its just for testing fortran, we should move it to "src".

[mvertens]

That's an interesting and valid point. Lets discuss this at the Wednesday meeting.

…

On Mon, Apr 24, 2017 at 9:57 PM, Robert Jacob ***@***.***> wrote: I agree unit testing should be encouraged. But "tools" is still for optional parts of CIME so if unit testing is now as crucial a part of CIME as the system tests, we should move tools/unit_testing somewhere else. If its just for testing fortran, we should move it to "src". — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#1295 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AHlxE2nOsWJa080Mse5OiXaGeGdo5EjQks5rzW9EgaJpZM4Mw9tc> .

[jgfouca]

Adding docs.