feat: add pre-commit hook support #795

ccoVeille · 2024-07-17T10:00:55Z

Description

Add pre-commit.com support in mockery.

Fixes Feature request: pre-commit hooks #791

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

Version of Go used when building/testing:

How Has This Been Tested?

Locally, by following the guide I provide in installation.md file

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes

liveFreeOrCode · 2024-07-17T15:37:50Z

.pre-commit-hooks.yaml

+  additional_dependencies:
+    - github.com/vektra/mockery/v2@latest
+  entry: mockery


Rather than using additional_dependencies, the pre-commit-hook will already have access to the file system. We should just be able to use go run . to enact the mockery ... command I believe.

Also, we may only want this hook to run when .go files are in the commit. What do you think?

Suggested change

additional_dependencies:

- github.com/vektra/mockery/v2@latest

entry: mockery

entry: go run .

files: \.go$

I'm unsure it will launch the code you expect to run.

I will make some tests.

But, I think keeping mockery call here would be clearer.

Using additional dependencies like this won't allow people to specify version in pre commit file because no matter what version they reference, you're pulling latest

Indeed, I'm unsure if there is something that can be done here, I will have to check

For now,it seems to me, that it would imply to maintain the version in sync in this file vs the tag. Quite a pain

Is it possible let the users assume the responsibility for installing mockery? If that's the case this should suffice

--- - id: generate-mocks name: generate mocks description: Generate mocks with mockery language: golang entry: mockery pass_filenames: false

Yes, of course, it makes sense.

But then having 2 rules could be a something to consider

I think your approach is the most commonly used in fact

https://github.com/search?q=path%3A%22%2F.pre-commit-hooks.yaml%22+golang&type=code

.pre-commit-config.yaml

docs/installation.md

.pre-commit-config.yaml

ccoVeille · 2024-07-18T19:45:00Z

anyway @liveFreeOrCode could you confirm it "works" as this ?

ccoVeille · 2024-07-31T08:31:29Z

@liveFreeOrCode (or anyone) could you confirm ? thanks

Then I will remove the oddities present to make it works with my branch, and switch to vektra/mokery one

ccoVeille · 2024-07-31T20:59:55Z

Hi @liveFreeOrCode

You commented the PR, thanks.

But you didn't reply my question. Does it work on your computer now with current code I provided.

I understand you might dislike the current implementation. I agree it could be improved. But right now,I would like to get a simple reply to the following question.

Does it work?

liveFreeOrCode · 2024-07-31T21:01:20Z

Hi @liveFreeOrCode

You commented the PR, thanks.

But you didn't reply my question. Does it work on your computer now with current code I provided.

I understand you might dislike the current implementation. I agree it could be improved. But right now,I would like to get a simple reply to the following question.

Does it work?

Yeah sorry I'm traveling without my PC. I can't test until next week

ccoVeille · 2024-07-31T21:58:12Z

OK thanks for replying, we can also wait

LandonTClipp · 2024-11-13T19:45:10Z

Closing due to inactivity, feel free to resurrect it if you find the time to finish it.

ccoVeille · 2024-11-13T19:47:20Z

Hi @LandonTClipp

Please reopen.

I was waiting for someone feedbacks.

The code is ready.

sx-klaviyo · 2024-12-12T15:08:52Z

I was just searching for pre-commit hooks for Mockery and found this 👀 Would love to see this reopened and merged!

ccoVeille · 2024-12-12T15:18:25Z

Just ping me back if nothing happen, I can reopen the PR

sx-klaviyo · 2024-12-17T18:51:19Z

Hi @ccoVeille! Just a reminder that this PR is opened now

ccoVeille · 2024-12-17T21:12:42Z

@sx-klaviyo

The MR was waiting for people to test since July.

@liveFreeOrCode said he would, but he didn't.

There are indeed some code reviews that were provided, but before going further and address them, I would like someone to test.

The code was supposed to work. I would appreciate it if you could, before I iterate on addressing feedbacks.

Because without a tester, it's uneasy to validate things out of my understanding/knowlege

sx-klaviyo · 2024-12-18T19:51:43Z

I'll try to test it this week and let you know!

sx-klaviyo · 2024-12-20T22:12:45Z

@ccoVeille I confirm that your .pre-commit-hooks.yaml is working!
I also left a comment in a the additional_dependency and entry conversation: #795 (comment) please let me know if that looks good to you

ccoVeille · 2024-12-21T07:34:01Z

Great. Thank you for testing.

For records, I'm unsure I will have time to fix that before Christmas break.

So be patient

sx-klaviyo · 2025-01-21T14:25:37Z

Hi @ccoVeille, just wondering if you are back from the Christmas break? Please let me know if I can help with anything!

ccoVeille · 2025-01-21T22:53:03Z

Thanks for the reminder.

Winter break was indeed a great period.

Please let me know, if you think it's OK now.

Fixes vektra#791

ccoVeille · 2025-01-21T23:00:26Z

@sx-klaviyo In order to test locally, please use the following set up

Add the following lines to your .pre-commit-config.yaml file

repos:
  - repo: https://github.com/ccoveille-forks/vektra-mockery
    rev: v2 # This is a mutable reference to the latest version
    hooks:
      - id: generate-mocks

Then test the other ones

repos:
  - repo: https://github.com/ccoveille-forks/vektra-mockery
    rev: v2 # This is a mutable reference to the latest version
    hooks:
      - id: generate-mocks-local

Both should work, I created a fake 2.51.1 tag

Please check and let me know.

sx-klaviyo · 2025-01-24T00:40:45Z

Thank you for the instructions!

