Add a convenience type for properties involving equivalence#281
Open
neithernut wants to merge 3 commits intoBurntSushi:masterfrom
Open
Add a convenience type for properties involving equivalence#281neithernut wants to merge 3 commits intoBurntSushi:masterfrom
neithernut wants to merge 3 commits intoBurntSushi:masterfrom
Conversation
Closed
89a056a to
4ac7722
Compare
b2fad5d to
da6b9e9
Compare
This type was originally motivated by observing that a class of
properties will involve a pseudo-identity followed by a check for
equivalence between its input and output. A generalization of would be
properties which are defined by the equivalence check, only.
For this class, we usually want to know _how_ those two values differ,
rather than only that they do. Test-authors may thus write tests like
the following in order to include those values in a failure report:
fn revrev(xs: Vec<usize>) -> TestResult {
let rev: Vec<_> = xs.clone().into_iter().rev().collect();
let revrev: Vec<_> = rev.into_iter().rev().collect();
if xs == revrev {
TestResult::passed()
} else {
TestResult::error(
format!("Original: '{:?}', Identity: '{:?}'", xs, revrev)
)
}
}
This change introduces a convenience type which encapsulates the
equivalence check as well as the error message generation. Using it, the
above test could be written as:
fn revrev(xs: Vec<usize>) -> Equivalence<Vec<usize>> {
let rev: Vec<_> = xs.clone().into_iter().rev().collect();
let revrev: Vec<_> = rev.into_iter().rev().collect();
Equivalence::of(xs, revrev)
}
`Equivalence` is meant to be trivially constructible, which was the movitation behind making it a tuple struct. However, it's still a _struct_ and its fields are not pubilic by default. Therefore, the type was not constructible as advertised, e.g. via `Equivalence(a, b)`. This change makes these fields public, as they are supposed to be.
`quickcheck` allows to skip tests (for given inputs) by returning a `TestResult` indicating that it should be ignored. Naturally, an `Equivalence` cannot express such an intent and neither can any other `Testable`s other than functions and `TestResult` itself. Hence, if we need the ability to skip tests, we need to return a `TestResult` or some dependent type (e.g. `Result<TestResult>`) from our property function. If we still want to make use of `Equivalence` in such tests, we need to convert it to a `TestResult`. Previously, we had to resort to using `Testable::result` with some dummy `&mut Gen`, even though it isn't even used in the conversion. As a remedy, this change moves the conversion into a dedicates function (with no additional parameters) which may be called inside property functions.
da6b9e9 to
f79da85
Compare
This file contains hidden or 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
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.
This type was originally motivated by observing that a class of
properties will involve a pseudo-identity followed by a check for
equivalence between its input and output. A generalization of would be
properties which are defined by the equivalence check, only. See #280.
For this class, we usually want to know how those two values differ,
rather than only that they do. Test-authors may thus write tests like
the following in order to include those values in a failure report:
This change introduces a convenience type which encapsulates the
equivalence check as well as the error message generation. Using it, the
above test could be written as: