convert to semver.Version, using only prerelease

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

Author: grokspawn

alpha/declcfg/declcfg_to_model.go

@@ -135,6 +135,18 @@ func ConvertToModel(cfg DeclarativeConfig) (model.Model, error) {
 			return nil, fmt.Errorf("error parsing bundle %q version %q: %v", b.Name, rawVersion, err)
 		}
 
+		// Parse release version from the package property.
+		var relver semver.Version
+		if props.Packages[0].Release != "" {
+			relver, err = semver.Parse(fmt.Sprintf("0.0.0-%s", props.Packages[0].Release))
+			if err != nil {
+				return nil, fmt.Errorf("error parsing bundle %q release version %q: %v", b.Name, props.Packages[0].Release, err)
+			}
+			if relver.Major != 0 || relver.Minor != 0 || relver.Patch != 0 || len(relver.Build) != 0 {
+				return nil, fmt.Errorf("bundle %q release version %q must only contain prerelease", b.Name, props.Packages[0].Release)
+			}
+		}
+
 		channelDefinedEntries[b.Package] = channelDefinedEntries[b.Package].Delete(b.Name)
 		found := false
 		for _, mch := range mpkg.Channels {
@@ -147,7 +159,7 @@ func ConvertToModel(cfg DeclarativeConfig) (model.Model, error) {
 				mb.Objects = b.Objects
 				mb.PropertiesP = props
 				mb.Version = ver
-				mb.Release = props.Packages[0].Release
+				mb.Release = relver
 			}
 		}
 		if !found {

alpha/declcfg/declcfg_to_model_test.go

@@ -442,6 +442,70 @@ func TestConvertToModel(t *testing.T) {
 				},
 			},
 		},
