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
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
/// A definition path.
#[derive(Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
pub struct DefinitionPath(pub String);

impl std::borrow::Borrow<str> for DefinitionPath {
    fn borrow(&self) -> &str {
        &self.0
    }
}

impl std::ops::Deref for DefinitionPath {
    type Target = str;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl std::fmt::Display for DefinitionPath {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.0.fmt(f)
    }
}

/// An integer format. This corresponds to the `"format"` property of an `"integer"` schema type.
#[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
pub enum IntegerFormat {
    Int32,
    Int64,
}

/// The value of an `x-kubernetes-list-type` annotation on a property.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Default, PartialOrd, Ord)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
pub enum KubernetesListType {
    #[default]
    #[cfg_attr(feature = "serde", serde(rename = "atomic"))]
    Atomic,

    #[cfg_attr(feature = "serde", serde(rename = "map"))]
    Map,

    #[cfg_attr(feature = "serde", serde(rename = "set"))]
    Set,
}

/// The value of an `x-kubernetes-map-type` annotation on a property.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Default, PartialOrd, Ord)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
pub enum KubernetesMapType {
    #[cfg_attr(feature = "serde", serde(rename = "atomic"))]
    Atomic,

    #[default]
    #[cfg_attr(feature = "serde", serde(rename = "granular"))]
    Granular,
}

#[derive(Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
pub enum MergeType {
    Default,

    List {
        strategy: KubernetesListType,
        keys: Vec<String>,
        item_merge_type: Box<MergeType>,
    },

    Map {
        strategy: KubernetesMapType,
        value_merge_type: Box<MergeType>,
    },
}

/// A number format. This corresponds to the `"format"` property of a `"number"` schema type.
#[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
pub enum NumberFormat {
    Double,
}

/// The name of a property of a schema type with a `"properties"` map.
#[derive(Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
pub struct PropertyName(pub String);

impl std::borrow::Borrow<str> for PropertyName {
    fn borrow(&self) -> &str {
        &self.0
    }
}

impl std::ops::Deref for PropertyName {
    type Target = str;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl std::fmt::Display for PropertyName {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.0.fmt(f)
    }
}

/// The path specified by a `"$ref"` property.
#[derive(Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
pub struct RefPath {
    pub path: String,
    pub can_be_default: Option<bool>,
}

#[cfg(feature = "serde")]
impl<'de> serde::Deserialize<'de> for RefPath {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: serde::Deserializer<'de> {
        let path: String = serde::Deserialize::deserialize(deserializer)?;
        let mut parts = path.split('/');

        if parts.next() != Some("#") {
            return Err(serde::de::Error::invalid_value(serde::de::Unexpected::Str(&path), &"path like `#/definitions/$definitionName`"));
        }

        if parts.next() != Some("definitions") {
            return Err(serde::de::Error::invalid_value(serde::de::Unexpected::Str(&path), &"path like `#/definitions/$definitionName`"));
        }

        let ref_path = parts.next().ok_or_else(|| serde::de::Error::invalid_value(serde::de::Unexpected::Str(&path), &"path like `#/definitions/$definitionName`"))?;

        if parts.next().is_some() {
            return Err(serde::de::Error::invalid_value(serde::de::Unexpected::Str(&path), &"path like `#/definitions/$definitionName`"));
        }

        Ok(RefPath {
            path: ref_path.to_string(),
            can_be_default: None,
        })
    }
}

impl RefPath {
    pub(crate) fn references_scope(&self, map_namespace: &impl crate::MapNamespace) -> bool {
        let path_parts: Vec<_> = self.path.split('.').collect();
        map_namespace.map_namespace(&path_parts[..(path_parts.len() - 1)]).is_none()
    }
}

/// The schema of a definition or operation parameter.
#[derive(Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
pub struct Schema {
    pub description: Option<String>,
    pub kind: SchemaKind,
    pub kubernetes_group_kind_versions: Vec<super::KubernetesGroupKindVersion>,

    pub merge_type: MergeType,

