Merge pull request #1511 from Scalingo/feat/no-more-gopath

feat(drop-gopath) Stop basing all generation on GOPATH which is not mandatory anymore

Author: briceamen

gomock_generator/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## To be Released
 
+* feat(drop-gopath) Stop basing all generation on GOPATH which is not mandatory anymore
+
 ## v1.4.2
 
 * build(gomock_generator): update `github.com/urfave/cli` from v1 to v3

gomock_generator/README.md

@@ -18,8 +18,8 @@ COMMANDS:
    help, h  Shows a list of commands or help for one command
 
 GLOBAL OPTIONS:
-   --mocks-filepath value         Path to the JSON file containing the MockConfiguration. Location of this file is the base package. (default: "./mocks.json") [$MOCKS_FILEPATH]
-   --signatures-filename value    Filename of the signatures cache. Location of this file is the base package. (default: "mocks_sig.json") [$SIGNATURES_FILENAME]
+   --mocks-filepath value         Path to the JSON file containing the MockConfiguration. Its containing directory is the base package directory. (default: "./mocks.json") [$MOCKS_FILEPATH]
+   --signatures-filename value    Filename of the signatures cache, written in the base package directory. (default: "mocks_sig.json") [$SIGNATURES_FILENAME]
    --concurrent-goroutines value  Concurrent amount of goroutines to generate mock. (default: 4) [$CONCURRENT_GOROUTINES]
    --debug                        Activate debug logs
    --help, -h                     show help
@@ -38,8 +38,7 @@ purpose of every attribute.
 ## Installation
 
 ```shell
-cd $GOPATH/src/github.com/Scalingo/go-utils/gomock_generator
-go install
+go install github.com/Scalingo/go-utils/gomock_generator@latest
 ```
 
 ## Release a new version of gomock_generator

gomock_generator/gomockgenerator/generate.go

