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

Common Verification Protocol #69

Open
shanemcq18 opened this issue Oct 21, 2024 · 0 comments
Open

Common Verification Protocol #69

shanemcq18 opened this issue Oct 21, 2024 · 0 comments

Comments

@shanemcq18
Copy link
Member

Several of the template classes have a verify() method for lightly testing custom child classes. For example, LifterTemplate.verify() checks that lift() and unlift() are inverses and does a finite difference check for lift_ddts() (when implemented). Most of the verify() methods raise a VerificationError at the first sign of trouble, but this isn't uniform. The purpose is of verify() is to give the user concise info on what appears to be working and what appears to not be working.

Proposed verification protocol:

  • Do as many tests as possible, even if one test "fails"
  • Print the results of all tests at the end
  • Then, raise a VerificationError if any tests have failed
  • Unit tests of verify() don't need to get out of hand to get total line coverage, but verify() may be used to implement certain unit tests.

When all verify() methods are standardized, it should be straightforward to implement verify() for the ROM class.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant