Add shemars as dev-dependency and fix tests

kube-rs · Dec 19, 2020 · 2aeee34 · 2aeee34
1 parent 95651b8
commit 2aeee34
Show file tree

Hide file tree

Showing 10 changed files with 19 additions and 8 deletions.
diff --git a/examples/configmapgen_controller.rs b/examples/configmapgen_controller.rs
@@ -10,6 +10,7 @@ use kube::{
     Api, Client, CustomResource,
 };
 use kube_runtime::controller::{Context, Controller, ReconcilerAction};
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use snafu::{Backtrace, OptionExt, ResultExt, Snafu};
 use std::collections::BTreeMap;
@@ -32,7 +33,7 @@ enum Error {
     },
 }
 
-#[derive(CustomResource, Debug, Clone, Deserialize, Serialize)]
+#[derive(CustomResource, Debug, Clone, Deserialize, Serialize, JsonSchema)]
 #[kube(group = "nullable.se", version = "v1", kind = "ConfigMapGenerator")]
 #[kube(shortname = "cmg", namespaced)]
 struct ConfigMapGeneratorSpec {

diff --git a/examples/crd_api.rs b/examples/crd_api.rs
@@ -1,5 +1,6 @@
 #[macro_use] extern crate log;
 use either::Either::{Left, Right};
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use serde_json::json;
 use std::time::Duration;
@@ -14,7 +15,7 @@ use kube::{
 };
 
 // Own custom resource
-#[derive(CustomResource, Deserialize, Serialize, Clone, Debug)]
+#[derive(CustomResource, Deserialize, Serialize, Clone, Debug, JsonSchema)]
 #[kube(group = "clux.dev", version = "v1", kind = "Foo", namespaced)]
 #[kube(apiextensions = "v1beta1")]
 #[kube(status = "FooStatus")]

diff --git a/examples/crd_apply.rs b/examples/crd_apply.rs
@@ -1,5 +1,6 @@
 #[macro_use] extern crate log;
 use futures::{StreamExt, TryStreamExt};
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 use apiexts::CustomResourceDefinition;
@@ -14,7 +15,7 @@ use kube::{
 // Please test against Kubernetes 1.16.X!
 
 // Own custom resource
-#[derive(CustomResource, Deserialize, Serialize, Clone, Debug)]
+#[derive(CustomResource, Deserialize, Serialize, Clone, Debug, JsonSchema)]
 #[kube(group = "clux.dev", version = "v1", kind = "Foo", namespaced)]
 #[kube(status = "FooStatus")]
 #[kube(apiextensions = "v1beta1")] // remove this if using Kubernetes >= 1.17

diff --git a/examples/crd_reflector.rs b/examples/crd_reflector.rs
@@ -5,9 +5,10 @@ use kube::{
     Client, CustomResource,
 };
 use kube_runtime::{reflector, utils::try_flatten_applied, watcher};
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
-#[derive(CustomResource, Deserialize, Serialize, Clone, Debug)]
+#[derive(CustomResource, Deserialize, Serialize, Clone, Debug, JsonSchema)]
 #[kube(group = "clux.dev", version = "v1", kind = "Foo", namespaced)]
 pub struct FooSpec {
     name: String,

diff --git a/kube-derive/Cargo.toml b/kube-derive/Cargo.toml
@@ -22,3 +22,4 @@ proc-macro = true
 serde = { version = "1.0.111", features = ["derive"] }
 serde_yaml = "0.8.12"
 k8s-openapi = { version = "0.10.0", default-features = false, features = ["v1_18"] }
+schemars = "0.8.0"
diff --git a/kube-derive/src/lib.rs b/kube-derive/src/lib.rs
@@ -59,8 +59,9 @@ use custom_resource::CustomResource;
 /// ```rust
 /// use serde::{Serialize, Deserialize};
 /// use kube_derive::CustomResource;
+/// use schemars::JsonSchema;
 ///
-/// #[derive(CustomResource, Clone, Debug, Deserialize, Serialize)]
+/// #[derive(CustomResource, Clone, Debug, Deserialize, Serialize, JsonSchema)]
 /// #[kube(group = "clux.dev", version = "v1", kind = "Foo", namespaced)]
 /// struct FooSpec {
 ///     info: String,
@@ -142,8 +143,9 @@ use custom_resource::CustomResource;
 /// ```rust
 /// use serde::{Serialize, Deserialize};
 /// use kube_derive::CustomResource;
+/// use schemars::JsonSchema;
 ///
-/// #[derive(CustomResource, Serialize, Deserialize, Debug, PartialEq, Clone)]
+/// #[derive(CustomResource, Serialize, Deserialize, Debug, PartialEq, Clone, JsonSchema)]
 /// #[kube(
 ///     group = "clux.dev",
 ///     version = "v1",

diff --git a/kube-runtime/Cargo.toml b/kube-runtime/Cargo.toml
@@ -42,3 +42,4 @@ kube-derive = { path = "../kube-derive", version = "^0.43.0"}
 serde_json = "1.0.57"
 tokio = { version = "0.2.22", features = ["full", "test-util"] }
 rand = "0.7.3"
+schemars = "0.8.0"
diff --git a/kube-runtime/src/controller.rs b/kube-runtime/src/controller.rs
@@ -226,12 +226,13 @@ where
 /// use futures::StreamExt;
 /// use kube_runtime::controller::{Context, Controller, ReconcilerAction};
 /// use k8s_openapi::api::core::v1::ConfigMap;
+/// use schemars::JsonSchema;
 ///
 /// use snafu::{Backtrace, OptionExt, ResultExt, Snafu};
 /// #[derive(Debug, Snafu)]
 /// enum Error {}
 /// /// A custom resource
-/// #[derive(CustomResource, Debug, Clone, Deserialize, Serialize)]
+/// #[derive(CustomResource, Debug, Clone, Deserialize, Serialize, JsonSchema)]
 /// #[kube(group = "nullable.se", version = "v1", kind = "ConfigMapGenerator", namespaced)]
 /// struct ConfigMapGeneratorSpec {
 ///     content: String,

diff --git a/kube/Cargo.toml b/kube/Cargo.toml
@@ -61,6 +61,7 @@ features = []
 [dev-dependencies]
 tempfile = "3.1.0"
 tokio = { version = "0.2.21", features = ["full"] }
+schemars = "0.8.0"
 
 [dev-dependencies.k8s-openapi]
 version = "0.10.0"

diff --git a/kube/src/api/dynamic.rs b/kube/src/api/dynamic.rs
@@ -221,8 +221,9 @@ mod test {
     #[ignore] // circle has no kubeconfig
     async fn convenient_custom_resource() {
         use crate::{Api, Client, CustomResource};
+        use schemars::JsonSchema;
         use serde::{Deserialize, Serialize};
-        #[derive(Clone, Debug, CustomResource, Deserialize, Serialize)]
+        #[derive(Clone, Debug, CustomResource, Deserialize, Serialize, JsonSchema)]
         #[kube(group = "clux.dev", version = "v1", kind = "Foo", namespaced)]
         struct FooSpec {
             foo: String,