Implementation of CSV scaffold and update process

commands/operator-sdk/cmd/build.go

@@ -146,11 +146,12 @@ func buildFunc(cmd *cobra.Command, args []string) error {
 	projutil.MustInProjectRoot()
 	goBuildEnv := append(os.Environ(), "GOOS=linux", "GOARCH=amd64", "CGO_ENABLED=0")
 	absProjectPath := projutil.MustGetwd()
+	projectName := filepath.Base(absProjectPath)
 
 	// Don't need to build Go code if a non-Go Operator.
 	if projutil.GetOperatorType() == projutil.OperatorTypeGo {
 		managerDir := filepath.Join(projutil.CheckAndGetProjectGoPkg(), scaffold.ManagerDir)
-		outputBinName := filepath.Join(absProjectPath, scaffold.BuildBinDir, filepath.Base(absProjectPath))
+		outputBinName := filepath.Join(absProjectPath, scaffold.BuildBinDir, projectName)
 		buildCmd := exec.Command("go", "build", "-o", outputBinName, managerDir)
 		buildCmd.Env = goBuildEnv
 		if err := projutil.ExecCmd(buildCmd); err != nil {
@@ -176,25 +177,25 @@ func buildFunc(cmd *cobra.Command, args []string) error {
 
 	if enableTests {
 		if projutil.GetOperatorType() == projutil.OperatorTypeGo {
-			testBinary := filepath.Join(absProjectPath, scaffold.BuildBinDir, filepath.Base(absProjectPath)+"-test")
+			testBinary := filepath.Join(absProjectPath, scaffold.BuildBinDir, projectName+"-test")
 			buildTestCmd := exec.Command("go", "test", "-c", "-o", testBinary, testLocationBuild+"/...")
 			buildTestCmd.Env = goBuildEnv
 			if err := projutil.ExecCmd(buildTestCmd); err != nil {
 				return fmt.Errorf("failed to build test binary: (%v)", err)
 			}
 		}
+
 		// if a user is using an older sdk repo as their library, make sure they have required build files
 		testDockerfile := filepath.Join(scaffold.BuildTestDir, scaffold.DockerfileFile)
 		_, err := os.Stat(testDockerfile)
 		if err != nil && os.IsNotExist(err) {
 
 			log.Info("Generating build manifests for test-framework.")
 
-			absProjectPath := projutil.MustGetwd()
 			cfg := &input.Config{
 				Repo:           projutil.CheckAndGetProjectGoPkg(),
 				AbsProjectPath: absProjectPath,
-				ProjectName:    filepath.Base(absProjectPath),
+				ProjectName:    projectName,
 			}
 
 			s := &scaffold.Scaffold{}

commands/operator-sdk/cmd/olm-catalog.go

@@ -0,0 +1,32 @@
+// Copyright 2018 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 cmd
+
+import (
+	catalog "github.com/operator-framework/operator-sdk/commands/operator-sdk/cmd/olm-catalog"
+
+	"github.com/spf13/cobra"
+)
+
+func NewOLMCatalogCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "olm-catalog <olm-catalog-command>",
+		Short: "Invokes a olm-catalog command",
+		Long: `The operator-sdk olm-catalog command invokes a command to perform
+Catalog related actions.`,
+	}
+	cmd.AddCommand(catalog.NewGenCSVCmd())
+	return cmd
+}

commands/operator-sdk/cmd/olm-catalog/gen-csv.go

@@ -0,0 +1,98 @@
+// Copyright 2018 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 catalog
+
+import (
+	"fmt"
+	"path/filepath"
+
+	"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"
+	catalog "github.com/operator-framework/operator-sdk/pkg/scaffold/olm-catalog"
+
+	"github.com/coreos/go-semver/semver"
+	log "github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+)
+
+var (
+	csvVersion    string
+	csvConfigPath string
+)
+
+func NewGenCSVCmd() *cobra.Command {
+	genCSVCmd := &cobra.Command{
+		Use:   "gen-csv",
+		Short: "Generates a Cluster Service Version yaml file for the operator",
+		Long: `The gen-csv command generates a Cluster Service Version (CSV) YAML manifest
+for the operator. This file is used to publish the operator to the OLM Catalog.
+
+A CSV semantic version is supplied via the --csv-version flag.
+
+Configure CSV generation by writing a config file 'deploy/olm-catalog/csv-config.yaml`,
+		RunE: genCSVFunc,
+	}
+
+	genCSVCmd.Flags().StringVar(&csvVersion, "csv-version", "", "Semantic version of the CSV")
+	genCSVCmd.MarkFlagRequired("csv-version")
+	genCSVCmd.Flags().StringVar(&csvConfigPath, "csv-config", "", "Path to CSV config file. Defaults to deploy/olm-catalog/csv-config.yaml")
+
+	return genCSVCmd
+}
+
+func genCSVFunc(cmd *cobra.Command, args []string) error {
+	if len(args) != 0 {
+		return fmt.Errorf("command %s doesn't accept any arguments", cmd.CommandPath())
+	}
+
+	if err := verifyGenCSVFlags(); err != nil {
+		return err
+	}
+
+	absProjectPath := projutil.MustGetwd()
+	cfg := &input.Config{
+		AbsProjectPath: absProjectPath,
+		ProjectName:    filepath.Base(absProjectPath),
+	}
+	if projutil.GetOperatorType() == projutil.OperatorTypeGo {
+		cfg.Repo = projutil.CheckAndGetProjectGoPkg()
+	}
+
+	log.Infof("Generating CSV manifest version %s", csvVersion)
+
+	s := &scaffold.Scaffold{}
+	err := s.Execute(cfg,
+		&catalog.CSV{CSVVersion: csvVersion, ConfigFilePath: csvConfigPath},
+		&catalog.ConcatCRD{ConfigFilePath: csvConfigPath},
+	)
+	if err != nil {
+		return fmt.Errorf("catalog scaffold failed: (%v)", err)
+	}
+	return nil
+}
+
+func verifyGenCSVFlags() error {
+	v, err := semver.NewVersion(csvVersion)
+	if err != nil {
+		return fmt.Errorf("%s is not a valid semantic version: (%v)", csvVersion, err)
+	}
+	// Ensures numerical values composing csvVersion don't contain leading 0's,
+	// ex. 01.01.01
+	if v.String() != csvVersion {
+		return fmt.Errorf("provided CSV version %s contains bad values (parses to %s)", csvVersion, v)
+	}
+	return nil
+}

commands/operator-sdk/cmd/root.go

@@ -38,6 +38,7 @@ func NewRootCmd() *cobra.Command {
 	cmd.AddCommand(NewPrintDepsCmd())
 	cmd.AddCommand(NewMigrateCmd())
 	cmd.AddCommand(NewRunCmd())
+	cmd.AddCommand(NewOLMCatalogCmd())
 
 	return cmd
 }

doc/sdk-cli-reference.md

@@ -143,6 +143,33 @@ pkg/apis/app/v1alpha1/
 └── zz_generated.deepcopy.go
 ```
 
+## olm-catalog
+
+Parent command for all OLM Catalog related commands.
+
+### gen-csv
+
+Writes a Cluster Service Version (CSV) manifest and concatenated CRD files to `deploy/olm-catalog`.
+
+#### Flags
+
+* `--csv-version` (required) Semantic version of the CSV manifest.
+* `--csv-config` Path to CSV config file. Defaults to deploy/olm-catalog/csv-config.yaml.
+
+#### Example
+
+```console
+$ operator-sdk olm-catalog gen-csv --csv-version 0.1.1
+INFO[0000] Generating CSV manifest version 0.1.1
+INFO[0000] Fill in the following required fields in file deploy/olm-catalog/operator-name.csv.yaml:
+	spec.keywords
+	spec.maintainers
+	spec.provider
+	spec.labels
+INFO[0000] Create deploy/olm-catalog/operator-name.csv.yaml     
+INFO[0000] Create deploy/olm-catalog/_generated.concat_crd.yaml
+```
+
 ## migrate
 
 Adds a main.go source file and any associated source files for an operator that

internal/util/fileutil/file_util.go

@@ -33,7 +33,7 @@ const (
 	DefaultFileMode     = 0644
 	DefaultExecFileMode = 0755
 
-	DefaultFileFlags = os.O_WRONLY | os.O_CREATE | os.O_TRUNC
+	DefaultFileFlags = os.O_WRONLY | os.O_CREATE
 )
 
 // FileWriter is a io wrapper to write files