Skip to content

kube-derive: Add additional CRD tests #1921

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

Merged
clux merged 1 commit into from
Jan 29, 2026
Merged

kube-derive: Add additional CRD tests #1921

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
387 changes: 387 additions & 0 deletions kube-derive/tests/crd_complex_enum_test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,387 @@
#![allow(missing_docs)]

use assert_json_diff::assert_json_eq;
use kube::{CustomResource, CustomResourceExt};
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use serde_json::json;

// Enum definitions

/// A very simple enum with unit variants
#[derive(Serialize, Deserialize, Debug, Clone, JsonSchema)]
enum NormalEnum {
/// First variant
A,
/// Second variant
B,

// No doc-comments on these variants
C,
D,
}

#[derive(Serialize, Deserialize, Debug, Clone, JsonSchema)]
pub enum NormalEnumWithoutDescriptions {
A,
B,
C,
D,
}

/// A complex enum with tuple and struct variants
#[derive(Serialize, Deserialize, Debug, Clone, JsonSchema)]
enum ComplexEnum {
/// Override documentation on the Normal variant
Normal(NormalEnum),

/// Documentation on the Hardcore variant
Hardcore {
hard: String,
core: NormalEnum,
without_description: NormalEnumWithoutDescriptions,
},
}

// CRD definitions

#[derive(CustomResource, Serialize, Deserialize, Debug, Clone, JsonSchema)]
#[kube(group = "clux.dev", version = "v1", kind = "NormalEnumTest")]
struct NormalEnumTestSpec {
foo: NormalEnum,
}

#[derive(CustomResource, Serialize, Deserialize, Debug, Clone, JsonSchema)]
#[kube(group = "clux.dev", version = "v1", kind = "OptionalEnumTest")]
struct OptionalEnumTestSpec {
foo: Option<NormalEnum>,
}

#[derive(CustomResource, Serialize, Deserialize, Debug, Clone, JsonSchema)]
#[kube(
group = "clux.dev",
version = "v1",
kind = "NormalEnumWithoutDescriptionsTest"
)]
struct NormalEnumWithoutDescriptionsTestSpec {
foo: NormalEnumWithoutDescriptions,
}

#[derive(CustomResource, Serialize, Deserialize, Debug, Clone, JsonSchema)]
#[kube(group = "clux.dev", version = "v1", kind = "ComplexEnumTest")]
struct ComplexEnumTestSpec {
foo: ComplexEnum,
}

#[test]
fn complex_enum() {
assert_json_eq!(
ComplexEnumTest::crd(),
json!(
{
"apiVersion": "apiextensions.k8s.io/v1",
"kind": "CustomResourceDefinition",
"metadata": {
"name": "complexenumtests.clux.dev"
},
"spec": {
"group": "clux.dev",
"names": {
"categories": [],
"kind": "ComplexEnumTest",
"plural": "complexenumtests",
"shortNames": [],
"singular": "complexenumtest"
},
"scope": "Cluster",
"versions": [
{
"additionalPrinterColumns": [],
"name": "v1",
"schema": {
"openAPIV3Schema": {
"description": "Auto-generated derived type for ComplexEnumTestSpec via `CustomResource`",
"properties": {
"spec": {
"properties": {
"foo": {
"description": "A complex enum with tuple and struct variants",
"oneOf": [
{
"required": [
"Normal"
]
},
{
"required": [
"Hardcore"
]
}
],
"properties": {
"Hardcore": {
"description": "Documentation on the Hardcore variant",
"properties": {
"core": {
"description": "A very simple enum with unit variants",
"enum": [
"C",
"D",
"A",
"B"
],
"type": "string"
},
"hard": {
"type": "string"
},
"without_description": {
"enum": [
"A",
"B",
"C",
"D"
],
"type": "string"
}
},
"required": [
"core",
"hard",
"without_description"
],
"type": "object"
},
"Normal": {
"description": "Override documentation on the Normal variant",
"enum": [
"C",
"D",
"A",
"B"
],
"type": "string"
}
},
"type": "object"
}
},
"required": [
"foo"
],
"type": "object"
}
},
"required": [
"spec"
],
"title": "ComplexEnumTest",
"type": "object"
}
},
"served": true,
"storage": true,
"subresources": {}
}
]
}
}
)
);
}

