✨ Implement Boxcutter #1946

thetechnick · 2025-04-30T14:47:07Z

Description

Reviewer Checklist

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

netlify · 2025-04-30T14:47:25Z

✅ Deploy Preview for olmv1 ready!

Name	Link
🔨 Latest commit	`ae9d77c`
🔍 Latest deploy log	https://app.netlify.com/projects/olmv1/deploys/68a5bd47b6f83800082afa92
😎 Deploy Preview	https://deploy-preview-1946--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 project configuration.

api/v1/clusterextensionrevision_types.go

internal/operator-controller/applier/boxcutter.go

joelanford · 2025-04-30T17:03:46Z

internal/operator-controller/applier/boxcutter.go

+	hasher.Reset()
+
+	printer := spew.ConfigState{
+		Indent:         " ",
+		SortKeys:       true,
+		DisableMethods: true,
+		SpewKeys:       true,
+	}
+	if _, err := printer.Fprintf(hasher, "%#v", objectToWrite); err != nil {
+		panic(err)
+	}


Is this an OLM-ism or a boxcutter-ism? I wonder if json.NewEncoder(hasher).Encode(objectToWrite) would be better?

This is a kubernetes apimachinery thing:
https://github.com/kubernetes/kubernetes/blob/627ce4946ccd6b67bc18f5a4dda92cf6c583e9b7/pkg/util/hash/hash.go#L26-L32
https://github.com/kubernetes/apimachinery/blob/master/pkg/util/dump/dump.go

I'll import from apimachinery next.

internal/operator-controller/applier/boxcutter.go

codecov · 2025-07-15T12:09:46Z

Codecov Report

❌ Patch coverage is 70.13388% with 290 lines in your changes missing coverage. Please review.
✅ Project coverage is 71.87%. Comparing base (35bcd7a) to head (ae9d77c).
⚠️ Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
...controllers/clusterextensionrevision_controller.go	78.17%	54 Missing and 13 partials ⚠️
api/v1/zz_generated.deepcopy.go	46.49%	56 Missing and 5 partials ⚠️
internal/operator-controller/applier/boxcutter.go	71.58%	33 Missing and 19 partials ⚠️
...perator-controller/rukpak/util/testing/bundlefs.go	0.00%	42 Missing ⚠️
cmd/operator-controller/main.go	74.66%	25 Missing and 13 partials ⚠️
internal/operator-controller/applier/helm.go	57.14%	10 Missing and 5 partials ⚠️
internal/operator-controller/applier/preflight.go	40.00%	8 Missing and 1 partial ⚠️
...troller/controllers/clusterextension_controller.go	94.28%	4 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1946      +/-   ##
==========================================
- Coverage   72.75%   71.87%   -0.88%     
==========================================
  Files          79       84       +5     
  Lines        7340     8132     +792     
==========================================
+ Hits         5340     5845     +505     
- Misses       1653     1892     +239     
- Partials      347      395      +48

Flag	Coverage Δ
e2e	`40.19% <14.42%> (?)`
experimental-e2e	`44.30% <58.66%> (-10.62%)`	⬇️
unit	`56.34% <41.09%> (-1.89%)`	⬇️

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.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

scripts/install.tpl.sh

…time libs Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>

Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>

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

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

Signed-off-by: Todd Short <tshort@redhat.com>

Ensure informers are started before reconciling and stopped before removing the finalizer.

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

This change accommodates the possibility of a revision that is currently rolling out, which is possible for appliers that perform rollouts asynchronously. Signed-off-by: Joe Lanford <joe.lanford@gmail.com>

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

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

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 Apr 30, 2025

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 30, 2025

joelanford reviewed Apr 30, 2025

View reviewed changes

api/v1/clusterextensionrevision_types.go Show resolved Hide resolved

joelanford reviewed Apr 30, 2025

View reviewed changes

internal/operator-controller/applier/boxcutter.go Outdated Show resolved Hide resolved

joelanford reviewed Apr 30, 2025

View reviewed changes

internal/operator-controller/applier/boxcutter.go Outdated Show resolved Hide resolved

camilamacedo86 mentioned this pull request Jun 28, 2025

✨ Add support for deploying OCI helm charts in OLM v1 #1971

Merged