+		{
+			name:      "Error/InvalidReleaseVersion",
+			assertion: hasError(`error parsing bundle "foo.v0.1.0" release version "!!!": Invalid character(s) found in prerelease "!!!"`),
+			cfg: DeclarativeConfig{
+				Packages: []Package{newTestPackage("foo", "alpha", svgSmallCircle)},
+				Channels: []Channel{newTestChannel("foo", "alpha", ChannelEntry{Name: testBundleName("foo", "0.1.0")})},
+				Bundles: []Bundle{newTestBundle("foo", "0.1.0", func(b *Bundle) {
+					b.Properties = []property.Property{
+						property.MustBuildPackageRelease("foo", "0.1.0", "!!!"),
+					}
+				})},
+			},
+		},
+		{
+			name: "Error/InvalidBundleNormalizedName",
+			assertion: hasError(`invalid index:
+└── invalid package "foo":
+    └── invalid channel "alpha":
+        └── invalid bundle "foo.v0.1.0-alpha.1.0.0":
+            └── name "foo.v0.1.0-alpha.1.0.0" does not match normalized name "foo-v0.1.0-alpha.1.0.0"`),
+			cfg: DeclarativeConfig{
+				Packages: []Package{newTestPackage("foo", "alpha", svgSmallCircle)},
+				Channels: []Channel{newTestChannel("foo", "alpha", ChannelEntry{Name: "foo.v0.1.0-alpha.1.0.0"})},
+				Bundles: []Bundle{newTestBundle("foo", "0.1.0", func(b *Bundle) {
+					b.Properties = []property.Property{
+						property.MustBuildPackageRelease("foo", "0.1.0", "alpha.1.0.0"),
+					}
+					b.Name = "foo.v0.1.0-alpha.1.0.0"
+				})},
+			},
+		},
+		{
+			name:      "Success/ValidBundleReleaseVersion",
+			assertion: require.NoError,
+			cfg: DeclarativeConfig{
+				Packages: []Package{newTestPackage("foo", "alpha", svgSmallCircle)},
+				Channels: []Channel{newTestChannel("foo", "alpha", ChannelEntry{Name: "foo-v0.1.0-alpha.1.0.0"})},
+				Bundles: []Bundle{newTestBundle("foo", "0.1.0", func(b *Bundle) {
+					b.Properties = []property.Property{
+						property.MustBuildPackageRelease("foo", "0.1.0", "alpha.1.0.0"),
+					}
+					b.Name = "foo-v0.1.0-alpha.1.0.0"
+				})},
+			},
+		},
+		{
+			name: "Error/BundleReleaseWithBuildMetadata",
+			assertion: hasError(`invalid index:
+└── invalid package "foo":
+    └── invalid channel "alpha":
+        └── invalid bundle "foo.v0.1.0+alpha.1.0.0-0.0.1":
+            ├── name "foo.v0.1.0+alpha.1.0.0-0.0.1" does not match normalized name "foo-v0.1.0+alpha.1.0.0-0.0.1"
+            └── cannot use build metadata in version with a release version`),
+			cfg: DeclarativeConfig{
+				Packages: []Package{newTestPackage("foo", "alpha", svgSmallCircle)},
+				Channels: []Channel{newTestChannel("foo", "alpha", ChannelEntry{Name: "foo.v0.1.0+alpha.1.0.0-0.0.1"})},
+				Bundles: []Bundle{newTestBundle("foo", "0.1.0", func(b *Bundle) {
+					b.Properties = []property.Property{
+						property.MustBuildPackageRelease("foo", "0.1.0+alpha.1.0.0", "0.0.1"),
+					}
+					b.Name = "foo.v0.1.0+alpha.1.0.0-0.0.1"
+				})},
+			},
+		},
 	}
 
 	for _, s := range specs {

alpha/model/model.go

@@ -332,12 +332,16 @@ type Bundle struct {
 	// These fields are used to compare bundles in a diff.
 	PropertiesP *property.Properties
 	Version     semver.Version
-	Release     semver.PRVersion
+	Release     semver.Version
 }
 
 func (b *Bundle) VersionString() string {
-	relString := b.Release.String()
-	if relString != "" {
+	if len(b.Release.Pre) > 0 {
+		pres := []string{}
+		for _, pre := range b.Release.Pre {
+			pres = append(pres, pre.String())
+		}
+		relString := strings.Join(pres, ".")
 		return strings.Join([]string{b.Version.String(), relString}, "-")
 	}
 	return b.Version.String()
@@ -347,9 +351,8 @@ func (b *Bundle) normalizeName() string {
 	// if the bundle has release versioning, then the name must include this in standard form:
 	// <package-name>-v<version>-<release version>
 	// if no release versioning exists, then just return the bundle name
-	relString := b.Release.String()
-	if relString != "" {
-		return strings.Join([]string{b.Package.Name, "v" + b.Version.String(), b.Release.String()}, "-")
+	if len(b.Release.Pre) > 0 {
+		return strings.Join([]string{b.Package.Name, "v" + b.VersionString()}, "-")
 	}
 	return b.Name
 }
@@ -415,6 +418,10 @@ func (b *Bundle) Validate() error {
 		result.subErrors = append(result.subErrors, fmt.Errorf("invalid deprecation: %v", err))
 	}
 
+	if len(b.Version.Build) > 0 && len(b.Release.Pre) > 0 {
+		result.subErrors = append(result.subErrors, fmt.Errorf("cannot use build metadata in version with a release version"))
+	}
+
 	return result.orNil()
 }
 

alpha/model/model_test.go

@@ -4,6 +4,7 @@ import (
 	"encoding/base64"
 	"encoding/json"
 	"errors"
+	"fmt"
 	"testing"
 
 	"github.com/blang/semver/v4"
@@ -299,8 +300,8 @@ func TestValidators(t *testing.T) {
 						Bundles: map[string]*Bundle{
 							"anakin.v0.0.1":              {Name: "anakin.v0.0.1", Version: semver.MustParse("0.0.1")},
 							"anakin.v0.0.2":              {Name: "anakin.v0.0.2", Version: semver.MustParse("0.0.1")},
-							"anakin-v0.0.1-hotfix.0.0.1": {Name: "anakin.v0.0.1", Version: semver.MustParse("0.0.1"), Release: property.MustBuildPackageReleaseVersion("100"), Package: pkg},
-							"anakin-v0.0.2-hotfix.0.0.1": {Name: "anakin.v0.0.2", Version: semver.MustParse("0.0.1"), Release: property.MustBuildPackageReleaseVersion("100"), Package: pkg},
+							"anakin-v0.0.1-hotfix.0.0.1": {Name: "anakin.v0.0.1", Version: semver.MustParse("0.0.1"), Release: semver.MustParse(fmt.Sprintf("0.0.0-%s", "100")), Package: pkg},
+							"anakin-v0.0.2-hotfix.0.0.1": {Name: "anakin.v0.0.2", Version: semver.MustParse("0.0.1"), Release: semver.MustParse(fmt.Sprintf("0.0.0-%s", "100")), Package: pkg},
 						},
 					},
 				},
@@ -316,7 +317,7 @@ func TestValidators(t *testing.T) {
 						Package: pkg,
 						Name:    "light",
 						Bundles: map[string]*Bundle{
-							"anakin.v0.0.1.alpha1": {Name: "anakin.v0.0.1.alpha1", Version: semver.MustParse("0.0.1"), Release: property.MustBuildPackageReleaseVersion("alpha1"), Package: pkg},
+							"anakin.v0.0.1.alpha1": {Name: "anakin.v0.0.1.alpha1", Version: semver.MustParse("0.0.1"), Release: semver.MustParse(fmt.Sprintf("0.0.0-%s", "alpha1")), Package: pkg},
 						},
 					},
 				},

alpha/property/property.go

@@ -7,7 +7,6 @@ import (
 	"fmt"
 	"reflect"
 
-	"github.com/blang/semver/v4"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 	"github.com/operator-framework/api/pkg/operators/v1alpha1"
@@ -37,9 +36,9 @@ func (p Property) String() string {
 }
 
 type Package struct {
-	PackageName string           `json:"packageName"`
-	Version     string           `json:"version"`
-	Release     semver.PRVersion `json:"release,omitzero"`
+	PackageName string `json:"packageName"`
+	Version     string `json:"version"`
+	Release     string `json:"release,omitzero"`
 }
 
 // NOTICE: The Channel properties are for internal use only.
@@ -249,15 +248,8 @@ func jsonMarshal(p interface{}) ([]byte, error) {
 func MustBuildPackage(name, version string) Property {
 	return MustBuild(&Package{PackageName: name, Version: version})
 }
-func MustBuildPackageReleaseVersion(relVersion string) semver.PRVersion {
-	val, err := semver.NewPRVersion(relVersion)
-	if err != nil {
-		panic(err)
-	}
-	return val
-}
 func MustBuildPackageRelease(name, version, relVersion string) Property {
-	return MustBuild(&Package{PackageName: name, Version: version, Release: MustBuildPackageReleaseVersion(relVersion)})
+	return MustBuild(&Package{PackageName: name, Version: version, Release: relVersion})
 }
 func MustBuildPackageRequired(name, versionRange string) Property {
 	return MustBuild(&PackageRequired{name, versionRange})

alpha/property/property_test.go

@@ -212,19 +212,19 @@ func TestBuild(t *testing.T) {
 		},
 		{
 			name:             "Success/Package-ReleaseVersionNumber",
-			input:            &Package{PackageName: "name", Version: "0.1.0", Release: MustBuildPackageReleaseVersion("1")},
+			input:            &Package{PackageName: "name", Version: "0.1.0", Release: "1"},
 			assertion:        require.NoError,
 			expectedProperty: propPtr(MustBuildPackageRelease("name", "0.1.0", "1")),
 		},
 		{
 			name:             "Success/Package-ReleaseVersionAlpha",
-			input:            &Package{PackageName: "name", Version: "0.1.0", Release: MustBuildPackageReleaseVersion("gamma")},
+			input:            &Package{PackageName: "name", Version: "0.1.0", Release: "gamma"},
 			assertion:        require.NoError,
 			expectedProperty: propPtr(MustBuildPackageRelease("name", "0.1.0", "gamma")),
 		},
 		{
 			name:             "Success/Package-ReleaseVersionMixed",
-			input:            &Package{PackageName: "name", Version: "0.1.0", Release: MustBuildPackageReleaseVersion("gamma1")},
+			input:            &Package{PackageName: "name", Version: "0.1.0", Release: "gamma1"},
 			assertion:        require.NoError,
 			expectedProperty: propPtr(MustBuildPackageRelease("name", "0.1.0", "gamma1")),
 		},