Support directory exclusion when generating mocks

README.md

@@ -31,6 +31,7 @@ Table of Contents
 - [Expecter Interfaces](#expecter-interfaces)
 - [Mock constructors](#mock-constructors)
 - [Extended Flag Descriptions](#extended-flag-descriptions)
+- [Excluding Directories](#excluding-directories)
 - [Mocking interfaces in `main`](#mocking-interfaces-in-main)
 - [Configuration](#configuration)
   * [Example](#example)
@@ -367,6 +368,11 @@ The following descriptions provide additional elaboration on a few common parame
 | `--exported` | Use `mockery --exported` to generate public mocks for private interfaces. |
 | `--with-expecter` | Use `mockery --with-expecter` to generate `EXPECT()` methods for your mocks. This is the preferred way to setup your mocks. |
 
+Excluding Directories
+---------------------
+
+Directories can be excluded from mock generation by placing a file `.mockery_skip` inside them. Mocks will not be generated for any types present in a directory containing such a file nor for any in its sub-directories.
+
 Mocking interfaces in `main`
 ----------------------------
 

pkg/walker.go

@@ -68,9 +68,11 @@ func (w *Walker) doWalk(ctx context.Context, p *Parser, dir string, visitor Walk
 
 	files, err := ioutil.ReadDir(dir)
 	if err != nil {
+		log.Err(err).Msgf("Error reading directory")
 		return
 	}
 
+OUTER:
 	for _, file := range files {
 		if strings.HasPrefix(file.Name(), ".") || strings.HasPrefix(file.Name(), "_") {
 			continue
@@ -80,6 +82,17 @@ func (w *Walker) doWalk(ctx context.Context, p *Parser, dir string, visitor Walk
 
 		if file.IsDir() {
 			if w.Recursive {
+				nextFiles, err := ioutil.ReadDir(path)
+				if err != nil {
+					log.Err(err).Msgf("Error reading directory")
+					return
+				}
+				for _, nextFile := range nextFiles {
+					if nextFile.Name() == ".mockery_skip" {
+						continue OUTER
+					}
+				}
+
 				generated = w.doWalk(ctx, p, path, visitor) || generated
 				if generated && w.LimitOne {
 					return

pkg/walker_test.go

@@ -120,3 +120,30 @@ func TestPackagePrefix(t *testing.T) {
 	w.Walk(context.Background(), gv)
 	assert.Regexp(t, regexp.MustCompile("package prefix_test_test"), bufferedProvider.String())
 }
+
+func TestWalkerDirectorySkip(t *testing.T) {
+	if testing.Short() {
+		t.Skip("skipping recursive walker test")
+	}
+
+	wd, err := os.Getwd()
+	assert.NoError(t, err)
+	w := Walker{
+		BaseDir:   wd,
+		Recursive: true,
+		LimitOne:  false,
+		Filter:    regexp.MustCompile(".*"),
+	}
+
+	gv := NewGatheringVisitor()
+
+	// Generating mocks, ignoring the fixtures directory
+	skipMarker, err := os.Create(getFixturePath(".mockery_skip"))
+	assert.NoError(t, err)
+	defer func() { os.Remove(skipMarker.Name()) }()
+
+	w.Walk(context.Background(), gv)
+
+	// There are 4 mocks generated from the files within pkg/* but outside pkg/fixtures/*
+	assert.Len(t, gv.Interfaces, 4)
+}