Merge pull request #1029 from LandonTClipp/LandonTClipp/issue_1019

Fix mockery reading auto-generated files

Author: LandonTClipp

.mockery_testify.yml

@@ -74,16 +74,19 @@ packages:
   github.com/vektra/mockery/v3/internal/fixtures/example_project:
   github.com/vektra/mockery/v3/internal/fixtures/index_list_expr:
   github.com/vektra/mockery/v3/internal/fixtures/iface_new_type:
+  github.com/vektra/mockery/v3/internal/fixtures/auto_generated_skip:
   github.com/vektra/mockery/v3/internal/fixtures/type_alias:
   io:
     config:
       all: True
       dir: internal/fixtures/
       pkgname: test
+      filename: mocks_io_test.go
   net/http:
     config:
       all: false
       dir: internal/fixtures/
       pkgname: test
+      filename: mocks_net_http_test.go
     interfaces:
       ResponseWriter:

config/config.go

@@ -7,7 +7,6 @@
 package config
 
 import (
-	"bufio"
 	"bytes"
 	"context"
 	"fmt"
@@ -568,24 +567,6 @@ func (c *Config) ShouldExcludeSubpkg(pkgPath string) bool {
 	return false
 }
 
-func IsAutoGenerated(path *pathlib.Path) (bool, error) {
-	file, err := path.OpenFile(os.O_RDONLY)
-	if err != nil {
-		return false, stackerr.NewStackErr(err)
-	}
-	defer file.Close()
-	scanner := bufio.NewScanner(file)
-	for scanner.Scan() {
-		text := scanner.Text()
-		if strings.Contains(text, "DO NOT EDIT") {
-			return true, nil
-		} else if strings.HasPrefix(text, "package ") {
-			break
-		}
-	}
-	return false, nil
-}
-
 var ErrInfiniteLoop = fmt.Errorf("infinite loop in template variables detected")
 
 // ParseTemplates parses various templated strings

internal/fixtures/auto_generated_skip/auto_generated.go

@@ -0,0 +1,5 @@
+package autogeneratedskip
+
+type Foo interface {
+	Get() string
+}

internal/fixtures/auto_generated_skip/foo.go

@@ -0,0 +1,18 @@
+package autogeneratedskip
+
+import (
+	"testing"
+
+	"github.com/chigopher/pathlib"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestFooExists(t *testing.T) {
+	mockFile := pathlib.NewPath("./mocks_testify_autogeneratedskip_test.go")
+	mockContents, err := mockFile.ReadFile()
+	require.NoError(t, err)
+
+	assert.NotContains(t, string(mockContents), "func NewMockBar", "mock for type Bar was generated when it shouldn't have been because it's in an auto-generated file.")
+	assert.Contains(t, string(mockContents), "func NewMockFoo")
+}

internal/fixtures/auto_generated_skip/foo_test.go

@@ -1,16 +1,24 @@
 package internal
 
 import (
+	"bufio"
 	"context"
 	"errors"
+	"fmt"
 	"go/ast"
 	"go/types"
+	"os"
+	"regexp"
 	"strings"
 
+	"github.com/chigopher/pathlib"
 	"github.com/rs/zerolog"
+	"github.com/vektra/mockery/v3/internal/stackerr"
 	"golang.org/x/tools/go/packages"
 )
 
+var autoGeneratedRegex = regexp.MustCompile(`^\/\/ Code generated by .*; DO NOT EDIT(\.?)( )*$`)
+
 type Parser struct {
 	parserPackages []*types.Package
 	conf           packages.Config
@@ -61,6 +69,16 @@ func (p *Parser) ParsePackages(ctx context.Context, packageNames []string) ([]*I
 		for fileIdx, file := range pkg.GoFiles {
 			fileLog := pkgLog.With().Str("file", file).Logger()
 			fileLog.Debug().Msg("found file")
+			isGenerated, err := isAutoGenerated(pathlib.NewPath(file))
+			if err != nil {
+				return nil, fmt.Errorf("determining if file is auto-generated: %w", err)
+			}
+			if isGenerated {
+				fileLog.Debug().Msg("file is auto-generated, skipping.")
+				continue
+			}
+			fileLog.Debug().Msg("file is not auto-generated.")
+
 			fileCtx := fileLog.WithContext(pkgCtx)
 
 			fileSyntax := pkg.Syntax[fileIdx]
@@ -110,3 +128,21 @@ func (p *Parser) ParsePackages(ctx context.Context, packageNames []string) ([]*I
 	}
 	return interfaces, nil
 }
+
+func isAutoGenerated(path *pathlib.Path) (bool, error) {
+	file, err := path.OpenFile(os.O_RDONLY)
+	if err != nil {
+		return false, stackerr.NewStackErr(err)
+	}
+	defer file.Close()
+	scanner := bufio.NewScanner(file)
+	for scanner.Scan() {
+		text := scanner.Text()
+		if autoGeneratedRegex.MatchString(text) {
+			return true, nil
+		} else if strings.HasPrefix(text, "package ") {
+			break
+		}
+	}
+	return false, nil
+}

internal/fixtures/auto_generated_skip/mocks_testify_autogeneratedskip_test.go

@@ -27,7 +27,6 @@ type MethodScope struct {
 	// scope. This includes import qualifiers, type names etc. This is used to prevent naming
 	// collisions.
 	visibleNames map[string]any
-	imports      map[string]*Package
 }
 
 func NewMethodScope(r *Registry) *MethodScope {
@@ -36,7 +35,6 @@ func NewMethodScope(r *Registry) *MethodScope {
 		vars:         []*Var{},
 		conflicted:   map[string]bool{},
 		visibleNames: map[string]any{},
-		imports:      map[string]*Package{},
 	}
 	for key := range r.importQualifiers {
 		m.AddName(key)
@@ -214,7 +212,6 @@ func (m *MethodScope) NameExists(name string) bool {
 func (m *MethodScope) addImport(ctx context.Context, pkg TypesPackage, imports map[string]*Package) {
 	imprt := m.registry.addImport(ctx, pkg)
 	imports[pkg.Path()] = imprt
-	m.imports[pkg.Path()] = imprt
 	m.AddName(imprt.Qualifier())
 }
 
@@ -226,7 +223,9 @@ func (m *MethodScope) populateImportNamedType(
 	},
 	imports map[string]*Package,
 ) {
+	log := zerolog.Ctx(ctx)
 	if pkg := t.Obj().Pkg(); pkg != nil {
+		log.Debug().Str("method", "populateImportNamedType").Str("pkg-path", pkg.Path()).Msg("adding import from var")
 		m.addImport(ctx, pkg, imports)
 	}
 	// The imports of a Type with a TypeList must be added to the imports list