Skip to content
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.

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

tests: Adds mock patch autospec fixture #323

Merged
merged 1 commit into from
Jul 3, 2024

Conversation

claudiubelu
Copy link
Member

When mocking something, there's the possibility to reference a property that does not exist, or call a method with invalid arguments, but the unit tests to keep passing, resulting in false positives.

We've seen this issue several times in OpenStack, and we have created and started using a mock patch fixture (can be seen in OpenStack Nova's test.py) which enables autospec by default.

This guarantees 2 things: that the thing we're patching exists, and if it's callable, that the calls respect the callable's signature (e.g.: no unknown arguments can be used).

When mocking something, there's the possibility to reference a
property that does not exist, or call a method with invalid arguments,
but the unit tests to keep passing, resulting in false positives.

We've seen this issue several times in OpenStack, and we have created
and started using a mock patch fixture (can be seen in OpenStack Nova's test.py)
which enables autospec by default.

This guarantees 2 things: that the thing we're patching exists, and if it's
callable, that the calls respect the callable's signature (e.g.: no unknown
arguments can be used).
Copy link
Contributor

@Dany9966 Dany9966 left a comment

Choose a reason for hiding this comment

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

Nice addition, I don't have to check all of the call args in reviews now :) thanks a bunch!

@Dany9966 Dany9966 merged commit 20dab35 into cloudbase:master Jul 3, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants