chore: Follow-up to Mockery followup #288
Conversation
tools/Makefile
Outdated
| rm -Rf ../mockadmin | ||
| mockery | ||
| curl -L -o mockery.tar.gz https://github.com/vektra/mockery/releases/download/v2.42.1/mockery_2.42.1_Linux_x86_64.tar.gz |
There was a problem hiding this comment.
From this comment in the previous PR, this dependency would not be automatically updated, right?
There was a problem hiding this comment.
not sure I understand your question
There was a problem hiding this comment.
Sorry, what I meant is that as far as I understand, @wtrocki wanted the mockery dependency version to be elsewhere so that it can be automatically updated by dependabot. As it is now, I don't think that's the case
There was a problem hiding this comment.
Related to the #288 (comment)
Re version - I think we use pattern to define them in the header of the markdown to understand how to update them and cover them in the Contributing guide
There was a problem hiding this comment.
There was a problem hiding this comment.
Alternatively we can use tools target as way to install all dependencies:
https://github.com/mongodb/atlas-sdk-go/blob/main/Makefile#L40
tools/Makefile
Outdated
| rm -Rf ../mockadmin | ||
| mockery | ||
| curl -L -o mockery.tar.gz https://github.com/vektra/mockery/releases/download/v2.42.1/mockery_2.42.1_Linux_x86_64.tar.gz |
There was a problem hiding this comment.
I think we can reuse some of the scripts linked below as this solution to introduce patterns for make:
- Cache installation (mocking locally fails
- Clean up files or ignore them with git)
- Check if tool exist (making redundant installs without cache)
We tend to use .bin file in the repo so developers do not get tar.gz file as change when running this command.
Official docs:
https://vektra.github.io/mockery/latest/installation/
Some examples of makefile efficient installations:
- https://github.com/bxcodec/go-clean-arch/blob/e06c6d0cb37069b0ef56e3df67f80ca130a1ab82/misc/make/tools.Makefile#L85
- https://github.com/hyperledger/fabric/blob/111cff51600d26d4b4b05f52825da11e7629e971/gotools.mk#L36
- https://github.com/tendermint/tendermint/blob/35581cf54ec436b8c37fabb43fdaa3f48339a170/scripts/mockery_generate.sh#L9-L15
There was a problem hiding this comment.
thank you, at the end I've followed the Docker approach so it works both in local and in the GH action
| @@ -84,6 +84,7 @@ Repository contains following SDKs | |||
| - `tools`: tooling used to generate Atlas Admin SDK. See [./tools](./tools) for more information. | |||
| - `examples`: SDK examples | |||
| - `internal`: folder for hosting non user facing SDK methods and core helpers | |||
| - `mockadmin`: [Testify mocks](https://pkg.go.dev/github.com/stretchr/testify/mock) generated with [Mockery](https://github.com/vektra/mockery) for API interfaces | |||
There was a problem hiding this comment.
IMHO we might need documentation that clarifies how we maintain mockery as part of the SDK.
Defining make target to regenerate locally and pointing to the tests example
lantoli
force-pushed
the
mockery_followup
branch
from
00b8d2e
to
5315668
Compare
| ./mockery | ||
| .PHONY: generate_mocks | ||
| generate_mocks: | ||
| ./scripts/generate_mocks.sh |
Description
Follow-up for Mockery PR: #287
Type of change:
Required Checklist:
make fmtand formatted my codeFurther comments