Move overrides into #[kube(crates)], rename schema_mode to schema

Signed-off-by: Teo Klestrup Röijezon <[email protected]>

Author: nightkr

CHANGELOG.md

@@ -12,8 +12,10 @@ UNRELEASED
    - Replaced `kube::Error::RequestValidation(String)` variant with `kube::Error::BuildRequest(kube::core::request::Error)`. This variant includes possible errors when building an HTTP request as described above, and contains errors that was previously grouped under `kube::Error::SerdeError` and `kube::Error::HttpError`.
    - Removed `impl From<T> for kube::Error` for the following types: `std::io::Error`, `hyper::Error`, `tower::BoxError`, `std::string::FromUtf8Error`, `http::Error`, `http::uri::InvalidUri`, `serde_json::Error`, `openssl::error::ErrorStack`, `kube::core::Error`, `kube::error::ConfigError`, `kube::error::DisoveryError`, `kube::error::OAuthError`.
    - Changed variants of error enums in `kube::runtime`. Replaced `snafu` with `thiserror`.
- * BREAKING: Replaced feature `kube-derive/schema` with attribute `#[kube(schema_mode)]` - #690
-   - If you currently disable default `kube-derive` default features to avoid automatic schema generation, add `#[kube(schema_mode = "disabled")]` to your spec struct instead
+ * BREAKING: Replaced feature `kube-derive/schema` with attribute `#[kube(schema)]` - #690
+   - If you currently disable default `kube-derive` default features to avoid automatic schema generation, add `#[kube(schema = "disabled")]` to your spec struct instead
+ * BREAKING: Moved `CustomResource` derive crate overrides into subattribute `#[kube(crates(...))]` - #690
+   - Replace `#[kube(kube_core = .., k8s_openapi = .., schema = .., serde = .., serde_json = ..)]` with `#[kube(crates(kube_core = .., k8s_openapi = .., schema = .., serde = .., serde_json = ..))]`
 
 0.63.2 / 2021-10-28
 ===================

examples/crd_derive_custom_schema.rs

@@ -13,7 +13,7 @@ use serde::{Deserialize, Serialize};
     version = "v1",
     kind = "Bar",
     namespaced,