I believe the repo link should be https://github.com/ccoveille-forks/vektra-mockery
Also, it only worked when I use this:

  - repo: https://github.com/ccoveille-forks/vektra-mockery
    rev: v2.51.1-alpha # by explicitly using the tag that you created
    hooks:
      - id: generate-mocks

Using v2 is not working for me. Also, i'm not sure if generate-mocks-local is a valid hook: https://github.com/ccoveille-forks/vektra-mockery/blob/0db88da09d747f44f7bdcd2b680e7c77fb4f506e/.pre-commit-hooks.yaml (this is the commit on master branch as I'm making this comment)

ccoVeille · 2025-01-26T16:09:12Z

I had to test a lot to finally find why

I worked in a branch in my fork, but here is what the documentation of pre-commit says:

https://pre-commit.com/#updating-hooks-automatically

You can update your hooks to the latest version automatically by running pre-commit autoupdate. By default, this will bring the hooks to the latest tag on the default branch.

I had to switch the default branch of my fork to be the one of my PR ... so the tag I created would be the one precommit looks for.

Now everything works as expected. Please check by following steps:

repos:
  - repo: https://github.com/ccoveille-forks/vektra-mockery
    rev: v2
    hooks:
      - id: generate-mocks

Then

$ pre-commit install
$ pre-commit autoupgrade

Then try to commit a Go file

Then proceed with the exact same steps with

repos:
  - repo: https://github.com/ccoveille-forks/vektra-mockery
    rev: v2
    hooks:
      - id: generate-mocks-local

Then

$ pre-commit install
$ pre-commit autoupgrade

Then try to commit a Go file

And it should be OK (famous last words)

Please let me know @sx-klaviyo and even @liveFreeOrCode

So much time lost because of the "last tag from the default branch" joke. It's logic, But it's a pain to spot.

I might open a bug report/feature request on pre-commit code

liveFreeOrCode reviewed Jul 17, 2024

View reviewed changes

ccoVeille commented Jul 17, 2024

View reviewed changes

.pre-commit-config.yaml Outdated Show resolved Hide resolved

ccoVeille marked this pull request as draft July 18, 2024 20:21

LandonTClipp closed this Nov 13, 2024

LandonTClipp reopened this Dec 12, 2024

ccoVeille force-pushed the pre-commit branch 2 times, most recently from 943dcde to 3b14ef9 Compare January 21, 2025 22:51

feat: add pre-commit hook support

f0890a9

Fixes vektra#791

ccoVeille force-pushed the pre-commit branch from 3b14ef9 to f0890a9 Compare January 21, 2025 22:55

ccoVeille force-pushed the pre-commit branch from ad12d14 to f0890a9 Compare January 26, 2025 15:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add pre-commit hook support #795

feat: add pre-commit hook support #795

ccoVeille commented Jul 17, 2024

liveFreeOrCode Jul 17, 2024

ccoVeille Jul 17, 2024

liveFreeOrCode Jul 31, 2024

ccoVeille Jul 31, 2024

ccoVeille Jul 31, 2024

sx-klaviyo Dec 20, 2024

ccoVeille Dec 21, 2024

ccoVeille Dec 21, 2024

ccoVeille commented Jul 18, 2024

ccoVeille commented Jul 31, 2024

ccoVeille commented Jul 31, 2024 •

edited

Loading

liveFreeOrCode commented Jul 31, 2024

ccoVeille commented Jul 31, 2024

LandonTClipp commented Nov 13, 2024

ccoVeille commented Nov 13, 2024

sx-klaviyo commented Dec 12, 2024

ccoVeille commented Dec 12, 2024

sx-klaviyo commented Dec 17, 2024

ccoVeille commented Dec 17, 2024

sx-klaviyo commented Dec 18, 2024

sx-klaviyo commented Dec 20, 2024 •

edited

Loading

ccoVeille commented Dec 21, 2024

sx-klaviyo commented Jan 21, 2025 •

edited

Loading

ccoVeille commented Jan 21, 2025

ccoVeille commented Jan 21, 2025 •

edited

Loading

sx-klaviyo commented Jan 24, 2025 •

edited

Loading

ccoVeille commented Jan 26, 2025 •

edited

Loading

feat: add pre-commit hook support #795

Are you sure you want to change the base?

feat: add pre-commit hook support #795

Conversation

ccoVeille commented Jul 17, 2024

Description

Type of change

Version of Go used when building/testing:

How Has This Been Tested?

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ccoVeille commented Jul 18, 2024

ccoVeille commented Jul 31, 2024

ccoVeille commented Jul 31, 2024 • edited Loading

liveFreeOrCode commented Jul 31, 2024

ccoVeille commented Jul 31, 2024

LandonTClipp commented Nov 13, 2024

ccoVeille commented Nov 13, 2024

sx-klaviyo commented Dec 12, 2024

ccoVeille commented Dec 12, 2024

sx-klaviyo commented Dec 17, 2024

ccoVeille commented Dec 17, 2024

sx-klaviyo commented Dec 18, 2024

sx-klaviyo commented Dec 20, 2024 • edited Loading

ccoVeille commented Dec 21, 2024

sx-klaviyo commented Jan 21, 2025 • edited Loading

ccoVeille commented Jan 21, 2025

ccoVeille commented Jan 21, 2025 • edited Loading

sx-klaviyo commented Jan 24, 2025 • edited Loading

ccoVeille commented Jan 26, 2025 • edited Loading

ccoVeille commented Jul 31, 2024 •

edited

Loading

sx-klaviyo commented Dec 20, 2024 •

edited

Loading

sx-klaviyo commented Jan 21, 2025 •

edited

Loading

ccoVeille commented Jan 21, 2025 •

edited

Loading

sx-klaviyo commented Jan 24, 2025 •

edited

Loading

ccoVeille commented Jan 26, 2025 •

edited

Loading