*: remove GOPATH requirement from the SDK and operator projects (#1475)

* internal/util/projutil: generalize project util functions for GOPATH and non-GOPATH scenarios

* *.go: remove `projutil.CheckAndGetProjectGoPkg()` and use `projutil.GetGoPkg()` instead

*.md: remove $GOPATH references

* test/e2e/main_test.go: use testArgs struct for test args; add
local-repo flag to specify the local repo path if the SDK is not
in $GOPATH/src/github.com/operator-framework/operator-sdk

test/e2e/memcached_test.go: remove any 'replace' directives for
the SDK repo in memcached-operator's go.mod file before adding one
for the e2e test; cp e2e code templates without replacing repo; set --repo in "operator-sdk new"

* hack/tests/e2e-{ansible,helm}.sh: remove SDK replace lines in go.mod before adding one

* CHANGELOG.md: add GOPATH change and --repo addition

* doc/sdk-cli-reference.md: add --repo to new and migrate, and add/remove some flags where appropriate

Author: estroz

CHANGELOG.md

@@ -9,11 +9,13 @@
 - Generating and serving info metrics about each custom resource. By default these metrics are exposed on port 8686. ([#1277](https://github.com/operator-framework/operator-sdk/pull/1277))
 - Scaffold a `pkg/apis/<group>/group.go` package file to avoid `go/build` errors when running Kubernetes code generators. ([#1401](https://github.com/operator-framework/operator-sdk/pull/1401))
 - Adds a new extra variable containing the unmodified CR spec for ansible based operators. [#1563](https://github.com/operator-framework/operator-sdk/pull/1563)
+- New flag `--repo` for subcommands [`new`](https://github.com/operator-framework/operator-sdk/blob/master/doc/sdk-cli-reference.md#new) and [`migrate`](https://github.com/operator-framework/operator-sdk/blob/master/doc/sdk-cli-reference.md#migrate) specifies the repository path to be used in Go source files generated by the SDK. This flag can only be used with [Go modules](https://github.com/golang/go/wiki/Modules). ([#1475](https://github.com/operator-framework/operator-sdk/pull/1475))
 
 ### Changed
 
 - Remove TypeMeta declaration from the implementation of the objects [#1462](https://github.com/operator-framework/operator-sdk/pull/1462/)
 - Relaxed API version format check when parsing `pkg/apis` in code generators. API dir structures can now be of the format `pkg/apis/<group>/<anything>`, where `<anything>` was previously required to be in the Kubernetes version format, ex. `v1alpha1`. ([#1525](https://github.com/operator-framework/operator-sdk/pull/1525))
+- The SDK and operator projects will work outside of `$GOPATH/src` when using [Go modules](https://github.com/golang/go/wiki/Modules). ([#1475](https://github.com/operator-framework/operator-sdk/pull/1475))
 
 ### Deprecated
 

README.md

@@ -57,9 +57,9 @@ Follow the steps in the [installation guide][install_guide] to learn how to inst
 
 ```sh
 # Create an app-operator project that defines the App CR.
-$ mkdir -p $GOPATH/src/github.com/example-inc/
+$ mkdir -p $HOME/projects/example-inc/
 # Create a new app-operator project
-$ cd $GOPATH/src/github.com/example-inc/
+$ cd $HOME/projects/example-inc/
 $ export GO111MODULE=on
 $ operator-sdk new app-operator
 $ cd app-operator

cmd/operator-sdk/add/api.go

@@ -103,7 +103,7 @@ func apiRun(cmd *cobra.Command, args []string) error {
 	absProjectPath := projutil.MustGetwd()
 
 	cfg := &input.Config{
-		Repo:           projutil.CheckAndGetProjectGoPkg(),
+		Repo:           projutil.GetGoPkg(),
 		AbsProjectPath: absProjectPath,
 	}
 	s := &scaffold.Scaffold{}

cmd/operator-sdk/add/controller.go

@@ -81,7 +81,7 @@ func controllerRun(cmd *cobra.Command, args []string) error {
 	}
 
 	cfg := &input.Config{
-		Repo:           projutil.CheckAndGetProjectGoPkg(),
+		Repo:           projutil.GetGoPkg(),
 		AbsProjectPath: projutil.MustGetwd(),
 	}
 	s := &scaffold.Scaffold{}

cmd/operator-sdk/add/crd.go

@@ -118,7 +118,7 @@ func verifyCRDFlags() error {
 	return nil
 }
 
-// verifyCRDDeployPath checks if the path <project-name>/deploy sub-directory is exists, and that is rooted under $GOPATH
+// verifyCRDDeployPath checks if the <project-name>/deploy directory exists.
 func verifyCRDDeployPath() error {
 	wd, err := os.Getwd()
 	if err != nil {

cmd/operator-sdk/build/cmd.go

@@ -93,17 +93,16 @@ func buildFunc(cmd *cobra.Command, args []string) error {
 		goBuildEnv = append(goBuildEnv, "CGO_ENABLED=0")
 	}
 
-	trimPath := os.ExpandEnv("all=-trimpath=${GOPATH}")
-	goTrimFlags := []string{"-gcflags", trimPath, "-asmflags", trimPath}
 	absProjectPath := projutil.MustGetwd()
 	projectName := filepath.Base(absProjectPath)
 
 	// Don't need to build Go code if a non-Go Operator.
 	if projutil.IsOperatorGo() {
+		trimPath := fmt.Sprintf("all=-trimpath=%s", filepath.Dir(absProjectPath))
 		opts := projutil.GoCmdOptions{
 			BinName:     filepath.Join(absProjectPath, scaffold.BuildBinDir, projectName),
-			PackagePath: path.Join(projutil.CheckAndGetProjectGoPkg(), filepath.ToSlash(scaffold.ManagerDir)),
-			Args:        goTrimFlags,
+			PackagePath: path.Join(projutil.GetGoPkg(), filepath.ToSlash(scaffold.ManagerDir)),
+			Args:        []string{"-gcflags", trimPath, "-asmflags", trimPath},
 			Env:         goBuildEnv,
 			GoMod:       projutil.IsDepManagerGoMod(),
 		}

cmd/operator-sdk/internal/genutil/k8s.go

@@ -35,7 +35,7 @@ import (
 func K8sCodegen() error {
 	projutil.MustInProjectRoot()
 
-	repoPkg := projutil.CheckAndGetProjectGoPkg()
+	repoPkg := projutil.GetGoPkg()
 
 	gvMap, err := parseGroupVersions()
 	if err != nil {

cmd/operator-sdk/internal/genutil/openapi.go

@@ -38,7 +38,7 @@ func OpenAPIGen() error {
 	projutil.MustInProjectRoot()
 
 	absProjectPath := projutil.MustGetwd()
-	repoPkg := projutil.CheckAndGetProjectGoPkg()
+	repoPkg := projutil.GetGoPkg()
 
 	gvMap, err := parseGroupVersions()
 	if err != nil {

cmd/operator-sdk/main.go

@@ -15,6 +15,7 @@
 package main
 
 import (
+	"fmt"
 	"os"
 
 	// Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
@@ -48,14 +49,15 @@ func main() {
 		Short: "An SDK for building operators with ease",
 		PersistentPreRun: func(cmd *cobra.Command, args []string) {
 			if viper.GetBool(flags.VerboseOpt) {
-				err := projutil.SetGoVerbose()
-				if err != nil {
-					log.Errorf("Could not set GOFLAGS: (%v)", err)
-					return
+				if err := projutil.SetGoVerbose(); err != nil {
+					log.Fatalf("Could not set GOFLAGS: (%v)", err)
 				}
 				log.SetLevel(log.DebugLevel)
 				log.Debug("Debug logging is set")
 			}
+			if err := checkDepManagerForCmd(cmd); err != nil {
+				log.Fatal(err)
+			}
 		},
 	}
 
@@ -82,3 +84,77 @@ func main() {
 		os.Exit(1)
 	}
 }
+
+func checkDepManagerForCmd(cmd *cobra.Command) (err error) {
+	// Certain commands are able to be run anywhere or handle this check
+	// differently in their CLI code.
+	if skipCheckForCmd(cmd) {
+		return nil
+	}
+	// Do not perform this check if the project is non-Go, as they will not have
+	// a (Go) dep manager.
+	if !projutil.IsOperatorGo() {
+		return nil
+	}
+	// Do not perform a dep manager check if the working directory is not in
+	// the project root, as some sub-commands might not require project root.
+	// Individual subcommands will perform this check as needed.
+	if err := projutil.CheckProjectRoot(); err != nil {
+		return nil
+	}
+
+	dm, err := projutil.GetDepManagerType()
+	if err != nil {
+		return err
+	}
+	return checkDepManager(dm)
+}
+
+var commandsToSkip = map[string]struct{}{
+	"new":          struct{}{}, // Handles this logic in cmd/operator-sdk/new
+	"migrate":      struct{}{}, // Handles this logic in cmd/operator-sdk/migrate
+	"operator-sdk": struct{}{}, // Alias for "help"
+	"help":         struct{}{},
+	"completion":   struct{}{},
+	"version":      struct{}{},
+}
+
+func skipCheckForCmd(cmd *cobra.Command) (skip bool) {
+	if _, ok := commandsToSkip[cmd.Name()]; ok {
+		return true
+	}
+	cmd.VisitParents(func(pc *cobra.Command) {
+		if _, ok := commandsToSkip[pc.Name()]; ok {
+			// The bare "operator-sdk" command will be checked above.
+			if pc.Name() != "operator-sdk" {
+				skip = true
+			}
+		}
+	})
+	return skip
+}
+
+func checkDepManager(dm projutil.DepManagerType) error {
+	switch dm {
+	case projutil.DepManagerGoMod:
+		goModOn, err := projutil.GoModOn()
+		if err != nil {
+			return err
+		}
+		if !goModOn {
+			return fmt.Errorf(`dependency manager "modules" requires working directory to be in $GOPATH/src` +
+				` and GO111MODULE=on, or outside of $GOPATH/src and GO111MODULE="on", "auto", or unset`)
+		}
+	case projutil.DepManagerDep:
+		inGopathSrc, err := projutil.WdInGoPathSrc()
+		if err != nil {
+			return err
+		}
+		if !inGopathSrc {
+			return fmt.Errorf(`dependency manager "dep" requires working directory to be in $GOPATH/src`)
+		}
+	default:
+		return projutil.ErrInvalidDepManager(dm)
+	}
+	return nil
+}

cmd/operator-sdk/migrate/cmd.go

@@ -33,6 +33,7 @@ import (
 var (
 	depManager string
 	headerFile string
+	repo       string
 )
 
 // NewCmd returns a command that will add source code to an existing non-go operator
@@ -46,6 +47,7 @@ func NewCmd() *cobra.Command {
 
 	newCmd.Flags().StringVar(&depManager, "dep-manager", "modules", `Dependency manager the new project will use (choices: "dep", "modules")`)
 	newCmd.Flags().StringVar(&headerFile, "header-file", "", "Path to file containing headers for generated Go files. Copied to hack/boilerplate.go.txt")
+	newCmd.Flags().StringVar(&repo, "repo", "", "Project repository path. Used as the project's Go import path. This must be set if outside of $GOPATH/src with Go modules, and cannot be set if --dep-manager=dep")
 
 	return newCmd
 }
@@ -55,7 +57,13 @@ func NewCmd() *cobra.Command {
 func migrateRun(cmd *cobra.Command, args []string) error {
 	projutil.MustInProjectRoot()
 
-	_ = projutil.CheckAndGetProjectGoPkg()
+	if err := verifyFlags(); err != nil {
+		return err
+	}
+
+	if repo == "" {
+		repo = projutil.GetGoPkg()
+	}
 
 	opType := projutil.GetOperatorType()
 	switch opType {
@@ -67,12 +75,20 @@ func migrateRun(cmd *cobra.Command, args []string) error {
 	return fmt.Errorf("operator of type %s cannot be migrated", opType)
 }
 
+func verifyFlags() error {
+	err := projutil.CheckDepManagerWithRepo(projutil.DepManagerType(depManager), repo)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
 // migrateAnsible runs the migration process for an ansible-based operator
 func migrateAnsible() error {
 	wd := projutil.MustGetwd()
 
 	cfg := &input.Config{
-		Repo:           projutil.CheckAndGetProjectGoPkg(),
+		Repo:           repo,
 		AbsProjectPath: wd,
 		ProjectName:    filepath.Base(wd),
 	}
@@ -126,7 +142,7 @@ func migrateHelm() error {
 	wd := projutil.MustGetwd()
 
 	cfg := &input.Config{
-		Repo:           projutil.CheckAndGetProjectGoPkg(),
+		Repo:           repo,
 		AbsProjectPath: wd,
 		ProjectName:    filepath.Base(wd),
 	}
@@ -180,9 +196,6 @@ func scaffoldHelmDepManager(s *scaffold.Scaffold, cfg *input.Config) error {
 	case projutil.DepManagerDep:
 		files = append(files, &helm.GopkgToml{})
 	case projutil.DepManagerGoMod:
-		if err := goModCheck(); err != nil {
-			return err
-		}
 		files = append(files, &helm.GoMod{}, &scaffold.Tools{})
 	default:
 		return projutil.ErrInvalidDepManager(depManager)
@@ -196,21 +209,9 @@ func scaffoldAnsibleDepManager(s *scaffold.Scaffold, cfg *input.Config) error {
 	case projutil.DepManagerDep:
 		files = append(files, &ansible.GopkgToml{})
 	case projutil.DepManagerGoMod:
-		if err := goModCheck(); err != nil {
-			return err
-		}
 		files = append(files, &ansible.GoMod{}, &scaffold.Tools{})
 	default:
 		return projutil.ErrInvalidDepManager(depManager)
 	}
 	return s.Execute(cfg, files...)
 }
-
-func goModCheck() error {
-	goModOn, err := projutil.GoModOn()
-	if err == nil && !goModOn {
-		log.Fatal(`Dependency manager "modules" has been selected but go modules are not active. ` +
-			`Activate modules then run "operator-sdk migrate".`)
-	}
-	return err
-}