Skip to content

NotSame should fail if args are not pointers #1661 #1664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 11 commits into from
Oct 28, 2024
Merged

NotSame should fail if args are not pointers #1661 #1664

merged 11 commits into from
Oct 28, 2024

Conversation

sikehish
Copy link
Contributor

@sikehish sikehish commented Oct 17, 2024 •
edited
Loading

Summary

Reduces the confusion assosciated with NotSame that previously would check nothing if any of the values is not a pointer. The changes made were tested using TestSame, TestNotSame, and Test_samePointers tests, and the changes did clear the tests.

Changes

  1. Modified samePointers to return another bool value(ok) that would determine if the 2 values are of pointer type or not, while the returned "same" bool value would determine if the 2 pointers are same.
  2. Modified assert.NotSame to call Fail() if the 2 values are either i)pointers pointing to the same address or ii)either/both of the values are not pointers.
  3. Modified assert.Same to call Fail() if the 2 values are either i)pointers not pointing to the same address or ii)either/both of the values are not pointers.
  4. Modified Test_samePointers to handle the new behavior of samePointers by checking both if the inputs are pointers (ok) and if they point to the same object (same).

Motivation

Ensure NotSame accurately verifies pointer sameness by handling non-pointer inputs explicitly, improving clarity and reducing potential misuse.

Related issues

Closes #1661

@sikehish sikehish mentioned this pull request Oct 17, 2024
Closed
brackendawson
brackendawson requested changes Oct 18, 2024
View reviewed changes
@sikehish
Copy link
Contributor Author

Hi, @brackendawson.
I've made all the requested amendments. Do let me know if any other changes are to be made :)

brackendawson
brackendawson requested changes Oct 26, 2024
View reviewed changes
Copy link
Collaborator

@brackendawson brackendawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the late re-review, that's looking good, just a couple more bits.

assert/assertions.go Outdated
expected, expected), msgAndArgs...)
same, ok := samePointers(expected, actual)

if ok {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Almost there, if you flip this to if !ok { then you can avoid the nested if statements and fully preserve line of sight.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also we don't really want the blank line first as this is "error handling" for the line above.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've made the changes