Mark test.EquateErrors as deprecated #529
Open
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
See crossplane/crossplane#4514 for context. We can't remove this (it would be a breaking API change) but I want to discourage and redirect folks. Signed-off-by: Nic Cope <[email protected]>
|
Converting to draft because I forgot I had to update all the uses in this repo. 😆 |
To avoid doing a whole bunch of string comparison in unit tests, we also switch to using cmpopts.EquateErrors. Signed-off-by: Nic Cope <[email protected]>
This way code in policies.go has its tests in policies_test.go, not reconciler_test.go. Signed-off-by: Nic Cope <[email protected]>
phisco
approved these changes
Aug 28, 2023
| @@ -214,7 +202,7 @@ func SecretToDeleteMustBeOwnedBy(so metav1.Object) store.DeleteOption { | |||
|
|
|||
| func secretMustBeOwnedBy(so metav1.Object, secret *store.Secret) error { | |||
| if secret.Metadata == nil || secret.Metadata.GetOwnerUID() != string(so.GetUID()) { | |||
| return errors.Errorf(errFmtNotOwnedBy, string(so.GetUID())) | |||
| return errors.Errorf("existing secret is not woned by UID %q", string(so.GetUID())) | |||
There was a problem hiding this comment.
Suggested change
| return errors.Errorf("existing secret is not woned by UID %q", string(so.GetUID())) | |
| return errors.Errorf("existing secret is not owned by UID %q", string(so.GetUID())) |
| @@ -87,7 +84,8 @@ func TestManagerConnectStore(t *testing.T) { | |||
| }, | |||
| }, | |||
| want: want{ | |||
| err: errors.Wrapf(kerrors.NewNotFound(schema.GroupResource{}, fakeConfig), errGetStoreConfig), | |||
| // TODO(negz): Can we test that this is kerrors.NewNotFound? | |||
There was a problem hiding this comment.
I tried implementing a custom EquateErrors based on errors.As, but unfortunately I couldn't make it work, so I guess we're stuck with cmptopts.AnyError.
|
This is approved, so if this PR is still relevant could we rebase and merge? |
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 of your changes
We can't remove this (it would be a breaking API change) but I want to discourage and redirect folks.
See crossplane/crossplane#4514 for context and more discussion. I've also updated this repo to follow the new pattern proposed in that issue, so it acts as an example of how tests might look if we choose to adopt it.
I have:
make reviewable testto ensure this PR is ready for review.How has this code been tested