Don't recurse into submodules on recursive: true

This PR changes mockery to not recurse into paths that contain
a `go.mod` submodule. This is to help support monorepos that contain
many modules. In this case, mockery should not be recursing into these
because it causes issues, like in issue vektra#706.

go.mod

@@ -1,9 +1,11 @@
 module github.com/vektra/mockery/v2
 
-go 1.19
+go 1.21
+
+toolchain go1.21.0
 
 require (
-	github.com/chigopher/pathlib v0.15.0
+	github.com/chigopher/pathlib v0.19.0
 	github.com/davecgh/go-spew v1.1.1
 	github.com/huandu/xstrings v1.4.0
 	github.com/iancoleman/strcase v0.2.0

go.sum

@@ -41,6 +41,10 @@ github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
 github.com/chigopher/pathlib v0.15.0 h1:1pg96WL3iC1/YyWV4UJSl3E0GBf4B+h5amBtsbAAieY=
 github.com/chigopher/pathlib v0.15.0/go.mod h1:3+YPPV21mU9vyw8Mjp+F33CyCfE6iOzinpiqBcccv7I=
+github.com/chigopher/pathlib v0.18.0 h1:JJipJZFl+o+BBavTYnWHBlOp0hYqETRqHFuHyPX+C50=
+github.com/chigopher/pathlib v0.18.0/go.mod h1:tzC1dZLW8o33UQpWkNkhvPwL5n4yyFRFm/jL1YGWFvY=
+github.com/chigopher/pathlib v0.19.0 h1:E+vKIGDJK58jLElqFSaFhtwgMlfHcPmtM/WiXwoCfRY=
+github.com/chigopher/pathlib v0.19.0/go.mod h1:tzC1dZLW8o33UQpWkNkhvPwL5n4yyFRFm/jL1YGWFvY=
 github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI=
 github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI=
 github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU=

go.work

@@ -1,4 +1,6 @@
-go 1.19
+go 1.21
+
+toolchain go1.21.0
 
 use (
 	.

pkg/config/config.go

@@ -558,7 +558,7 @@ func (c *Config) subPackages(
 
 	walker, err := pathlib.NewWalk(
 		searchRoot,
-		pathlib.WalkAlgorithm(pathlib.AlgorithmBasic),
+		pathlib.WalkAlgorithm(pathlib.AlgorithmPreOrderDepthFirst),
 		pathlib.WalkFollowSymlinks(false),
 		pathlib.WalkVisitDirs(false),
 		pathlib.WalkVisitFiles(true),
@@ -575,12 +575,23 @@ func (c *Config) subPackages(
 	visitedDirs[searchRoot.String()] = nil
 
 	// Walk the filesystem path, starting at the root of the package we've
-	// been given. Note that this will always work because Golang downloads
+	// been given. Note that this will always work because Go downloads
 	// the package when we call `packages.Load`
 	walkErr := walker.Walk(func(path *pathlib.Path, info os.FileInfo, err error) error {
 		if err != nil {
 			return err
 		}
+		if path.Name() == "go.mod" {
+			// Check if our current depth is 0. We do this to skip sub-modules, but
+			// not the current module we're generating mocks for.
+			relative, err := path.Parent().RelativeTo(searchRoot)
+			if err != nil {
+				return stackerr.NewStackErrf(err, "determining distance from search root")
+			}
+			if len(relative.Parts()) != 0 {
+				return pathlib.ErrWalkSkipSubtree
+			}
+		}
 
 		_, haveVisitedDir := visitedDirs[path.Parent().String()]
 		if !haveVisitedDir && strings.HasSuffix(path.Name(), ".go") {

pkg/config/config_test.go

@@ -1231,6 +1231,23 @@ packages:
             recursive: true
             with-expecter: true
 with-expecter: false
+`,
+		},
+		{
+			name: "package with submodule that should be excluded",
+			cfgYaml: `
+all: true
+packages:
+    github.com/vektra/mockery/v2/pkg/fixtures/example_project/pkg_with_submodules:
+        config:
+            recursive: True
+`,
+			wantCfgMap: `all: true
+packages:
+    github.com/vektra/mockery/v2/pkg/fixtures/example_project/pkg_with_submodules:
+        config:
+            all: true
+            recursive: true
 `,
 		},
 	}

pkg/fixtures/example_project/pkg_with_submodules/string.go

@@ -0,0 +1,5 @@
+package pkg_with_submodules
+
+type Stringer interface {
+	String() string
+}

pkg/fixtures/example_project/pkg_with_submodules/submodule/go.mod

@@ -0,0 +1,3 @@
+module github.com/vektra/mockery/v2/pkg/fixtures/example_project/submodule
+
+go 1.21.0

pkg/fixtures/example_project/pkg_with_submodules/submodule/string.go

@@ -0,0 +1,5 @@
+package submodule
+
+type Stringer interface {
+	String() string
+}