Skip to content

✨ OPRUN-4112: Add config support with jsonschema validation [WIP] #2177

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
Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

✨ OPRUN-4112: Add config support with jsonschema validation [WIP] #2177

wants to merge 1 commit into from
+511 −1

Conversation

perdasilva
Copy link
Contributor

Description

Reviewer Checklist

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

@openshift-ci 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 Aug 29, 2025
@perdasilva perdasilva changed the title ✨ Add config support with jsonschema validation ✨ Add config support with jsonschema validation [WIP] Aug 29, 2025
@netlify Netlify
Copy link

netlify bot commented Aug 29, 2025 •
edited
Loading

✅ Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit 16bb72e
🔍 Latest deploy log https://app.netlify.com/projects/olmv1/deploys/68b8648376dc7200086045a9
😎 Deploy Preview https://deploy-preview-2177--olmv1.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@codecov Codecov
Copy link

codecov bot commented Aug 29, 2025 •
edited
Loading

Codecov Report

❌ Patch coverage is 80.00000% with 30 lines in your changes missing coverage. Please review.
✅ Project coverage is 72.90%. Comparing base (5d6e431) to head (16bb72e).
⚠️ Report is 7 commits behind head on main.

Files with missing lines Patch % Lines
...ternal/operator-controller/rukpak/bundle/config.go 80.00% 19 Missing and 11 partials ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #2177      +/-   ##
==========================================
+ Coverage   72.73%   72.90%   +0.17%     
==========================================
  Files          79       80       +1     
  Lines        7391     7541     +150     
==========================================
+ Hits         5376     5498     +122     
- Misses       1667     1685      +18     
- Partials      348      358      +10
Flag Coverage Δ
e2e 43.20% <0.00%> (-1.02%) ⬇️
experimental-e2e 54.98% <0.00%> (-1.20%) ⬇️
unit 58.70% <80.00%> (+0.41%) ⬆️

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.

@perdasilva perdasilva force-pushed the config-support-converter branch 4 times, most recently from 1d44a8f to 86f8c3a Compare September 3, 2025 14:26
@perdasilva perdasilva changed the title ✨ Add config support with jsonschema validation [WIP] ✨ OPRUN-4112: Add config support with jsonschema validation [WIP] Sep 3, 2025
@perdasilva perdasilva force-pushed the config-support-converter branch from 86f8c3a to 3a81ef9 Compare September 3, 2025 14:50
@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Sep 3, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign tmshort for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Add config support with jsonschema validation
16bb72e 
Signed-off-by: Per Goncalves da Silva <[email protected]>
@perdasilva perdasilva force-pushed the config-support-converter branch from 3a81ef9 to 16bb72e Compare September 3, 2025 15:53
joelanford
joelanford reviewed Sep 3, 2025
View reviewed changes
internal/operator-controller/rukpak/bundle/config.go
// WatchNamespace is supported for certain bundles to allow the user to configure installation in Single- or OwnNamespace modes
// The validation behavior of this field is determined by the install modes supported by the bundle, e.g.:
// - If a bundle only supports AllNamespaces mode (or only OwnNamespace mode): this field will be unknown
// - If a bundle supports AllNamespaces and SingleNamespace install modes: this field is optional
Copy link
Member

@joelanford joelanford Sep 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
// - If a bundle supports AllNamespaces and SingleNamespace install modes: this field is optional
// - If a bundle supports AllNamespaces and SingleNamespace install modes: this field is optional and must NOT be equal to the install namespace.
// - If a bundle supports AllNamespaces, OwnNamespace, and SingleNamespace install modes: this field is optional.

joelanford
joelanford reviewed Sep 3, 2025
View reviewed changes
internal/operator-controller/rukpak/bundle/config.go
ownSupported := supportedInstallModes.Has(v1alpha1.InstallModeTypeOwnNamespace)

if len(supportedInstallModes) == 0 {
panic("bundle does not support any supported install modes")
Copy link
Member

Choose a reason for hiding this comment

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

Panic-ing here seems drastic, unless there's some other precondition check that would guarantee that the bundle has at least one supported install mode.

If we do have a precondition check, maybe beef up the panic message with something like:

Suggested change
panic("bundle does not support any supported install modes")
panic("programmer error: bundle validation should have guaranteed support for at least one install mode, but found no supported install modes")

@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 4, 2025
@openshift-merge-robot
Copy link

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joelanford joelanford joelanford left review comments

Assignees
No one assigned
Labels
do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@perdasilva @openshift-merge-robot @joelanford