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

Create sample unit test to assist developers #573

Closed
GeorgeGayno-NOAA opened this issue Aug 23, 2021 · 4 comments · Fixed by #576
Closed

Create sample unit test to assist developers #573

GeorgeGayno-NOAA opened this issue Aug 23, 2021 · 4 comments · Fixed by #576
Assignees
Labels
enhancement New feature or request

Comments

@GeorgeGayno-NOAA
Copy link
Collaborator

Unit tests are now required before any changes can be merged. When developers are told this, their first question is: "How do I create a unit test and run it under Github actions?" Then, I write a basic test for him. If we had a sample, working test baselined under the repo, it would serve as a guide for developers (and save the admins a lot of time).

@GeorgeGayno-NOAA GeorgeGayno-NOAA added the enhancement New feature or request label Aug 23, 2021
@kgerheiser
Copy link
Contributor

Maybe a README.md in the tests directory with a brief explanation of what a unit test should do (exercise the code, check results), and a sample (or point to a simple test like tst_quicksort)?

@edwardhartnett
Copy link
Collaborator

I suggest pointing such users at an existing test which most closely matches their proposed test. That will get easier as tests are added.

Adding a section to the README: "How to Add a Unit Test" would be a good idea.

@GeorgeGayno-NOAA GeorgeGayno-NOAA self-assigned this Aug 26, 2021
GeorgeGayno-NOAA added a commit to GeorgeGayno-NOAA/UFS_UTILS that referenced this issue Aug 26, 2021
GeorgeGayno-NOAA added a commit to GeorgeGayno-NOAA/UFS_UTILS that referenced this issue Aug 27, 2021
GeorgeGayno-NOAA added a commit to GeorgeGayno-NOAA/UFS_UTILS that referenced this issue Aug 27, 2021
GeorgeGayno-NOAA added a commit to GeorgeGayno-NOAA/UFS_UTILS that referenced this issue Aug 27, 2021
GeorgeGayno-NOAA added a commit to GeorgeGayno-NOAA/UFS_UTILS that referenced this issue Aug 27, 2021
GeorgeGayno-NOAA added a commit to GeorgeGayno-NOAA/UFS_UTILS that referenced this issue Aug 27, 2021
GeorgeGayno-NOAA added a commit to GeorgeGayno-NOAA/UFS_UTILS that referenced this issue Aug 27, 2021
GeorgeGayno-NOAA added a commit to GeorgeGayno-NOAA/UFS_UTILS that referenced this issue Aug 27, 2021
GeorgeGayno-NOAA added a commit to GeorgeGayno-NOAA/UFS_UTILS that referenced this issue Aug 30, 2021
GeorgeGayno-NOAA added a commit to GeorgeGayno-NOAA/UFS_UTILS that referenced this issue Sep 1, 2021
GeorgeGayno-NOAA added a commit to GeorgeGayno-NOAA/UFS_UTILS that referenced this issue Sep 3, 2021
GeorgeGayno-NOAA added a commit that referenced this issue Sep 3, 2021
Add 'readme' file with instructions for writing unit tests.

Fixes #573
@GeorgeGayno-NOAA
Copy link
Collaborator Author

Reopen so @LarissaReames-NOAA can add her sample unit test.

@GeorgeGayno-NOAA
Copy link
Collaborator Author

Merged to 'develop' at 7c31411.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants