Merge pull request #1059 from LandonTClipp/LandonTClipp/interface_dir_relative

Fix issue with relative `dir` values causing invalid in-package calculation

Author: LandonTClipp

.mockery_testify.yml

@@ -12,6 +12,9 @@ template-data:
   boilerplate-file: "./.boilerplate.txt"
 packages:
   github.com/vektra/mockery/v3/internal/cmd:
+  github.com/vektra/mockery/v3:
+    config:
+      dir: .
   github.com/vektra/mockery/v3/internal/fixtures/unexported:
   github.com/vektra/mockery/v3/internal/fixtures/buildtag/comment:
   github.com/vektra/mockery/v3/internal/fixtures/example_project/replace_type:

config/config.go

@@ -577,44 +577,53 @@ var ErrInfiniteLoop = fmt.Errorf("infinite loop in template variables detected")
 // interface being mocked. If this argument is nil, interface-specific template
 // variables will be set to the empty string. The srcPkg is also needed to
 // satisfy template variables regarding the source package.
-func (c *Config) ParseTemplates(ctx context.Context, ifaceFileName string, ifaceName string, srcPkg *packages.Package) error {
+func (c *Config) ParseTemplates(
+	ctx context.Context,
+	// ifaceFilePath is the absolute path of the original interface.
+	ifaceFilePath string,
+	ifaceName string,
+	srcPkg *packages.Package,
+) error {
 	log := zerolog.Ctx(ctx)
 
 	mock := "mock"
 	if ast.IsExported(ifaceName) {
 		mock = "Mock"
 	}
 
-	var (
-		interfaceDir         string
-		interfaceDirRelative string
-		interfaceFile        string
-		interfaceName        string
-	)
-	interfaceFile = ifaceFileName
-	interfaceName = ifaceName
-
 	workingDir, err := os.Getwd()
 	if err != nil {
 		return fmt.Errorf("get working directory: %w", err)
 	}
-	interfaceDirPath := pathlib.NewPath(ifaceFileName).Parent()
-	interfaceDir = interfaceDirPath.String()
+	interfaceDirPath := pathlib.NewPath(ifaceFilePath).Parent()
 	interfaceDirRelativePath, err := interfaceDirPath.RelativeToStr(workingDir)
+
+	var interfaceDirRelative string
+
 	if err != nil {
-		log.Debug().Err(err).Msg("can't make path relative to working dir, setting to './'")
+		log.Debug().
+			Err(err).
+			Str("working-dir", workingDir).
+			Str("interfaceDirPath", interfaceDirPath.String()).
+			Str("interface-dir-relative-path", interfaceDirRelativePath.String()).
+			Msg("can't make path relative to working dir, setting to './'")
 		interfaceDirRelative = "."
 	} else {
+		log.Debug().
+			Str("working-dir", workingDir).
+			Str("interfaceDirPath", interfaceDirPath.String()).
+			Str("interface-dir-relative-path", interfaceDirRelativePath.String()).
+			Msg("found relative path")
 		interfaceDirRelative = interfaceDirRelativePath.String()
 	}
 
 	// data is the struct sent to the template parser
 	data := TemplateData{
 		ConfigDir:            filepath.Dir(*c.ConfigFile),
-		InterfaceDir:         interfaceDir,
+		InterfaceDir:         interfaceDirPath.String(),
 		InterfaceDirRelative: interfaceDirRelative,
-		InterfaceFile:        interfaceFile,
-		InterfaceName:        interfaceName,
+		InterfaceFile:        ifaceFilePath,
+		InterfaceName:        ifaceName,
 		Mock:                 mock,
 		StructName:           *c.StructName,
 		SrcPackageName:       srcPkg.Types.Name(),

foo.go

@@ -0,0 +1,7 @@
+package main
+
+type baz string
+
+type foo interface {
+	Bar() baz
+}

foo_test.go

@@ -0,0 +1,13 @@
+package main
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestFoo(t *testing.T) {
+	m := newMockfoo(t)
+	m.EXPECT().Bar().Return(baz("foo"))
+	assert.Equal(t, "foo", m.Bar())
+}

internal/cmd/mockery.go

@@ -263,7 +263,7 @@ func (r *RootApp) Run() error {
 		}
 		ifaceConfig := pkgConfig.GetInterfaceConfig(ctx, iface.Name)
 		for _, ifaceConfig := range ifaceConfig.Configs {
-			if err := ifaceConfig.ParseTemplates(ifaceCtx, iface.FileName, iface.Name, iface.Pkg); err != nil {
+			if err := ifaceConfig.ParseTemplates(ifaceCtx, iface.FilePath, iface.Name, iface.Pkg); err != nil {
 				log.Err(err).Msg("Can't parse config templates for interface")
 				return err
 			}
@@ -279,15 +279,16 @@ func (r *RootApp) Run() error {
 					*ifaceConfig.PkgName,
 					*ifaceConfig.Template,
 				)
+				log.Debug().Str("file-path", filePath.String()).Msg("creating new interface collection")
 			}
 			if err := mockFileToInterfaces[filePath.String()].Append(
 				ctx,
 				internal.NewInterface(
 					iface.Name,
 					iface.TypeSpec,
 					iface.GenDecl,
-					iface.FileName,
-					iface.File,
+					iface.FilePath,
+					iface.FileSyntax,
 					iface.Pkg,
 					ifaceConfig),
 			); err != nil {

internal/interface.go

@@ -8,31 +8,31 @@ import (
 )
 
 type Interface struct {
-	Name     string // Name of the type to be mocked.
-	TypeSpec *ast.TypeSpec
-	GenDecl  *ast.GenDecl
-	FileName string
-	File     *ast.File
-	Pkg      *packages.Package
-	Config   *config.Config
+	Name       string // Name of the type to be mocked.
+	TypeSpec   *ast.TypeSpec
+	GenDecl    *ast.GenDecl
+	FilePath   string
+	FileSyntax *ast.File
+	Pkg        *packages.Package
+	Config     *config.Config
 }
 
 func NewInterface(
 	name string,
 	typeSpec *ast.TypeSpec,
 	genDecl *ast.GenDecl,
-	filename string,
-	file *ast.File,
+	filepath string,
+	fileSyntax *ast.File,
 	pkg *packages.Package,
 	config *config.Config,
 ) *Interface {
 	return &Interface{
-		Name:     name,
-		TypeSpec: typeSpec,
-		GenDecl:  genDecl,
-		FileName: filename,
-		File:     file,
-		Pkg:      pkg,
-		Config:   config,
+		Name:       name,
+		TypeSpec:   typeSpec,
+		GenDecl:    genDecl,
+		FilePath:   filepath,
+		FileSyntax: fileSyntax,
+		Pkg:        pkg,
+		Config:     config,
 	}
 }

internal/parse.go

@@ -66,10 +66,10 @@ func (p *Parser) ParsePackages(ctx context.Context, packageNames []string) ([]*I
 		if len(pkg.Errors) != 0 {
 			return nil, errors.New("error occurred when loading packages")
 		}
-		for fileIdx, file := range pkg.GoFiles {
-			fileLog := pkgLog.With().Str("file", file).Logger()
+		for fileIdx, filePath := range pkg.GoFiles {
+			fileLog := pkgLog.With().Str("file", filePath).Logger()
 			fileLog.Debug().Msg("found file")
-			isGenerated, err := isAutoGenerated(pathlib.NewPath(file))
+			isGenerated, err := isAutoGenerated(pathlib.NewPath(filePath))
 			if err != nil {
 				return nil, fmt.Errorf("determining if file is auto-generated: %w", err)
 			}
@@ -115,7 +115,7 @@ func (p *Parser) ParsePackages(ctx context.Context, packageNames []string) ([]*I
 					name,
 					declaredInterface.typeSpec,
 					declaredInterface.genDecl,
-					file,
+					filePath,
 					fileSyntax,
 					pkg,
 					// Leave the config nil because we don't yet know if

internal/template_generator.go

@@ -135,13 +135,9 @@ func NewTemplateGenerator(
 	pkgConfig *config.Config,
 	pkgName string,
 ) (*TemplateGenerator, error) {
+	log := *zerolog.Ctx(ctx)
+
 	srcPkgFSPath := pathlib.NewPath(srcPkg.GoFiles[0]).Parent()
-	log := zerolog.Ctx(ctx).With().
-		Stringer("srcPkgFSPath", srcPkgFSPath).
-		Stringer("outPkgFSPath", outPkgFSPath).
-		Str("src-pkg-name", srcPkg.Name).
-		Str("out-pkg-name", pkgName).
-		Logger()
 	if !outPkgFSPath.IsAbsolute() {
 		cwd, err := os.Getwd()
 		if err != nil {
@@ -150,6 +146,17 @@ func NewTemplateGenerator(
 		}
 		outPkgFSPath = pathlib.NewPath(cwd).JoinPath(outPkgFSPath)
 	}
+	srcPkgFSPath = srcPkgFSPath.Clean()
+	outPkgFSPath = outPkgFSPath.Clean()
+
+	newLogger := zerolog.Ctx(ctx).With().
+		Stringer("srcPkgFSPath", srcPkgFSPath).
+		Stringer("outPkgFSPath", outPkgFSPath).
+		Str("src-pkg-name", srcPkg.Name).
+		Str("out-pkg-name", pkgName).
+		Logger()
+	log = newLogger
+
 	outPkgPath, err := findPkgPath(outPkgFSPath)
 	if err != nil {
 		log.Err(err).Msg("failed to find output package path")