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

Remove test groups #111

Merged
merged 2 commits into from
Sep 5, 2023
Merged

Remove test groups #111

merged 2 commits into from
Sep 5, 2023

Conversation

xylar
Copy link
Collaborator

@xylar xylar commented Sep 3, 2023

In order to increase the flexibility in Polaris, we have removed test groups from the framework. Tasks can still be organized by a common theme in the spirit of test groups but this is no longer a requirement.

The constructors for test groups have been replaced by simple functions for adding the tasks directly to each component. The subdirectories for the test groups have been prepended to the subdirectories for the tasks instead.

Checklist

  • User's Guide has been updated
  • Developer's Guide has been updated
  • API documentation in the Developer's Guide (api.md) has any new or modified class, method and/or functions listed
  • Documentation has been built locally and changes look as expected
  • Testing comment in the PR documents testing used to verify the changes

Based off of #110, which is based off of #112

@xylar xylar added clean-up framework Changes relating to the polaris framework as opposed to individual tests or analysis in progress This PR is not ready for review or merging ocean Related to ocean tests or analysis labels Sep 3, 2023
@xylar
Copy link
Collaborator Author

xylar commented Sep 3, 2023

Note

I do not plan to clean up the tutorial until after the reorganization (including shared steps and perhaps task-parallelism) is finished. It's too much work and too much of a moving target.

The rest of the docs will also need a careful look. I have attempted to update them but haven't had time to give them a thorough read and that more thorough clean-up will also have to wait.

@xylar xylar added the sea ice Related to sea-ice tests or analysis label Sep 3, 2023
@xylar xylar force-pushed the remove-test-groups branch from a49d21f to 41dcd0f Compare September 4, 2023 11:52
This was referenced Sep 4, 2023
@xylar xylar force-pushed the remove-test-groups branch from 41dcd0f to 308ab13 Compare September 5, 2023 13:30
Copy link
Collaborator

@cbegeman cbegeman left a comment

Choose a reason for hiding this comment

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

@xylar This looks great! Thanks for all the work you've put into this. I just have a small fix to the docs to add.

In order to increase the flexibility in Polaris, we have removed
test groups from the framework.  Tasks can still be organized by
a common theme in the spirit of test groups but this is no longer
a requirement.

The constructors for test groups have been replaced by simple
functions for adding the tasks directly to each component.
The subdirectories for the test groups have been prepended to
the subdirectories for the tasks instead.
@xylar xylar force-pushed the remove-test-groups branch from 308ab13 to 42de4c6 Compare September 5, 2023 19:53
@xylar xylar removed the in progress This PR is not ready for review or merging label Sep 5, 2023
@xylar xylar marked this pull request as ready for review September 5, 2023 19:54
@xylar
Copy link
Collaborator Author

xylar commented Sep 5, 2023

Thanks for the suggestions. I believe I have things cleaned up but will run the pr suite to make sure things still work.

@xylar
Copy link
Collaborator Author

xylar commented Sep 5, 2023

Testing

I ran the pr suite using a recent main as a baseline. All tests passed.

@xylar xylar merged commit b99d080 into E3SM-Project:main Sep 5, 2023
@xylar xylar deleted the remove-test-groups branch September 5, 2023 20:15
@xylar
Copy link
Collaborator Author

xylar commented Sep 5, 2023

Thanks once again, @cbegeman!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clean-up framework Changes relating to the polaris framework as opposed to individual tests or analysis ocean Related to ocean tests or analysis sea ice Related to sea-ice tests or analysis
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants