Skip to content

Commit eb67641

Browse files
fix: import and arg collision (#219)
This PR fixes an issue where if the name of an argument to a method that is being mocked collides with the name of a package that needs to be imported, mockgen could generate uncompilable code. Resolves #218
1 parent c205527 commit eb67641

File tree

5 files changed

+90
-6
lines changed

5 files changed

+90
-6
lines changed
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
package internalpackage
2+
3+
type FooExported struct{}

mockgen/internal/tests/import_collision/p2/mocks/mocks.go

Lines changed: 55 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
package p2
2+
3+
//go:generate mockgen -destination=mocks/mocks.go -package=internalpackage . Mything
4+
5+
import (
6+
"go.uber.org/mock/mockgen/internal/tests/import_collision/internalpackage"
7+
)
8+
9+
type Mything interface {
10+
// issue here, is that the variable has the same name as an imported package.
11+
DoThat(internalpackage int) internalpackage.FooExported
12+
}

mockgen/internal/tests/package_mode/mock/interfaces.go

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

mockgen/mockgen.go

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -758,6 +758,17 @@ func (g *generator) GenerateMockReturnCallMethod(intf *model.Interface, m *model
758758
return nil
759759
}
760760

761+
// nameExistsAsPackage returns true if the name exists as a package name.
762+
// This is used to avoid name collisions when generating mock method arguments.
763+
func (g *generator) nameExistsAsPackage(name string) bool {
764+
for _, symbolName := range g.packageMap {
765+
if symbolName == name {
766+
return true
767+
}
768+
}
769+
return false
770+
}
771+
761772
func (g *generator) getArgNames(m *model.Method, in bool) []string {
762773
var params []*model.Parameter
763774
if in {
@@ -766,16 +777,19 @@ func (g *generator) getArgNames(m *model.Method, in bool) []string {
766777
params = m.Out
767778
}
768779
argNames := make([]string, len(params))
780+
769781
for i, p := range params {
770782
name := p.Name
771-
if name == "" || name == "_" {
783+
784+
if name == "" || name == "_" || g.nameExistsAsPackage(name) {
772785
name = fmt.Sprintf("arg%d", i)
773786
}
774787
argNames[i] = name
775788
}
776789
if m.Variadic != nil && in {
777790
name := m.Variadic.Name
778-
if name == "" {
791+
792+
if name == "" || g.nameExistsAsPackage(name) {
779793
name = fmt.Sprintf("arg%d", len(params))
780794
}
781795
argNames = append(argNames, name)

0 commit comments

Comments
 (0)