@@ -20,9 +20,10 @@ import (
 
 // GenerationConfiguration lets you configure the generation of mocks for your project
 type GenerationConfiguration struct {
-	// MocksFilePath is the path to the JSON file containing the mock configuration.  Location of this file is the base package.
+	// MocksFilePath is the path to the JSON file containing the mock configuration.
+	// The directory containing this file is considered as the base package directory.
 	MocksFilePath string
-	// SignaturesFilename is the filename of the signatures cache. Location of this file is the base package.
+	// SignaturesFilename is the filename of the signatures cache, written in the base package directory.
 	SignaturesFilename string
 	// ConcurrentGoroutines specifies the concurrent amount of goroutines which can execute
 	ConcurrentGoroutines int
@@ -64,22 +65,29 @@ func GenerateMocks(ctx context.Context, gcfg GenerationConfiguration, mocksCfg M
 	if err != nil {
 		return errors.Wrap(ctx, err, "fail to get current directory")
 	}
+	absMocksFilePath, err := filepath.Abs(gcfg.MocksFilePath)
+	if err != nil {
+		return errors.Wrap(ctx, err, "fail to resolve absolute path of the mocks file")
+	}
+	basePackageDirectory := filepath.Dir(absMocksFilePath)
 	if mocksCfg.BaseDirectory == "" {
-		mocksCfg.BaseDirectory = mocksCfg.BasePackage
+		mocksCfg.BaseDirectory = "."
 	}
-	err = os.Chdir(path.Join(os.Getenv("GOPATH"), "src", mocksCfg.BaseDirectory))
+	packageRootDirectory := filepath.Join(basePackageDirectory, mocksCfg.BaseDirectory)
+	err = os.Chdir(packageRootDirectory)
 	if err != nil {
 		return errors.Wrap(ctx, err, "fail to move to base package directory")
 	}
 	defer os.Chdir(cwd)
 
 	ctx, log := logger.WithFieldToCtx(ctx, "nb_mocks", len(mocksCfg.Mocks))
 	log.WithFields(logrus.Fields{
-		"base_package": mocksCfg.BasePackage,
+		"base_package":           mocksCfg.BasePackage,
+		"base_package_directory": packageRootDirectory,
 	}).Infof("Generating %v mocks", len(mocksCfg.Mocks))
 
 	var mockSigs map[string]string
-	mockSigsPath := path.Join(os.Getenv("GOPATH"), "src", mocksCfg.BaseDirectory, gcfg.SignaturesFilename)
+	mockSigsPath := filepath.Join(packageRootDirectory, gcfg.SignaturesFilename)
 
 	sigs, err := os.ReadFile(mockSigsPath)
 	if os.IsNotExist(err) {
@@ -105,7 +113,7 @@ func GenerateMocks(ctx context.Context, gcfg GenerationConfiguration, mocksCfg M
 				<-sem
 			}()
 			sem <- true
-			path, sig, err := generateMock(ctx, gcfg, mocksCfg.BaseDirectory, mocksCfg.BasePackage, mock, mockSigs)
+			path, sig, err := generateMock(ctx, gcfg, packageRootDirectory, mocksCfg.BasePackage, mock, mockSigs)
 			if err != nil {
 				log.Error(err)
 				return
@@ -128,7 +136,7 @@ func GenerateMocks(ctx context.Context, gcfg GenerationConfiguration, mocksCfg M
 	return nil
 }
 
-func generateMock(ctx context.Context, gcfg GenerationConfiguration, baseDirectory, basePackage string, mock MockConfiguration, sigs map[string]string) (string, string, error) {
+func generateMock(ctx context.Context, gcfg GenerationConfiguration, basePackageDirectory, basePackage string, mock MockConfiguration, sigs map[string]string) (string, string, error) {
 	log := logger.Get(ctx)
 
 	if !mock.External {
@@ -164,11 +172,12 @@ func generateMock(ctx context.Context, gcfg GenerationConfiguration, baseDirecto
 		mock.DstPackage = dst
 	}
 
+	localSrcPackage := mock.SrcPackage
 	if !mock.External {
-		mock.SrcPackage = path.Join(basePackage, mock.SrcPackage)
+		mock.SrcPackage = path.Join(basePackage, localSrcPackage)
 	}
 
-	mockPath := filepath.Join(os.Getenv("GOPATH"), "src", baseDirectory, mock.MockFile)
+	mockPath := filepath.Join(basePackageDirectory, mock.MockFile)
 	log = log.WithFields(logrus.Fields{
 		"mock_file":   mock.MockFile,
 		"interface":   mock.Interface,
@@ -195,10 +204,15 @@ func generateMock(ctx context.Context, gcfg GenerationConfiguration, baseDirecto
 		mock.DstPackage = filepath.Base(mock.SrcPackage)
 	}
 
-	mockSrcPath := strings.Replace(mock.SrcPackage, basePackage, baseDirectory, -1)
+	hashSourcePath := mock.SrcPackage
+	hashKeyPackage := mock.SrcPackage
+	if !mock.External {
+		hashSourcePath = filepath.Join(basePackageDirectory, localSrcPackage)
+		hashKeyPackage = localSrcPackage
+	}
 
-	hashKey := fmt.Sprintf("%s.%s", mockSrcPath, mock.Interface)
-	hash, err := interfaceHash(mockSrcPath, mock.Interface)
+	hashKey := fmt.Sprintf("%s.%s", hashKeyPackage, mock.Interface)
+	hash, err := interfaceHash(hashSourcePath, mock.Interface)
 	if err != nil {
 		return "", "", errors.Wrapf(ctx, err, "fail to get interface hash of %v:%v", mock.SrcPackage, mock.Interface)
 	}
@@ -224,7 +238,7 @@ func generateMock(ctx context.Context, gcfg GenerationConfiguration, baseDirecto
 
 	vendorDir := path.Join(basePackage, "vendor")
 	cmd := fmt.Sprintf(
-		"mockgen %s -destination %s %s -package %s %s %s && sed -i s,%s,, %s && goimports -w %s",
+		"mockgen -write_command_comment=false %s -destination %s %s -package %s %s %s && sed -i s,%s,, %s && goimports -w %s",
 		gomod, mockPath, selfPackage, mock.DstPackage, mock.SrcPackage, mock.Interface,
 		vendorDir, mockPath, mockPath,
 	)

gomock_generator/gomockgenerator/package.go

@@ -7,7 +7,6 @@ import (
 	"go/parser"
 	"go/token"
 	"os"
-	"path"
 	"path/filepath"
 	"strings"
 
@@ -31,10 +30,18 @@ func interfaceSignature(pkg, iName string) (string, error) {
 	if err != nil {
 		return "", errors.Wrap(err, "fail to get current working directory")
 	}
-	fullPath := path.Join(os.Getenv("GOPATH"), "src", pkg)
-	vendoredPkg := filepath.Join(cwd, "vendor", pkg)
-	if _, err := os.Stat(vendoredPkg); err == nil {
-		fullPath = vendoredPkg
+	fullPath := pkg
+	if !filepath.IsAbs(fullPath) {
+		localPkg := filepath.Join(cwd, fullPath)
+		vendoredPkg := filepath.Join(cwd, "vendor", fullPath)
+		switch {
+		case isDir(localPkg):
+			fullPath = localPkg
+		case isDir(vendoredPkg):
+			fullPath = vendoredPkg
+		default:
+			fullPath = localPkg
+		}
 	}
 	fileSet := token.NewFileSet()
 	packages, err := parser.ParseDir(fileSet, fullPath, func(info os.FileInfo) bool {
@@ -131,3 +138,8 @@ func fieldToString(field ast.Expr) string {
 
 	return fmt.Sprintf("%v", field)
 }
+
+func isDir(path string) bool {
+	info, err := os.Stat(path)
+	return err == nil && info.IsDir()
+}

gomock_generator/main.go

@@ -23,7 +23,7 @@ func main() {
 
 	%s --concurrent-goroutine 8 --mocks-filename mymocks.json --signatures-filename sigs.json
 
-	Reads the mymocks.json file from the current directory and generates the mocks, 8 goroutines at a time. The signatures of the mocks are stored in sigs.json, in the folder designated by the base package written in mymocks.json.
+	Reads the mymocks.json file from the current directory and generates the mocks, 8 goroutines at a time. The signatures of the mocks are stored in sigs.json in the same directory as mymocks.json.
 
 	`, cli.RootCommandHelpTemplate, os.Args[0])
 
@@ -35,8 +35,8 @@ func main() {
 		Usage:     "Highly parallelized generator of gomock mocks",
 		Version:   version,
 		Flags: []cli.Flag{
-			&cli.StringFlag{Name: "mocks-filepath", Value: "./mocks.json", Usage: "Path to the JSON file containing the MockConfiguration. Location of this file is the base package.", Sources: cli.EnvVars("MOCKS_FILEPATH")},
-			&cli.StringFlag{Name: "signatures-filename", Value: "mocks_sig.json", Usage: "Filename of the signatures cache. Location of this file is the base package.", Sources: cli.EnvVars("SIGNATURES_FILENAME")},
+			&cli.StringFlag{Name: "mocks-filepath", Value: "./mocks.json", Usage: "Path to the JSON file containing the MockConfiguration. Its containing directory is the base package directory.", Sources: cli.EnvVars("MOCKS_FILEPATH")},
+			&cli.StringFlag{Name: "signatures-filename", Value: "mocks_sig.json", Usage: "Filename of the signatures cache, written in the base package directory.", Sources: cli.EnvVars("SIGNATURES_FILENAME")},
 			&cli.IntFlag{Name: "concurrent-goroutines", Value: 4, Usage: "Concurrent amount of goroutines to generate mock.", Sources: cli.EnvVars("CONCURRENT_GOROUTINES")},
 			&cli.BoolFlag{Name: "debug", Usage: "Activate debug logs"},
 		},