Merge branch 'master' into crd-validation

Author: estroz

.travis.yml

@@ -16,7 +16,7 @@ x_base_steps:
       # that it can properly exit the test early with success
       - source hack/ci/check-doc-only-update.sh
       - curl -Lo dep https://github.com/golang/dep/releases/download/v0.5.0/dep-linux-amd64 && chmod +x dep && sudo mv dep /usr/local/bin/
-      - travis_retry dep ensure
+      - travis_retry dep ensure -v
 
   # Base go, ansbile, and helm job
   - &test

CHANGELOG.md

@@ -8,6 +8,8 @@
 
 ### Changed
 
+- In new Helm operator projects, the scaffolded CR `spec` field now contains the default values.yaml from the generated chart. ([#967](https://github.com/operator-framework/operator-sdk/pull/967))
+
 ### Deprecated
 
 ### Removed

Gopkg.lock

@@ -261,6 +261,14 @@ func doHelmScaffold() error {
 		return err
 	}
 
+	chart, err := helm.CreateChartForResource(resource, cfg.AbsProjectPath)
+	if err != nil {
+		log.Fatalf("Failed to create initial helm chart for resource (%v, %v): (%v)", resource.APIVersion, resource.Kind, err)
+	}
+
+	valuesPath := filepath.Join("<project_dir>", helm.HelmChartsDir, chart.GetMetadata().GetName(), "values.yaml")
+	crSpec := fmt.Sprintf("# Default values copied from %s\n\n%s", valuesPath, chart.GetValues().GetRaw())
+
 	s := &scaffold.Scaffold{}
 	err = s.Execute(cfg,
 		&helm.Dockerfile{},
@@ -270,16 +278,15 @@ func doHelmScaffold() error {
 		&scaffold.RoleBinding{IsClusterScoped: isClusterScoped},
 		&helm.Operator{IsClusterScoped: isClusterScoped},
 		&scaffold.CRD{Resource: resource},
-		&scaffold.CR{Resource: resource},
+		&scaffold.CR{
+			Resource: resource,
+			Spec:     crSpec,
+		},
 	)
 	if err != nil {
 		return fmt.Errorf("new helm scaffold failed: (%v)", err)
 	}
 
-	if err := helm.CreateChartForResource(resource, cfg.AbsProjectPath); err != nil {
-		return fmt.Errorf("failed to create initial helm chart for resource (%v, %v): (%v)", resource.APIVersion, resource.Kind, err)
-	}
-
 	if err := scaffold.UpdateRoleForResource(resource, cfg.AbsProjectPath); err != nil {
 		return fmt.Errorf("failed to update the RBAC manifest for resource (%v, %v): (%v)", resource.APIVersion, resource.Kind, err)
 	}

commands/operator-sdk/cmd/new.go

@@ -20,11 +20,31 @@ import (
 
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
 
 	"github.com/operator-framework/operator-sdk/commands/operator-sdk/cmd/scorecard"
 	"github.com/operator-framework/operator-sdk/version"
 )
 
+// scorecardConfig stores all scorecard config passed as flags
+type scorecardConfig struct {
+	namespace          string
+	kubeconfigPath     string
+	initTimeout        int
+	csvPath            string
+	basicTests         bool
+	olmTests           bool
+	tenantTests        bool
+	namespacedManifest string
+	globalManifest     string
+	crManifest         string
+	proxyImage         string
+	proxyPullPolicy    string
+	verbose            bool
+}
+
+var scConf scorecardConfig
+
 func NewScorecardCmd() *cobra.Command {
 	scorecardCmd := &cobra.Command{
 		Use:   "scorecard",
@@ -34,21 +54,23 @@ func NewScorecardCmd() *cobra.Command {
 		RunE: scorecard.ScorecardTests,
 	}
 
-	scorecardCmd.Flags().StringVar(&scorecard.SCConf.Namespace, "namespace", "", "Namespace of custom resource created in cluster")
-	scorecardCmd.Flags().StringVar(&scorecard.SCConf.KubeconfigPath, "kubeconfig", "", "Path to kubeconfig of custom resource created in cluster")
-	scorecardCmd.Flags().IntVar(&scorecard.SCConf.InitTimeout, "init-timeout", 10, "Timeout for status block on CR to be created in seconds")
-	scorecardCmd.Flags().StringVar(&scorecard.SCConf.CSVPath, "csv-path", "", "Path to CSV being tested")
-	scorecardCmd.Flags().BoolVar(&scorecard.SCConf.BasicTests, "basic-tests", true, "Enable basic operator checks")
-	scorecardCmd.Flags().BoolVar(&scorecard.SCConf.OLMTests, "olm-tests", true, "Enable OLM integration checks")
-	scorecardCmd.Flags().StringVar(&scorecard.SCConf.NamespacedManifest, "namespaced-manifest", "", "Path to manifest for namespaced resources (e.g. RBAC and Operator manifest)")
-	scorecardCmd.Flags().StringVar(&scorecard.SCConf.GlobalManifest, "global-manifest", "", "Path to manifest for Global resources (e.g. CRD manifests)")
-	scorecardCmd.Flags().StringVar(&scorecard.SCConf.CRManifest, "cr-manifest", "", "Path to manifest for Custom Resource")
-	scorecardCmd.Flags().StringVar(&scorecard.SCConf.ProxyImage, "proxy-image", fmt.Sprintf("quay.io/operator-framework/scorecard-proxy:%s", strings.TrimSuffix(version.Version, "+git")), "Image name for scorecard proxy")
-	scorecardCmd.Flags().StringVar(&scorecard.SCConf.ProxyPullPolicy, "proxy-pull-policy", "Always", "Pull policy for scorecard proxy image")
-	scorecardCmd.Flags().BoolVar(&scorecard.SCConf.Verbose, "verbose", false, "Enable verbose logging")
-	// Since it's difficult to handle multiple CRs, we will require users to specify what CR they want to test; we can handle this better in the future
-	if err := scorecardCmd.MarkFlagRequired("cr-manifest"); err != nil {
-		log.Fatalf("Failed to mark `cr-manifest` flag for `scorecard` subcommand as required")
+	scorecardCmd.Flags().StringVar(&scorecard.ScorecardConf, scorecard.ConfigOpt, "", "config file (default is <project_dir>/.osdk-scorecard.yaml)")
+	scorecardCmd.Flags().StringVar(&scConf.namespace, scorecard.NamespaceOpt, "", "Namespace of custom resource created in cluster")
+	scorecardCmd.Flags().StringVar(&scConf.kubeconfigPath, scorecard.KubeconfigOpt, "", "Path to kubeconfig of custom resource created in cluster")
+	scorecardCmd.Flags().IntVar(&scConf.initTimeout, scorecard.InitTimeoutOpt, 10, "Timeout for status block on CR to be created in seconds")
+	scorecardCmd.Flags().StringVar(&scConf.csvPath, scorecard.CSVPathOpt, "", "Path to CSV being tested")
+	scorecardCmd.Flags().BoolVar(&scConf.basicTests, scorecard.BasicTestsOpt, true, "Enable basic operator checks")
+	scorecardCmd.Flags().BoolVar(&scConf.olmTests, scorecard.OLMTestsOpt, true, "Enable OLM integration checks")
+	scorecardCmd.Flags().BoolVar(&scConf.tenantTests, scorecard.TenantTestsOpt, false, "Enable good tenant checks")
+	scorecardCmd.Flags().StringVar(&scConf.namespacedManifest, scorecard.NamespacedManifestOpt, "", "Path to manifest for namespaced resources (e.g. RBAC and Operator manifest)")
+	scorecardCmd.Flags().StringVar(&scConf.globalManifest, scorecard.GlobalManifestOpt, "", "Path to manifest for Global resources (e.g. CRD manifests)")
+	scorecardCmd.Flags().StringVar(&scConf.crManifest, scorecard.CRManifestOpt, "", "Path to manifest for Custom Resource (required)")
+	scorecardCmd.Flags().StringVar(&scConf.proxyImage, scorecard.ProxyImageOpt, fmt.Sprintf("quay.io/operator-framework/scorecard-proxy:%s", strings.TrimSuffix(version.Version, "+git")), "Image name for scorecard proxy")
+	scorecardCmd.Flags().StringVar(&scConf.proxyPullPolicy, scorecard.ProxyPullPolicyOpt, "Always", "Pull policy for scorecard proxy image")
+	scorecardCmd.Flags().BoolVar(&scConf.verbose, scorecard.VerboseOpt, false, "Enable verbose logging")
+
+	if err := viper.BindPFlags(scorecardCmd.Flags()); err != nil {
+		log.Fatalf("Failed to bind scorecard flags to viper: %v", err)
 	}
 
 	return scorecardCmd

commands/operator-sdk/cmd/scorecard.go

@@ -27,6 +27,7 @@ import (
 	"github.com/operator-framework/operator-sdk/internal/util/fileutil"
 
 	log "github.com/sirupsen/logrus"
+	"github.com/spf13/viper"
 	appsv1 "k8s.io/api/apps/v1"
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
@@ -43,7 +44,7 @@ import (
 func checkSpecAndStat(runtimeClient client.Client, obj *unstructured.Unstructured, noStore bool) error {
 	testSpec := scorecardTest{testType: basicOperator, name: "Spec Block Exists", maximumPoints: 1}
 	testStat := scorecardTest{testType: basicOperator, name: "Status Block Exist", maximumPoints: 1}
-	err := wait.Poll(time.Second*1, time.Second*time.Duration(SCConf.InitTimeout), func() (bool, error) {
+	err := wait.Poll(time.Second*1, time.Second*time.Duration(viper.GetInt64(InitTimeoutOpt)), func() (bool, error) {
 		err := runtimeClient.Get(context.TODO(), types.NamespacedName{Namespace: obj.GetNamespace(), Name: obj.GetName()}, obj)
 		if err != nil {
 			return false, fmt.Errorf("error getting custom resource: %v", err)

commands/operator-sdk/cmd/scorecard/basic_tests.go

@@ -25,6 +25,7 @@ import (
 
 	proxyConf "github.com/operator-framework/operator-sdk/pkg/ansible/proxy/kubeconfig"
 	"github.com/operator-framework/operator-sdk/pkg/k8sutil"
+	"github.com/spf13/viper"
 
 	"github.com/ghodss/yaml"
 	log "github.com/sirupsen/logrus"
@@ -56,7 +57,7 @@ func yamlToUnstructured(yamlPath string) (*unstructured.Unstructured, error) {
 		return nil, fmt.Errorf("failed to unmarshal custom resource manifest to unstructured: %s", err)
 	}
 	// set the namespace
-	obj.SetNamespace(SCConf.Namespace)
+	obj.SetNamespace(viper.GetString(NamespaceOpt))
 	return obj, nil
 }
 
@@ -81,7 +82,7 @@ func createFromYAMLFile(yamlPath string) error {
 		if err := obj.UnmarshalJSON(jsonSpec); err != nil {
 			return fmt.Errorf("could not unmarshal resource spec: %v", err)
 		}
-		obj.SetNamespace(SCConf.Namespace)
+		obj.SetNamespace(viper.GetString(NamespaceOpt))
 
 		// dirty hack to merge scorecard proxy into operator deployment; lots of serialization and deserialization
 		if obj.GetKind() == "Deployment" {
@@ -136,7 +137,7 @@ func createFromYAMLFile(yamlPath string) error {
 // the kubeconfig for communicating with the proxy
 func createKubeconfigSecret() error {
 	kubeconfigMap := make(map[string][]byte)
-	kc, err := proxyConf.Create(metav1.OwnerReference{Name: "scorecard"}, "http://localhost:8889", SCConf.Namespace)
+	kc, err := proxyConf.Create(metav1.OwnerReference{Name: "scorecard"}, "http://localhost:8889", viper.GetString(NamespaceOpt))
 	if err != nil {
 		return err
 	}
@@ -157,7 +158,7 @@ func createKubeconfigSecret() error {
 	kubeconfigSecret := &v1.Secret{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:      "scorecard-kubeconfig",
-			Namespace: SCConf.Namespace,
+			Namespace: viper.GetString(NamespaceOpt),
 		},
 		Data: kubeconfigMap,
 	}
@@ -199,8 +200,9 @@ func addMountKubeconfigSecret(dep *appsv1.Deployment) {
 
 // addProxyContainer adds the container spec for the scorecard-proxy to the deployment's podspec
 func addProxyContainer(dep *appsv1.Deployment) {
+	pullPolicyString := viper.GetString(ProxyPullPolicyOpt)
 	var pullPolicy v1.PullPolicy
-	switch SCConf.ProxyPullPolicy {
+	switch pullPolicyString {
 	case "Always":
 		pullPolicy = v1.PullAlways
 	case "Never":
@@ -213,7 +215,7 @@ func addProxyContainer(dep *appsv1.Deployment) {
 	}
 	dep.Spec.Template.Spec.Containers = append(dep.Spec.Template.Spec.Containers, v1.Container{
 		Name:            "scorecard-proxy",
-		Image:           SCConf.ProxyImage,
+		Image:           viper.GetString(ProxyImageOpt),
 		ImagePullPolicy: pullPolicy,
 		Command:         []string{"scorecard-proxy"},
 		Env: []v1.EnvVar{{