OpenFreeEnergy / OpenFreeEnergy/openfe

Create new test class for serialization tests or upstream to gufe?

Open
#1,308 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
332
Forks
56
Avg merge
3d 9h
Merged PRs (30d)
13

Description

Follow up from #1294

Our serialization tests subclass the GufeTokenizableTestsMixin but consistently overwrite the test_repr method to offer a little bit more testing than what the gufe base class offers.

Since we overwrite this method for nearly all protocol tests, we should either a) create a base test class with this overriden method here in openfe, or b) update the gufe test class to have this extra test functionality.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing follow-up issue #1294 and the serialization tests that subclass GufeTokenizableTestsMixin, focusing on their repeated test_repr overrides. Compare the two proposed destinations: a new base test class in openfe or enhanced functionality in gufe. Done means the approach is decided and the repeated test_repr behavior is consolidated without losing the additional coverage.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.