-    schema_mode = "custom"
+    schema = "custom"
 )]
 pub struct MyBar {
     bars: u32,

examples/crd_derive_no_schema.rs

@@ -14,7 +14,7 @@ use serde::{Deserialize, Serialize};
     version = "v1",
     kind = "Bar",
     namespaced,
-    schema_mode = "disabled"
+    schema = "disabled"
 )]
 pub struct MyBar {
     bars: u32,

kube-derive/src/custom_resource.rs

@@ -24,7 +24,7 @@ struct KubeAttrs {
     #[darling(multiple, rename = "derive")]
     derives: Vec<String>,
     #[darling(default)]
-    schema_mode: Option<SchemaMode>,
+    schema: Option<SchemaMode>,
     #[darling(default)]
     status: Option<String>,
     #[darling(multiple, rename = "category")]
@@ -35,35 +35,56 @@ struct KubeAttrs {
     printcolums: Vec<String>,
     #[darling(default)]
     scale: Option<String>,
-    #[darling(default = "default_kube_core")]
+    #[darling(default)]
+    crates: Crates,
+}
+
+#[derive(Debug, FromMeta)]
+struct Crates {
+    #[darling(default = "Self::default_kube_core")]
     kube_core: Path,
-    #[darling(default = "default_k8s_openapi")]
+    #[darling(default = "Self::default_k8s_openapi")]
     k8s_openapi: Path,
-    #[darling(default = "default_schemars")]
+    #[darling(default = "Self::default_schemars")]
     schemars: Path,
-    #[darling(default = "default_serde")]
+    #[darling(default = "Self::default_serde")]
     serde: Path,
-    #[darling(default = "default_serde_json")]
+    #[darling(default = "Self::default_serde_json")]
     serde_json: Path,
 }
 
-fn default_apiext() -> String {
-    "v1".to_owned()
-}
-fn default_kube_core() -> Path {
-    parse_quote! { ::kube::core } // by default must work well with people using facade crate
-}
-fn default_k8s_openapi() -> Path {
-    parse_quote! { ::k8s_openapi }
-}
-fn default_schemars() -> Path {
-    parse_quote! { ::schemars }
+// Default is required when the subattribute isn't mentioned at all
+// Delegate to darling rather than deriving, so that we can piggyback off the `#[darling(default)]` clauses
+impl Default for Crates {
+    fn default() -> Self {
+        Self::from_list(&[]).unwrap()
+    }
 }
-fn default_serde() -> Path {
-    parse_quote! { ::serde }
+
+impl Crates {
+    fn default_kube_core() -> Path {
+        parse_quote! { ::kube::core } // by default must work well with people using facade crate
+    }
+
+    fn default_k8s_openapi() -> Path {
+        parse_quote! { ::k8s_openapi }
+    }
+
+    fn default_schemars() -> Path {
+        parse_quote! { ::schemars }
+    }
+
+    fn default_serde() -> Path {
+        parse_quote! { ::serde }
+    }
+
+    fn default_serde_json() -> Path {
+        parse_quote! { ::serde_json }
+    }
 }
-fn default_serde_json() -> Path {
-    parse_quote! { ::serde_json }
+
+fn default_apiext() -> String {
+    "v1".to_owned()
 }
 
 #[derive(Debug, PartialEq, Eq, Clone, Copy)]
@@ -130,7 +151,7 @@ pub(crate) fn derive(input: proc_macro2::TokenStream) -> proc_macro2::TokenStrea
         version,
         namespaced,
         derives,
-        schema_mode,
+        schema: schema_mode,
         status,
         plural,
         singular,
@@ -139,11 +160,14 @@ pub(crate) fn derive(input: proc_macro2::TokenStream) -> proc_macro2::TokenStrea
         printcolums,
         apiextensions,
         scale,
-        kube_core,
-        k8s_openapi,
-        schemars,
-        serde,
-        serde_json,
+        crates:
+            Crates {
+                kube_core,
+                k8s_openapi,
+                schemars,
+                serde,
+                serde_json,
+            },
     } = kube_attrs;
 
     let struct_name = kind_struct.unwrap_or_else(|| kind.clone());

kube-derive/src/lib.rs

@@ -87,20 +87,20 @@ mod custom_resource;
 /// ### `#[kube(struct = "StructName")]`
 /// Customize the name of the generated root struct (defaults to `kind`).
 ///
-/// ### `#[kube(kube_core = "::kube::core")]`
+/// ### `#[kube(crates(kube_core = "::kube::core"))]`
 /// Customize the crate name the generated code will reach into (defaults to `::kube::core`).
 /// Should be one of `kube::core`, `kube_client::core` or `kube_core`.
 ///
-/// ### `#[kube(k8s_openapi = "::k8s_openapi")]`
+/// ### `#[kube(crates(k8s_openapi = "::k8s_openapi"))]`
 /// Customize the crate name the generated code will use for [`k8s_openapi`](https://docs.rs/k8s-openapi/) (defaults to `::k8s_openapi`).
 ///
-/// ### `#[kube(schemars = "::schemars")]`
+/// ### `#[kube(crates(schemars = "::schemars"))]`
 /// Customize the crate name the generated code will use for [`schemars`](https://docs.rs/schemars/) (defaults to `::schemars`).
 ///
-/// ### `#[kube(serde = "::serde")]`
+/// ### `#[kube(crates(serde = "::serde"))]`
 /// Customize the crate name the generated code will use for [`serde`](https://docs.rs/serde/) (defaults to `::serde`).
 ///
-/// ### `#[kube(serde_json = "::serde_json")]`
+/// ### `#[kube(crates(serde_json = "::serde_json"))]`
 /// Customize the crate name the generated code will use for [`serde_json`](https://docs.rs/serde_json/) (defaults to `::serde_json`).
 ///
 /// ### `#[kube(status = "StatusStructName")]`
@@ -111,7 +111,7 @@ mod custom_resource;
 /// Adding `#[kube(derive = "PartialEq")]` is required if you want your generated
 /// top level type to be able to `#[derive(PartialEq)]`
 ///
-/// ### `#[kube(schema_mode = "mode")]`
+/// ### `#[kube(schema = "mode")]`
 /// Defines whether the `JsonSchema` of the top level generated type should be used when generating a `CustomResourceDefinition`.
 ///
 /// Legal values:
@@ -124,7 +124,7 @@ mod custom_resource;
 ///
 /// Defaults to `"disabled"` when `apiextensions = "v1beta1"`, otherwise `"derived"`.
 ///
-/// NOTE: `apiextensions = "v1"` `CustomResourceDefinition`s require a schema. If `schema_mode = "disabled"` then
+/// NOTE: `apiextensions = "v1"` `CustomResourceDefinition`s require a schema. If `schema = "disabled"` then
 /// `Self::crd()` will not be installable into the cluster as-is.
 ///
 /// ### `#[kube(scale = r#"json"#)]`
@@ -206,7 +206,7 @@ mod custom_resource;
 ///
 /// See [kubernetes openapi validation](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#validation) for the format of the OpenAPI v3 schemas.
 ///
-/// If you have to override a lot, [you can opt-out of schema-generation entirely](#kubeschema_mode--mode)
+/// If you have to override a lot, [you can opt-out of schema-generation entirely](#kubeschema--mode)
 ///
 /// ## Advanced Features
 /// - **embedding k8s-openapi types** can be done by enabling the `schemars` feature of `k8s-openapi` from [`0.13.0`](https://github.com/Arnavion/k8s-openapi/blob/master/CHANGELOG.md#v0130-2021-08-09)