🌱 use operator-registry's FBC types directly; add `Resolver` interface #1033

joelanford · 2024-07-11T01:54:52Z

Signed-off-by: Joe Lanford joe.lanford@gmail.com

Description

This is a code refactoring to:

align operator-controller's resolver to use the FBC types directly, which seems like it would be able to evolve better alongside FBC evolution.
introduce a resolver abstraction to the reconciler, which simplifies reconciler AND resolver testability

Reviewer Checklist

API Go Documentation
Tests: Unit Tests (and E2E Tests, if appropriate)
Comprehensive Commit Messages
Links to related GitHub Issue(s)

netlify · 2024-07-11T01:55:09Z

✅ Deploy Preview for olmv1 ready!

Name	Link
🔨 Latest commit	`b59ac9e`
🔍 Latest deploy log	https://app.netlify.com/sites/olmv1/deploys/6696b6016c7d880008b40fb2
😎 Deploy Preview	https://deploy-preview-1033--olmv1.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

codecov · 2024-07-11T02:03:48Z

Codecov Report

Attention: Patch coverage is 87.25490% with 39 lines in your changes missing coverage. Please review.

Project coverage is 72.10%. Comparing base (957fc1b) to head (b59ac9e).
Report is 1 commits behind head on main.

Files	Patch %	Lines
internal/catalogmetadata/filter/successors.go	74.46%	6 Missing and 6 partials ⚠️
cmd/manager/main.go	52.17%	7 Missing and 4 partials ⚠️
...nternal/controllers/clusterextension_controller.go	90.27%	5 Missing and 2 partials ⚠️
internal/resolve/catalog.go	95.45%	2 Missing and 2 partials ⚠️
internal/bundleutil/bundle.go	86.66%	1 Missing and 1 partial ⚠️
internal/resolve/resolver.go	0.00%	2 Missing ⚠️
internal/catalogmetadata/client/client.go	94.44%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1033      +/-   ##
==========================================
- Coverage   73.60%   72.10%   -1.50%     
==========================================
  Files          30       31       +1     
  Lines        1951     1807     -144     
==========================================
- Hits         1436     1303     -133     
+ Misses        381      377       -4     
+ Partials      134      127       -7

