Merge pull request #1325 from Adirio/scaffold-enhancement/config

Move configuration file related types and functions to separate package

Author: k8s-ci-robot

cmd/api.go

@@ -27,6 +27,7 @@ import (
 	"github.com/spf13/cobra"
 	flag "github.com/spf13/pflag"
 
+	"sigs.k8s.io/kubebuilder/cmd/internal"
 	"sigs.k8s.io/kubebuilder/cmd/util"
 	"sigs.k8s.io/kubebuilder/pkg/scaffold"
 	"sigs.k8s.io/kubebuilder/pkg/scaffold/resource"
@@ -76,7 +77,7 @@ func resourceForFlags(f *flag.FlagSet) *resource.Resource {
 
 // APICmd represents the resource command
 func (o *apiOptions) runAddAPI() {
-	dieIfNoProject()
+	internal.DieIfNotConfigured()
 
 	switch strings.ToLower(o.pattern) {
 	case "":
@@ -96,12 +97,12 @@ func (o *apiOptions) runAddAPI() {
 	reader := bufio.NewReader(os.Stdin)
 	if !o.resourceFlag.Changed {
 		fmt.Println("Create Resource [y/n]")
-		o.apiScaffolder.DoResource = util.Yesno(reader)
+		o.apiScaffolder.DoResource = util.YesNo(reader)
 	}
 
 	if !o.controllerFlag.Changed {
 		fmt.Println("Create Controller [y/n]")
-		o.apiScaffolder.DoController = util.Yesno(reader)
+		o.apiScaffolder.DoController = util.YesNo(reader)
 	}
 
 	fmt.Println("Writing scaffold for you to edit...")
@@ -171,10 +172,3 @@ After the scaffold is written, api will run make on the project.
 
 	return apiCmd
 }
-
-// dieIfNoProject checks to make sure the command is run from a directory containing a project file.
-func dieIfNoProject() {
-	if _, err := os.Stat("PROJECT"); os.IsNotExist(err) {
-		log.Fatalf("Command must be run from a directory containing %s", "PROJECT")
-	}
-}

cmd/create.go

@@ -20,6 +20,8 @@ import (
 	"fmt"
 
 	"github.com/spf13/cobra"
+
+	"sigs.k8s.io/kubebuilder/cmd/internal"
 )
 
 func newCreateCmd() *cobra.Command {
@@ -35,11 +37,7 @@ func newCreateCmd() *cobra.Command {
 		newAPICommand(),
 	)
 
-	foundProject, version := getProjectVersion()
-	// It add webhook v2 command in the following 2 cases:
-	// - There are no PROJECT file found.
-	// - version == 2 is found in the PROJECT file.
-	if !foundProject || version == "2" {
+	if !internal.ConfiguredAndV1() {
 		cmd.AddCommand(
 			newWebhookV2Cmd(),
 		)

cmd/edit.go

@@ -17,16 +17,12 @@ limitations under the License.
 package main
 
 import (
-	"fmt"
-	"io/ioutil"
 	"log"
 
 	"github.com/spf13/cobra"
 
-	"sigs.k8s.io/kubebuilder/pkg/scaffold"
-	"sigs.k8s.io/kubebuilder/pkg/scaffold/input"
-	"sigs.k8s.io/kubebuilder/pkg/scaffold/project"
-	"sigs.k8s.io/yaml"
+	"sigs.k8s.io/kubebuilder/cmd/internal"
+	"sigs.k8s.io/kubebuilder/internal/config"
 )
 
 func newEditProjectCmd() *cobra.Command {
@@ -35,31 +31,33 @@ func newEditProjectCmd() *cobra.Command {
 
 	editProjectCmd := &cobra.Command{
 		Use:   "edit",
-		Short: "This command will edit the configuration of the PROJECT file",
-		Long:  `This command will edit the configuration of the PROJECT file`,
+		Short: "This command will edit the project configuration",
+		Long:  `This command will edit the project configuration`,
 		Example: `
 		# To enable the multigroup layout/support
 		kubebuilder edit --multigroup
 		
 		# To disable the multigroup layout/support
 		kubebuilder edit --multigroup=false`,
 		Run: func(cmd *cobra.Command, args []string) {
-			dieIfNoProject()
+			internal.DieIfNotConfigured()
 
-			projectInfo, err := scaffold.LoadProjectFile("PROJECT")
+			projectConfig, err := config.Load()
 			if err != nil {
-				log.Fatalf("failed to read the PROJECT file: %v", err)
+				log.Fatalf("failed to read the configuration file: %v", err)
 			}
 
-			if projectInfo.Version != project.Version2 {
-				log.Fatalf("kubebuilder multigroup is for project version: 2,"+
-					" the version of this project is: %s \n", projectInfo.Version)
-			}
+			if opts.multigroup {
+				if !projectConfig.IsV2() {
+					log.Fatalf("kubebuilder multigroup is for project version: 2,"+
+						" the version of this project is: %s \n", projectConfig.Version)
+				}
 
-			// Set MultiGroup Option
-			projectInfo.MultiGroup = opts.multigroup
+				// Set MultiGroup Option
+				projectConfig.MultiGroup = true
+			}
 
-			err = saveProjectFile("PROJECT", &projectInfo)
+			err = projectConfig.Save()
 			if err != nil {
 				log.Fatalf("error updating project file with resource information : %v", err)
 			}
@@ -72,19 +70,6 @@ func newEditProjectCmd() *cobra.Command {
 	return editProjectCmd
 }
 
-// saveProjectFile saves the given ProjectFile at the given path.
-func saveProjectFile(path string, project *input.ProjectFile) error {
-	content, err := yaml.Marshal(project)
-	if err != nil {
-		return fmt.Errorf("error marshalling project info %v", err)
-	}
-	err = ioutil.WriteFile(path, content, 0666)
-	if err != nil {
-		return fmt.Errorf("failed to save project file at %s %v", path, err)
-	}
-	return nil
-}
-
 type editProjectCmdOptions struct {
 	multigroup bool
 }

cmd/init_project.go

@@ -29,7 +29,9 @@ import (
 	"github.com/spf13/cobra"
 	flag "github.com/spf13/pflag"
 
+	"sigs.k8s.io/kubebuilder/cmd/internal"
 	"sigs.k8s.io/kubebuilder/cmd/util"
+	"sigs.k8s.io/kubebuilder/pkg/model/config"
 	"sigs.k8s.io/kubebuilder/pkg/scaffold"
 	"sigs.k8s.io/kubebuilder/pkg/scaffold/project"
 )
@@ -44,7 +46,7 @@ func newInitProjectCmd() *cobra.Command {
 
 Writes the following files:
 - a boilerplate license file
-- a PROJECT file with the domain and repo
+- a PROJECT file with the project configuration
 - a Makefile to build the project
 - a go.mod with project dependencies
 - a Kustomization.yaml for customizating manifests
@@ -117,15 +119,17 @@ func (o *projectOptions) bindCmdlineFlags(cmd *cobra.Command) {
 		"name to use for go module, e.g. github.com/user/repo.  "+
 			"defaults to the go package of the current working directory.")
 	cmd.Flags().StringVar(&o.project.Domain, "domain", "my.domain", "domain for groups")
-	cmd.Flags().StringVar(&o.project.Version, "project-version", project.Version2, "project version")
+	cmd.Flags().StringVar(&o.project.Version, "project-version", config.Version2, "project version")
 }
 
 func (o *projectOptions) initializeProject() {
+	internal.DieIfConfigured()
+
 	if err := o.validate(); err != nil {
 		log.Fatal(err)
 	}
 
-	if o.project.Version == project.Version1 {
+	if o.project.IsV1() {
 		printV1DeprecationWarning()
 	}
 
@@ -169,8 +173,8 @@ func (o *projectOptions) validate() error {
 		o.project.Repo = repoPath
 	}
 
-	switch o.project.Version {
-	case project.Version1:
+	switch {
+	case o.project.IsV1():
 		var defEnsure *bool
 		if o.depFlag.Changed {
 			defEnsure = &o.dep
@@ -182,7 +186,7 @@ func (o *projectOptions) validate() error {
 			DepArgs:          o.depArgs,
 			DefinitelyEnsure: defEnsure,
 		}
-	case project.Version2:
+	case o.project.IsV2():
 		o.scaffolder = &scaffold.V2Project{
 			Project:     o.project,
 			Boilerplate: o.boilerplate,
@@ -195,10 +199,6 @@ func (o *projectOptions) validate() error {
 		return err
 	}
 
-	if util.ProjectExist() {
-		return fmt.Errorf("failed to initialize project because project is already initialized")
-	}
-
 	return nil
 }
 

cmd/internal/config.go

@@ -0,0 +1,61 @@
+/*
+Copyright 2017 The Kubernetes 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 internal
+
+import (
+	"log"
+
+	"sigs.k8s.io/kubebuilder/internal/config"
+)
+
+// isProjectConfigured checks for the existence of the configuration file
+func isProjectConfigured() bool {
+	exists, err := config.Exists()
+	if err != nil {
+		log.Fatalf("Unable to check if configuration file exists: %v", err)
+	}
+
+	return exists
+}
+
+// DieIfConfigured exists if a configuration file was found
+func DieIfConfigured() {
+	if isProjectConfigured() {
+		log.Fatalf("Project is already initialized")
+	}
+}
+
+// DieIfNotConfigured exists if no configuration file was found
+func DieIfNotConfigured() {
+	if !isProjectConfigured() {
+		log.Fatalf("Command must be run after `kubebuilder init ...`")
+	}
+}
+
+// ConfiguredAndV1 returns true if the project is already configured and it is v1
+func ConfiguredAndV1() bool {
+	if !isProjectConfigured() {
+		return false
+	}
+
+	projectConfig, err := config.Read()
+	if err != nil {
+		log.Fatalf("failed to read the configuration file: %v", err)
+	}
+
+	return projectConfig.IsV1()
+}

cmd/main.go

@@ -26,9 +26,8 @@ import (
 	"github.com/spf13/cobra"
 	"golang.org/x/tools/go/packages"
 
+	"sigs.k8s.io/kubebuilder/cmd/internal"
 	"sigs.k8s.io/kubebuilder/cmd/version"
-	"sigs.k8s.io/kubebuilder/pkg/scaffold"
-	"sigs.k8s.io/kubebuilder/pkg/scaffold/project"
 )
 
 const (
@@ -67,13 +66,7 @@ func findGoModulePath(forceModules bool) (string, error) {
 // findCurrentRepo attempts to determine the current repository
 // though a combination of go/packages and `go mod` commands/tricks.
 func findCurrentRepo() (string, error) {
-	// easiest case: project file already exists
-	projFile, err := scaffold.LoadProjectFile("PROJECT")
-	if err == nil {
-		return projFile.Repo, nil
-	}
-
-	// next easy case: existing go module
+	// easiest case: existing go module
 	path, err := findGoModulePath(false)
 	if err == nil {
 		return path, nil
@@ -118,8 +111,7 @@ func main() {
 		version.NewVersionCmd(),
 	)
 
-	foundProject, projectVersion := getProjectVersion()
-	if foundProject && projectVersion == project.Version1 {
+	if internal.ConfiguredAndV1() {
 		printV1DeprecationWarning()
 
 		rootCmd.AddCommand(
@@ -187,19 +179,6 @@ After the scaffold is written, api will run make on the project.
 	}
 }
 
-// getProjectVersion tries to load PROJECT file and returns if the file exist
-// and the version string
-func getProjectVersion() (bool, string) {
-	if _, err := os.Stat("PROJECT"); os.IsNotExist(err) {
-		return false, ""
-	}
-	projectInfo, err := scaffold.LoadProjectFile("PROJECT")
-	if err != nil {
-		log.Fatalf("failed to read the PROJECT file: %v", err)
-	}
-	return true, projectInfo.Version
-}
-
 func printV1DeprecationWarning() {
 	fmt.Printf(NoticeColor, "[Deprecation Notice] The v1 projects are deprecated and will not be supported "+
 		"beyond Feb 1, 2020.\nSee how to upgrade your project to v2:"+

cmd/util/stdin.go

@@ -23,9 +23,9 @@ import (
 	"strings"
 )
 
-// Yesno reads from stdin looking for one of "y", "yes", "n", "no" and returns
+// YesNo reads from stdin looking for one of "y", "yes", "n", "no" and returns
 // true for "y" and false for "n"
-func Yesno(reader *bufio.Reader) bool {
+func YesNo(reader *bufio.Reader) bool {
 	for {
 		text := readstdin(reader)
 		switch text {