DATA-DOG / go-sqlmock

Sql mock driver for golang to test database interactions
Other
5.95k stars 404 forks source link

Add WillCompleteOnCancel expectation #300

Closed cleroux closed 1 month ago

cleroux commented 1 year ago

Closes #299

I nerd-sniped myself after writing up the issue and started looking into the code. Turned out to be pretty straight-forward. So here's a PR! I hope you think it's useful. If you decide to merge this I would certainly pull this update and use this feature to write some new tests.

The goal of .WillCompleteOnCancel() is to be able to test a pretty rare edge case in Postgres (and maybe other databases?) where the Go context is cancelled but due to timing, may not succeed in actually cancelling the query. In this case the query completes without error, and functions like QueryContext() et al. do not return the "context canceled" error we normally expect.

This change is fully backward-compatible. There is no change to the default behavior which is to return ErrCancelled when the context is cancelled.

diegommm commented 1 month ago

Hi @cleroux! I suggest that before submitting a PR you have a discussion with maintainers in the issue so that we can agree on what needs to be implemented, and whether we want it to be part of sqlmock in the first place.

However, I wanted to thank you for your contribution and the time you took to work on this, kind regards.