New linter: flag unnecessary calls to Finish on gomock.Controllers in Go 1.14+

[jamietanna]

Your feature request related to a problem? Please describe.

As highlighted in https://pkg.go.dev/github.com/golang/mock/gomock#NewController:

New in go1.14+, if you are passing a *testing.T into this function you no longer need to call ctrl.Finish() in your test methods.

Describe the solution you'd like.

A linting rule that can flag when we're unnecessarily calling .Finish, when using a Go version of 1.14+

Describe alternatives you've considered.

N/A

Additional context.

No response

[ldez]

Hello,

FYI golangci-lint is a meta-linter, there are no internal linting rules.

[jamietanna]

That's fair! Are you happy me leaving this here in case someone else wants to pick it up and contribute it?

[ldez]

I flagged it as a linter idea, so yes we can keep it.
Can you improve the title of your issue?

[daikidev111]

Hi can I try implementing a linter based on this idea?

[jamietanna]

Yes please, happy for you to go for it ☺

[daikidev111]

Sorry for a bit of delay as I was busy with my uni work. I have finished the implementation part and I will do more testing to ensure that it really works. Once done with it, I will throw a PR.

[Antonboom]

@daikidev111, how is it going? :)

Pay attention that github.com/golang/mock is archived and moved under Uber support (github.com/uber-go/mock).

[daikidev111]

@Antonboom
I've completed 90% of the implementation. However, due to the package having different support now, I'm unsure whether I should finish the implementation and submit a pull request or not. Is it possible to create a linter for a package that isn't natively supported by Go?

[ldez]

Is it possible to create a linter for a package that isn't natively supported by Go?

It has never been supported natively by Go, it was related to a library.

The libraries inside the golang organization are not related to Go itself.

[daikidev111]

Thank you for the clarification. I will resume working on this!

[hendrywiranto]

Hi, look like the interested user still doesn't move forward with this

so I created the linter here https://github.com/hendrywiranto/gomockcontrollerfinish
will open a PR soon to integrate it
also if you guys have other idea for the name I'm still open for it, maybe gomocklint might be a more suitable name

[alexandear]

For the workaround see #4202 (comment)

[alexandear]

@ldez maybe we should close this issue because it's possible to detect Finish calls with forbidigo?