1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
#![recursion_limit = "1024"]
#![warn(rust_2018_idioms)]
#![deny(clippy::all, clippy::pedantic)]
#![allow(
clippy::too_many_lines,
)]
//! This crate contains custom derives related to the [`k8s-openapi`](https://crates.io/crates/k8s-openapi) crate.
mod custom_resource_definition;
trait CustomDerive: Sized {
fn parse(input: syn::DeriveInput, tokens: proc_macro2::TokenStream) -> Result<Self, syn::Error>;
fn emit(self) -> Result<proc_macro2::TokenStream, syn::Error>;
}
fn run_custom_derive<T>(input: proc_macro::TokenStream) -> proc_macro::TokenStream where T: CustomDerive {
let input: proc_macro2::TokenStream = input.into();
let tokens = input.clone();
let token_stream = match syn::parse2(input).and_then(|input| <T as CustomDerive>::parse(input, tokens)).and_then(<T as CustomDerive>::emit) {
Ok(token_stream) => token_stream,
Err(err) => err.to_compile_error(),
};
token_stream.into()
}
trait ResultExt<T> {
fn spanning(self, spanned: impl quote::ToTokens) -> Result<T, syn::Error>;
}
impl<T, E> ResultExt<T> for Result<T, E> where E: std::fmt::Display {
fn spanning(self, spanned: impl quote::ToTokens) -> Result<T, syn::Error> {
self.map_err(|err| syn::Error::new_spanned(spanned, err))
}
}
/// This custom derive can be used on a Kubernetes custom resource spec type to generate a custom resource definition object
/// and associated API functions.
///
/// # Example
///
/// ```rust,ignore
/// #[derive(
/// Clone, Debug, PartialEq,
/// k8s_openapi_derive::CustomResourceDefinition,
/// serde::Deserialize, serde::Serialize,
/// )]
/// #[custom_resource_definition(
/// group = "k8s-openapi-tests-custom-resource-definition.com",
/// version = "v1",
/// plural = "foobars",
/// generate_schema,
/// namespaced,
/// has_subresources = "v1",
/// impl_deep_merge,
/// )]
/// struct FooBarSpec {
/// prop1: String,
/// prop2: Vec<bool>,
/// #[serde(skip_serializing_if = "Option::is_none")]
/// prop3: Option<i32>,
/// }
/// ```
///
/// Note:
///
/// - The spec type must impl the following traits (either manually or via `#[derive]`): `Clone`, `Debug`, `PartialEq`,
/// `serde::Deserialize` and `serde::Serialize`
///
/// - The name of the spec type must end with `Spec`. This suffix is trimmed to generate the names of the other types.
///
/// - The `k8s_openapi` crate must have been added as a dependency, since the macro expansion refers to types from it.
///
/// The custom derive then generates a `FooBar` type that represents a custom resource corresponding to this definition:
///
/// ```rust,ignore
/// /// Custom resource for FooBarSpec
/// #[derive(Clone, Debug, Default, PartialEq)]
/// struct FooBar {
/// metadata: k8s_openapi::apimachinery::pkg::apis::meta::v1::ObjectMeta,
/// spec: Option<FooBarSpec>,
/// subresources: k8s_openapi::apiextensions_apiserver::pkg::apis::apiextensions::v1::CustomResourceSubresources,
/// }
///
/// impl k8s_openapi::Resource for FooBar { ... }
///
/// impl k8s_openapi::ListableResource for FooBar { ... }
///
/// impl k8s_openapi::Metadata for FooBar {
/// type Ty = k8s_openapi::apimachinery::pkg::apis::meta::v1::ObjectMeta;
///
/// ...
/// }
///
/// impl<'de> k8s_openapi::serde::Deserialize<'de> for FooBar { ... }
///
/// impl k8s_openapi::serde::Serialize for FooBar { ... }
///
/// impl k8s_openapi::schemars::JsonSchema for FooBar { ... }
/// ```
///
/// The name of this type is automatically derived from the name of the spec type by truncating the `Spec` suffix.
///
/// The `group` and `version` meta items of the `#[custom_resource_definition]` attribute of the macro are used to set
/// the "group" and "API version" in the `k8s_openapi::Resource` impl respectively. The "kind" is automatically set to be the same as the resource type name,
/// ie `"FooBar"` in this example. The `plural` meta item is used to construct the URLs of API operations for this custom resource.
///
/// The `generate_schema` meta item is optional. If set, the generated custom resource type will have an impl of `schemars::JsonSchema` from the `schemars` crate.
/// The `schemars` feature of the `k8s-openapi` crate must be enabled so that the types in that crate also have their `schemars::JsonSchema` impls enabled.
/// You will also need to impl `schemars::JsonSchema` on the `Spec` type itself, either manually or via `#[derive(schemars::JsonSchema)]`.
///
/// The `has_subresources` meta item is optional. If set, the generated custom resource type will have a `subresources` field. The value of the meta item
/// specifies which namespace the type will be used from. For example, setting `has_subresources = "v1"` causes the field to be of the
/// `k8s_openapi::apiextensions_apiserver::pkg::apis::apiextensions::v1::CustomResourceSubresources` type.
///
/// The `impl_deep_merge` meta item is optional. If set, the generated custom resource type will impl the `k8s_openapi::DeepMerge` trait. This impl will require
/// you to impl `k8s_openapi::DeepMerge` on the spec type yourself.
///
/// You would then register this custom resource definition with Kubernetes, with code like this:
///
/// ```rust,ignore
/// use k8s_openapi::apiextensions_apiserver::pkg::apis::apiextensions::v1 as apiextensions;
/// use k8s_openapi::apimachinery::pkg::apis::meta::v1 as meta;
///
/// // Same as the `plurals` meta item in the `#[custom_resource_definition]` attribute
/// let plural = "foobars";
///
/// let custom_resource_definition_spec = apiextensions::CustomResourceDefinitionSpec {
/// group: <FooBar as k8s_openapi::Resource>::GROUP.to_owned(),
/// names: apiextensions::CustomResourceDefinitionNames {
/// kind: <FooBar as k8s_openapi::Resource>::KIND.to_owned(),
/// plural: plural.to_owned(),
/// short_names: Some(vec!["fb".to_owned()]),
/// singular: Some("foobar".to_owned()),
/// ..Default::default()
/// },
/// scope: "Namespaced".to_owned(),
/// version: <FooBar as k8s_openapi::Resource>::VERSION.to_owned().into(),
/// ..Default::default()
/// };
///
/// let custom_resource_definition = apiextensions::CustomResourceDefinition {
/// metadata: meta::ObjectMeta {
/// name: Some(format!("{plural}.{}", <FooBar as k8s_openapi::Resource>::GROUP)),
/// ..Default::default()
/// },
/// spec: custom_resource_definition_spec.into(),
/// ..Default::default()
/// };
///
/// let (request, response_body) =
/// apiextensions::CustomResourceDefinition::create(&custom_resource_definition, Default::default())
/// .expect("couldn't create custom resource definition");
/// let response = client.execute(request).expect("couldn't create custom resource definition");
/// ```
///
/// The macro also generates clientset functions associated with the custom resource type to create, get, update, etc.
/// This is just like a regular Kubernetes resource type like `Pod`.
///
/// ```rust,ignore
/// impl FooBar {
/// /// Create a FooBar
/// fn create(
/// namespace: &str,
/// body: &FooBar,
/// optional: k8s_openapi::DeleteOptional<'_>,
/// ) ->
/// Result<
/// (
/// k8s_openapi::http::Request<Vec<u8>>,
/// fn(k8s_openapi::http::StatusCode) -> k8s_openapi::ResponseBody<k8s_openapi::CreateResponse<Self>>
/// ),
/// k8s_openapi::RequestError,
/// >
/// { ... }
///
/// /// Delete a FooBar
/// fn delete(
/// name: &str,
/// namespace: &str,
/// optional: k8s_openapi::DeleteOptional<'_>,
/// ) ->
/// Result<
/// (
/// k8s_openapi::http::Request<Vec<u8>>,
/// fn(k8s_openapi::http::StatusCode) -> k8s_openapi::ResponseBody<k8s_openapi::DeleteResponse<Self>>
/// ),
/// k8s_openapi::RequestError,
/// >
/// { ... }
///
/// /// Delete a collection of objects of kind FooBar
/// fn delete_collection(
/// namespace: &str,
/// delete_optional: k8s_openapi::DeleteOptional<'_>,
/// list_optional: k8s_openapi::ListOptional<'_>,
/// ) ->
/// Result<
/// (
/// k8s_openapi::http::Request<Vec<u8>>,
/// fn(k8s_openapi::http::StatusCode) -> k8s_openapi::ResponseBody<k8s_openapi::DeleteResponse<k8s_openapi::List<Self>>>
/// ),
/// k8s_openapi::RequestError,
/// >
/// { ... }
///
/// /// List objects of kind FooBar
/// fn list(
/// namespace: &str,
/// optional: k8s_openapi::ListOptional<'_>,
/// ) ->
/// Result<
/// (
/// k8s_openapi::http::Request<Vec<u8>>,
/// fn(k8s_openapi::http::StatusCode) -> k8s_openapi::ResponseBody<k8s_openapi::ListResponse<Self>>
/// ),
/// k8s_openapi::RequestError,
/// >
/// { ... }
///
/// /// Partially update the specified FooBar
/// fn patch(
/// name: &str,
/// namespace: &str,
/// body: &k8s_openapi::apimachinery::pkg::apis::meta::v1::Patch,
/// optional: k8s_openapi::PatchOptional<'_>,
/// ) ->
/// Result<
/// (
/// k8s_openapi::http::Request<Vec<u8>>,
/// fn(k8s_openapi::http::StatusCode) -> k8s_openapi::ResponseBody<k8s_openapi::PatchResponse<Self>>
/// ),
/// k8s_openapi::RequestError,
/// >
/// { ... }
///
/// /// Partially update the state of the specified FooBar
/// fn patch_status(
/// name: &str,
/// namespace: &str,
/// body: &k8s_openapi::apimachinery::pkg::apis::meta::v1::Patch,
/// optional: k8s_openapi::PatchOptional<'_>,
/// ) ->
/// Result<
/// (
/// k8s_openapi::http::Request<Vec<u8>>,
/// fn(k8s_openapi::http::StatusCode) -> k8s_openapi::ResponseBody<k8s_openapi::PatchResponse<Self>>
/// ),
/// k8s_openapi::RequestError,
/// >
/// { ... }
///
/// /// Read the specified FooBar
/// fn read(
/// name: &str,
/// namespace: &str,
/// ) -> Result<
/// (
/// k8s_openapi::http::Request<Vec<u8>>,
/// fn(k8s_openapi::http::StatusCode) -> k8s_openapi::ResponseBody<ReadFooBarResponse>
/// ),
/// k8s_openapi::RequestError,
/// > { ... }
///
/// /// Read status of the specified FooBar
/// fn read_status(
/// name: &str,
/// namespace: &str,
/// ) -> Result<
/// (
/// k8s_openapi::http::Request<Vec<u8>>,
/// fn(k8s_openapi::http::StatusCode) -> k8s_openapi::ResponseBody<ReadFooBarStatusResponse>
/// ),
/// k8s_openapi::RequestError,
/// > { ... }
///
/// /// Replace the specified FooBar
/// fn replace(
/// name: &str,
/// namespace: &str,
/// body: &FooBar,
/// optional: k8s_openapi::ReplaceOptional<'_>,
/// ) ->
/// Result<
/// (
/// k8s_openapi::http::Request<Vec<u8>>,
/// fn(k8s_openapi::http::StatusCode) -> k8s_openapi::ResponseBody<k8s_openapi::ReplaceResponse<Self>>
/// ),
/// k8s_openapi::RequestError,
/// >
/// { ... }
///
/// /// Replace status of the specified FooBar
/// fn replace_status(
/// name: &str,
/// namespace: &str,
/// body: &FooBar,
/// optional: k8s_openapi::ReplaceOptional<'_>,
/// ) ->
/// Result<
/// (
/// k8s_openapi::http::Request<Vec<u8>>,
/// fn(k8s_openapi::http::StatusCode) -> k8s_openapi::ResponseBody<k8s_openapi::ReplaceResponse<Self>>
/// ),
/// k8s_openapi::RequestError,
/// >
/// { ... }
///
/// /// Watch objects of kind FooBar
/// fn watch(
/// namespace: &str,
/// optional: k8s_openapi::WatchOptional<'_>,
/// ) ->
/// Result<
/// (
/// k8s_openapi::http::Request<Vec<u8>>,
/// fn(k8s_openapi::http::StatusCode) -> k8s_openapi::ResponseBody<k8s_openapi::WatchResponse<Self>>
/// ),
/// k8s_openapi::RequestError,
/// >
/// { ... }
/// }
/// ```
///
/// (You may wish to generate your own crate's docs, or run it through `cargo-expand`, to be able to see the macro expansion.)
///
/// Refer to [the `k8s-openapi` crate docs](https://arnavion.github.io/k8s-openapi/) to learn more about how to use the return values of these functions.
///
/// See the [`custom_resource_definition` test in the repository](https://github.com/Arnavion/k8s-openapi/blob/master/k8s-openapi-tests/src/custom_resource_definition.rs)
/// for a full example of using this custom derive.
#[proc_macro_derive(CustomResourceDefinition, attributes(custom_resource_definition))]
pub fn derive_custom_resource_definition(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
run_custom_derive::<custom_resource_definition::CustomResourceDefinition>(input)
}