Extend Idioms page to include new support for IEqualityComparer<T>
#36
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
agnerh
suggested changes
Sep 16, 2020
docs/autofixture/idioms.md
Outdated
| @@ -187,7 +187,7 @@ Specifically, these assertions are available: | |||
| * `EqualsSuccessiveAssertion` verifies that `Object.Equals` is implemented so that calling `x.Equals(y)` several times returns always the same value, | |||
| * `GetHashCodeSuccessiveAssertion` verifies that `Object.GetHashCode` is implemented so that calling `x.GetHashCode()` several times returns always the same value. | |||
|
|
|||
| As of today, developers are left to write unit tests that prove that the symmetric and transitive properties are respected. | |||
| As of today, developers are left to write unit tests that prove that the symmetric and transitive properties are respected. [This package](https://www.nuget.org/packages/EqualityTests/) contains the missing tests. Since it's based on AutoFixture 3.36, it might not work with newer versions but developers can take inspiration from [its source code](https://github.com/baks/EqualityTests). | |||
There was a problem hiding this comment.
I'm afraid that the phrase
contains the missing tests
is not really clear. In what aspect are the tests missing?
There was a problem hiding this comment.
Earlier I have specified the properties must be enforced for a good equality check. AutoFixture does not include idiomatic assertions for all of them. The package I linked adds the missing ones.
Kralizek
commented
Sep 16, 2020
| @@ -187,7 +187,7 @@ Specifically, these assertions are available: | |||
| * `EqualsSuccessiveAssertion` verifies that `Object.Equals` is implemented so that calling `x.Equals(y)` several times returns always the same value, | |||
| * `GetHashCodeSuccessiveAssertion` verifies that `Object.GetHashCode` is implemented so that calling `x.GetHashCode()` several times returns always the same value. | |||
|
|
|||
| As of today, developers are left to write unit tests that prove that the symmetric and transitive properties are respected. | |||
| As of today, developers are left to write unit tests that prove that the symmetric and transitive properties are respected but they can be found in [this package](https://www.nuget.org/packages/EqualityTests/). Since this package is based on AutoFixture 3.36, it might not work with newer versions but developers can take inspiration from [its source code](https://github.com/baks/EqualityTests). | |||
There was a problem hiding this comment.
Is it clearer now? @agnerh
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 PR adds a paragraph to the Idioms page that shows how to use the new
EqualityComparerAssertionintroduced in AutoFixture 4.14.0.It also adds a link to the package EqualityTests by baks.
Fixes #35