Some state machine test fixes and refactorings #556
+190
−60
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jorisdral
requested review from
dcoutts,
mheinzel,
recursion-ninja and
wenkokke
as code owners
jorisdral
force-pushed
the
jdral/qls-fixes
branch
from
ff05138 to
f990599
Compare
Also, rename `ErrFsError` to `ErrDiskFault`
Previously, if `checkForgottenRefs` threw an error, no counterexample output would be produced by the test. Now that is a property, counterexamples are properly printed again.
Changes include: * Add a new `ErrOther` model error. * Define a separate error handler for each specific type of SUT exception. * Create `realErrorHandlers`, the set of error handlers used on the SUT. * Define a new `catchAllErrorHandler`, which matches on `SomeException` and maps it to `ErrOther`. The main intent of this refactoring is to map *all* SUT exceptions to a model `Err`. If a SUT exception is not explicitly caught by specialised error handlers such as `lsmTreeErrorHandler`, then `catchAllErrorHandler` will make sure to catch the exception and map it to the catch-all `ErrOther` value. As a result, we get proper counterexample output, which would not happen if we were to get an uncaught exception in the test.
jorisdral
force-pushed
the
jdral/qls-fixes
branch
from
f990599 to
3b75198
Compare
mheinzel
approved these changes
Feb 13, 2025
| @@ -351,6 +340,14 @@ propLockstep_RealImpl_MockFS_IO tr = | |||
| ) | |||
| tagFinalState' | |||
|
|
|||
| -- We can not use @bracket@ inside @PropertyM@, so @acuire_RealImpl_MockFS@ and | |||
There was a problem hiding this comment.
Suggested change
| -- We can not use @bracket@ inside @PropertyM@, so @acuire_RealImpl_MockFS@ and | |
| -- We can not use @bracket@ inside @PropertyM@, so @acquire_RealImpl_MockFS@ and |
| @@ -351,6 +340,14 @@ propLockstep_RealImpl_MockFS_IO tr = | |||
| ) | |||
| tagFinalState' | |||
|
|
|||
| -- We can not use @bracket@ inside @PropertyM@, so @acuire_RealImpl_MockFS@ and | |||
| -- @release_RealImpl_MockFS@ are not run in a maksed state and it is not | |||
There was a problem hiding this comment.
Suggested change
| -- @release_RealImpl_MockFS@ are not run in a maksed state and it is not | |
| -- @release_RealImpl_MockFS@ are not run in a masked state and it is not |
| hasBlockIO <- ioHasBlockIO hasFS defaultIOCtxParams | ||
| pure (tempDir, hasFS, hasBlockIO) | ||
| -- | When combined with other handlers, 'catchAllErrorHandler' has to go last | ||
| -- because it matches on 'SomeException', an no other handlers are run after |
There was a problem hiding this comment.
Suggested change
| -- because it matches on 'SomeException', an no other handlers are run after | |
| -- because it matches on 'SomeException', and no other handlers are run after |
Comment on lines
+284
to
+298
| -- Approximate equality for errors. | ||
| -- | ||
| -- This approximate equality satisfies the __Reflexivity__, __Symmetry__, and | ||
| -- __Negation__ laws for the 'Eq' class, but not __Transitivity__ and | ||
| -- __Substitutivity__. | ||
| -- | ||
| -- These laws should be sufficient for the purpose of comparing an error | ||
| -- returned from the SUT to an error returned from the model. | ||
| -- | ||
| -- Where @'Eq' 'Err'@ deviates from a typical instance is that 'ErrDiskFault' is | ||
| -- equal to all other errors. This is important for comparing SUT exceptions to | ||
| -- model exceptions. The model only knows /something/ went wrong, but the SUT | ||
| -- will probably have a very specific error that it throws. In such cases where | ||
| -- the SUT error is more specific then the model error, the errors are | ||
| -- considered equal. |
There was a problem hiding this comment.
This unlawful instance seems quite hacky. Is using a plain function difficult because quickcheck-lockstep asks for an Eq instance?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.