    /// Used to store the definition path of the corresponding list type, if any.
    pub list_kind: Option<String>,

    /// Used to enable or disable the auto-generated impl of `k8s_openapi::DeepMerge` on the generated type.
    pub impl_deep_merge: bool,
}

#[cfg(feature = "serde")]
#[allow(clippy::use_self)]
impl<'de> serde::Deserialize<'de> for Schema {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: serde::Deserializer<'de> {
        #[derive(Debug, serde::Deserialize)]
        struct InnerSchema {
            #[serde(rename = "additionalProperties")]
            additional_properties: Option<Box<Schema>>,

            description: Option<String>,

            format: Option<String>,

            items: Option<Box<Schema>>,

            #[serde(default, rename = "x-kubernetes-group-version-kind")]
            kubernetes_group_kind_versions: Vec<super::KubernetesGroupKindVersion>,

            #[serde(default, rename = "x-kubernetes-list-map-keys")]
            kubernetes_list_map_keys: Vec<String>,

            #[serde(default, rename = "x-kubernetes-list-type")]
            kubernetes_list_type: KubernetesListType,

            #[serde(default, rename = "x-kubernetes-map-type")]
            kubernetes_map_type: KubernetesMapType,

            #[serde(default, rename = "x-kubernetes-patch-merge-key")]
            kubernetes_patch_merge_key: Option<String>,

            /// Comma-separated list of strategy tags.
            /// Ref: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-api-machinery/strategic-merge-patch.md
            #[serde(default, rename = "x-kubernetes-patch-strategy")]
            kubernetes_patch_strategy: String,

            properties: Option<std::collections::BTreeMap<PropertyName, Schema>>,

            #[serde(rename = "$ref")]
            ref_path: Option<RefPath>,

            #[serde(default)]
            required: Vec<PropertyName>,

            #[serde(rename = "type")]
            ty: Option<String>,
        }

        let mut value: InnerSchema = serde::Deserialize::deserialize(deserializer)?;

        let kind =
            if let Some(ref_path) = value.ref_path {
                SchemaKind::Ref(ref_path)
            }
            else if let Some(properties) = value.properties.take() {
                if value.ty.as_deref() != Some("object") {
                    return Err(serde::de::Error::custom(format!("schema has properties but not type=object {value:?}")));
                }

                let required: std::collections::BTreeSet<_> = value.required.into_iter().collect();
                SchemaKind::Properties(properties.into_iter().map(|(name, schema)| {
                    let required = required.contains(&name);
                    (name, (schema, required))
                }).collect())
            }
            else if let Some(ty) = value.ty {
                SchemaKind::Ty(Type::parse::<D>(
                    &ty,
                    value.additional_properties,
                    value.format.as_deref(),
                    value.items,
                )?)
            }
            else {
                SchemaKind::Ty(Type::Any)
            };

        if let Some(key) = value.kubernetes_patch_merge_key {
            value.kubernetes_list_map_keys = vec![key];
        }
        if value.kubernetes_patch_strategy.split(',').any(|x| x == "merge") {
            value.kubernetes_list_type =
                if value.kubernetes_list_map_keys.is_empty() {
                    KubernetesListType::Set
                }
                else {
                    KubernetesListType::Map
                };
        }

        let merge_type = match &kind {
            SchemaKind::Ty(Type::Array { items }) => MergeType::List {
                strategy: value.kubernetes_list_type,
                keys: value.kubernetes_list_map_keys,
                item_merge_type: Box::new(items.merge_type.clone()),
            },

            SchemaKind::Ty(Type::Object { additional_properties }) => MergeType::Map {
                strategy: value.kubernetes_map_type,
                value_merge_type: Box::new(additional_properties.merge_type.clone()),
            },

            _ => MergeType::Default,
        };

        Ok(Schema {
            description: value.description,
            kind,
            kubernetes_group_kind_versions: value.kubernetes_group_kind_versions,
            list_kind: None,
            merge_type,
            impl_deep_merge: true,
        })
    }
}

