[sdk-stamps] add sdk stamps to bundle images (#3120)

* [sdk-stamps] add sdk stamps to bundle images

Add SDK related metric labels and annotations to bundle images

* [sdk-stamps] Add sdk stamps to CSV

* [sdk-stamps] Add test case for csv stamps

* [sdk-stamps] Add stamps to crds

* [sdk-stamps] Modify test case for addition of stamps in crds

* [sdk-stamps] modify test scripts

* [sdk-stamps] update implementation with operator-registry dependency

* [sdk-stamps] addressing review comments

* [sdk-stamps] Remove addition of sdk labels from crd

Co-Authored by: Eric Stroczynski <[email protected]>

Author: varshaprasad96

changelog/fragments/add-sdk-stamps.yaml

@@ -0,0 +1,3 @@
+entries:
+    - description: Add sdk annotations to bundle resources (CSVs, `annotations.yaml` and `bundle.dockerfile`).
+      kind: "addition"

cmd/operator-sdk/bundle/create.go

@@ -24,6 +24,8 @@ import (
 	catalog "github.com/operator-framework/operator-sdk/internal/generate/olm-catalog"
 	"github.com/operator-framework/operator-sdk/internal/util/projutil"
 
+	"github.com/operator-framework/operator-sdk/internal/registry"
+
 	"github.com/blang/semver"
 	"github.com/operator-framework/operator-registry/pkg/lib/bundle"
 	scorecard "github.com/operator-framework/operator-sdk/internal/scorecard/alpha"
@@ -234,7 +236,14 @@ func (c bundleCreateCmd) runGenerate() error {
 	if err != nil {
 		return fmt.Errorf("error generating bundle image files: %v", err)
 	}
-	if err = copyScorecardConfig(); err != nil {
+
+	// rootDir is the location where metadata directory is present.
+	rootDir := c.outputDir
+	if rootDir == "" {
+		rootDir = filepath.Dir(c.directory)
+	}
+
+	if err = RewriteBundleImageContents(rootDir); err != nil {
 		return err
 	}
 	return nil
@@ -330,3 +339,49 @@ func copyScorecardConfig() error {
 	}
 	return nil
 }
+
+func addLabelsToDockerfile(filename string, metricAnnotation map[string]string) error {
+	var sdkMetricContent strings.Builder
+	for key, value := range metricAnnotation {
+		sdkMetricContent.WriteString(fmt.Sprintf("LABEL %s=%s\n", key, value))
+	}
+
+	err := projutil.RewriteFileContents(filename, "LABEL", sdkMetricContent.String())
+	if err != nil {
+		return fmt.Errorf("error rewriting dockerfile with metric labels, %v", err)
+	}
+	return nil
+}
+
+func RewriteBundleImageContents(rootDir string) error {
+	metricLabels := projutil.MakeBundleMetricsLabels()
+
+	// write metric labels to bundle.Dockerfile
+	if err := addLabelsToDockerfile(bundle.DockerFile, metricLabels); err != nil {
+		return fmt.Errorf("error writing metric labels to bundle.dockerfile: %v", err)
+	}
+
+	annotationsFilePath := getAnnotationsFilePath(rootDir)
+	if err := addLabelsToAnnotations(annotationsFilePath, metricLabels); err != nil {
+		return fmt.Errorf("error writing metric labels to annotations.yaml: %v", err)
+	}
+
+	// Add a COPY for the scorecard config to bundle.Dockerfile.
+	if err := copyScorecardConfig(); err != nil {
+		return fmt.Errorf("error copying scorecardConfig to bundle image, %v", err)
+	}
+	return nil
+}
+
+// getAnnotationsFilePath return the locations of annotations.yaml.
+func getAnnotationsFilePath(rootDir string) string {
+	return filepath.Join(rootDir, bundle.MetadataDir, bundle.AnnotationsFile)
+}
+
+func addLabelsToAnnotations(filename string, metricLables map[string]string) error {
+	err := registry.RewriteAnnotationsYaml(filename, metricLables)
+	if err != nil {
+		return err
+	}
+	return nil
+}

cmd/operator-sdk/generate/bundle/bundle.go

@@ -24,6 +24,7 @@ import (
 	"github.com/operator-framework/operator-registry/pkg/lib/bundle"
 	"sigs.k8s.io/kubebuilder/pkg/model/config"
 
+	genbundle "github.com/operator-framework/operator-sdk/cmd/operator-sdk/bundle"
 	genutil "github.com/operator-framework/operator-sdk/cmd/operator-sdk/generate/internal"
 	gencsv "github.com/operator-framework/operator-sdk/internal/generate/clusterserviceversion"
 	"github.com/operator-framework/operator-sdk/internal/generate/collector"
@@ -255,9 +256,39 @@ func (c bundleCmd) runMetadata() error {
 
 // generateMetadata wraps the operator-registry bundle Dockerfile/metadata generator.
 func (c bundleCmd) generateMetadata(manifestsDir, outputDir string) error {
+
+	metadataExists := checkMetatdataExists(outputDir, manifestsDir)
 	err := bundle.GenerateFunc(manifestsDir, outputDir, c.operatorName, c.channels, c.defaultChannel, c.overwrite)
 	if err != nil {
 		return fmt.Errorf("error generating bundle metadata: %v", err)
 	}
+
+	// Add SDK stamps if metadata is not present before or when overwrite is set to true.
+	if c.overwrite || !metadataExists {
+		rootDir := outputDir
+		if rootDir == "" {
+			rootDir = filepath.Dir(manifestsDir)
+		}
+
+		if err = genbundle.RewriteBundleImageContents(rootDir); err != nil {
+			return err
+		}
+	}
 	return nil
 }
+
+// checkMetatdataExists returns true if bundle.Dockerfile and metadataDir exist, if not
+// it returns false.
+func checkMetatdataExists(outputDir, manifestsDir string) bool {
+	var annotationsDir string
+	if outputDir == "" {
+		annotationsDir = filepath.Dir(manifestsDir) + bundle.MetadataDir
+	} else {
+		annotationsDir = outputDir + bundle.MetadataDir
+	}
+
+	if genutil.IsNotExist(bundle.DockerFile) || genutil.IsNotExist(annotationsDir) {
+		return false
+	}
+	return true
+}

internal/generate/clusterserviceversion/clusterserviceversion.go

@@ -21,6 +21,7 @@ import (
 	"strings"
 
 	"github.com/blang/semver"
+	"github.com/operator-framework/api/pkg/operators/v1alpha1"
 	operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
 	"github.com/operator-framework/operator-registry/pkg/lib/bundle"
 	"k8s.io/apimachinery/pkg/runtime/schema"
@@ -160,13 +161,29 @@ func (g *Generator) Generate(cfg *config.Config, opts ...Option) (err error) {
 		return err
 	}
 
+	// Add sdk labels to csv
+	setSDKAnnotations(csv)
+
 	w, err := g.getWriter()
 	if err != nil {
 		return err
 	}
 	return genutil.WriteObject(w, csv)
 }
 
+// setSDKAnnotations adds SDK metric labels to the base if they do not exist.
+func setSDKAnnotations(csv *v1alpha1.ClusterServiceVersion) {
+	annotations := csv.GetAnnotations()
+	if annotations == nil {
+		annotations = make(map[string]string)
+	}
+
+	for key, value := range projutil.MakeOperatorMetricLabels() {
+		annotations[key] = value
+	}
+	csv.SetAnnotations(annotations)
+}
+
 // LegacyOption is a function that modifies a Generator for legacy project layouts.
 type LegacyOption Option
 
@@ -204,6 +221,9 @@ func (g *Generator) GenerateLegacy(opts ...LegacyOption) (err error) {
 		return err
 	}
 
+	// Add sdk labels to csv
+	setSDKAnnotations(csv)
+
 	w, err := g.getWriter()
 	if err != nil {
 		return err

internal/generate/clusterserviceversion/clusterserviceversion_test.go

@@ -19,6 +19,7 @@ import (
 	"io/ioutil"
 	"os"
 	"path/filepath"
+	"strings"
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
@@ -59,6 +60,11 @@ var (
 	cfg *config.Config
 )
 
+const (
+	testSDKbuilderStamp = "operators.operatorframework.io/builder: operator-sdk-unknown"
+	testSDKlayoutStamp  = "operators.operatorframework.io/project_layout: unknown"
+)
+
 var (
 	baseCSV, baseCSVUIMeta, newCSV          *v1alpha1.ClusterServiceVersion
 	baseCSVStr, baseCSVUIMetaStr, newCSVStr string
@@ -121,7 +127,8 @@ var _ = Describe("Generating a ClusterServiceVersion", func() {
 					WithWriter(buf),
 				}
 				Expect(g.Generate(cfg, opts...)).ToNot(HaveOccurred())
-				Expect(buf.String()).To(MatchYAML(newCSVStr))
+				outputCSV := removeSDKLabelsFromCSVString(buf.String())
+				Expect(outputCSV).To(MatchYAML(newCSVStr))
 			})
 			It("should write a ClusterServiceVersion manifest to a base file", func() {
 				g = Generator{
@@ -135,7 +142,27 @@ var _ = Describe("Generating a ClusterServiceVersion", func() {
 				Expect(g.Generate(cfg, opts...)).ToNot(HaveOccurred())
 				outputFile := filepath.Join(tmp, "bases", makeCSVFileName(operatorName))
 				Expect(outputFile).To(BeAnExistingFile())
-				Expect(string(readFileHelper(outputFile))).To(MatchYAML(baseCSVUIMetaStr))
+				Expect(readFileHelper(outputFile)).To(MatchYAML(baseCSVUIMetaStr))
+			})
+			It("should have sdk labels in annotations", func() {
+				g = Generator{
+					OperatorName: operatorName,
+					OperatorType: operatorType,
+				}
+				opts := []Option{
+					WithBase(csvBasesDir, goAPIsDir, projutil.InteractiveHardOff),
+					WithBaseWriter(tmp),
+				}
+				Expect(g.Generate(cfg, opts...)).ToNot(HaveOccurred())
+				outputFile := filepath.Join(tmp, "bases", makeCSVFileName(operatorName))
+				outputCSV, _, err := getCSVFromFile(outputFile)
+				Expect(err).ToNot(HaveOccurred())
+				Expect(outputFile).To(BeAnExistingFile())
+
+				annotations := outputCSV.GetAnnotations()
+				Expect(annotations).ToNot(BeNil())
+				Expect(annotations).Should(HaveKey(projutil.OperatorBuilder))
+				Expect(annotations).Should(HaveKey(projutil.OperatorLayout))
 			})
 			It("should write a ClusterServiceVersion manifest to a bundle file", func() {
 				g = Generator{
@@ -151,7 +178,7 @@ var _ = Describe("Generating a ClusterServiceVersion", func() {
 				Expect(g.Generate(cfg, opts...)).ToNot(HaveOccurred())
 				outputFile := filepath.Join(tmp, bundle.ManifestsDir, makeCSVFileName(operatorName))
 				Expect(outputFile).To(BeAnExistingFile())
-				Expect(string(readFileHelper(outputFile))).To(MatchYAML(newCSVStr))
+				Expect(readFileHelper(outputFile)).To(MatchYAML(newCSVStr))
 			})
 			It("should write a ClusterServiceVersion manifest to a package file", func() {
 				g = Generator{
@@ -167,7 +194,7 @@ var _ = Describe("Generating a ClusterServiceVersion", func() {
 				Expect(g.Generate(cfg, opts...)).ToNot(HaveOccurred())
 				outputFile := filepath.Join(tmp, g.Version, makeCSVFileName(operatorName))
 				Expect(outputFile).To(BeAnExistingFile())
-				Expect(string(readFileHelper(outputFile))).To(MatchYAML(newCSVStr))
+				Expect(readFileHelper(outputFile)).To(MatchYAML(newCSVStr))
 			})
 
 			It("should write a ClusterServiceVersion manifest to a legacy bundle file", func() {
@@ -184,7 +211,7 @@ var _ = Describe("Generating a ClusterServiceVersion", func() {
 				Expect(g.GenerateLegacy(opts...)).ToNot(HaveOccurred())
 				outputFile := filepath.Join(tmp, bundle.ManifestsDir, makeCSVFileName(operatorName))
 				Expect(outputFile).To(BeAnExistingFile())
-				Expect(string(readFileHelper(outputFile))).To(MatchYAML(newCSVStr))
+				Expect(readFileHelper(outputFile)).To(MatchYAML(newCSVStr))
 			})
 			It("should write a ClusterServiceVersion manifest as a legacy package file", func() {
 				g = Generator{
@@ -332,7 +359,6 @@ var _ = Describe("Generating a ClusterServiceVersion", func() {
 				Expect(csv).To(Equal(upgradeCSV(newCSV, g.OperatorName, g.Version)))
 			})
 		})
-
 	})
 
 })
@@ -397,10 +423,10 @@ func initTestCSVsHelper() {
 	ExpectWithOffset(1, err).ToNot(HaveOccurred())
 }
 
-func readFileHelper(path string) []byte {
+func readFileHelper(path string) string {
 	b, err := ioutil.ReadFile(path)
 	ExpectWithOffset(1, err).ToNot(HaveOccurred())
-	return b
+	return removeSDKLabelsFromCSVString(string(b))
 }
 
 func modifyCSVDepImageHelper(tag string) func(csv *v1alpha1.ClusterServiceVersion) {
@@ -469,3 +495,11 @@ func upgradeCSV(csv *v1alpha1.ClusterServiceVersion, name, version string) *v1al
 
 	return upgraded
 }
+
+// removeSDKLabelsFromCSVString to remove the sdk labels from test CSV structs. The test
+// cases do not generate a PROJECTFILE or an entire operator to get the version or layout
+// of SDK. Hence the values of those will appear "unknown".
+func removeSDKLabelsFromCSVString(csv string) string {
+	replacer := strings.NewReplacer(testSDKbuilderStamp, "", testSDKlayoutStamp, "")
+	return replacer.Replace(csv)
+}

internal/registry/validate.go

@@ -16,14 +16,18 @@ package registry
 
 import (
 	"fmt"
+	"io/ioutil"
+	"os"
 
 	apimanifests "github.com/operator-framework/api/pkg/manifests"
 	apivalidation "github.com/operator-framework/api/pkg/validation"
 	apierrors "github.com/operator-framework/api/pkg/validation/errors"
 	registrybundle "github.com/operator-framework/operator-registry/pkg/lib/bundle"
 	log "github.com/sirupsen/logrus"
+	"gopkg.in/yaml.v2"
 	k8svalidation "k8s.io/apimachinery/pkg/api/validation"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
 	"k8s.io/apimachinery/pkg/util/validation/field"
 )
 
@@ -127,3 +131,59 @@ func appendResult(results []apierrors.ManifestResult, r apierrors.ManifestResult
 
 	return results
 }
+
+// RewriteAnnotationsYaml unmarshalls the specified yaml file, appends the content and
+// converts it again to yaml.
+func RewriteAnnotationsYaml(filename string, content map[string]string) error {
+
+	metadata, err := getAnnotationFileContents(filename)
+	if err != nil {
+		return err
+	}
+
+	// Append the contents to annotationsYaml
+	for key, val := range content {
+		metadata.Annotations[key] = val
+	}
+
+	err = writeAnnotationFile(filename, metadata)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func getAnnotationFileContents(filename string) (*registrybundle.AnnotationMetadata, error) {
+	f, err := ioutil.ReadFile(filename)
+	if err != nil {
+		return nil, err
+	}
+
+	annotationsYaml := &registrybundle.AnnotationMetadata{}
+	if err := yaml.Unmarshal(f, annotationsYaml); err != nil {
+		return nil, fmt.Errorf("error parsing annotations file: %v", err)
+	}
+	return annotationsYaml, nil
+}
+
+func writeAnnotationFile(filename string, annotation *registrybundle.AnnotationMetadata) error {
+	// TODO: replace `gopkg.in/yaml.v2` with `sigs.k8s.io/yaml`. Operator registry
+	// defines annotations with yaml format (using gopkg-yaml) and k8s-yaml takes name
+	// of field in the struct as the value of key in yaml.
+	file, err := yaml.Marshal(annotation)
+	if err != nil {
+		return err
+	}
+
+	mode := os.FileMode(0666)
+	if info, err := os.Stat(filename); err == nil {
+		mode = info.Mode()
+	}
+
+	err = ioutil.WriteFile(filename, []byte(file), mode)
+	if err != nil {
+		return fmt.Errorf("error writing modified contents to annotations file, %v", err)
+	}
+	return nil
+}

internal/util/projutil/sdk_stamps_util.go

@@ -0,0 +1,88 @@
+// Copyright 2020 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 projutil
+
+import (
+	"regexp"
+
+	kbutil "github.com/operator-framework/operator-sdk/internal/util/kubebuilder"
+	ver "github.com/operator-framework/operator-sdk/version"
+	log "github.com/sirupsen/logrus"
+)
+
+const (
+	OperatorBuilder  = "operators.operatorframework.io/builder"
+	OperatorLayout   = "operators.operatorframework.io/project_layout"
+	bundleMediaType  = "operators.operatorframework.io.metrics.mediatype.v1"
+	bundleBuilder    = "operators.operatorframework.io.metrics.builder"
+	bundleLayout     = "operators.operatorframework.io.metrics.project_layout"
+	metricsMediatype = "metrics+v1"
+)
+
+// MakeBundleMetricsLabels returns the SDK metric labels which will be added
+// to bundle resources like bundle.Dockerfile and annotations.yaml.
+func MakeBundleMetricsLabels() map[string]string {
+	return map[string]string{
+		bundleMediaType: metricsMediatype,
+		bundleBuilder:   getSDKBuilder(),
+		bundleLayout:    getSDKProjectLayout(),
+	}
+}
+
+// MakeOperatorMetricLabels returns the SDK metric labels which will be added
+// to custom resource definitions and cluster service versions.
+func MakeOperatorMetricLabels() map[string]string {
+	return map[string]string{
+		OperatorBuilder: getSDKBuilder(),
+		OperatorLayout:  getSDKProjectLayout(),
+	}
+}
+
+func getSDKBuilder() string {
+	return "operator-sdk" + "-" + parseVersion(ver.GitVersion)
+}
+
+func parseVersion(input string) string {
+	re := regexp.MustCompile(`v[0-9]+\.[0-9]+\.[0-9]+`)
+	version := re.FindString(input)
+	if version == "" {
+		return "unknown"
+	}
+
+	if checkIfUnreleased(input) {
+		version = version + "+git"
+	}
+	return version
+}
+
+// checkIfUnreleased returns true if sdk was not built from released version.
+func checkIfUnreleased(input string) bool {
+	re := regexp.MustCompile(`v[0-9]+\.[0-9]+\.[0-9]+-.+`)
+	return re.MatchString(input)
+}
+
+// getSDKProjectLayout returns the `layout` field in PROJECT file if it is a
+// Kubebuilder scaffolded project, or else returns the kind of operator.
+func getSDKProjectLayout() string {
+	if kbutil.HasProjectFile() {
+		cfg, err := kbutil.ReadConfig()
+		if err != nil {
+			log.Debugf("Error reading config: %v", err)
+			return "unknown"
+		}
+		return cfg.Layout
+	}
+	return GetOperatorType()
+}

internal/util/projutil/sdk_stamps_util_test.go

@@ -0,0 +1,41 @@
+// Copyright 2020 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 projutil
+
+import (
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("SDK Label helper functions", func() {
+	Describe("parseVersion", func() {
+		It("should extract sdk version", func() {
+			version := "v0.17.0-159-ge87627f4-dirty"
+			output := parseVersion(version)
+			Expect(output).To(Equal("v0.17.0+git"))
+		})
+		It("should extract sdk version", func() {
+			version := "v0.18.0"
+			output := parseVersion(version)
+			Expect(output).To(Equal("v0.18.0"))
+		})
+		It("should extract sdk version", func() {
+			version := "v0.18.0-ge87627f4"
+			output := parseVersion(version)
+			Expect(output).To(Equal("v0.18.0+git"))
+		})
+
+	})
+})