verify deploy sub-directory existance

Author: John Kim

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

@@ -18,6 +18,8 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"path/filepath"
+	"strings"
 
 	cmdError "github.com/operator-framework/operator-sdk/commands/operator-sdk/error"
 	"github.com/operator-framework/operator-sdk/pkg/generator"
@@ -29,11 +31,21 @@ var (
 	kind       string
 )
 
+const (
+	goDir        = "GOPATH"
+	deployCrdDir = "deploy"
+)
+
 func NewGenerateCrdCmd() *cobra.Command {
 	crdCmd := &cobra.Command{
 		Use:   "crd",
 		Short: "Generates a custom resource definition",
-		Long: `generates a custom resource definition (CRD) file for the .
+		Long: `The operator-sdk generate command will create a custom resource definition (CRD) file for the specified api-version and kind.
+
+Generated CRD filename: <project-name>/deploy/<kind>_crd.yaml
+
+	<project-name>/deploy path must already exist
+	--api-version and --kind are required flags to generate the new operator application.
 `,
 		Run: crdFunc,
 	}
@@ -49,11 +61,13 @@ func crdFunc(cmd *cobra.Command, args []string) {
 		cmdError.ExitWithError(cmdError.ExitBadArgs, errors.New("crd command doesn't accept any arguments."))
 	}
 	verifyCrdFlags()
+	verifyCrdDeployPath()
 
 	fmt.Fprintln(os.Stdout, "Generating custom resource definition (CRD) file")
 
-	// Generate CRD file
-	if err := generator.RenderDeployCrdFile(apiVersion, kind); err != nil {
+	// generate CRD file
+	wd, _ := os.Getwd()
+	if err := generator.RenderDeployCrdFile(filepath.Join(wd, deployCrdDir), apiVersion, kind); err != nil {
 		cmdError.ExitWithError(cmdError.ExitError, fmt.Errorf("failed to generate CRD file: (%v)", err))
 	}
 }
@@ -65,4 +79,33 @@ func verifyCrdFlags() {
 	if len(kind) == 0 {
 		cmdError.ExitWithError(cmdError.ExitBadArgs, errors.New("--kind must not have empty value"))
 	}
+	kindFirstLetter := string(kind[0])
+	if kindFirstLetter != strings.ToUpper(kindFirstLetter) {
+		cmdError.ExitWithError(cmdError.ExitBadArgs, errors.New("--kind must start with an uppercase letter"))
+	}
+	if strings.Count(apiVersion, "/") != 1 {
+		cmdError.ExitWithError(cmdError.ExitBadArgs, fmt.Errorf("api-version has wrong format (%v); format must be $GROUP_NAME/$VERSION (e.g app.example.com/v1alpha1)", apiVersion))
+	}
+}
+
+// verifyCrdDeployPath checks if the path <project-name>/deploy sub-directory is exists, and that is rooted under $GOPATH
+func verifyCrdDeployPath() {
+	// check if $GOPATH env exists
+	gp := os.Getenv(goDir)
+	if len(gp) == 0 {
+		cmdError.ExitWithError(cmdError.ExitError, fmt.Errorf("$GOPATH env not set"))
+	}
+	wd, err := os.Getwd()
+	if err != nil {
+		cmdError.ExitWithError(cmdError.ExitError, fmt.Errorf("failed to determine the full path of the current directory: %v", err))
+	}
+	// check if this project's repository path is rooted under $GOPATH
+	if !strings.HasPrefix(wd, gp) {
+		cmdError.ExitWithError(cmdError.ExitError, fmt.Errorf("project's repository path (%v) is not rooted under GOPATH (%v)", wd, gp))
+	}
+	// check if the deploy sub-directory exist
+	_, err = os.Stat(filepath.Join(wd, deployCrdDir))
+	if err != nil {
+		cmdError.ExitWithError(cmdError.ExitError, fmt.Errorf("the path (./%v) does not exist. run this command in your project directory", deployCrdDir))
+	}
 }

pkg/generator/generator.go

@@ -333,15 +333,15 @@ func renderRBAC(deployDir, projectName, groupName string) error {
 	return renderWriteFile(filepath.Join(deployDir, rbacYaml), rbacTmplName, rbacYamlTmpl, td)
 }
 
-func RenderDeployCrdFile(apiVersion, kind string) error {
+func RenderDeployCrdFile(crdDeployPath, apiVersion, kind string) error {
 	crdTd := tmplData{
 		Kind:         kind,
 		KindSingular: strings.ToLower(kind),
 		KindPlural:   toPlural(strings.ToLower(kind)),
 		GroupName:    groupName(apiVersion),
 		Version:      version(apiVersion),
 	}
-	crdFilePath := filepath.Join(deployDir, strings.ToLower(kind)+"_crd.yaml")
+	crdFilePath := filepath.Join(crdDeployPath, strings.ToLower(kind)+"_crd.yaml")
 	return renderWriteFile(crdFilePath, crdFilePath, crdYamlTmpl, crdTd)
 }