|
| 1 | +use std::{cmp::Ordering, fmt::Display, str::FromStr}; |
| 2 | + |
| 3 | +use snafu::{ResultExt, Snafu}; |
| 4 | + |
| 5 | +#[cfg(feature = "darling")] |
| 6 | +use darling::FromMeta; |
| 7 | + |
| 8 | +use crate::{Group, ParseGroupError, ParseVersionError, Version}; |
| 9 | + |
| 10 | +/// Error variants which can be encountered when creating a new [`ApiVersion`] |
| 11 | +/// from unparsed input. |
| 12 | +#[derive(Debug, PartialEq, Snafu)] |
| 13 | +pub enum ParseApiVersionError { |
| 14 | + #[snafu(display("failed to parse version"))] |
| 15 | + ParseVersion { source: ParseVersionError }, |
| 16 | + |
| 17 | + #[snafu(display("failed to parse group"))] |
| 18 | + ParseGroup { source: ParseGroupError }, |
| 19 | +} |
| 20 | + |
| 21 | +/// A Kubernetes API version, following the `(<GROUP>/)<VERSION>` format. |
| 22 | +/// |
| 23 | +/// The `<VERSION>` string must follow the DNS label format defined in the |
| 24 | +/// [Kubernetes design proposals archive][1]. The `<GROUP>` string must be lower |
| 25 | +/// case and must be a valid DNS subdomain. |
| 26 | +/// |
| 27 | +/// ### See |
| 28 | +/// |
| 29 | +/// - <https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#api-conventions> |
| 30 | +/// - <https://kubernetes.io/docs/reference/using-api/#api-versioning> |
| 31 | +/// - <https://kubernetes.io/docs/reference/using-api/#api-groups> |
| 32 | +/// |
| 33 | +/// [1]: https://github.com/kubernetes/design-proposals-archive/blob/main/architecture/identifiers.md#definitions |
| 34 | +#[derive(Clone, Debug, Hash, PartialEq, Eq)] |
| 35 | +pub struct ApiVersion { |
| 36 | + pub group: Option<Group>, |
| 37 | + pub version: Version, |
| 38 | +} |
| 39 | + |
| 40 | +impl FromStr for ApiVersion { |
| 41 | + type Err = ParseApiVersionError; |
| 42 | + |
| 43 | + fn from_str(input: &str) -> Result<Self, Self::Err> { |
| 44 | + let (group, version) = if let Some((group, version)) = input.split_once('/') { |
| 45 | + let group = Group::from_str(group).context(ParseGroupSnafu)?; |
| 46 | + |
| 47 | + ( |
| 48 | + Some(group), |
| 49 | + Version::from_str(version).context(ParseVersionSnafu)?, |
| 50 | + ) |
| 51 | + } else { |
| 52 | + (None, Version::from_str(input).context(ParseVersionSnafu)?) |
| 53 | + }; |
| 54 | + |
| 55 | + Ok(Self { group, version }) |
| 56 | + } |
| 57 | +} |
| 58 | + |
| 59 | +impl PartialOrd for ApiVersion { |
| 60 | + fn partial_cmp(&self, other: &Self) -> Option<Ordering> { |
| 61 | + match self.group.partial_cmp(&other.group) { |
| 62 | + Some(Ordering::Equal) => {} |
| 63 | + _ => return None, |
| 64 | + } |
| 65 | + self.version.partial_cmp(&other.version) |
| 66 | + } |
| 67 | +} |
| 68 | + |
| 69 | +impl Display for ApiVersion { |
| 70 | + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { |
| 71 | + match &self.group { |
| 72 | + Some(group) => write!(f, "{group}/{version}", version = self.version), |
| 73 | + None => write!(f, "{version}", version = self.version), |
| 74 | + } |
| 75 | + } |
| 76 | +} |
| 77 | + |
| 78 | +#[cfg(feature = "darling")] |
| 79 | +impl FromMeta for ApiVersion { |
| 80 | + fn from_string(value: &str) -> darling::Result<Self> { |
| 81 | + Self::from_str(value).map_err(darling::Error::custom) |
| 82 | + } |
| 83 | +} |
| 84 | + |
| 85 | +impl ApiVersion { |
| 86 | + /// Create a new Kubernetes API version. |
| 87 | + pub fn new(group: Option<Group>, version: Version) -> Self { |
| 88 | + Self { group, version } |
| 89 | + } |
| 90 | + |
| 91 | + /// Try to create a new Kubernetes API version based on the unvalidated |
| 92 | + /// `group` string. |
| 93 | + pub fn try_new(group: Option<&str>, version: Version) -> Result<Self, ParseApiVersionError> { |
| 94 | + let group = group |
| 95 | + .map(|g| g.parse()) |
| 96 | + .transpose() |
| 97 | + .context(ParseGroupSnafu)?; |
| 98 | + |
| 99 | + Ok(Self { group, version }) |
| 100 | + } |
| 101 | +} |
| 102 | + |
| 103 | +#[cfg(test)] |
| 104 | +mod test { |
| 105 | + use super::*; |
| 106 | + use crate::Level; |
| 107 | + |
| 108 | + use rstest::rstest; |
| 109 | + |
| 110 | + #[cfg(feature = "darling")] |
| 111 | + use quote::quote; |
| 112 | + |
| 113 | + #[cfg(feature = "darling")] |
| 114 | + fn parse_meta(tokens: proc_macro2::TokenStream) -> ::std::result::Result<syn::Meta, String> { |
| 115 | + let attribute: syn::Attribute = syn::parse_quote!(#[#tokens]); |
| 116 | + Ok(attribute.meta) |
| 117 | + } |
| 118 | + |
| 119 | + #[rstest] |
| 120 | + #[case("extensions/v1beta1", ApiVersion { group: Some("extensions".parse().unwrap()), version: Version { major: 1, level: Some(Level::Beta(1)) } })] |
| 121 | + #[case("v1beta1", ApiVersion { group: None, version: Version { major: 1, level: Some(Level::Beta(1)) } })] |
| 122 | + #[case("v1", ApiVersion { group: None, version: Version { major: 1, level: None } })] |
| 123 | + fn valid_api_version(#[case] input: &str, #[case] expected: ApiVersion) { |
| 124 | + let api_version = ApiVersion::from_str(input).expect("valid Kubernetes api version"); |
| 125 | + assert_eq!(api_version, expected); |
| 126 | + } |
| 127 | + |
| 128 | + #[rstest] |
| 129 | + #[case("extensions/beta1", ParseApiVersionError::ParseVersion { source: ParseVersionError::InvalidFormat })] |
| 130 | + #[case("/v1beta1", ParseApiVersionError::ParseGroup { source: ParseGroupError::Empty })] |
| 131 | + fn invalid_api_version(#[case] input: &str, #[case] error: ParseApiVersionError) { |
| 132 | + let err = ApiVersion::from_str(input).expect_err("invalid Kubernetes api versions"); |
| 133 | + assert_eq!(err, error); |
| 134 | + } |
| 135 | + |
| 136 | + #[rstest] |
| 137 | + #[case(Version {major: 1, level: Some(Level::Alpha(2))}, Version {major: 1, level: Some(Level::Alpha(1))}, Ordering::Greater)] |
| 138 | + #[case(Version {major: 1, level: Some(Level::Alpha(1))}, Version {major: 1, level: Some(Level::Alpha(1))}, Ordering::Equal)] |
| 139 | + #[case(Version {major: 1, level: Some(Level::Alpha(1))}, Version {major: 1, level: Some(Level::Alpha(2))}, Ordering::Less)] |
| 140 | + #[case(Version {major: 1, level: None}, Version {major: 1, level: Some(Level::Alpha(2))}, Ordering::Greater)] |
| 141 | + #[case(Version {major: 1, level: None}, Version {major: 1, level: Some(Level::Beta(2))}, Ordering::Greater)] |
| 142 | + #[case(Version {major: 1, level: None}, Version {major: 1, level: None}, Ordering::Equal)] |
| 143 | + #[case(Version {major: 1, level: None}, Version {major: 2, level: None}, Ordering::Less)] |
| 144 | + fn partial_ord(#[case] input: Version, #[case] other: Version, #[case] expected: Ordering) { |
| 145 | + assert_eq!(input.partial_cmp(&other), Some(expected)); |
| 146 | + } |
| 147 | + |
| 148 | + #[cfg(feature = "darling")] |
| 149 | + #[rstest] |
| 150 | + #[case(quote!(ignore = "extensions/v1beta1"), ApiVersion { group: Some("extensions".parse().unwrap()), version: Version { major: 1, level: Some(Level::Beta(1)) } })] |
| 151 | + #[case(quote!(ignore = "v1beta1"), ApiVersion { group: None, version: Version { major: 1, level: Some(Level::Beta(1)) } })] |
| 152 | + #[case(quote!(ignore = "v1"), ApiVersion { group: None, version: Version { major: 1, level: None } })] |
| 153 | + fn from_meta(#[case] input: proc_macro2::TokenStream, #[case] expected: ApiVersion) { |
| 154 | + let meta = parse_meta(input).expect("valid attribute tokens"); |
| 155 | + let api_version = ApiVersion::from_meta(&meta).expect("version must parse from attribute"); |
| 156 | + assert_eq!(api_version, expected); |
| 157 | + } |
| 158 | +} |
0 commit comments