#[test]
fn normal_enum() {
assert_json_eq!(
NormalEnumTest::crd(),
json!(
{
"apiVersion": "apiextensions.k8s.io/v1",
"kind": "CustomResourceDefinition",
"metadata": {
"name": "normalenumtests.clux.dev"
},
"spec": {
"group": "clux.dev",
"names": {
"categories": [],
"kind": "NormalEnumTest",
"plural": "normalenumtests",
"shortNames": [],
"singular": "normalenumtest"
},
"scope": "Cluster",
"versions": [
{
"additionalPrinterColumns": [],
"name": "v1",
"schema": {
"openAPIV3Schema": {
"description": "Auto-generated derived type for NormalEnumTestSpec via `CustomResource`",
"properties": {
"spec": {
"properties": {
"foo": {
"description": "A very simple enum with unit variants",
"enum": [
"C",
"D",
"A",
"B"
],
"type": "string"
}
},
"required": [
"foo"
],
"type": "object"
}
},
"required": [
"spec"
],
"title": "NormalEnumTest",
"type": "object"
}
},
"served": true,
"storage": true,
"subresources": {}
}
]
}
}
)
);
}

#[test]
fn optional_enum() {
assert_json_eq!(
OptionalEnumTest::crd(),
json!(
{
"apiVersion": "apiextensions.k8s.io/v1",
"kind": "CustomResourceDefinition",
"metadata": {
"name": "optionalenumtests.clux.dev"
},
"spec": {
"group": "clux.dev",
"names": {
"categories": [],
"kind": "OptionalEnumTest",
"plural": "optionalenumtests",
"shortNames": [],
"singular": "optionalenumtest"
},
"scope": "Cluster",
"versions": [
{
"additionalPrinterColumns": [],
"name": "v1",
"schema": {
"openAPIV3Schema": {
"description": "Auto-generated derived type for OptionalEnumTestSpec via `CustomResource`",
"properties": {
"spec": {
"properties": {
"foo": {
"description": "A very simple enum with unit variants",
"enum": [
"C",
"D",
"A",
"B"
],
"nullable": true,
"type": "string"
}
},
"type": "object"
}
},
"required": [
"spec"
],
"title": "OptionalEnumTest",
"type": "object"
}
},
"served": true,
"storage": true,
"subresources": {}
}
]
}
}
)
);
}


#[test]
fn normal_enum_without_descriptions() {
assert_json_eq!(
NormalEnumWithoutDescriptionsTest::crd(),
json!(
{
"apiVersion": "apiextensions.k8s.io/v1",
"kind": "CustomResourceDefinition",
"metadata": {
"name": "normalenumwithoutdescriptionstests.clux.dev"
},
"spec": {
"group": "clux.dev",
"names": {
"categories": [],
"kind": "NormalEnumWithoutDescriptionsTest",
"plural": "normalenumwithoutdescriptionstests",
"shortNames": [],
"singular": "normalenumwithoutdescriptionstest"
},
"scope": "Cluster",
"versions": [
{
"additionalPrinterColumns": [],
"name": "v1",
"schema": {
"openAPIV3Schema": {
"description": "Auto-generated derived type for NormalEnumWithoutDescriptionsTestSpec via `CustomResource`",
"properties": {
"spec": {
"properties": {
"foo": {
"enum": [
"A",
"B",
"C",
"D"
],
"type": "string"
}
},
"required": [
"foo"
],
"type": "object"
}
},
"required": [
"spec"
],
"title": "NormalEnumWithoutDescriptionsTest",
"type": "object"
}
},
"served": true,
"storage": true,
"subresources": {}
}
]
}
}
)
);
}
Loading