Unable to generate mocks for protobuf clients?

[leaanthony-sc]

Description

We have been using mockery (v2.10.6 - docker) successfully to generate mocks for protobuf clients but recently upgraded to v2.32.0 to try out the new packages configuration. It now appears to be impossible to generate protobuf client mocks. Running mockery in debug mode indicated that all source files were being skipped with the message DBG skipping file as auto-generated. Investigating further, I believe I've narrowed it down to this check in config.go. This appears to have been added as part of this commit which was intended to introduce the recursive option. The linked issue doesn't have any information with regards to now skipping auto generated code so it's not clear what the driver was for this change. There also does not appear to be a way around this limitation. I did search through the issue tracker prior to opening this but could not find anything related. Generating mocks for protobuf clients is not uncommon so I'm surprised this hasn't been raised already. Thanks for your time.

Mockery Version

v2.32.0 via docker image

Golang Version

v1.20.7

Installation Method

• Binary Distribution
• Docker
• brew
• go install
• Other: [specify]

Steps to Reproduce

1. Generate client protobuf
2. Use mockery to try and generate a mock for the client

Expected Behavior

I would expect a mock to be generated like it did prior to the change on the 9th of April, or at least an option to allow it to be generated.

Actual Behavior

The file does not get processed due to a hard coded restriction.

[LandonTClipp]

The reason why this behavior was added is because mockery might generate mocks of its own interfaces (so-called "infinite mocking"). However a change was introduced such that mockery no longer creates interfaces in its auto-generated files, so this behavior might not be needed anymore. This had previously been a huge source of pain and my original solution may not have been the optimal one, but it worked for the time. The PR for the removal of the interfaces also includes proper integration tests to assert infinite mocking no longer happens. This is indeed the first time this issue has been posed for the packages feature, and I agree there needs to be a solution for this.

I think this could be easily fixed by simply adding a parameter called include_auto_generated: true that will disable the check you linked to. I'm also open to the idea of removing the check altogether as the original motivation is no longer a factor, however I'm not sure that it wouldn't break other use cases.

Would you or anyone have the time to implement this new feature?

[LandonTClipp]

On second thought, I think it might be better to remove the check by default and consider the current behavior to be a bug. We should preemptively also add include_auto_generated but set the default to true so if people need to revert to the "buggy" behavior, they can. What are your thoughts?

[LandonTClipp]

@leaanthony-sc please try v2.32.3, which introduces this "bug fix" that also adds the include-auto-generated parameter to retain the buggy behavior if needed.

[leaanthony-sc]

@LandonTClipp - Thanks for the quick turnaround on this 🙏 I can confirm that auto-generated files are now picked up by default. Thank you!