Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixes semver range parsing for required packages #423

Merged
merged 1 commit into from
Sep 20, 2023
Merged

Fixes semver range parsing for required packages #423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions internal/catalogmetadata/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ type Channel struct {

type PackageRequired struct {
property.PackageRequired
SemverRange *bsemver.Range `json:"-"`
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need a pointer to a function here.

SemverRange bsemver.Range `json:"-"`
}

type Bundle struct {
Expand Down Expand Up @@ -98,17 +98,17 @@ func (b *Bundle) loadRequiredPackages() error {
if err != nil {
return fmt.Errorf("error determining bundle required packages for bundle %q: %s", b.Name, err)
}
for _, requiredPackage := range requiredPackages {
semverRange, err := bsemver.ParseRange(requiredPackage.VersionRange)
for i := range requiredPackages {
semverRange, err := bsemver.ParseRange(requiredPackages[i].VersionRange)
if err != nil {
return fmt.Errorf(
"error parsing bundle required package semver range for bundle %q (required package %q): %s",
b.Name,
requiredPackage.PackageName,
requiredPackages[i].PackageName,
err,
)
}
requiredPackage.SemverRange = &semverRange
Copy link
Member Author

@m1kola m1kola Sep 20, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the issue is that we were setting SemverRange on a copy and not on the instance from requiredPackages.

I think we have the same issue in master here:

operator-controller/internal/resolution/entities/bundle_entity.go

Lines 234 to 240 in cdb99fa

for _, requiredPackage := range requiredPackages {
semverRange, err := bsemver.ParseRange(requiredPackage.VersionRange)
if err != nil {
return fmt.Errorf("error determining bundle required package semver range for entity '%s': '%w'", b.ID, err)
}
requiredPackage.SemverRange = &semverRange
}

But I believe it is unused currently in master since we do parsing here anyway:

operator-controller/internal/resolution/variablesources/bundles_and_dependencies.go

Lines 90 to 93 in cdb99fa

semverRange, err := bsemver.ParseRange(requiredPackage.VersionRange)
if err != nil {
return nil, err
}

Not going to submit a PR for bundle_entity.go since it is going away as soon as #413 merges.

requiredPackages[i].SemverRange = semverRange
}
b.requiredPackages = requiredPackages
}
Expand Down
10 changes: 10 additions & 0 deletions internal/catalogmetadata/types_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,16 @@ func TestBundleRequiredPackages(t *testing.T) {
} {
t.Run(tt.name, func(t *testing.T) {
packages, err := tt.bundle.RequiredPackages()
assert.Len(t, packages, len(tt.wantRequiredPackages))
for i := range packages {
// SemverRange is a function which is not comparable
// so we just make sure that it is set.
assert.NotNil(t, packages[i].SemverRange)

// And then we set it to nil for ease of further comparisons
packages[i].SemverRange = nil
}

assert.Equal(t, tt.wantRequiredPackages, packages)
if tt.wantErr != "" {
assert.EqualError(t, err, tt.wantErr)
Expand Down