extract csv.release if present, parse from version build metadata if possible; fatal if annotation present and build metadata cannot represent release

Signed-off-by: grokspawn <[email protected]>

Author: grokspawn

pkg/lib/validation/bundle.go

@@ -39,6 +39,14 @@ func validateBundle(bundle *registry.Bundle) errors.ManifestResult {
 		result.Add(errors.ErrInvalidParse("error getting bundle CSV version", err))
 		return result
 	}
+	if result.Name, err = csv.GetRelease(); err != nil {
+		result.Add(errors.ErrInvalidParse("error getting bundle CSV release version", err))
+		return result
+	}
+	rel, _ := csv.GetRelease()
+	if rel == "" {
+		result.Add(errors.ErrInvalidParse("bundle CSV release version is not defined", errors.Error{}))
+	}
 	return result
 }
 

pkg/registry/bundle.go

@@ -42,6 +42,7 @@ type Bundle struct {
 	Channels     []string
 	BundleImage  string
 	version      string
+	release      string
 	csv          *ClusterServiceVersion
 	v1beta1crds  []*apiextensionsv1beta1.CustomResourceDefinition
 	v1crds       []*apiextensionsv1.CustomResourceDefinition
@@ -130,6 +131,23 @@ func (b *Bundle) Version() (string, error) {
 	return b.version, err
 }
 
+func (b *Bundle) Release() (string, error) {
+	if b.release != "" {
+		return b.release, nil
+	}
+
+	var err error
+	if err = b.cache(); err != nil {
+		return "", err
+	}
+
+	if b.csv != nil {
+		b.release, err = b.csv.GetRelease()
+	}
+
+	return b.release, err
+}
+
 func (b *Bundle) SkipRange() (string, error) {
 	if err := b.cache(); err != nil {
 		return "", err

pkg/registry/csv.go

@@ -58,6 +58,9 @@ const (
 	// expected to be semver and parseable by blang/semver/v4
 	version = "version"
 
+	// The yaml attribute that specifies the release version of the ClusterServiceVersion
+	release = "release"
+
 	// The yaml attribute that specifies the related images of the ClusterServiceVersion
 	relatedImages = "relatedImages"
 
@@ -181,6 +184,28 @@ func (csv *ClusterServiceVersion) GetVersion() (string, error) {
 	return v, nil
 }
 
+// GetRelease returns the release of the CSV
+//
+// If not defined, the function returns an empty string.
+func (csv *ClusterServiceVersion) GetRelease() (string, error) {
+	var objmap map[string]*json.RawMessage
+	if err := json.Unmarshal(csv.Spec, &objmap); err != nil {
+		return "", err
+	}
+
+	rawValue, ok := objmap[release]
+	if !ok || rawValue == nil {
+		return "", nil
+	}
+
+	var r string
+	if err := json.Unmarshal(*rawValue, &r); err != nil {
+		return "", err
+	}
+
+	return r, nil
+}
+
 // GetSkipRange returns the skiprange of the CSV
 //
 // If not defined, the function returns an empty string.

pkg/registry/parse.go

@@ -203,10 +203,30 @@ func (b *bundleParser) derivedProperties(bundle *Bundle) ([]Property, error) {
 		if err != nil {
 			return nil, err
 		}
+		release, err := bundle.Release()
+		if err != nil {
+			return nil, err
+		}
+		if release == "" && csv.GetSubstitutesFor() != "" {
+			// if the bundle expresses no release version, but
+			// includes the substitutesFor annotation, then we
+			// interpret any build metadata in the version as
+			// the release version.
+			// failure to parse build metadata under these conditions is fatal,
+			// though validation is later
+			parts := strings.SplitN(version, "+", 2)
+			if len(parts) == 2 {
+				version = parts[0]
+				release = parts[1]
+			} else {
+				return nil, fmt.Errorf("bundle %q with has substitutesFor annotation but release version not expressed as build metadata: %q", bundle.Name, version)
+			}
+		}
 
 		value, err := json.Marshal(PackageProperty{
 			PackageName: pkg,
 			Version:     version,
+			Release:     release,
 		})
 		if err != nil {
 			return nil, fmt.Errorf("failed to marshal package property: %s", err)

pkg/registry/registry_to_model.go

@@ -29,7 +29,7 @@ func ObjectsAndPropertiesFromBundle(b *Bundle) ([]string, []property.Property, e
 			if err := json.Unmarshal(p.Value, &v); err != nil {
 				return nil, nil, property.ParseError{Idx: i, Typ: p.Type, Err: err}
 			}
-			p := property.MustBuildPackage(v.PackageName, v.Version)
+			p := property.MustBuildPackageRelease(v.PackageName, v.Version, v.Release)
 			packageProvidedProperty = &p
 		default:
 			otherProps = append(otherProps, property.Property{
@@ -68,6 +68,11 @@ func ObjectsAndPropertiesFromBundle(b *Bundle) ([]string, []property.Property, e
 		return nil, nil, fmt.Errorf("get version: %v", err)
 	}
 
+	release, err := b.Release()
+	if err != nil {
+		return nil, nil, fmt.Errorf("get release: %v", err)
+	}
+
 	providedApis, err := b.ProvidedAPIs()
 	if err != nil {
 		return nil, nil, fmt.Errorf("get provided apis: %v", err)
@@ -105,7 +110,7 @@ func ObjectsAndPropertiesFromBundle(b *Bundle) ([]string, []property.Property, e
 	}
 
 	if packageProvidedProperty == nil {
-		p := property.MustBuildPackage(b.Package, version)
+		p := property.MustBuildPackageRelease(b.Package, version, release)
 		packageProvidedProperty = &p
 	}
 	props = append(props, *packageProvidedProperty)

pkg/registry/types.go

@@ -256,6 +256,9 @@ type PackageProperty struct {
 
 	// The version of package in semver format
 	Version string `json:"version" yaml:"version"`
+
+	// The release version of the package in semver pre-release format
+	Release string `json:"release,omitzero" yaml:"release,omitzero"`
 }
 
 type DeprecatedProperty struct {