fix: kube-core::Schema hoisting logic #1

sbernauer · 2025-10-08T13:58:31Z

Fixes kube Schema conversion since schemars Schema's have changed.

Add tests for a variety of enum use-cases:
- Tagged vs Untagged
- Unit vs Tuple vs Structural variants
- With and without doc-comments (descriptions)
Rewrite the hoisting logic
- This is annotated with dev-comments to help understand intend and to ease future schemars changes.

This also fixes other issues:

Untagged enum variant doc-comments were being applied to field descriptions.
Additional null entry added to enums.

kube-core/src/schema.rs

Note: As described on the function, it is overly documented to express intent where it can be a little unclear. Ideally where would be some clearer official Kubernetes documentation on the differences between regular OpenAPI 3 schemas, and what Kubernetes accepts.

… there are no oneOfs at the top level of the schema

Note: At this point, there is some strange interaction with the new hoisting functions and the existing code whereby "properties" disappear.

kube-core/src/schema.rs

…l as enum All tests in this PR are passing Note: The function should be renamed, but it needs some work to not only do optional things.

…behavior

These include tests for a variety of schemas

kube-core/src/schema/transform_any_of.rs

stackable-cla · 2025-10-28T09:18:46Z

All committers have signed the CLA.

Techassi

Mostly looks good to me, just a few questions and comments.

kube-core/src/schema/transform_any_of.rs

kube-core/src/schema/transform_optional_enum_with_null.rs

kube-core/src/schema/transform_properties.rs

kube-derive/src/custom_resource.rs

kube-derive/tests/crd_complex_enum_tests.rs

kube-derive/tests/crd_mixed_enum_test.rs

Co-authored-by: Techassi <git@techassi.dev>

This reverts commit dcbe17e.

Fixes kube Schema conversion since schemars Schema's have changed. - Add tests for a variety of enum use-cases: - Tagged vs Untagged - Unit vs Tuple vs Structural variants - With and without doc-comments (descriptions) - Rewrite the hoisting logic - This is annotated with dev-comments to help understand intend and to ease future schemars changes. This also fixes other issues: - Untagged enum variant doc-comments were being applied to field descriptions. - Additional `null` entry added to enums. --------- Co-authored-by: Nick Larsen <nick.larsen@stackable.tech> Co-authored-by: Sebastian Bernauer <sebastian.bernauer@stackable.tech> Co-authored-by: Techassi <git@techassi.dev>

Fixes kube Schema conversion since schemars Schema's have changed. - Add tests for a variety of enum use-cases: - Tagged vs Untagged - Unit vs Tuple vs Structural variants - With and without doc-comments (descriptions) - Rewrite the hoisting logic - This is annotated with dev-comments to help understand intend and to ease future schemars changes. This also fixes other issues: - Untagged enum variant doc-comments were being applied to field descriptions. - Additional `null` entry added to enums. --------- Co-authored-by: Nick Larsen <nick.larsen@stackable.tech> Co-authored-by: Sebastian Bernauer <sebastian.bernauer@stackable.tech> Co-authored-by: Techassi <git@techassi.dev> Signed-off-by: Nick Larsen <nick.larsen@stackable.tech>

sbernauer self-assigned this Oct 8, 2025

sbernauer added this to Stackable Engineering Oct 8, 2025

sbernauer moved this to Development: In Progress in Stackable Engineering Oct 8, 2025

Add some tests for CRD generation for enums

295c431

sbernauer force-pushed the test/add-enum-tests branch from 6480fee to 295c431 Compare October 8, 2025 14:06

sbernauer mentioned this pull request Oct 8, 2025

Add some tests for CRD generation for enums kube-rs/kube#1832

Closed

sbernauer and others added 4 commits October 9, 2025 14:27

Update assertions to valid CRDs from kube 1.1.0

13db30c

test: Add some un-documented variants to the NormalEnum

fb77413

test: Partial new impl for one_of hoisting

0cb62f1

Finish enum oneOf hoisting

85eaf36

sbernauer closed this Oct 9, 2025

sbernauer reopened this Oct 9, 2025

NickLarsenNZ reviewed Oct 9, 2025

View reviewed changes

kube-core/src/schema.rs Outdated Show resolved Hide resolved

NickLarsenNZ reviewed Oct 9, 2025

View reviewed changes

kube-core/src/schema.rs Outdated Show resolved Hide resolved

NickLarsenNZ added 6 commits October 10, 2025 13:02

test: Add more basic testing to ensure hoisting is not performed when…

e256f3a

… there are no oneOfs at the top level of the schema

hoist anyOf optional enums

35034c5

left a todo for empty structural variants in untagged enums

3850a19

test: Add missing enum entries to expected schemas

