internal: moved file and project utilities that are not intended to be exported

commands/operator-sdk/cmd/*: use internal/util packages and get rid of command/.../cmdutil

pkg/util/*: move all pkg utilities into pkg/util

Author: estroz

commands/operator-sdk/cmd/add/api.go

@@ -17,8 +17,9 @@ package add
 import (
 	"log"
 
-	"github.com/operator-framework/operator-sdk/commands/operator-sdk/cmd/cmdutil"
 	"github.com/operator-framework/operator-sdk/commands/operator-sdk/cmd/generate"
+	"github.com/operator-framework/operator-sdk/internal/util/fileutil"
+	"github.com/operator-framework/operator-sdk/internal/util/projutil"
 	"github.com/operator-framework/operator-sdk/pkg/scaffold"
 	"github.com/operator-framework/operator-sdk/pkg/scaffold/input"
 
@@ -64,16 +65,16 @@ Example:
 
 func apiRun(cmd *cobra.Command, args []string) {
 	// Create and validate new resource
-	cmdutil.MustInProjectRoot()
+	projutil.MustInProjectRoot()
 	r, err := scaffold.NewResource(apiVersion, kind)
 	if err != nil {
 		log.Fatal(err)
 	}
 
-	absProjectPath := cmdutil.MustGetwd()
+	absProjectPath := projutil.MustGetwd()
 
 	cfg := &input.Config{
-		Repo:           cmdutil.CheckAndGetCurrPkg(),
+		Repo:           projutil.CheckAndGetCurrPkg(),
 		AbsProjectPath: absProjectPath,
 	}
 

commands/operator-sdk/cmd/add/controller.go

@@ -17,7 +17,7 @@ package add
 import (
 	"log"
 
-	"github.com/operator-framework/operator-sdk/commands/operator-sdk/cmd/cmdutil"
+	"github.com/operator-framework/operator-sdk/internal/util/projutil"
 	"github.com/operator-framework/operator-sdk/pkg/scaffold"
 	"github.com/operator-framework/operator-sdk/pkg/scaffold/input"
 
@@ -57,16 +57,16 @@ Example:
 }
 
 func controllerRun(cmd *cobra.Command, args []string) {
-	cmdutil.MustInProjectRoot()
+	projutil.MustInProjectRoot()
 	// Create and validate new resource
 	r, err := scaffold.NewResource(apiVersion, kind)
 	if err != nil {
 		log.Fatal(err)
 	}
 
 	cfg := &input.Config{
-		Repo:           cmdutil.CheckAndGetCurrPkg(),
-		AbsProjectPath: cmdutil.MustGetwd(),
+		Repo:           projutil.CheckAndGetCurrPkg(),
+		AbsProjectPath: projutil.MustGetwd(),
 	}
 
 	s := &scaffold.Scaffold{}

commands/operator-sdk/cmd/add/crd.go

@@ -21,7 +21,7 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/operator-framework/operator-sdk/commands/operator-sdk/cmd/cmdutil"
+	"github.com/operator-framework/operator-sdk/internal/util/projutil"
 	"github.com/operator-framework/operator-sdk/pkg/scaffold"
 	"github.com/operator-framework/operator-sdk/pkg/scaffold/input"
 
@@ -52,7 +52,7 @@ Generated CR  filename: <project-name>/deploy/crds/<group>_<version>_<kind>_cr.y
 
 func crdFunc(cmd *cobra.Command, args []string) {
 	cfg := &input.Config{
-		AbsProjectPath: cmdutil.MustGetwd(),
+		AbsProjectPath: projutil.MustGetwd(),
 	}
 	if len(args) != 0 {
 		log.Fatal("crd command doesn't accept any arguments")

commands/operator-sdk/cmd/build.go

@@ -24,7 +24,7 @@ import (
 	"os/exec"
 	"path/filepath"
 
-	"github.com/operator-framework/operator-sdk/commands/operator-sdk/cmd/cmdutil"
+	"github.com/operator-framework/operator-sdk/internal/util/projutil"
 	"github.com/operator-framework/operator-sdk/pkg/scaffold"
 	"github.com/operator-framework/operator-sdk/pkg/scaffold/input"
 	"github.com/operator-framework/operator-sdk/pkg/test"
@@ -137,7 +137,7 @@ func buildFunc(cmd *cobra.Command, args []string) {
 		log.Fatalf("build command needs exactly 1 argument")
 	}
 
-	cmdutil.MustInProjectRoot()
+	projutil.MustInProjectRoot()
 	goBuildEnv := append(os.Environ(), "GOOS=linux", "GOARCH=amd64", "CGO_ENABLED=0")
 	wd, err := os.Getwd()
 	if err != nil {
@@ -187,9 +187,9 @@ func buildFunc(cmd *cobra.Command, args []string) {
 		_, err = os.Stat(testDockerfile)
 		if err != nil && os.IsNotExist(err) {
 
-			absProjectPath := cmdutil.MustGetwd()
+			absProjectPath := projutil.MustGetwd()
 			cfg := &input.Config{
-				Repo:           cmdutil.CheckAndGetCurrPkg(),
+				Repo:           projutil.CheckAndGetCurrPkg(),
 				AbsProjectPath: absProjectPath,
 				ProjectName:    filepath.Base(wd),
 			}

commands/operator-sdk/cmd/generate/k8s.go

@@ -22,7 +22,7 @@ import (
 	"os/exec"
 	"path/filepath"
 
-	"github.com/operator-framework/operator-sdk/commands/operator-sdk/cmd/cmdutil"
+	"github.com/operator-framework/operator-sdk/internal/util/projutil"
 	"github.com/operator-framework/operator-sdk/pkg/scaffold"
 
 	"github.com/spf13/cobra"
@@ -48,8 +48,8 @@ func k8sFunc(cmd *cobra.Command, args []string) {
 
 // K8sCodegen performs deepcopy code-generation for all custom resources under pkg/apis
 func K8sCodegen() {
-	cmdutil.MustInProjectRoot()
-	repoPkg := cmdutil.CheckAndGetCurrPkg()
+	projutil.MustInProjectRoot()
+	repoPkg := projutil.CheckAndGetCurrPkg()
 	outputPkg := filepath.Join(repoPkg, "pkg/generated")
 	apisPkg := filepath.Join(repoPkg, scaffold.ApisDir)
 	groupVersions, err := parseGroupVersions()

commands/operator-sdk/cmd/new.go

@@ -23,7 +23,8 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/operator-framework/operator-sdk/commands/operator-sdk/cmd/cmdutil"
+	"github.com/operator-framework/operator-sdk/internal/util/fileutil"
+	"github.com/operator-framework/operator-sdk/internal/util/projutil"
 	"github.com/operator-framework/operator-sdk/pkg/scaffold"
 	"github.com/operator-framework/operator-sdk/pkg/scaffold/ansible"
 	"github.com/operator-framework/operator-sdk/pkg/scaffold/input"
@@ -83,10 +84,10 @@ func newFunc(cmd *cobra.Command, args []string) {
 	verifyFlags()
 
 	switch operatorType {
-	case cmdutil.OperatorTypeGo:
+	case projutil.OperatorTypeGo:
 		doScaffold()
 		pullDep()
-	case cmdutil.OperatorTypeAnsible:
+	case projutil.OperatorTypeAnsible:
 		doAnsibleScaffold()
 	}
 	initGit()
@@ -105,7 +106,7 @@ func parse(args []string) {
 // mustBeNewProject checks if the given project exists under the current diretory.
 // it exits with error when the project exists.
 func mustBeNewProject() {
-	fp := filepath.Join(cmdutil.MustGetwd(), projectName)
+	fp := filepath.Join(projutil.MustGetwd(), projectName)
 	stat, err := os.Stat(fp)
 	if err != nil && os.IsNotExist(err) {
 		return
@@ -120,8 +121,8 @@ func mustBeNewProject() {
 
 func doScaffold() {
 	cfg := &input.Config{
-		Repo:           filepath.Join(cmdutil.CheckAndGetCurrPkg(), projectName),
-		AbsProjectPath: filepath.Join(cmdutil.MustGetwd(), projectName),
+		Repo:           filepath.Join(projutil.CheckAndGetCurrPkg(), projectName),
+		AbsProjectPath: filepath.Join(projutil.MustGetwd(), projectName),
 		ProjectName:    projectName,
 	}
 
@@ -146,7 +147,7 @@ func doScaffold() {
 
 func doAnsibleScaffold() {
 	cfg := &input.Config{
-		AbsProjectPath: filepath.Join(cmdutil.MustGetwd(), projectName),
+		AbsProjectPath: filepath.Join(projutil.MustGetwd(), projectName),
 		ProjectName:    projectName,
 	}
 
@@ -225,8 +226,8 @@ func doAnsibleScaffold() {
 // repoPath field on generator is used primarily in generation of Go operator. For Ansible we will set it to cwd
 func repoPath() string {
 	// We only care about GOPATH constraint checks if we are a Go operator
-	wd := cmdutil.MustGetwd()
-	if operatorType == cmdutil.OperatorTypeGo {
+	wd := projutil.MustGetwd()
+	if operatorType == projutil.OperatorTypeGo {
 		gp := os.Getenv(gopath)
 		if len(gp) == 0 {
 			log.Fatal("$GOPATH env not set")
@@ -244,17 +245,17 @@ func repoPath() string {
 }
 
 func verifyFlags() {
-	if operatorType != cmdutil.OperatorTypeGo && operatorType != cmdutil.OperatorTypeAnsible {
+	if operatorType != projutil.OperatorTypeGo && operatorType != projutil.OperatorTypeAnsible {
 		log.Fatal("--type can only be `go` or `ansible`")
 	}
-	if operatorType != cmdutil.OperatorTypeAnsible && generatePlaybook {
+	if operatorType != projutil.OperatorTypeAnsible && generatePlaybook {
 		log.Fatal("--generate-playbook can only be used with --type `ansible`")
 	}
-	if operatorType == cmdutil.OperatorTypeGo && (len(apiVersion) != 0 || len(kind) != 0) {
+	if operatorType == projutil.OperatorTypeGo && (len(apiVersion) != 0 || len(kind) != 0) {
 		log.Fatal(`go type operator does not use --api-version or --kind. Please see "operator-sdk add" command after running new.`)
 	}
 
-	if operatorType != cmdutil.OperatorTypeGo {
+	if operatorType != projutil.OperatorTypeGo {
 		if len(apiVersion) == 0 {
 			log.Fatal("--api-version must not have empty value")
 		}
@@ -273,7 +274,7 @@ func verifyFlags() {
 
 func execCmd(stdout *os.File, cmd string, args ...string) {
 	dc := exec.Command(cmd, args...)
-	dc.Dir = filepath.Join(cmdutil.MustGetwd(), projectName)
+	dc.Dir = filepath.Join(projutil.MustGetwd(), projectName)
 	dc.Stdout = stdout
 	dc.Stderr = os.Stderr
 	err := dc.Run()

commands/operator-sdk/cmd/test/local.go

@@ -23,7 +23,8 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/operator-framework/operator-sdk/commands/operator-sdk/cmd/cmdutil"
+	"github.com/operator-framework/operator-sdk/internal/util/fileutil"
+	"github.com/operator-framework/operator-sdk/internal/util/projutil"
 	"github.com/operator-framework/operator-sdk/pkg/scaffold"
 	"github.com/operator-framework/operator-sdk/pkg/test"
 
@@ -68,7 +69,7 @@ func testLocalFunc(cmd *cobra.Command, args []string) {
 	}
 	// if no namespaced manifest path is given, combine deploy/service_account.yaml, deploy/role.yaml, deploy/role_binding.yaml and deploy/operator.yaml
 	if tlConfig.namespacedManPath == "" {
-		err := os.MkdirAll(deployTestDir, os.FileMode(cmdutil.DefaultDirFileMode))
+		err := os.MkdirAll(deployTestDir, os.FileMode(fileutil.DefaultDirFileMode))
 		if err != nil {
 			log.Fatalf("could not create %s: %v", deployTestDir, err)
 		}
@@ -97,7 +98,7 @@ func testLocalFunc(cmd *cobra.Command, args []string) {
 		combined = append(combined, roleBinding...)
 		combined = append(combined, []byte("\n---\n")...)
 		combined = append(combined, operator...)
-		err = ioutil.WriteFile(tlConfig.namespacedManPath, combined, os.FileMode(cmdutil.DefaultFileMode))
+		err = ioutil.WriteFile(tlConfig.namespacedManPath, combined, os.FileMode(fileutil.DefaultFileMode))
 		if err != nil {
 			log.Fatalf("could not create temporary namespaced manifest file: %v", err)
 		}
@@ -109,7 +110,7 @@ func testLocalFunc(cmd *cobra.Command, args []string) {
 		}()
 	}
 	if tlConfig.globalManPath == "" {
-		err := os.MkdirAll(deployTestDir, os.FileMode(cmdutil.DefaultDirFileMode))
+		err := os.MkdirAll(deployTestDir, os.FileMode(fileutil.DefaultDirFileMode))
 		if err != nil {
 			log.Fatalf("could not create %s: %v", deployTestDir, err)
 		}
@@ -133,7 +134,7 @@ func testLocalFunc(cmd *cobra.Command, args []string) {
 				combined = append(combined, fileBytes...)
 			}
 		}
-		err = ioutil.WriteFile(tlConfig.globalManPath, combined, os.FileMode(cmdutil.DefaultFileMode))
+		err = ioutil.WriteFile(tlConfig.globalManPath, combined, os.FileMode(fileutil.DefaultFileMode))
 		if err != nil {
 			log.Fatalf("could not create temporary global manifest file: %v", err)
 		}
@@ -148,7 +149,7 @@ func testLocalFunc(cmd *cobra.Command, args []string) {
 	testArgs = append(testArgs, "-"+test.KubeConfigFlag, tlConfig.kubeconfig)
 	testArgs = append(testArgs, "-"+test.NamespacedManPathFlag, tlConfig.namespacedManPath)
 	testArgs = append(testArgs, "-"+test.GlobalManPathFlag, tlConfig.globalManPath)
-	testArgs = append(testArgs, "-"+test.ProjRootFlag, cmdutil.MustGetwd())
+	testArgs = append(testArgs, "-"+test.ProjRootFlag, projutil.MustGetwd())
 	// if we do the append using an empty go flags, it inserts an empty arg, which causes
 	// any later flags to be ignored
 	if tlConfig.goTestFlags != "" {
@@ -159,7 +160,7 @@ func testLocalFunc(cmd *cobra.Command, args []string) {
 	}
 	dc := exec.Command("go", testArgs...)
 	dc.Env = append(os.Environ(), fmt.Sprintf("%v=%v", test.TestNamespaceEnv, tlConfig.namespace))
-	dc.Dir = cmdutil.MustGetwd()
+	dc.Dir = projutil.MustGetwd()
 	dc.Stdout = os.Stdout
 	dc.Stderr = os.Stderr
 	err := dc.Run()

commands/operator-sdk/cmd/up/local.go

@@ -26,7 +26,7 @@ import (
 	"strings"
 	"syscall"
 
-	"github.com/operator-framework/operator-sdk/commands/operator-sdk/cmd/cmdutil"
+	"github.com/operator-framework/operator-sdk/internal/util/projutil"
 	ansibleOperator "github.com/operator-framework/operator-sdk/pkg/ansible/operator"
 	proxy "github.com/operator-framework/operator-sdk/pkg/ansible/proxy"
 	"github.com/operator-framework/operator-sdk/pkg/scaffold"
@@ -70,11 +70,11 @@ const (
 
 func upLocalFunc(cmd *cobra.Command, args []string) {
 	mustKubeConfig()
-	switch cmdutil.GetOperatorType() {
-	case cmdutil.OperatorTypeGo:
-		cmdutil.MustInProjectRoot()
+	switch projutil.GetOperatorType() {
+	case projutil.OperatorTypeGo:
+		projutil.MustInProjectRoot()
 		upLocal()
-	case cmdutil.OperatorTypeAnsible:
+	case projutil.OperatorTypeAnsible:
 		upLocalAnsible()
 	default:
 		log.Fatal("failed to determine operator type")

pkg/util/file_util.go renamed to internal/util/fileutil/file_util.go

@@ -14,7 +14,7 @@
 
 // Modified from github.com/kubernetes-sigs/controller-tools/pkg/util/util.go
 
-package util
+package fileutil
 
 import (
 	"fmt"

commands/operator-sdk/cmd/cmdutil/util.go renamed to internal/util/projutil/project_util.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package cmdutil
+package projutil
 
 import (
 	"encoding/json"
@@ -32,10 +32,15 @@ import (
 )
 
 const (
+	SrcDir          = "src"
 	gopkgToml       = "./Gopkg.toml"
 	buildDockerfile = "./build/Dockerfile"
 )
 
+const (
+	GopathEnv = "GOPATH"
+)
+
 // OperatorType - the type of operator
 type OperatorType = string
 
@@ -46,15 +51,6 @@ const (
 	OperatorTypeAnsible OperatorType = "ansible"
 )
 
-const (
-	GopathEnv = "GOPATH"
-	SrcDir    = "src"
-
-	DefaultDirFileMode  = 0750
-	DefaultFileMode     = 0644
-	DefaultExecFileMode = 0744
-)
-
 // MustInProjectRoot checks if the current dir is the project root and returns the current repo's import path
 // e.g github.com/example-inc/app-operator
 func MustInProjectRoot() {

pkg/scaffold/scaffold.go

@@ -26,8 +26,8 @@ import (
 	"strings"
 	"text/template"
 
+	"github.com/operator-framework/operator-sdk/internal/util/fileutil"
 	"github.com/operator-framework/operator-sdk/pkg/scaffold/input"
-	"github.com/operator-framework/operator-sdk/pkg/util"
 	"golang.org/x/tools/imports"
 )
 
@@ -74,7 +74,7 @@ func (s *Scaffold) configure(cfg *input.Config) {
 // Execute executes scaffolding the Files
 func (s *Scaffold) Execute(cfg *input.Config, files ...input.File) error {
 	if s.GetWriter == nil {
-		s.GetWriter = (&util.FileWriter{}).WriteCloser
+		s.GetWriter = (&fileutil.FileWriter{}).WriteCloser
 	}
 
 	// Configure s using common fields from cfg.
@@ -128,9 +128,9 @@ func (s *Scaffold) doTemplate(i input.Input, e input.File, absPath string) error
 		return err
 	}
 
-	var mode os.FileMode = util.DefaultFileMode
+	var mode os.FileMode = fileutil.DefaultFileMode
 	if i.IsExec {
-		mode = util.DefaultExecFileMode
+		mode = fileutil.DefaultExecFileMode
 	}
 	f, err := s.GetWriter(absPath, mode)
 	if err != nil {