ansible and helm migrations use go.mod

Author: estroz

Diff for: commands/operator-sdk/cmd/build.go

@@ -212,7 +212,7 @@ func buildFunc(cmd *cobra.Command, args []string) error {
 			case projutil.OperatorTypeHelm:
 				return fmt.Errorf("test scaffolding for Helm Operators is not implemented")
 			default:
-				return fmt.Errorf("unknown operator type '%v'", t)
+				return &projutil.ErrUnknownOperatorType{t}
 			}
 
 			if err != nil {

Diff for: commands/operator-sdk/cmd/migrate.go

@@ -86,7 +86,7 @@ func migrateAnsible() error {
 	s := &scaffold.Scaffold{}
 	err = s.Execute(cfg,
 		&ansible.Main{},
-		&ansible.GopkgToml{},
+		&ansible.GoMod{},
 		&dockerfile,
 		&ansible.Entrypoint{},
 		&ansible.UserSetup{},
@@ -114,7 +114,7 @@ func migrateHelm() error {
 	s := &scaffold.Scaffold{}
 	err := s.Execute(cfg,
 		&helm.Main{},
-		&helm.GopkgToml{},
+		&helm.GoMod{},
 		&helm.DockerfileHybrid{
 			Watches:    true,
 			HelmCharts: true,

Diff for: go.mod

@@ -2,7 +2,6 @@ module github.com/operator-framework/operator-sdk
 
 require (
 	github.com/Azure/go-ansiterm v0.0.0-20170929234023-d6e3b3328b78 // indirect
-	github.com/BurntSushi/toml v0.3.1
 	github.com/MakeNowJust/heredoc v0.0.0-20171113091838-e9091a26100e // indirect
 	github.com/Masterminds/semver v1.4.2 // indirect
 	github.com/Masterminds/sprig v2.16.0+incompatible // indirect

Diff for: internal/gomod/print.go

@@ -19,14 +19,32 @@ import (
 	"fmt"
 	"text/tabwriter"
 
+	"github.com/operator-framework/operator-sdk/internal/util/projutil"
+	"github.com/operator-framework/operator-sdk/pkg/scaffold/ansible"
+	"github.com/operator-framework/operator-sdk/pkg/scaffold/helm"
 	"github.com/operator-framework/operator-sdk/pkg/scaffold/project"
 )
 
 func PrintDepsAsFile() error {
-	b, err := project.ReadDepsFile()
+	var (
+		b   []byte
+		err error
+		t   = projutil.GetOperatorType()
+	)
+	switch t {
+	case projutil.OperatorTypeGo:
+		b, err = project.ReadDepsFile()
+	case projutil.OperatorTypeAnsible:
+		b, err = ansible.ReadDepsFile()
+	case projutil.OperatorTypeHelm:
+		b, err = helm.ReadDepsFile()
+	default:
+		return &projutil.ErrUnknownOperatorType{t}
+	}
 	if err != nil {
 		return err
 	}
+
 	fmt.Println(string(b))
 	return nil
 }

Diff for: internal/util/fileutil/file_util.go

@@ -34,6 +34,9 @@ const (
 	DefaultExecFileMode = 0755
 
 	DefaultFileFlags = os.O_WRONLY | os.O_CREATE
+
+	// Separator to statically create directories.
+	PathSep = string(filepath.Separator)
 )
 
 // FileWriter is a io wrapper to write files

Diff for: internal/util/projutil/project_util.go

@@ -21,21 +21,21 @@ import (
 	"path/filepath"
 	"strings"
 
-	"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/helm"
+	"github.com/operator-framework/operator-sdk/internal/util/fileutil"
 
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
 const (
-	GopathEnv = "GOPATH"
-	SrcDir    = "src"
+	GopathEnv       = "GOPATH"
+	SrcDir          = "src"
+	mainFile        = "cmd" + fileutil.PathSep + "manager" + fileutil.PathSep + "main.go"
+	rolesDir        = "roles"
+	helmChartsDir   = "helm-charts"
+	buildDockerfile = "build" + fileutil.PathSep + "Dockerfile"
 )
 
-var mainFile = filepath.Join(scaffold.ManagerDir, scaffold.CmdFile)
-
 // OperatorType - the type of operator
 type OperatorType = string
 
@@ -50,15 +50,23 @@ const (
 	OperatorTypeUnknown OperatorType = "unknown"
 )
 
-// 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
+type ErrUnknownOperatorType struct {
+	Typ string
+}
+
+func (e *ErrUnknownOperatorType) Error() string {
+	return fmt.Sprintf("unknown operator type '%v'", e.Typ)
+}
+
+// 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() {
-	// if the current directory has the "./build/dockerfile" file, then it is safe to say
+	// if the current directory has the buildDockerfile, then it is safe to say
 	// we are at the project root.
-	_, err := os.Stat(filepath.Join(scaffold.BuildDir, scaffold.DockerfileFile))
+	_, err := os.Stat(buildDockerfile)
 	if err != nil {
 		if os.IsNotExist(err) {
-			log.Fatal("Must run command in project root dir: project structure requires ./build/Dockerfile")
+			log.Fatalf("Must run command in project root dir: project structure requires %s", buildDockerfile)
 		}
 		log.Fatalf("Error while checking if current directory is the project root: (%v)", err)
 	}
@@ -101,10 +109,10 @@ func GetOperatorType() OperatorType {
 	if _, err := os.Stat(mainFile); err == nil {
 		return OperatorTypeGo
 	}
-	if stat, err := os.Stat(ansible.RolesDir); err == nil && stat.IsDir() {
+	if stat, err := os.Stat(rolesDir); err == nil && stat.IsDir() {
 		return OperatorTypeAnsible
 	}
-	if stat, err := os.Stat(helm.HelmChartsDir); err == nil && stat.IsDir() {
+	if stat, err := os.Stat(helmChartsDir); err == nil && stat.IsDir() {
 		return OperatorTypeHelm
 	}
 	return OperatorTypeUnknown

Diff for: pkg/scaffold/ansible/go_mod.go

@@ -0,0 +1,108 @@
+// Copyright 2019 The Operator-SDK Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package ansible
+
+import (
+	"bytes"
+	"fmt"
+	"html/template"
+
+	"github.com/operator-framework/operator-sdk/internal/util/projutil"
+	"github.com/operator-framework/operator-sdk/pkg/scaffold/input"
+)
+
+const GoModFile = "go.mod"
+
+// GoMod - the go.mod file for an Ansible hybrid operator.
+type GoMod struct {
+	input.Input
+}
+
+func (s *GoMod) GetInput() (input.Input, error) {
+	if s.Path == "" {
+		s.Path = GoModFile
+	}
+	s.TemplateBody = goModTmpl
+	return s.Input, nil
+}
+
+const goModTmpl = `module {{ .Repo }}
+
+require (
+	cloud.google.com/go v0.30.0 // indirect
+	github.com/coreos/prometheus-operator v0.26.0 // indirect
+	github.com/emicklei/go-restful v2.8.1+incompatible // indirect
+	github.com/ghodss/yaml v1.0.0 // indirect
+	github.com/go-logr/logr v0.1.0 // indirect
+	github.com/go-logr/zapr v0.1.0 // indirect
+	github.com/go-openapi/spec v0.18.0 // indirect
+	github.com/gogo/protobuf v1.1.1 // indirect
+	github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b // indirect
+	github.com/golang/groupcache v0.0.0-20180924190550-6f2cf27854a4 // indirect
+	github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c // indirect
+	github.com/google/gofuzz v0.0.0-20170612174753-24818f796faf // indirect
+	github.com/google/uuid v1.0.0 // indirect
+	github.com/googleapis/gnostic v0.2.0 // indirect
+	github.com/gregjones/httpcache v0.0.0-20180305231024-9cad4c3443a7 // indirect
+	github.com/hashicorp/golang-lru v0.5.0 // indirect
+	github.com/imdario/mergo v0.3.6 // indirect
+	github.com/json-iterator/go v1.1.5 // indirect
+	github.com/mattbaird/jsonpatch v0.0.0-20171005235357-81af80346b1a // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742 // indirect
+	github.com/onsi/ginkgo v1.7.0 // indirect
+	github.com/onsi/gomega v1.4.3 // indirect
+	github.com/operator-framework/operator-sdk v0.4.1-0.20190125185245-3d91991d7b0a
+	github.com/pborman/uuid v0.0.0-20180906182336-adf5a7427709 // indirect
+	github.com/peterbourgon/diskv v2.0.1+incompatible // indirect
+	github.com/pkg/errors v0.8.0 // indirect
+	github.com/prometheus/client_golang v0.9.2 // indirect
+	github.com/spf13/pflag v1.0.3 // indirect
+	go.uber.org/atomic v1.3.2 // indirect
+	go.uber.org/multierr v1.1.0 // indirect
+	go.uber.org/zap v1.9.1 // indirect
+	golang.org/x/crypto v0.0.0-20181015023909-0c41d7ab0a0e // indirect
+	golang.org/x/oauth2 v0.0.0-20181017192945-9dcd33a902f4 // indirect
+	golang.org/x/sys v0.0.0-20181019160139-8e24a49d80f8 // indirect
+	golang.org/x/time v0.0.0-20180412165947-fbb02b2291d2 // indirect
+	golang.org/x/tools v0.0.0-20190124215303-cc6a436ffe6b // indirect
+	google.golang.org/appengine v1.2.0 // indirect
+	gopkg.in/inf.v0 v0.9.1 // indirect
+	k8s.io/api v0.0.0-20181126151915-b503174bad59 // indirect
+	k8s.io/apiextensions-apiserver v0.0.0-20181126155829-0cd23ebeb688 // indirect
+	k8s.io/apimachinery v0.0.0-20181126123746-eddba98df674
+	k8s.io/client-go v2.0.0-alpha.0.0.20181126152608-d082d5923d3c+incompatible
+	k8s.io/code-generator v0.0.0-20180823001027-3dcf91f64f63
+	k8s.io/gengo v0.0.0-20181113154421-fd15ee9cc2f7 // indirect
+	k8s.io/klog v0.1.0 // indirect
+	k8s.io/kube-openapi v0.0.0-20180711000925-0cf8f7e6ed1d // indirect
+	sigs.k8s.io/controller-runtime v0.1.8
+	sigs.k8s.io/testing_frameworks v0.1.0 // indirect
+)
+`
+
+func ReadDepsFile() ([]byte, error) {
+	projutil.MustInProjectRoot()
+	repo := projutil.CheckAndGetProjectGoPkg()
+	t, err := template.New("").Parse(goModTmpl)
+	if err != nil {
+		return nil, fmt.Errorf("failed to parse go mod template: (%v)", err)
+	}
+	buf := &bytes.Buffer{}
+	if err := t.Execute(buf, struct{ Repo string }{Repo: repo}); err != nil {
+		return nil, fmt.Errorf("failed to execute go mod template: (%v)", err)
+	}
+	return buf.Bytes(), nil
+}

Diff for: pkg/scaffold/ansible/gopkgtoml.go

@@ -14,26 +14,21 @@
 
 package scaffold
 
-import (
-	"path/filepath"
-)
+import "github.com/operator-framework/operator-sdk/internal/util/fileutil"
 
 const (
-	// Separator to statically create directories.
-	filePathSep = string(filepath.Separator)
-
 	// dirs
 	CmdDir         = "cmd"
-	ManagerDir     = CmdDir + filePathSep + "manager"
+	ManagerDir     = CmdDir + fileutil.PathSep + "manager"
 	PkgDir         = "pkg"
-	ApisDir        = PkgDir + filePathSep + "apis"
-	ControllerDir  = PkgDir + filePathSep + "controller"
+	ApisDir        = PkgDir + fileutil.PathSep + "apis"
+	ControllerDir  = PkgDir + fileutil.PathSep + "controller"
 	BuildDir       = "build"
-	BuildTestDir   = BuildDir + filePathSep + "test-framework"
-	BuildBinDir    = BuildDir + filePathSep + "_output" + filePathSep + "bin"
-	BuildScriptDir = BuildDir + filePathSep + "bin"
+	BuildTestDir   = BuildDir + fileutil.PathSep + "test-framework"
+	BuildBinDir    = BuildDir + fileutil.PathSep + "_output" + fileutil.PathSep + "bin"
+	BuildScriptDir = BuildDir + fileutil.PathSep + "bin"
 	DeployDir      = "deploy"
-	OLMCatalogDir  = DeployDir + filePathSep + "olm-catalog"
-	CrdsDir        = DeployDir + filePathSep + "crds"
+	OLMCatalogDir  = DeployDir + fileutil.PathSep + "olm-catalog"
+	CrdsDir        = DeployDir + fileutil.PathSep + "crds"
 	VersionDir     = "version"
 )