c2fbe70

test: Add empty object handling to existing hoisting function

8abef36

Note: At this point, there is some strange interaction with the new hoisting functions and the existing code whereby "properties" disappear.

NickLarsenNZ reviewed Oct 10, 2025

View reviewed changes

kube-core/src/schema.rs Outdated Show resolved Hide resolved

NickLarsenNZ reviewed Oct 10, 2025

View reviewed changes

kube-core/src/schema.rs Outdated Show resolved Hide resolved

NickLarsenNZ reviewed Oct 10, 2025

View reviewed changes

kube-core/src/schema.rs Outdated Show resolved Hide resolved

NickLarsenNZ added 2 commits October 14, 2025 16:13

fix: Change hoist_any_of_option_enum to cater to nested any_of as wel…

8f578c2

…l as enum All tests in this PR are passing Note: The function should be renamed, but it needs some work to not only do optional things.

test: Add test for internal function, and add docs after seeing it's …

c23aabc

…behavior

This comment was marked as outdated.

Sign in to view

NickLarsenNZ added 4 commits October 21, 2025 22:23

feat: Add functions for specific hoisting tasks

e91665b

These include tests for a variety of schemas

chore: Add a crude fix to code that will be removed in a later commit

f13a751

fix: update changed function name in tests

730e0db

chore: Make new hoisting functions pub(crate)

7503fcc

NickLarsenNZ changed the base branch from main to fix/schema-hoisting October 28, 2025 07:36

Move tests into own "tests" module

9c19f10

sbernauer commented Oct 28, 2025

View reviewed changes

kube-core/src/schema/transform_any_of.rs Outdated Show resolved Hide resolved

sbernauer and others added 2 commits October 28, 2025 09:39

Move null schema into NULL_SCHEMA static

1ce7e47

refactor: use more descriptive variable names

9eaedbb

NickLarsenNZ force-pushed the fix/schema-hoisting branch from 7c63f56 to 45f9c9b Compare October 28, 2025 09:00

NickLarsenNZ force-pushed the test/add-enum-tests branch from b5fef7a to 9eaedbb Compare October 28, 2025 09:30

Techassi reviewed Oct 28, 2025

View reviewed changes

stackabletech deleted a comment from OpenDev-StockholmUni Oct 28, 2025

NickLarsenNZ and others added 9 commits October 28, 2025 12:33

Apply suggestions from code review

0477fd0

Co-authored-by: Techassi <git@techassi.dev>

refactor: Replace panic with pattern match

a237e1e

refactor: Simplify description preservation and type dropping

dcbe17e

refactor: Simplify the getting or defaulting of the parent object

acf3d57

refactor: Reorder test enums

925a8e3

docs: Revise doc comments

11a8ddc

Revert "refactor: Simplify description preservation and type dropping"

26146ea

This reverts commit dcbe17e.

refactor: Revise code after reverting

75c7ffa

test: Rework tests that check that the CRDs are valid

2055029

NickLarsenNZ requested a review from Techassi October 28, 2025 13:15

Techassi mentioned this pull request Oct 28, 2025

chore: Bump Rust dependencies pre-25.11.0 stackabletech/nifi-operator#859

Merged

5 tasks

Techassi approved these changes Oct 28, 2025

View reviewed changes

NickLarsenNZ merged commit 6938fad into fix/schema-hoisting Oct 28, 2025
13 of 16 checks passed

NickLarsenNZ moved this from Development: In Review to Development: Done in Stackable Engineering Oct 28, 2025

adwk67 mentioned this pull request Oct 28, 2025

chore: Bump Rust dependencies pre-25.11.0 stackabletech/spark-k8s-operator#622

Merged

5 tasks

Techassi mentioned this pull request Oct 28, 2025

chore: Bump Rust dependencies pre-25.11.0 stackabletech/trino-operator#810

Merged

5 tasks

NickLarsenNZ mentioned this pull request Oct 29, 2025

fix: kube-core::Schema hoisting logic kube-rs/kube#1839

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix: kube-core::Schema hoisting logic #1

fix: kube-core::Schema hoisting logic #1

Uh oh!

sbernauer commented Oct 8, 2025 •

edited by NickLarsenNZ

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

stackable-cla bot commented Oct 28, 2025 •

edited

Loading

Uh oh!

Techassi left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

fix: kube-core::Schema hoisting logic #1

fix: kube-core::Schema hoisting logic #1

Uh oh!

Conversation

sbernauer commented Oct 8, 2025 • edited by NickLarsenNZ Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

stackable-cla bot commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Techassi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sbernauer commented Oct 8, 2025 •

edited by NickLarsenNZ

Loading

stackable-cla bot commented Oct 28, 2025 •

edited

Loading