Merge pull request #31 from utgwkk/use-go-tool

Support `go tool` command and deprecate `-use_go_run` argument

Author: utgwkk

README.md

@@ -31,15 +31,15 @@ var Iset = []any{
 ```
 
 ```
-$ bulkmockgen -use_go_run Iset -- -package mock_foo -destination ./mock_foo/mock.go
+$ bulkmockgen -exec_mode go_run Iset -- -package mock_foo -destination ./mock_foo/mock.go
 ```
 
 You can use bulkmockgen with `go:generate` comment.
 
 ```go
 package foo
 
-//go:generate bulkmockgen -use_go_run Iset -- -package mock_foo -destination ./mock_foo/mock.go
+//go:generate bulkmockgen -exec_mode go_run Iset -- -package mock_foo -destination ./mock_foo/mock.go
 
 var Iset = []any{
 	new(IFoo),

cmd/bulkmockgen/main.go

@@ -14,8 +14,11 @@ import (
 )
 
 var (
-	useGoRun = flag.Bool("use_go_run", false, "Whether to use go run command to execute mockgen; defaults to false")
-	dryRun   = flag.Bool("dry_run", false, "Print command to be executed and exit")
+	useGoRun = flag.Bool("use_go_run", false, "(Deprecated) Whether to use go run command to execute mockgen; defaults to false")
+
+	flagExecMode = flag.String("exec_mode", "direct", "How to execute mockgen. Supported values are: direct, go_run, go_tool")
+
+	dryRun = flag.Bool("dry_run", false, "Print command to be executed and exit")
 )
 
 func main() {
@@ -32,8 +35,23 @@ func main() {
 		log.Fatal("rest separator (--) is required")
 	}
 
+	execMode := generator.ExecModeDirect
+	if *useGoRun {
+		execMode = generator.ExecModeGoRun
+	} else {
+		switch *flagExecMode {
+		case "direct":
+			execMode = generator.ExecModeDirect
+		case "go_run":
+			execMode = generator.ExecModeGoRun
+		case "go_tool":
+			execMode = generator.ExecModeGoTool
+		default:
+			log.Fatalf("unsupported exec mode (%s)", *flagExecMode)
+		}
+	}
 	g := &generator.Generator{
-		UseGoRun:    *useGoRun,
+		ExecMode:    execMode,
 		DryRun:      *dryRun,
 		MockSetName: mockSetName,
 		RestArgs:    args[restSeparatorIdx+1:],

generator/generator.go

@@ -18,10 +18,33 @@ const (
 	mockgenPackage = "go.uber.org/mock/mockgen"
 )
 
+type ExecMode int
+
+const (
+	ExecModeDirect ExecMode = iota + 1
+
+	ExecModeGoRun
+
+	ExecModeGoTool
+)
+
+func (e ExecMode) Command() (string, []string) {
+	switch e {
+	case ExecModeDirect:
+		return "mockgen", []string{}
+	case ExecModeGoRun:
+		return "go", []string{"run", mockgenPackage}
+	case ExecModeGoTool:
+		return "go", []string{"tool", mockgenPackage}
+	default:
+		panic("unsupported exec mode")
+	}
+}
+
 type runnerFactory func(ctx context.Context, cmdExecutable string, cmdArgs ...string) Runner
 
 type Generator struct {
-	UseGoRun    bool
+	ExecMode    ExecMode
 	DryRun      bool
 	MockSetName string
 	RestArgs    []string
@@ -33,14 +56,7 @@ func (g *Generator) Generate(ctx context.Context, rf runnerFactory) error {
 		return err
 	}
 
-	var cmdExecutable string
-	var cmdArgs []string
-	if g.UseGoRun {
-		cmdExecutable = "go"
-		cmdArgs = append(cmdArgs, "run", mockgenPackage)
-	} else {
-		cmdExecutable = "mockgen"
-	}
+	cmdExecutable, cmdArgs := g.ExecMode.Command()
 	cmdArgs = append(cmdArgs, g.RestArgs...)
 	if externalPkg != "" {
 		cmdArgs = append(cmdArgs, externalPkg)
@@ -100,7 +116,7 @@ func (g *Generator) findMockSetFromDirectory(sourceDir string) ([]string, string
 					}
 
 					splittedImpPath := strings.Split(impPath, "/")
-					if externalPkg == splittedImpPath[len(splittedImpPath) - 1] {
+					if externalPkg == splittedImpPath[len(splittedImpPath)-1] {
 						externalPkg = impPath
 						break
 					}

generator/generator_test.go

@@ -35,7 +35,7 @@ func TestGenerate(t *testing.T) {
 			name:    "basic",
 			baseDir: "fixtures/multifile",
 			g: &Generator{
-				UseGoRun:    false,
+				ExecMode:    ExecModeDirect,
 				DryRun:      false,
 				MockSetName: "MockInterfaces",
 				RestArgs:    []string{"-package", "mock_multifile", "-destination", "mock_multifile/mock.go"},
@@ -47,19 +47,31 @@ func TestGenerate(t *testing.T) {
 			name:    "with go run",
 			baseDir: "fixtures/multifile",
 			g: &Generator{
-				UseGoRun:    true,
+				ExecMode:    ExecModeGoRun,
 				DryRun:      false,
 				MockSetName: "MockInterfaces",
 				RestArgs:    []string{"-package", "mock_multifile", "-destination", "mock_multifile/mock.go"},
 			},
 			wantCmdExecutable: "go",
 			wantCmdArgs:       []string{"run", "go.uber.org/mock/mockgen", "-package", "mock_multifile", "-destination", "mock_multifile/mock.go", ".", "IFoo,IBar"},
 		},
+		{
+			name:    "with go tool",
+			baseDir: "fixtures/multifile",
+			g: &Generator{
+				ExecMode:    ExecModeGoTool,
+				DryRun:      false,
+				MockSetName: "MockInterfaces",
+				RestArgs:    []string{"-package", "mock_multifile", "-destination", "mock_multifile/mock.go"},
+			},
+			wantCmdExecutable: "go",
+			wantCmdArgs:       []string{"tool", "go.uber.org/mock/mockgen", "-package", "mock_multifile", "-destination", "mock_multifile/mock.go", ".", "IFoo,IBar"},
+		},
 		{
 			name:    "with external package",
 			baseDir: "fixtures/external",
 			g: &Generator{
-				UseGoRun:    false,
+				ExecMode:    ExecModeDirect,
 				DryRun:      false,
 				MockSetName: "MockInterfaces",
 				RestArgs:    []string{"-package", "mock_sql", "-destination", "mock_sql/mock.go"},