Better error assertions in tests #616
Merged
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
This change introduces better error assertions, prompted by a comment from Albert Teoh here: #615 (comment) The change introduces two new test helper functions: - expectErrIs(tb testing.TB, err, want error) - expectErrAs(tb testing.TB, err error, target interface{}) These wrap `errors.Is` and `errors.As` functions from the standard library, respectively. In order for this to work, the `mismatchedGeometryCollectionDimsError` must be exported, but _only during tests_ (because we don't want to expose it to users of the library). This is achieved by using type aliases in a `_test.go` file in the `geom` package. Because `_test.go` files are only included during tests, this is a safe way to expose the type only during tests.
peterstace
commented
May 15, 2024
| @@ -59,11 +59,11 @@ func wrapWithGeoJSONSyntaxError(err error) error { | |||
| } | |||
|
|
|||
| type mismatchedGeometryCollectionDimsError struct { | |||
| ct1, ct2 CoordinatesType | |||
| CT1, CT2 CoordinatesType | |||
There was a problem hiding this comment.
These need to be exported, otherwise they can't be accessed from the geom_test package. Because mismatchedGeometryCollectionDimsError isn't exported (except during tests), having CT1 and CT2 exported doesn't make any difference for users of the library.
albertteoh
approved these changes
May 16, 2024
| @@ -0,0 +1,3 @@ | |||
| package geom | |||
|
|
|||
| type MismatchedGeometryCollectionDimsError = mismatchedGeometryCollectionDimsError | |||
There was a problem hiding this comment.
Wizard! TIL something new about Go 🙏🏼
There was a problem hiding this comment.
I only learned about this yesterday 😁
|
Thanks for reviewing! |
peterstace
added a commit
that referenced
this pull request
May 20, 2024
This is a follow-on from #616. It adds additional improvements to error assertions during testing, including: - Asserting on GeoJSON unmarshalling target mismatch errors (when GeoJSON is unmarshalled into the wrong type). - Asserting on validation errors (with assertions that the expected validation rule violation occurred).
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.
Description
This change introduces better error assertions, prompted by a comment from Albert Teoh here: #615 (comment)
The change introduces two new test helper functions:
expectErrIs(tb testing.TB, err, want error)expectErrAs(tb testing.TB, err error, target interface{})These wrap
errors.Isanderrors.Asfunctions from the standard library, respectively.In order for this to work, the
mismatchedGeometryCollectionDimsErrormust be exported, but only during tests (because we don't want to expose it to users of the library). This is achieved by using type aliases in a_test.gofile in thegeompackage. Because_test.gofiles are only included during tests, this is a safe way to expose the type only during tests.Check List
Have you:
Added unit tests? Yes.
Add cmprefimpl tests? (if appropriate?) N/A
Updated release notes? (if appropriate?) N/A (internal change, so probably doesn't need them).
Related Issue