-
Notifications
You must be signed in to change notification settings - Fork 53
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.
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
add support for handling plain+v0 bundle types #242
Merged
joelanford
merged 7 commits into
operator-framework:main
from
everettraven:feature/plain-bundle-support
Jun 8, 2023
Merged
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
40022db
implement support for plain+v0 bundles
everettraven e8773ee
address review comments
everettraven 4a9adbc
create catalog in BeforeSuite, clean up unnecessary timeout+polling
everettraven 040d8a5
address review comments
everettraven 8abcc14
missed some
everettraven 814cb19
fix rebase conflicts causing unit test failures
everettraven f0a02bc
fix rebase mishaps
everettraven File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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 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 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 |
---|---|---|
|
@@ -904,58 +904,160 @@ var _ = Describe("Operator Controller Test", func() { | |
Expect(cond.Message).To(Equal("installation has not been attempted as resolution failed")) | ||
}) | ||
}) | ||
When("an invalid semver is provided that bypasses the regex validation", func() { | ||
var ( | ||
pkgName string | ||
fakeClient client.Client | ||
) | ||
When("the operator specifies a package with a plain+v0 bundle", func() { | ||
var pkgName string | ||
var pkgVer string | ||
var pkgChan string | ||
BeforeEach(func() { | ||
opKey = types.NamespacedName{Name: fmt.Sprintf("operator-validation-test-%s", rand.String(8))} | ||
|
||
By("injecting creating a client with the bad operator CR") | ||
pkgName = fmt.Sprintf("exists-%s", rand.String(6)) | ||
By("initializing cluster state") | ||
pkgName = "plain" | ||
pkgVer = "0.1.0" | ||
pkgChan = "beta" | ||
operator = &operatorsv1alpha1.Operator{ | ||
ObjectMeta: metav1.ObjectMeta{Name: opKey.Name}, | ||
Spec: operatorsv1alpha1.OperatorSpec{ | ||
PackageName: pkgName, | ||
Version: "1.2.3-123abc_def", // bad semver that matches the regex on the CR validation | ||
Version: pkgVer, | ||
Channel: pkgChan, | ||
}, | ||
} | ||
err := cl.Create(ctx, operator) | ||
Expect(err).NotTo(HaveOccurred()) | ||
}) | ||
It("sets resolution success status", func() { | ||
By("running reconcile") | ||
res, err := reconciler.Reconcile(ctx, ctrl.Request{NamespacedName: opKey}) | ||
Expect(res).To(Equal(ctrl.Result{})) | ||
Expect(err).NotTo(HaveOccurred()) | ||
By("fetching updated operator after reconcile") | ||
Expect(cl.Get(ctx, opKey, operator)).NotTo(HaveOccurred()) | ||
|
||
// this bypasses client/server-side CR validation and allows us to test the reconciler's validation | ||
fakeClient = fake.NewClientBuilder().WithScheme(sch).WithObjects(operator).Build() | ||
By("Checking the status fields") | ||
Expect(operator.Status.ResolvedBundleResource).To(Equal("quay.io/operatorhub/plain@sha256:plain")) | ||
Expect(operator.Status.InstalledBundleResource).To(Equal("")) | ||
|
||
By("changing the reconciler client to the fake client") | ||
reconciler.Client = fakeClient | ||
}) | ||
By("checking the expected conditions") | ||
cond := apimeta.FindStatusCondition(operator.Status.Conditions, operatorsv1alpha1.TypeResolved) | ||
Expect(cond).NotTo(BeNil()) | ||
Expect(cond.Status).To(Equal(metav1.ConditionTrue)) | ||
Expect(cond.Reason).To(Equal(operatorsv1alpha1.ReasonSuccess)) | ||
Expect(cond.Message).To(Equal("resolved to \"quay.io/operatorhub/plain@sha256:plain\"")) | ||
cond = apimeta.FindStatusCondition(operator.Status.Conditions, operatorsv1alpha1.TypeInstalled) | ||
Expect(cond).NotTo(BeNil()) | ||
Expect(cond.Status).To(Equal(metav1.ConditionUnknown)) | ||
Expect(cond.Reason).To(Equal(operatorsv1alpha1.ReasonInstallationStatusUnknown)) | ||
Expect(cond.Message).To(Equal("bundledeployment status is unknown")) | ||
|
||
It("should add an invalid spec condition and *not* re-enqueue for reconciliation", func() { | ||
By("fetching the bundled deployment") | ||
bd := &rukpakv1alpha1.BundleDeployment{} | ||
Expect(cl.Get(ctx, types.NamespacedName{Name: opKey.Name}, bd)).NotTo(HaveOccurred()) | ||
Expect(bd.Spec.ProvisionerClassName).To(Equal("core-rukpak-io-plain")) | ||
Expect(bd.Spec.Template.Spec.ProvisionerClassName).To(Equal("core-rukpak-io-plain")) | ||
Expect(bd.Spec.Template.Spec.Source.Type).To(Equal(rukpakv1alpha1.SourceTypeImage)) | ||
Expect(bd.Spec.Template.Spec.Source.Image).NotTo(BeNil()) | ||
Expect(bd.Spec.Template.Spec.Source.Image.Ref).To(Equal("quay.io/operatorhub/plain@sha256:plain")) | ||
}) | ||
}) | ||
When("the operator specifies a package with a bad bundle mediatype", func() { | ||
var pkgName string | ||
var pkgVer string | ||
var pkgChan string | ||
BeforeEach(func() { | ||
By("initializing cluster state") | ||
pkgName = "badmedia" | ||
pkgVer = "0.1.0" | ||
pkgChan = "beta" | ||
operator = &operatorsv1alpha1.Operator{ | ||
ObjectMeta: metav1.ObjectMeta{Name: opKey.Name}, | ||
Spec: operatorsv1alpha1.OperatorSpec{ | ||
PackageName: pkgName, | ||
Version: pkgVer, | ||
Channel: pkgChan, | ||
}, | ||
} | ||
err := cl.Create(ctx, operator) | ||
Expect(err).NotTo(HaveOccurred()) | ||
}) | ||
It("sets resolution success status", func() { | ||
By("running reconcile") | ||
res, err := reconciler.Reconcile(ctx, ctrl.Request{NamespacedName: opKey}) | ||
Expect(res).To(Equal(ctrl.Result{})) | ||
Expect(err).ToNot(HaveOccurred()) | ||
Expect(err).To(HaveOccurred()) | ||
Expect(err.Error()).To(Equal("unknown bundle mediatype: badmedia+v1")) | ||
|
||
By("fetching updated operator after reconcile") | ||
Expect(fakeClient.Get(ctx, opKey, operator)).NotTo(HaveOccurred()) | ||
Expect(cl.Get(ctx, opKey, operator)).NotTo(HaveOccurred()) | ||
|
||
By("Checking the status fields") | ||
Expect(operator.Status.ResolvedBundleResource).To(Equal("")) | ||
Expect(operator.Status.ResolvedBundleResource).To(Equal("quay.io/operatorhub/badmedia@sha256:badmedia")) | ||
Expect(operator.Status.InstalledBundleResource).To(Equal("")) | ||
|
||
By("checking the expected conditions") | ||
cond := apimeta.FindStatusCondition(operator.Status.Conditions, operatorsv1alpha1.TypeResolved) | ||
Expect(cond).NotTo(BeNil()) | ||
Expect(cond.Status).To(Equal(metav1.ConditionUnknown)) | ||
Expect(cond.Reason).To(Equal(operatorsv1alpha1.ReasonResolutionUnknown)) | ||
Expect(cond.Message).To(Equal("validation has not been attempted as spec is invalid")) | ||
Expect(cond.Status).To(Equal(metav1.ConditionTrue)) | ||
Expect(cond.Reason).To(Equal(operatorsv1alpha1.ReasonSuccess)) | ||
Expect(cond.Message).To(Equal("resolved to \"quay.io/operatorhub/badmedia@sha256:badmedia\"")) | ||
cond = apimeta.FindStatusCondition(operator.Status.Conditions, operatorsv1alpha1.TypeInstalled) | ||
Expect(cond).NotTo(BeNil()) | ||
Expect(cond.Status).To(Equal(metav1.ConditionUnknown)) | ||
Expect(cond.Reason).To(Equal(operatorsv1alpha1.ReasonInstallationStatusUnknown)) | ||
Expect(cond.Message).To(Equal("installation has not been attempted as spec is invalid")) | ||
Expect(cond.Status).To(Equal(metav1.ConditionFalse)) | ||
Expect(cond.Reason).To(Equal(operatorsv1alpha1.ReasonInstallationFailed)) | ||
Expect(cond.Message).To(Equal("unknown bundle mediatype: badmedia+v1")) | ||
}) | ||
}) | ||
}) | ||
When("an invalid semver is provided that bypasses the regex validation", func() { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This may have been missed in the merge. I moved this in #257. |
||
var ( | ||
operator *operatorsv1alpha1.Operator | ||
opKey types.NamespacedName | ||
pkgName string | ||
fakeClient client.Client | ||
) | ||
BeforeEach(func() { | ||
opKey = types.NamespacedName{Name: fmt.Sprintf("operator-validation-test-%s", rand.String(8))} | ||
|
||
By("injecting creating a client with the bad operator CR") | ||
pkgName = fmt.Sprintf("exists-%s", rand.String(6)) | ||
operator = &operatorsv1alpha1.Operator{ | ||
ObjectMeta: metav1.ObjectMeta{Name: opKey.Name}, | ||
Spec: operatorsv1alpha1.OperatorSpec{ | ||
PackageName: pkgName, | ||
Version: "1.2.3-123abc_def", // bad semver that matches the regex on the CR validation | ||
}, | ||
} | ||
|
||
// this bypasses client/server-side CR validation and allows us to test the reconciler's validation | ||
fakeClient = fake.NewClientBuilder().WithScheme(sch).WithObjects(operator).Build() | ||
|
||
By("changing the reconciler client to the fake client") | ||
reconciler.Client = fakeClient | ||
}) | ||
|
||
It("should add an invalid spec condition and *not* re-enqueue for reconciliation", func() { | ||
By("running reconcile") | ||
res, err := reconciler.Reconcile(ctx, ctrl.Request{NamespacedName: opKey}) | ||
Expect(res).To(Equal(ctrl.Result{})) | ||
Expect(err).ToNot(HaveOccurred()) | ||
|
||
By("fetching updated operator after reconcile") | ||
Expect(fakeClient.Get(ctx, opKey, operator)).NotTo(HaveOccurred()) | ||
|
||
By("Checking the status fields") | ||
Expect(operator.Status.ResolvedBundleResource).To(Equal("")) | ||
Expect(operator.Status.InstalledBundleResource).To(Equal("")) | ||
|
||
By("checking the expected conditions") | ||
cond := apimeta.FindStatusCondition(operator.Status.Conditions, operatorsv1alpha1.TypeResolved) | ||
Expect(cond).NotTo(BeNil()) | ||
Expect(cond.Status).To(Equal(metav1.ConditionUnknown)) | ||
Expect(cond.Reason).To(Equal(operatorsv1alpha1.ReasonResolutionUnknown)) | ||
Expect(cond.Message).To(Equal("validation has not been attempted as spec is invalid")) | ||
cond = apimeta.FindStatusCondition(operator.Status.Conditions, operatorsv1alpha1.TypeInstalled) | ||
Expect(cond).NotTo(BeNil()) | ||
Expect(cond.Status).To(Equal(metav1.ConditionUnknown)) | ||
Expect(cond.Reason).To(Equal(operatorsv1alpha1.ReasonInstallationStatusUnknown)) | ||
Expect(cond.Message).To(Equal("installation has not been attempted as spec is invalid")) | ||
}) | ||
}) | ||
}) | ||
|
||
|
@@ -1000,4 +1102,18 @@ var testEntitySource = input.NewCacheQuerier(map[deppy.Identifier]input.Entity{ | |
"olm.package": `{"packageName":"badimage","version":"0.1.0"}`, | ||
"olm.gvk": `[]`, | ||
}), | ||
"operatorhub/plain/0.1.0": *input.NewEntity("operatorhub/plain/0.1.0", map[string]string{ | ||
"olm.bundle.path": `"quay.io/operatorhub/plain@sha256:plain"`, | ||
"olm.channel": `{"channelName":"beta","priority":0}`, | ||
"olm.package": `{"packageName":"plain","version":"0.1.0"}`, | ||
"olm.gvk": `[]`, | ||
"olm.bundle.mediatype": `"plain+v0"`, | ||
}), | ||
"operatorhub/badmedia/0.1.0": *input.NewEntity("operatorhub/badmedia/0.1.0", map[string]string{ | ||
"olm.bundle.path": `"quay.io/operatorhub/badmedia@sha256:badmedia"`, | ||
"olm.channel": `{"channelName":"beta","priority":0}`, | ||
"olm.package": `{"packageName":"badmedia","version":"0.1.0"}`, | ||
"olm.gvk": `[]`, | ||
"olm.bundle.mediatype": `"badmedia+v1"`, | ||
}), | ||
}) |
This file contains 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 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
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.
This isn't new code for this PR but ... why not use SSA?
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.
Looks like it does here:
operator-controller/internal/controllers/operator_controller.go
Line 324 in 22afecf
generateExpectedBundleDeployment
is generating anunstructured.Unstructured
to use for that patch request. I'd be curious to see if it is worth it to create applyconfigurations for the rukpak APIs to improve the creation of the patch information hereThere 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 updated the generators upstream so you should get those free with newer codegen tools. I do think the apply you linked will be SSA - and the defaults worries from this block should be obviated.
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.
Watching this closely :) kubernetes-sigs/controller-tools#818