4 tasks

thetechnick force-pushed the poc-boxcutter branch from 36d9cd7 to b401796 Compare July 7, 2025 13:08

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

perdasilva force-pushed the poc-boxcutter branch 2 times, most recently from 1c23866 to dc66501 Compare July 15, 2025 11:12

perdasilva changed the title ~~POC: Implement Boxcutter~~ ✨ Implement Boxcutter Jul 15, 2025

perdasilva force-pushed the poc-boxcutter branch 6 times, most recently from 35cdf3b to 370bac6 Compare July 21, 2025 16:28

tmshort reviewed Jul 21, 2025

View reviewed changes

scripts/install.tpl.sh Outdated Show resolved Hide resolved

perdasilva force-pushed the poc-boxcutter branch 9 times, most recently from 4f39c38 to 842037e Compare July 23, 2025 15:27

openshift-merge-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Aug 7, 2025

Per Goncalves da Silva and others added 18 commits August 19, 2025 16:31

Update boxcutter library to branch with latest k8s and controller-run…

7f27f0a

…time libs Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>

Update go.mod

bf6d40e

Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>

Add ClusterExtensionRevisionAPI

34b0271

Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>

Add BoxcutterRuntime featuregate

0d62842

Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>

Add Boxcutter applier

b5bc064

Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>

Add ClusterExtensionRevision controller

31decf5

Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>

Add Boxcutter runtime to main

28d572b

Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>

Remove ClusterExtensionRevision from crd-docs

bf2d076

Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>

Update hack/tools/update-crds.sh for ClusterExtensionRevision API

0a8b1e7

Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>

Generate manifests

5b17943

Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>

Remove access manager and dynamic cache

5298c4b

Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>

Update boxcutter to v0.3.0, add TrackingCache to Runnables

4ba9b2b

boxcutter webhook support

2cf1884

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

add BoxcutterRuntime feature gate to experimental release

c831c76

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

add boxcutter cluster-admin cluster role binding in boxcutter's featu…

7581b67

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

Boxcutter Preflight

dc14495

Signed-off-by: Todd Short <tshort@redhat.com>

Boxcutter Preflight mock cleanup

57382f1

Signed-off-by: Todd Short <tshort@redhat.com>

Use new TrackingCache Watch/Free.

368f8f6

Ensure informers are started before reconciling and stopped before removing the finalizer.

thetechnick force-pushed the poc-boxcutter branch from 2ce9e61 to 368f8f6 Compare August 19, 2025 14:34

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 19, 2025

joelanford added 8 commits August 20, 2025 14:19

add BoxcutterInstalledBundleGetter, plumb bundle metadata into revisi…

625b368

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

InstalledBundleGetter -> RevisionStatesGetter

671c76d

This change accommodates the possibility of a revision that is currently rolling out, which is possible for appliers that perform rollouts asynchronously. Signed-off-by: Joe Lanford <joe.lanford@gmail.com>

refactor Applier interface and improve status reporting

cad475e

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

fixup tests for applier and installedbundlegetter changes

25e74e9

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

resolve linter issues

d87bab2

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

set status for other failure modes during ClusterExtensionRevision re…

13e6283

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

TODO: fail upgrade-e2e if revision storage is unmigrated

75e3040

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

fixing broken tests after rebase

ae9d77c

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

✨ Implement Boxcutter #1946

✨ Implement Boxcutter #1946

Uh oh!

thetechnick commented Apr 30, 2025

Uh oh!

netlify bot commented Apr 30, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

joelanford Apr 30, 2025

Uh oh!

thetechnick May 12, 2025

Uh oh!

Uh oh!

codecov bot commented Jul 15, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

✨ Implement Boxcutter #1946

Are you sure you want to change the base?

✨ Implement Boxcutter #1946

Uh oh!

Conversation

thetechnick commented Apr 30, 2025

Description

Reviewer Checklist

Uh oh!

netlify bot commented Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for olmv1 ready!

Uh oh!

Uh oh!

Uh oh!

joelanford Apr 30, 2025

Choose a reason for hiding this comment

Uh oh!

thetechnick May 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov bot commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

netlify bot commented Apr 30, 2025 •

edited

Loading

codecov bot commented Jul 15, 2025 •

edited

Loading