🐛 Add support for build metadata precedence in bundle version comparison #2273
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| package bundle | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| bsemver "github.com/blang/semver/v4" | ||
|
|
||
| slicesutil "github.com/operator-framework/operator-controller/internal/shared/util/slices" | ||
| ) | ||
|
|
||
| // NewLegacyRegistryV1VersionRelease parses a registry+v1 bundle version string and returns | ||
| // a VersionRelease. For registry+v1 bundles, the build metadata field of the semver version | ||
| // is treated as release information (a semver spec violation maintained for backward compatibility). | ||
| // The returned VersionRelease has the build metadata extracted into the Release field, and the | ||
| // Version field has its Build metadata cleared. | ||
| func NewLegacyRegistryV1VersionRelease(vStr string) (*VersionRelease, error) { | ||
joelanford marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| vers, err := bsemver.Parse(vStr) | ||
| if err != nil { | ||
| return nil, err | ||
|
There was a problem hiding this comment. This is not back-compat. We should return a releaseless |
||
| } | ||
|
|
||
| rel, err := NewRelease(strings.Join(vers.Build, ".")) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| vers.Build = nil | ||
|
|
||
| return &VersionRelease{ | ||
| Version: vers, | ||
| Release: rel, | ||
| }, nil | ||
| } | ||
|
|
||
| type VersionRelease struct { | ||
| Version bsemver.Version | ||
| Release Release | ||
| } | ||
|
|
||
| // Compare compares two VersionRelease values. It returns: | ||
| // | ||
| // -1 if vr < other | ||
| // 0 if vr == other | ||
| // +1 if vr > other | ||
| // | ||
| // Comparison is done first by Version, then by Release if versions are equal. | ||
| func (vr *VersionRelease) Compare(other VersionRelease) int { | ||
joelanford marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if vCmp := vr.Version.Compare(other.Version); vCmp != 0 { | ||
| return vCmp | ||
| } | ||
| return vr.Release.Compare(other.Release) | ||
| } | ||
|
|
||
| func (vr *VersionRelease) AsLegacyRegistryV1Version() bsemver.Version { | ||
| return bsemver.Version{ | ||
| Major: vr.Version.Major, | ||
| Minor: vr.Version.Minor, | ||
| Patch: vr.Version.Patch, | ||
| Pre: vr.Version.Pre, | ||
| Build: slicesutil.Map(vr.Release, func(i bsemver.PRVersion) string { return i.String() }), | ||
| } | ||
| } | ||
|
|
||
| type Release []bsemver.PRVersion | ||
|
|
||
| // Compare compares two Release values. It returns: | ||
| // | ||
| // -1 if r < other | ||
| // 0 if r == other | ||
| // +1 if r > other | ||
| // | ||
| // Comparison is done segment by segment from left to right. Numeric segments are | ||
| // compared numerically, and alphanumeric segments are compared lexically in ASCII | ||
| // sort order. A shorter release is considered less than a longer release if all | ||
| // corresponding segments are equal. | ||
| func (r Release) Compare(other Release) int { | ||
pedjak marked this conversation as resolved.
Show resolved
Hide resolved
pedjak marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if len(r) == 0 && len(other) > 0 { | ||
| return -1 | ||
| } | ||
| if len(other) == 0 && len(r) > 0 { | ||
| return 1 | ||
| } | ||
| a := bsemver.Version{Pre: r} | ||
| b := bsemver.Version{Pre: other} | ||
| return a.Compare(b) | ||
| } | ||
|
|
||
| // NewRelease parses a release string into a Release. The release string should be | ||
| // a dot-separated sequence of non-empty identifiers, where each identifier contains | ||
| // only ASCII alphanumerics and hyphens [0-9A-Za-z-]. Numeric identifiers (those | ||
| // containing only digits) must not have leading zeros. An empty string returns a nil | ||
| // Release. Returns an error if any segment is invalid. | ||
| func NewRelease(relStr string) (Release, error) { | ||
pedjak marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if relStr == "" { | ||
| return nil, nil | ||
| } | ||
|
|
||
| var ( | ||
| segments = strings.Split(relStr, ".") | ||
| r = make(Release, 0, len(segments)) | ||
| errs []error | ||
| ) | ||
| for i, segment := range segments { | ||
| prVer, err := bsemver.NewPRVersion(segment) | ||
| if err != nil { | ||
| errs = append(errs, fmt.Errorf("segment %d: %v", i, err)) | ||
| continue | ||
| } | ||
| r = append(r, prVer) | ||
| } | ||
| if err := errors.Join(errs...); err != nil { | ||
| return nil, fmt.Errorf("invalid release %q: %v", relStr, err) | ||
| } | ||
| return r, nil | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'll need to update this once the bundle release version feature lands, since we will need to mention both approaches, including how one is preferred in future. Right now the bundle release version approach is to use
[version]-[release]to express the attribute combo in a string (though the source of truth is always the discrete version and release fields in theolm.packageproperty).Perhaps this is better resolved in a doc where we can go into more depth?