/// The kind of a [`Schema`]
#[derive(Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
pub enum SchemaKind {
    Properties(std::collections::BTreeMap<PropertyName, (Schema, bool)>),
    Ref(RefPath),
    Ty(Type),
}

/// A string format. This corresponds to the `"format"` property of an `"string"` schema type.
#[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
pub enum StringFormat {
    Byte,
    DateTime,
}

/// A type definition.
#[derive(Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
pub enum Type {
    Any,
    Array { items: Box<Schema> },
    Boolean,
    Integer { format: IntegerFormat },
    Number { format: NumberFormat },
    Object { additional_properties: Box<Schema> },
    String { format: Option<StringFormat> },

    // Special type for the `subresources` field of custom resources.
    CustomResourceSubresources(String),

    // Special types that need alterative codegen
    IntOrString,
    JsonSchemaPropsOr(&'static str, JsonSchemaPropsOr),

    Patch,
    WatchEvent(RefPath),

    // Special type for lists
    ListDef { metadata: Box<SchemaKind> }, // The definition of the List type
    ListRef { items: Box<SchemaKind> }, // A reference to a specialization of the List type for a particular resource type, eg List<Pod> for PodList

    // Special types for common parameters of some API operations
    CreateOptional(std::collections::BTreeMap<PropertyName, Schema>),
    DeleteOptional(std::collections::BTreeMap<PropertyName, Schema>),
    ListOptional(std::collections::BTreeMap<PropertyName, Schema>),
    PatchOptional(std::collections::BTreeMap<PropertyName, Schema>),
    ReplaceOptional(std::collections::BTreeMap<PropertyName, Schema>),
    WatchOptional(std::collections::BTreeMap<PropertyName, Schema>),

    // Special types for responses of some API operations
    CreateResponse,
    DeleteResponse,
    ListResponse,
    PatchResponse,
    ReplaceResponse,
    WatchResponse,
}

#[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
pub enum JsonSchemaPropsOr {
    Array,
    Bool,
    StringArray,
}

impl Type {
    #[cfg(feature = "serde")]
    pub(crate) fn parse<'de, D>(
        ty: &str,
        additional_properties: Option<Box<Schema>>,
        format: Option<&str>,
        items: Option<Box<Schema>>,
    ) -> Result<Self, D::Error> where D: serde::Deserializer<'de> {
        match ty {
            "array" => Ok(Type::Array {
                items: items.ok_or_else(|| serde::de::Error::missing_field("items"))?,
            }),

            "boolean" => Ok(Type::Boolean),

            "integer" => {
                let format = match format {
                    Some("int32") => IntegerFormat::Int32,
                    Some("int64") | None => IntegerFormat::Int64,
                    Some(format) => return Err(serde::de::Error::invalid_value(serde::de::Unexpected::Str(format), &"one of int32, int64")),
                };
                Ok(Type::Integer { format })
            },

            "number" => {
                let format = format.ok_or_else(|| serde::de::Error::missing_field("format"))?;
                let format = match format {
                    "double" => NumberFormat::Double,
                    format => return Err(serde::de::Error::invalid_value(serde::de::Unexpected::Str(format), &"one of double")),
                };
                Ok(Type::Number { format })
            },

            "object" => match additional_properties {
                Some(additional_properties) => Ok(Type::Object { additional_properties }),
                None => Ok(Type::Any),
            },

            "string" => {
                let format = match format {
                    Some("byte") => Some(StringFormat::Byte),
                    Some("date-time") => Some(StringFormat::DateTime),
                    Some("int-or-string") => return Ok(Type::IntOrString),
                    Some(format) => return Err(serde::de::Error::invalid_value(serde::de::Unexpected::Str(format), &"one of byte, date-time, int-or-string")),
                    None => None,
                };
                Ok(Type::String { format })
            },

            s => Err(serde::de::Error::invalid_value(serde::de::Unexpected::Str(s), &"one of array, boolean, integer, number, object, string")),
        }
    }
}