Flag	Coverage Δ
e2e	`55.67% <54.24%> (+1.29%)`	⬆️
unit	`43.38% <78.43%> (-4.44%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

tmshort · 2024-07-15T15:16:29Z

Upgrade e2e fails...

joelanford · 2024-07-15T15:21:58Z

I'm hoping #1050 improves the situation on the upgrade-e2e. I'll rebase after that merges.

joelanford · 2024-07-15T18:02:03Z

Rebased. Let's see if upgrade-e2e passes now.

EDIT: It did! 🎉

perdasilva

lgtm to me - just a couple of small questions but nothing that should block this (though some tracking tickets if we want to address anything would be good =))

perdasilva · 2024-07-16T12:02:55Z

internal/bundleutil/bundle.go

+	return nil, fmt.Errorf("no package property found in bundle %q", b.Name)
+}
+
+// MetadataFor returns a BundleMetadata for the given bundle. If the provided bundle is nil,


Is this still accurate? Would something like the following be more accurate?

Suggested change

// MetadataFor returns a BundleMetadata for the given bundle. If the provided bundle is nil,

// MetadataFor returns a BundleMetadata for the given bundle name and version. If the provided bundle version is nil,

Addressed this in two ways:

Added name and version

Dropped the second sentence because I changed the signature to avoid nil-pointer panic possibilities.

perdasilva · 2024-07-16T12:12:58Z

internal/bundleutil/bundle.go

+
+// MetadataFor returns a BundleMetadata for the given bundle. If the provided bundle is nil,
+// this function panics. It is up to the caller to ensure that the bundle is non-nil.
+func MetadataFor(bundleName string, bundleVersion *bsemver.Version) *ocv1alpha1.BundleMetadata {


would it make sense to wrap the bundle in an internal struct with this added method? I can see both ways working, I just don't know how "first class" this method needs to be.

catalogmetadata.Bundle was the wrapper that this PR removed, somewhat purposefully. What I had noticed is that we started losing parity with the FBC data model (we put channel membership and deprecation information in that wrapper). And that seemed like a recipe for more spaghetti-making when FBC evolves new types and semantics.

So I opted for functions over declcfg.Bundle rather than a wrapper type with methods.

internal/bundleutil/bundle.go

perdasilva · 2024-07-16T12:16:06Z

also it may impact #1030 @bentito

Signed-off-by: Joe Lanford <joe.lanford@gmail.com>

joelanford · 2024-07-16T18:07:28Z

Most recent push:

Rebases to main
Changes bundleutil.MetadataFor to fix GoDoc and avoid accepting a pointer to a blang semver version.

dtfranz

/lgtm
Looks like this will make the codebase a lot more manageable!

…or-framework#1033) Signed-off-by: Joe Lanford <joe.lanford@gmail.com>

openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 11, 2024

joelanford force-pushed the use-declcfg-types branch from c5230bd to f23a6a1 Compare July 11, 2024 01:56

joelanford force-pushed the use-declcfg-types branch 4 times, most recently from 3664e64 to a03a969 Compare July 12, 2024 18:31

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 12, 2024

joelanford force-pushed the use-declcfg-types branch from a03a969 to 9803223 Compare July 12, 2024 19:06

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 12, 2024

joelanford changed the title ~~🌱 WIP: use operator-registry's FBC types directly~~ 🌱 use operator-registry's FBC types directly; add Resolver interface Jul 12, 2024

joelanford force-pushed the use-declcfg-types branch from 9803223 to 7b0983c Compare July 12, 2024 20:20

joelanford marked this pull request as ready for review July 12, 2024 21:04

joelanford requested a review from a team as a code owner July 12, 2024 21:04

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 12, 2024

joelanford force-pushed the use-declcfg-types branch from 7b0983c to 72f672e Compare July 15, 2024 18:01

perdasilva previously approved these changes Jul 16, 2024

View reviewed changes

remove catalogmetadata types, introduce to resolver interface

b59ac9e

Signed-off-by: Joe Lanford <joe.lanford@gmail.com>

joelanford dismissed perdasilva’s stale review via b59ac9e July 16, 2024 18:03

joelanford force-pushed the use-declcfg-types branch from 72f672e to b59ac9e Compare July 16, 2024 18:03

joelanford mentioned this pull request Jul 16, 2024

bug: Misleading error message when no successors available #1022

Open

joelanford enabled auto-merge July 16, 2024 18:34

dtfranz approved these changes Jul 17, 2024

View reviewed changes

joelanford added this pull request to the merge queue Jul 17, 2024

openshift-ci bot assigned dtfranz Jul 17, 2024

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jul 17, 2024

Merged via the queue into operator-framework:main with commit 6cd022e Jul 17, 2024
17 of 18 checks passed

joelanford deleted the use-declcfg-types branch July 20, 2024 01:59

joelanford mentioned this pull request Aug 6, 2024

Improve unit testing of reconcile() function. #879

Closed

perdasilva pushed a commit to LalatenduMohanty/operator-controller that referenced this pull request Aug 13, 2024

remove catalogmetadata types, introduce to resolver interface (operat…

3b16f24

…or-framework#1033) Signed-off-by: Joe Lanford <joe.lanford@gmail.com>

perdasilva pushed a commit to kevinrizza/operator-controller that referenced this pull request Aug 13, 2024

remove catalogmetadata types, introduce to resolver interface (operat…

9094fed

…or-framework#1033) Signed-off-by: Joe Lanford <joe.lanford@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🌱 use operator-registry's FBC types directly; add `Resolver` interface #1033

🌱 use operator-registry's FBC types directly; add `Resolver` interface #1033

joelanford commented Jul 11, 2024 •

edited

Loading

netlify bot commented Jul 11, 2024 •

edited

Loading

codecov bot commented Jul 11, 2024 •

edited

Loading

tmshort commented Jul 15, 2024

joelanford commented Jul 15, 2024

joelanford commented Jul 15, 2024 •

edited

Loading

perdasilva left a comment

perdasilva Jul 16, 2024

joelanford Jul 16, 2024

perdasilva Jul 16, 2024

joelanford Jul 16, 2024

perdasilva commented Jul 16, 2024

joelanford commented Jul 16, 2024

dtfranz left a comment

	// MetadataFor returns a BundleMetadata for the given bundle. If the provided bundle is nil,
	// MetadataFor returns a BundleMetadata for the given bundle name and version. If the provided bundle version is nil,

🌱 use operator-registry's FBC types directly; add Resolver interface #1033

🌱 use operator-registry's FBC types directly; add Resolver interface #1033

Conversation

joelanford commented Jul 11, 2024 • edited Loading

Description

Reviewer Checklist

netlify bot commented Jul 11, 2024 • edited Loading

✅ Deploy Preview for olmv1 ready!

codecov bot commented Jul 11, 2024 • edited Loading

Codecov Report

tmshort commented Jul 15, 2024

joelanford commented Jul 15, 2024

joelanford commented Jul 15, 2024 • edited Loading

perdasilva left a comment

Choose a reason for hiding this comment

perdasilva Jul 16, 2024

Choose a reason for hiding this comment

joelanford Jul 16, 2024

Choose a reason for hiding this comment

perdasilva Jul 16, 2024

Choose a reason for hiding this comment

joelanford Jul 16, 2024

Choose a reason for hiding this comment

perdasilva commented Jul 16, 2024

joelanford commented Jul 16, 2024

dtfranz left a comment

Choose a reason for hiding this comment

🌱 use operator-registry's FBC types directly; add `Resolver` interface #1033

🌱 use operator-registry's FBC types directly; add `Resolver` interface #1033

joelanford commented Jul 11, 2024 •

edited

Loading

netlify bot commented Jul 11, 2024 •

edited

Loading

codecov bot commented Jul 11, 2024 •

edited

Loading

joelanford commented Jul 15, 2024 •

edited

Loading