⚠️ updates from api audit #1404
Merged
Conversation
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
openshift-ci
bot
added
the
do-not-merge/work-in-progress
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1404 +/- ##
==========================================
- Coverage 75.18% 74.88% -0.31%
==========================================
Files 42 42
Lines 3236 3237 +1
==========================================
- Hits 2433 2424 -9
- Misses 632 640 +8
- Partials 171 173 +2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
config/base/crd/bases/olm.operatorframework.io_clusterextensions.yaml
Outdated
Show resolved
Hide resolved
grokspawn
force-pushed
the
api-audit-updates
branch
from
b7e2f01 to
ae86221
Compare
perdasilva
reviewed
Nov 5, 2024
| @@ -258,7 +264,7 @@ type CatalogSource struct { | |||
| // For more information on semver, please see https://semver.org/ | |||
| // | |||
| //+kubebuilder:validation:MaxLength:=64 | |||
| //+kubebuilder:validation:Pattern=`^(\s*(=||!=|>|<|>=|=>|<=|=<|~|~>|\^)\s*(v?(0|[1-9]\d*|[x|X|\*])(\.(0|[1-9]\d*|x|X|\*]))?(\.(0|[1-9]\d*|x|X|\*))?(-([0-9A-Za-z\-]+(\.[0-9A-Za-z\-]+)*))?(\+([0-9A-Za-z\-]+(\.[0-9A-Za-z\-]+)*))?)\s*)((?:\s+|,\s*|\s*\|\|\s*)(=||!=|>|<|>=|=>|<=|=<|~|~>|\^)\s*(v?(0|[1-9]\d*|x|X|\*])(\.(0|[1-9]\d*|x|X|\*))?(\.(0|[1-9]\d*|x|X|\*]))?(-([0-9A-Za-z\-]+(\.[0-9A-Za-z\-]+)*))?(\+([0-9A-Za-z\-]+(\.[0-9A-Za-z\-]+)*))?)\s*)*$` | |||
| //+kubebuilder:validation.XValidation:rule="self.matches(r'^(\s*(=||!=|>|<|>=|=>|<=|=<|~|~>|\^)\s*(v?(0|[1-9]\d*|[x|X|\*])(\.(0|[1-9]\d*|x|X|\*]))?(\.(0|[1-9]\d*|x|X|\*))?(-([0-9A-Za-z\-]+(\.[0-9A-Za-z\-]+)*))?(\+([0-9A-Za-z\-]+(\.[0-9A-Za-z\-]+)*))?)\s*)((?:\s+|,\s*|\s*\|\|\s*)(=||!=|>|<|>=|=>|<=|=<|~|~>|\^)\s*(v?(0|[1-9]\d*|x|X|\*])(\.(0|[1-9]\d*|x|X|\*))?(\.(0|[1-9]\d*|x|X|\*]))?(-([0-9A-Za-z\-]+(\.[0-9A-Za-z\-]+)*))?(\+([0-9A-Za-z\-]+(\.[0-9A-Za-z\-]+)*))?)\s*)*$')"", message="invalid version expression in the catalog source" | |||
There was a problem hiding this comment.
Is the error message correct here?
There was a problem hiding this comment.
We don't need to say "in the catalog source" because the error emitted by the validator includes the parent path leading up to this field.
Suggested change
| //+kubebuilder:validation.XValidation:rule="self.matches(r'^(\s*(=||!=|>|<|>=|=>|<=|=<|~|~>|\^)\s*(v?(0|[1-9]\d*|[x|X|\*])(\.(0|[1-9]\d*|x|X|\*]))?(\.(0|[1-9]\d*|x|X|\*))?(-([0-9A-Za-z\-]+(\.[0-9A-Za-z\-]+)*))?(\+([0-9A-Za-z\-]+(\.[0-9A-Za-z\-]+)*))?)\s*)((?:\s+|,\s*|\s*\|\|\s*)(=||!=|>|<|>=|=>|<=|=<|~|~>|\^)\s*(v?(0|[1-9]\d*|x|X|\*])(\.(0|[1-9]\d*|x|X|\*))?(\.(0|[1-9]\d*|x|X|\*]))?(-([0-9A-Za-z\-]+(\.[0-9A-Za-z\-]+)*))?(\+([0-9A-Za-z\-]+(\.[0-9A-Za-z\-]+)*))?)\s*)*$')"", message="invalid version expression in the catalog source" | |
| //+kubebuilder:validation.XValidation:rule="self.matches(r'^(\s*(=||!=|>|<|>=|=>|<=|=<|~|~>|\^)\s*(v?(0|[1-9]\d*|[x|X|\*])(\.(0|[1-9]\d*|x|X|\*]))?(\.(0|[1-9]\d*|x|X|\*))?(-([0-9A-Za-z\-]+(\.[0-9A-Za-z\-]+)*))?(\+([0-9A-Za-z\-]+(\.[0-9A-Za-z\-]+)*))?)\s*)((?:\s+|,\s*|\s*\|\|\s*)(=||!=|>|<|>=|=>|<=|=<|~|~>|\^)\s*(v?(0|[1-9]\d*|x|X|\*])(\.(0|[1-9]\d*|x|X|\*))?(\.(0|[1-9]\d*|x|X|\*]))?(-([0-9A-Za-z\-]+(\.[0-9A-Za-z\-]+)*))?(\+([0-9A-Za-z\-]+(\.[0-9A-Za-z\-]+)*))?)\s*)*$')"", message="invalid version expression" |
There was a problem hiding this comment.
The error message here definitely seems a bit vague to me. Could we update the message to also include some helpful information for crafting a valid version expression?
There was a problem hiding this comment.
What do you have in mind? I was specifically modeling after https://github.com/openshift/api/blob/4f6053f954b069f7fea5788d4307f4213db53678/config/v1alpha1/types_image_policy.go#L56-L60
grokspawn
force-pushed
the
api-audit-updates
branch
from
ae86221 to
7a14b4d
Compare
everettraven
reviewed
Nov 6, 2024
everettraven
reviewed
Nov 6, 2024
everettraven
reviewed
Nov 6, 2024
everettraven
reviewed
Nov 6, 2024
joelanford
reviewed
Nov 6, 2024
joelanford
reviewed
Nov 6, 2024
everettraven
reviewed
Nov 6, 2024
everettraven
reviewed
Nov 6, 2024
everettraven
reviewed
Nov 6, 2024
joelanford
reviewed
Nov 6, 2024
internal/applier/helm.go
Outdated
| func shouldSkipPreflight(preflight Preflight, ctx context.Context, ext *ocv1alpha1.ClusterExtension, state string) bool { | ||
| l := log.FromContext(ctx) | ||
| if ext.Spec.Install.Preflight != nil && ext.Spec.Install.Preflight.CRDUpgradeSafety != nil { | ||
| if _, ok := preflight.(*crdupgradesafety.Preflight); ok { |
There was a problem hiding this comment.
Maybe move this line out to the calling function, probably a more appropriate place for it, and might solve the linter concern around nested blocks.
There was a problem hiding this comment.
I resolved this by externalizing the conditions somewhat, but still putting all the 'CRDUpgradeSafety' checks in one place.
My assertion is still that this kind of thing should be exposed via an interface.
everettraven
reviewed
Nov 6, 2024
everettraven
reviewed
Nov 6, 2024
grokspawn
force-pushed
the
api-audit-updates
branch
6 times, most recently
from
f04b254 to
237bcf6
Compare
openshift-merge-robot
added
the
needs-rebase
grokspawn
force-pushed
the
api-audit-updates
branch
from
237bcf6 to
a3684a6
Compare
everettraven
reviewed
Nov 7, 2024
everettraven
reviewed
Nov 7, 2024
everettraven
reviewed
Nov 7, 2024
everettraven
reviewed
Nov 7, 2024
everettraven
reviewed
Nov 7, 2024
everettraven
reviewed
Nov 7, 2024
everettraven
reviewed
Nov 7, 2024
everettraven
reviewed
Nov 7, 2024
everettraven
reviewed
Nov 8, 2024
everettraven
reviewed
Nov 8, 2024
grokspawn
force-pushed
the
api-audit-updates
branch
from
18552d0 to
22ef06f
Compare
Signed-off-by: Jordan Keister <jordan@nimblewidget.com>
grokspawn
force-pushed
the
api-audit-updates
branch
from
22ef06f to
8189015
Compare
4 tasks
|
New changes are detected. LGTM label has been removed. |
everettraven
approved these changes
Nov 8, 2024
Merged
via the queue into
operator-framework:main
with commit Nov 8, 2024
6c2be08
16 of 19 checks passed
|
Solves #1426 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is API changes in preparation for our v1.0 release, mostly from the openshift API team's audit but also from feedback from the maintainers and community.
It is expected that this PR contains breaking changes as we prepare (tightening types, enhancing docs, etc.) for the release.
Description
Reviewer Checklist