cmd/operator-sdk: scaffold a boilerplate file for new and migrated projects (#1275)

* cmd/operator-sdk: scaffold a boilerplate file for new and migrated projects
with --header-file, and use for generate commands

* internal/pkg/scaffold: add boilerplate scaffold and logic, validate boilerplate text

Author: Eric Stroczynski

Diff for: cmd/operator-sdk/add/api.go

@@ -29,7 +29,6 @@ import (
 var (
 	apiVersion string
 	kind       string
-	headerFile string
 )
 
 func newAddApiCmd() *cobra.Command {
@@ -77,7 +76,6 @@ Example:
 	if err := apiCmd.MarkFlagRequired("kind"); err != nil {
 		log.Fatalf("Failed to mark `kind` flag for `add api` subcommand as required")
 	}
-	apiCmd.Flags().StringVar(&headerFile, "header-file", "", "Path to file containing headers for generated files.")
 
 	return apiCmd
 }
@@ -124,12 +122,12 @@ func apiRun(cmd *cobra.Command, args []string) error {
 	}
 
 	// Run k8s codegen for deepcopy
-	if err := genutil.K8sCodegen(headerFile); err != nil {
+	if err := genutil.K8sCodegen(); err != nil {
 		return err
 	}
 
 	// Generate a validation spec for the new CRD.
-	if err := genutil.OpenAPIGen(headerFile); err != nil {
+	if err := genutil.OpenAPIGen(); err != nil {
 		return err
 	}
 

Diff for: cmd/operator-sdk/generate/k8s.go

@@ -24,7 +24,7 @@ import (
 )
 
 func newGenerateK8SCmd() *cobra.Command {
-	k8sCmd := &cobra.Command{
+	return &cobra.Command{
 		Use:   "k8s",
 		Short: "Generates Kubernetes code for custom resource",
 		Long: `k8s generator generates code for custom resources given the API
@@ -41,10 +41,6 @@ Example:
 `,
 		RunE: k8sFunc,
 	}
-
-	k8sCmd.Flags().StringVar(&headerFile, "header-file", "", "Path to file containing headers for generated files.")
-
-	return k8sCmd
 }
 
 func k8sFunc(cmd *cobra.Command, args []string) error {
@@ -57,5 +53,5 @@ func k8sFunc(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	return genutil.K8sCodegen(headerFile)
+	return genutil.K8sCodegen()
 }

Diff for: cmd/operator-sdk/generate/openapi.go

@@ -21,10 +21,8 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var headerFile string
-
 func newGenerateOpenAPICmd() *cobra.Command {
-	openAPICmd := &cobra.Command{
+	return &cobra.Command{
 		Use:   "openapi",
 		Short: "Generates OpenAPI specs for API's",
 		Long: `generate openapi generates OpenAPI validation specs in Go from tagged types
@@ -47,16 +45,12 @@ Example:
 `,
 		RunE: openAPIFunc,
 	}
-
-	openAPICmd.Flags().StringVar(&headerFile, "header-file", "", "Path to file containing headers for generated files.")
-
-	return openAPICmd
 }
 
 func openAPIFunc(cmd *cobra.Command, args []string) error {
 	if len(args) != 0 {
 		return fmt.Errorf("command %s doesn't accept any arguments", cmd.CommandPath())
 	}
 
-	return genutil.OpenAPIGen(headerFile)
+	return genutil.OpenAPIGen()
 }

Diff for: cmd/operator-sdk/internal/genutil/genutil.go

@@ -110,10 +110,14 @@ func createFQApis(pkg string, gvs map[string][]string) string {
 	return fqb.String()
 }
 
-func withHeaderFile(hf string, f func(string) error) (err error) {
-	if hf == "" {
-		hf, err = createEmptyTmpFile()
-		if err != nil {
+func withHeaderFile(f func(string) error) (err error) {
+	i, err := (&scaffold.Boilerplate{}).GetInput()
+	if err != nil {
+		return err
+	}
+	hf := i.Path
+	if _, err := os.Stat(hf); os.IsNotExist(err) {
+		if hf, err = createEmptyTmpFile(); err != nil {
 			return err
 		}
 		defer func() {

Diff for: cmd/operator-sdk/internal/genutil/k8s.go

@@ -27,9 +27,8 @@ import (
 )
 
 // K8sCodegen performs deepcopy code-generation for all custom resources under
-// pkg/apis. hf is  a path to a header file containing text to add to generated
-// files.
-func K8sCodegen(hf string) error {
+// pkg/apis.
+func K8sCodegen() error {
 	projutil.MustInProjectRoot()
 
 	wd := projutil.MustGetwd()
@@ -59,7 +58,7 @@ func K8sCodegen(hf string) error {
 	log.Infof("Running deepcopy code-generation for Custom Resource group versions: [%v]\n", gvb.String())
 
 	fdc := func(a string) error { return deepcopyGen(binDir, repoPkg, a, gvMap) }
-	if err = withHeaderFile(hf, fdc); err != nil {
+	if err = withHeaderFile(fdc); err != nil {
 		return err
 	}
 

Diff for: cmd/operator-sdk/internal/genutil/openapi.go

@@ -28,9 +28,8 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
-// OpenAPIGen generates OpenAPI validation specs for all CRD's in dirs. hf is
-// a path to a header file containing text to add to generated files.
-func OpenAPIGen(hf string) error {
+// OpenAPIGen generates OpenAPI validation specs for all CRD's in dirs.
+func OpenAPIGen() error {
 	projutil.MustInProjectRoot()
 
 	absProjectPath := projutil.MustGetwd()
@@ -57,7 +56,7 @@ func OpenAPIGen(hf string) error {
 	fqApiStr := createFQApis(apisPkg, gvMap)
 	fqApis := strings.Split(fqApiStr, ",")
 	f := func(a string) error { return openAPIGen(binDir, a, fqApis) }
-	if err = withHeaderFile(hf, f); err != nil {
+	if err = withHeaderFile(f); err != nil {
 		return err
 	}
 

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

@@ -30,7 +30,10 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var depManager string
+var (
+	depManager string
+	headerFile string
+)
 
 // NewCmd returns a command that will add source code to an existing non-go operator
 func NewCmd() *cobra.Command {
@@ -42,6 +45,7 @@ func NewCmd() *cobra.Command {
 	}
 
 	newCmd.Flags().StringVar(&depManager, "dep-manager", "dep", `Dependency manager the new project will use (choices: "dep")`)
+	newCmd.Flags().StringVar(&headerFile, "header-file", "", "Path to file containing headers for generated Go files. Copied to hack/boilerplate.go.txt")
 
 	return newCmd
 }
@@ -72,7 +76,6 @@ func migrateAnsible() error {
 		AbsProjectPath: wd,
 		ProjectName:    filepath.Base(wd),
 	}
-	s := &scaffold.Scaffold{}
 
 	dockerfile := ansible.DockerfileHybrid{
 		Watches: true,
@@ -91,6 +94,15 @@ func migrateAnsible() error {
 		return err
 	}
 
+	s := &scaffold.Scaffold{}
+	if headerFile != "" {
+		err = s.Execute(cfg, &scaffold.Boilerplate{BoilerplateSrcPath: headerFile})
+		if err != nil {
+			return fmt.Errorf("boilerplate scaffold failed: (%v)", err)
+		}
+		s.BoilerplatePath = headerFile
+	}
+
 	if err := scaffoldAnsibleDepManager(s, cfg); err != nil {
 		return errors.Wrap(err, "migrate Ansible dependency manager file scaffold failed")
 	}
@@ -124,6 +136,14 @@ func migrateHelm() error {
 	}
 
 	s := &scaffold.Scaffold{}
+	if headerFile != "" {
+		err := s.Execute(cfg, &scaffold.Boilerplate{BoilerplateSrcPath: headerFile})
+		if err != nil {
+			return fmt.Errorf("boilerplate scaffold failed: (%v)", err)
+		}
+		s.BoilerplatePath = headerFile
+	}
+
 	if err := scaffoldHelmDepManager(s, cfg); err != nil {
 		return errors.Wrap(err, "migrate Helm dependency manager file scaffold failed")
 	}

Diff for: cmd/operator-sdk/new/cmd.go

@@ -56,6 +56,7 @@ generates a skeletal app-operator application in $GOPATH/src/github.com/example.
 	newCmd.Flags().StringVar(&operatorType, "type", "go", "Type of operator to initialize (choices: \"go\", \"ansible\" or \"helm\")")
 	newCmd.Flags().StringVar(&depManager, "dep-manager", "dep", `Dependency manager the new project will use (choices: "dep")`)
 	newCmd.Flags().BoolVar(&skipGit, "skip-git-init", false, "Do not init the directory as a git repository")
+	newCmd.Flags().StringVar(&headerFile, "header-file", "", "Path to file containing headers for generated Go files. Copied to hack/boilerplate.go.txt")
 	newCmd.Flags().BoolVar(&generatePlaybook, "generate-playbook", false, "Generate a playbook skeleton. (Only used for --type ansible)")
 	newCmd.Flags().BoolVar(&isClusterScoped, "cluster-scoped", false, "Generate cluster-scoped resources instead of namespace-scoped")
 
@@ -72,6 +73,7 @@ var (
 	operatorType     string
 	projectName      string
 	depManager       string
+	headerFile       string
 	skipGit          bool
 	generatePlaybook bool
 	isClusterScoped  bool
@@ -152,6 +154,14 @@ func doGoScaffold() error {
 	}
 	s := &scaffold.Scaffold{}
 
+	if headerFile != "" {
+		err := s.Execute(cfg, &scaffold.Boilerplate{BoilerplateSrcPath: headerFile})
+		if err != nil {
+			return fmt.Errorf("boilerplate scaffold failed: (%v)", err)
+		}
+		s.BoilerplatePath = headerFile
+	}
+
 	var err error
 	switch m := projutil.DepManagerType(depManager); m {
 	case projutil.DepManagerDep:

Diff for: internal/pkg/scaffold/boilerplate_go_txt.go

@@ -0,0 +1,52 @@
+// 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 scaffold
+
+import (
+	"io/ioutil"
+	"path/filepath"
+
+	"github.com/operator-framework/operator-sdk/internal/pkg/scaffold/input"
+
+	"github.com/spf13/afero"
+)
+
+const (
+	BoilerplateFile = "boilerplate.go.txt"
+	HackDir         = "hack"
+)
+
+type Boilerplate struct {
+	input.Input
+
+	// BoilerplateSrcPath is the path to a file containing boilerplate text for
+	// generated Go files.
+	BoilerplateSrcPath string
+}
+
+func (s *Boilerplate) GetInput() (input.Input, error) {
+	if s.Path == "" {
+		s.Path = filepath.Join(HackDir, BoilerplateFile)
+	}
+	return s.Input, nil
+}
+
+var _ CustomRenderer = &Boilerplate{}
+
+func (s *Boilerplate) SetFS(_ afero.Fs) {}
+
+func (s *Boilerplate) CustomRender() ([]byte, error) {
+	return ioutil.ReadFile(s.BoilerplateSrcPath)
+}

Diff for: internal/pkg/scaffold/boilerplate_go_txt_test.go

@@ -0,0 +1,59 @@
+// 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 scaffold
+
+import (
+	"testing"
+
+	"github.com/operator-framework/operator-sdk/internal/util/diffutil"
+
+	"github.com/spf13/afero"
+)
+
+func TestBoilerplate(t *testing.T) {
+	s, buf := setupScaffoldAndWriter()
+	s.Fs = afero.NewMemMapFs()
+	f, err := afero.TempFile(s.Fs, "", "")
+	if err != nil {
+		t.Fatal(err)
+	}
+	if _, err = f.Write([]byte(boilerplate)); err != nil {
+		t.Fatal(err)
+	}
+	if err = f.Close(); err != nil {
+		t.Fatal(err)
+	}
+	s.BoilerplatePath = f.Name()
+	err = s.Execute(appConfig, &Apis{})
+	if err != nil {
+		t.Fatalf("Failed to execute the scaffold: (%v)", err)
+	}
+
+	if boilerplateExp != buf.String() {
+		diffs := diffutil.Diff(boilerplateExp, buf.String())
+		t.Fatalf("Expected vs actual differs.\n%v", diffs)
+	}
+}
+
+const boilerplate = `// Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean ac
+// velit a lacus tempor accumsan sit amet eu velit. Mauris orci lectus,
+// rutrum vitae porttitor in, interdum nec mauris. Praesent porttitor
+// lectus a sem volutpat, ac fringilla magna fermentum. Donec a nibh
+// a urna fringilla eleifend. Curabitur vitae lorem nulla. Ut at risus
+// varius, blandit risus quis, porta tellus. Vivamus scelerisque turpis
+// quis viverra rhoncus. Aenean non arcu velit.
+`
+
+const boilerplateExp = boilerplate + "\n" + apisExp