Skip to content
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.

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

Unit test infrastructure setup #144

Merged
merged 18 commits into from
Nov 14, 2024
Merged

Conversation

mwaxmonsky
Copy link
Collaborator

@mwaxmonsky mwaxmonsky commented Oct 24, 2024

Originator(s): @mwaxmonsky

Summary (include the keyword ['closes', 'fixes', 'resolves'] and issue number): Sets up the basic infrastructure to start enabling unit testing. Addresses #82

Describe any changes made to the namelist: N/A

List all files eliminated and why: N/A

List all files added and what they do:
A .github/workflows/code-coverage.yaml
A test/unit-test/CMakeLists.txt
A test/unit-test/include/ccpp_kinds.F90
A test/unit-test/tests/CMakeLists.txt
A test/unit-test/tests/utilities/CMakeLists.txt
A test/unit-test/tests/utilities/test_state_converters.pf

  • Initial round of infrastructure to start enabling unit tests.

List all existing files that have been modified, and describe the changes: N/A
(Helpful git command: git diff --name-status development...<your_branch_name>)

List any test failures: N/A

Is this a science-changing update? New physics package, algorithm change, tuning changes, etc? No

@mwaxmonsky mwaxmonsky self-assigned this Oct 28, 2024
Copy link
Collaborator

@nusbaume nusbaume left a comment

Choose a reason for hiding this comment

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

Looks good to me! Just had a couple of questions.

Also, when you get the chance can you add some general instructions for how to add a new unit test to the official CAM-SIMA documentation? You can probably put it under the "Atmospheric_physics" section for now (but feel free to add it somewhere else if you think it makes more sense). Thanks!

.github/workflows/code-coverage.yaml Outdated Show resolved Hide resolved
test/unit-test/CMakeLists.txt Show resolved Hide resolved
Copy link
Collaborator

@peverwhee peverwhee left a comment

Choose a reason for hiding this comment

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

couple small questions.

Also, I know you've documented this stuff on the new doc page (thanks!), but can I also request a README in the test/unit-test directory that describes, at minimum, how to run the tests?

.github/workflows/code-coverage.yaml Outdated Show resolved Hide resolved
@mwaxmonsky
Copy link
Collaborator Author

couple small questions.

Also, I know you've documented this stuff on the new doc page (thanks!), but can I also request a README in the test/unit-test directory that describes, at minimum, how to run the tests?

Added a README with a few instructions and pointer to the gh-docs page but just let me know if there's any other details you think we should add.

Copy link
Collaborator

@peverwhee peverwhee left a comment

Choose a reason for hiding this comment

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

thanks! one request on the new readme. and reminder to pick a new name for the workflow yaml (assuming you're ok with changing it)

test/unit-test/README.md Show resolved Hide resolved
@mwaxmonsky mwaxmonsky merged commit 026c4c5 into ESCOMP:development Nov 14, 2024
3 checks passed
jimmielin added a commit that referenced this pull request Nov 19, 2024
Tag name (The PR title should also include the tag name):
`atmos_phys0_07_000`
Originator(s): @jimmielin

List all `development` PR URLs included in this PR and a short
description of each:
* #141 by @mattldawson @boulderdaze 
* #147 by @peverwhee 
* #144 by @mwaxmonsky 
* #151 by @mattldawson 
* #145 by @jimmielin 

List all test failures: N/A
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants