feat(registry): Add label dependency constraint and property

dinhxuanvu · dinhxuanvu · commit eb48f7628ccd · 2020-07-30T05:48:08.000-04:00
1. Introduce a new type of dependency constraint named `olm.label` which
represents the constraints that are based on CSV labels.
2. The new label property is parsed from CSV labels.

Signed-off-by: Vu Dinh &lt;vdinh@redhat.com&gt;
diff --git a/docs/design/operator-bundle.md b/docs/design/operator-bundle.md
@@ -69,21 +69,24 @@ annotations:
 
 The dependencies of an operator are listed as a list in `dependencies.yaml` file inside `/metadata` folder of a bundle. This file is optional and only used to specify explicit operator version dependencies at first. Eventually, operator authors can migrate the API-based dependencies into `dependencies.yaml` as well in the future. The ultimate goal is to have `dependencies.yaml` as a centralized metadata for operator dependencies and moving the dependency information away from CSV.
 
-The dependency list will contain a `type` field for each item to specify what kind of dependency this is. There are two supported `type` of operator dependencies. It can be a package type (`olm.package`) meaning this is a dependency for a specific operator version. For `olm.package` type, the dependency information should include the `package` name and the `version` of the package in semver format. We use `blang/semver` library for semver parsing (https://github.com/blang/semver). For example, you can specify an exact version such as `0.5.2` or a range of version such as `>0.5.1` (https://github.com/blang/semver#ranges). In addition, the author can specify dependency that is similiar to existing CRD/API-based using `olm.gvk` type and then specify GVK information as how it is done in CSV. This is a path to enable operator authors to consolidate all dependencies (API or explicit version) to be in the same place.
+The dependency list will contain a `type` field for each item to specify what kind of dependency this is. There are two supported `type` of operator dependencies. It can be a package type (`olm.package`) meaning this is a dependency for a specific operator version. For `olm.package` type, the dependency information should include the `package` name and the `version` of the package in semver format. We use `blang/semver` library for semver parsing (https://github.com/blang/semver). For example, you can specify an exact version such as `0.5.2` or a range of version such as `>0.5.1` (https://github.com/blang/semver#ranges). In addition, the author can specify dependency that is similar to existing CRD/API-based using `olm.gvk` type and then specify GVK information as how it is done in CSV. The author can also specify CSV labels as dependency constraints using `olm.label` type. The value of `olm.label` type will be matched against labels in CSV with the key starting with the phrase `olm.label`. This is a path to enable operator authors to consolidate all dependencies (API or explicit version) to be in the same place.
 
 An example of a `dependencies.yaml` that specifies Prometheus operator and etcd CRD dependencies:
 
 ```
 dependencies:
   - type: olm.package
-    value: 
+    value:
       packageName: prometheus
       version: >0.27.0
   - type: olm.gvk
     value:
       group: etcd.database.coreos.com
       kind: EtcdCluster
       version: v1beta2
+  - type: olm.label
+    value:
+      label: lts
 ```
 
 ### Bundle Dockerfile
diff --git a/manifests/etcd/0.9.2/etcdoperator.v0.9.2.clusterserviceversion.yaml b/manifests/etcd/0.9.2/etcdoperator.v0.9.2.clusterserviceversion.yaml
@@ -4,6 +4,9 @@ kind: ClusterServiceVersion
 metadata:
   name: etcdoperator.v0.9.2
   namespace: placeholder
+  labels:
+    olm.label: testlabel
+    olm.label.1: testlabel1
   annotations:
     tectonic-visibility: ocs
     olm.skipRange: "< 0.6.0"
diff --git a/pkg/lib/bundle/testdata/validate/invalid_dependencies_bundle/invalid_label_dependency/manifests/etcdbackups.etcd.database.coreos.com.crd.yaml b/pkg/lib/bundle/testdata/validate/invalid_dependencies_bundle/invalid_label_dependency/manifests/etcdbackups.etcd.database.coreos.com.crd.yaml
@@ -0,0 +1,13 @@
+apiVersion: apiextensions.k8s.io/v1beta1
+kind: CustomResourceDefinition
+metadata:
+  name: etcdbackups.etcd.database.coreos.com
+spec:
+  group: etcd.database.coreos.com
+  names:
+    kind: EtcdBackup
+    listKind: EtcdBackupList
+    plural: etcdbackups
+    singular: etcdbackup
+  scope: Namespaced
+  version: v1beta2
diff --git a/pkg/lib/bundle/testdata/validate/invalid_dependencies_bundle/invalid_label_dependency/manifests/etcdclusters.etcd.database.coreos.com.crd.yaml b/pkg/lib/bundle/testdata/validate/invalid_dependencies_bundle/invalid_label_dependency/manifests/etcdclusters.etcd.database.coreos.com.crd.yaml
@@ -0,0 +1,16 @@
+apiVersion: apiextensions.k8s.io/v1beta1
+kind: CustomResourceDefinition
+metadata:
+  name: etcdclusters.etcd.database.coreos.com
+spec:
+  group: etcd.database.coreos.com
+  names:
+    kind: EtcdCluster
+    listKind: EtcdClusterList
+    plural: etcdclusters
+    shortNames:
+    - etcdclus
+    - etcd
+    singular: etcdcluster
+  scope: Namespaced
+  version: v1beta2
diff --git a/pkg/lib/bundle/testdata/validate/invalid_dependencies_bundle/invalid_label_dependency/manifests/etcdoperator.v0.9.4.clusterserviceversion.yaml b/pkg/lib/bundle/testdata/validate/invalid_dependencies_bundle/invalid_label_dependency/manifests/etcdoperator.v0.9.4.clusterserviceversion.yaml
diff --git a/pkg/lib/bundle/testdata/validate/invalid_dependencies_bundle/invalid_label_dependency/manifests/etcdrestores.etcd.database.coreos.com.crd.yaml b/pkg/lib/bundle/testdata/validate/invalid_dependencies_bundle/invalid_label_dependency/manifests/etcdrestores.etcd.database.coreos.com.crd.yaml
@@ -0,0 +1,13 @@
+apiVersion: apiextensions.k8s.io/v1beta1
+kind: CustomResourceDefinition
+metadata:
+  name: etcdrestores.etcd.database.coreos.com
+spec:
+  group: etcd.database.coreos.com
+  names:
+    kind: EtcdRestore
+    listKind: EtcdRestoreList
+    plural: etcdrestores
+    singular: etcdrestore
+  scope: Namespaced
+  version: v1beta2
diff --git a/pkg/lib/bundle/testdata/validate/invalid_dependencies_bundle/invalid_label_dependency/metadata/annotations.yaml b/pkg/lib/bundle/testdata/validate/invalid_dependencies_bundle/invalid_label_dependency/metadata/annotations.yaml
@@ -0,0 +1,7 @@
+annotations:
+  operators.operatorframework.io.bundle.channel.default.v1: stable
+  operators.operatorframework.io.bundle.channels.v1: stable,beta
+  operators.operatorframework.io.bundle.manifests.v1: manifests/
+  operators.operatorframework.io.bundle.mediatype.v1: registry+v1
+  operators.operatorframework.io.bundle.metadata.v1: metadata/
+  operators.operatorframework.io.bundle.package.v1: etcd
diff --git a/pkg/lib/bundle/testdata/validate/invalid_dependencies_bundle/invalid_label_dependency/metadata/dependencies.yaml b/pkg/lib/bundle/testdata/validate/invalid_dependencies_bundle/invalid_label_dependency/metadata/dependencies.yaml
@@ -0,0 +1,3 @@
+dependencies:
+  - type: olm.label
+    value:
diff --git a/pkg/lib/bundle/testdata/validate/valid_bundle/metadata/dependencies.yaml b/pkg/lib/bundle/testdata/validate/valid_bundle/metadata/dependencies.yaml
diff --git a/pkg/lib/bundle/validate.go b/pkg/lib/bundle/validate.go
@@ -230,6 +230,8 @@ func validateDependencies(dependenciesFile *registry.DependenciesFile) []error {
 				errs = dp.Validate()
 			case registry.PackageDependency:
 				errs = dp.Validate()
+			case registry.LabelDependency:
+				errs = dp.Validate()
 			default:
 				errs = append(errs, fmt.Errorf("unsupported dependency type %s", d.GetType()))
 			}
diff --git a/pkg/lib/bundle/validate_test.go b/pkg/lib/bundle/validate_test.go
@@ -61,6 +61,14 @@ func TestValidateBundleDependencies(t *testing.T) {
 				fmt.Errorf("couldn't parse dependency of type olm.crd"),
 			},
 		},
+		{
+			description: "registryv1 bundle/invalid label type",
+			mediaType:   RegistryV1Type,
+			directory:   "./testdata/validate/invalid_dependencies_bundle/invalid_label_dependency/",
+			errs: []error{
+				fmt.Errorf("Label information is missing"),
+			},
+		},
 	}
 
 	for _, tt := range table {
diff --git a/pkg/registry/types.go b/pkg/registry/types.go
@@ -43,6 +43,7 @@ const (
 	GVKType        = "olm.gvk"
 	PackageType    = "olm.package"
 	DeprecatedType = "olm.deprecated"
+	LabelType      = "olm.label"
 )
 
 // APIKey stores GroupVersionKind for use as map keys
@@ -193,6 +194,11 @@ type PackageDependency struct {
 	Version string `json:"version" yaml:"version"`
 }
 
+type LabelDependency struct {
+	// The version range of dependency in semver range format
+	Label string `json:"label" yaml:"label"`
+}
+
 type GVKProperty struct {
 	// The group of GVK based property
 	Group string `json:"group" yaml:"group"`
@@ -216,6 +222,11 @@ type DeprecatedProperty struct {
 	// Whether the bundle is deprecated
 }
 
+type LabelProperty struct {
+	// The version range of dependency in semver range format
+	Label string `json:"label" yaml:"label"`
+}
+
 // Validate will validate GVK dependency type and return error(s)
 func (gd *GVKDependency) Validate() []error {
 	errs := []error{}
@@ -231,6 +242,15 @@ func (gd *GVKDependency) Validate() []error {
 	return errs
 }
 
+// Validate will validate GVK dependency type and return error(s)
+func (ld *LabelDependency) Validate() []error {
+	errs := []error{}
+	if *ld == (LabelDependency{}) {
+		errs = append(errs, fmt.Errorf("Label information is missing"))
+	}
+	return errs
+}
+
 // Validate will validate package dependency type and return error(s)
 func (pd *PackageDependency) Validate() []error {
 	errs := []error{}
@@ -281,6 +301,13 @@ func (e *Dependency) GetTypeValue() interface{} {
 			return nil
 		}
 		return dep
+	case LabelType:
+		dep := LabelDependency{}
+		err := json.Unmarshal([]byte(e.GetValue()), &dep)
+		if err != nil {
+			return nil
+		}
+		return dep
 	}
 	return nil
 }
diff --git a/pkg/server/server_test.go b/pkg/server/server_test.go
diff --git a/pkg/sqlite/directory_test.go b/pkg/sqlite/directory_test.go
diff --git a/pkg/sqlite/load.go b/pkg/sqlite/load.go
@@ -803,6 +803,24 @@ func (s *sqlLoader) addBundleProperties(tx *sql.Tx, bundle *registry.Bundle) err
 		}
 	}
 
+	// Add label properties
+	if csv, err := bundle.ClusterServiceVersion(); err == nil {
+		for k, v := range csv.GetLabels() {
+			if strings.HasPrefix(k, registry.LabelType) {
+				prop := registry.LabelProperty{
+					Label: v,
+				}
+				value, err := json.Marshal(prop)
+				if err != nil {
+					continue
+				}
+				if err := s.addProperty(tx, registry.LabelType, string(value), bundle.Name, bundleVersion, bundle.BundleImage); err != nil {
+					continue
+				}
+			}
+		}
+	}
+
 	return nil
 }
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+dependencies:`
	`2`	`+ - type: olm.label`
	`3`	`+ value:`
Original file line number	Diff line number	Diff line change
`@@ -230,6 +230,8 @@ func validateDependencies(dependenciesFile *registry.DependenciesFile) []error {`
`230`	`230`	`errs = dp.Validate()`
`231`	`231`	`case registry.PackageDependency:`
`232`	`232`	`errs = dp.Validate()`
	`233`	`+ case registry.LabelDependency:`
	`234`	`+ errs = dp.Validate()`
`233`	`235`	`default:`
`234`	`236`	`errs = append(errs, fmt.Errorf("unsupported dependency type %s", d.GetType()))`
`235`	`237`	`}`