Skip to content

feat(stackable-versioned): Add flux-converter #1050

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ educe = { version = "0.6.0", default-features = false, features = ["Clone", "De
either = "1.13.0"
futures = "0.3.30"
futures-util = "0.3.30"
indexmap = "2.5"
indexmap = "2.5.0"
indoc = "2.0.6"
insta = { version= "1.40", features = ["glob"] }
hyper = { version = "1.4.1", features = ["full"] }
hyper-util = "0.1.8"
Expand Down
35 changes: 35 additions & 0 deletions crates/k8s-version/src/api_version/darling.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
use std::str::FromStr;

use darling::FromMeta;

use crate::ApiVersion;

impl FromMeta for ApiVersion {
fn from_string(value: &str) -> darling::Result<Self> {
Self::from_str(value).map_err(darling::Error::custom)
}
}

#[cfg(test)]
mod test {
use quote::quote;
use rstest::rstest;

use super::*;
use crate::{Level, Version};

fn parse_meta(tokens: proc_macro2::TokenStream) -> ::std::result::Result<syn::Meta, String> {
let attribute: syn::Attribute = syn::parse_quote!(#[#tokens]);
Ok(attribute.meta)
}

#[rstest]
#[case(quote!(ignore = "extensions/v1beta1"), ApiVersion { group: Some("extensions".parse().unwrap()), version: Version { major: 1, level: Some(Level::Beta(1)) } })]
#[case(quote!(ignore = "v1beta1"), ApiVersion { group: None, version: Version { major: 1, level: Some(Level::Beta(1)) } })]
#[case(quote!(ignore = "v1"), ApiVersion { group: None, version: Version { major: 1, level: None } })]
fn from_meta(#[case] input: proc_macro2::TokenStream, #[case] expected: ApiVersion) {
let meta = parse_meta(input).expect("valid attribute tokens");
let api_version = ApiVersion::from_meta(&meta).expect("version must parse from attribute");
assert_eq!(api_version, expected);
}
}
41 changes: 8 additions & 33 deletions crates/k8s-version/src/api_version/mod.rs
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
use std::{cmp::Ordering, fmt::Display, str::FromStr};

#[cfg(feature = "darling")]
use darling::FromMeta;
use snafu::{ResultExt, Snafu};

use crate::{Group, ParseGroupError, ParseVersionError, Version};

#[cfg(feature = "serde")]
mod serde;

#[cfg(feature = "darling")]
mod darling;

/// Error variants which can be encountered when creating a new [`ApiVersion`]
/// from unparsed input.
#[derive(Debug, PartialEq, Snafu)]
Expand Down Expand Up @@ -45,13 +46,13 @@ impl FromStr for ApiVersion {
fn from_str(input: &str) -> Result<Self, Self::Err> {
let (group, version) = if let Some((group, version)) = input.split_once('/') {
let group = Group::from_str(group).context(ParseGroupSnafu)?;
let version = Version::from_str(version).context(ParseVersionSnafu)?;

(
Some(group),
Version::from_str(version).context(ParseVersionSnafu)?,
)
(Some(group), version)
} else {
(None, Version::from_str(input).context(ParseVersionSnafu)?)
let version = Version::from_str(input).context(ParseVersionSnafu)?;

(None, version)
};

Ok(Self { group, version })
Expand All @@ -77,13 +78,6 @@ impl Display for ApiVersion {
}
}

#[cfg(feature = "darling")]
impl FromMeta for ApiVersion {
fn from_string(value: &str) -> darling::Result<Self> {
Self::from_str(value).map_err(darling::Error::custom)
}
}

impl ApiVersion {
/// Create a new Kubernetes API version.
pub fn new(group: Option<Group>, version: Version) -> Self {
Expand All @@ -104,19 +98,11 @@ impl ApiVersion {

#[cfg(test)]
mod test {
#[cfg(feature = "darling")]
use quote::quote;
use rstest::rstest;

use super::*;
use crate::Level;

#[cfg(feature = "darling")]
fn parse_meta(tokens: proc_macro2::TokenStream) -> ::std::result::Result<syn::Meta, String> {
let attribute: syn::Attribute = syn::parse_quote!(#[#tokens]);
Ok(attribute.meta)
}

#[rstest]
#[case("extensions/v1beta1", ApiVersion { group: Some("extensions".parse().unwrap()), version: Version { major: 1, level: Some(Level::Beta(1)) } })]
#[case("v1beta1", ApiVersion { group: None, version: Version { major: 1, level: Some(Level::Beta(1)) } })]
Expand Down Expand Up @@ -145,15 +131,4 @@ mod test {
fn partial_ord(#[case] input: Version, #[case] other: Version, #[case] expected: Ordering) {
assert_eq!(input.partial_cmp(&other), Some(expected));
}

#[cfg(feature = "darling")]
#[rstest]
#[case(quote!(ignore = "extensions/v1beta1"), ApiVersion { group: Some("extensions".parse().unwrap()), version: Version { major: 1, level: Some(Level::Beta(1)) } })]
#[case(quote!(ignore = "v1beta1"), ApiVersion { group: None, version: Version { major: 1, level: Some(Level::Beta(1)) } })]
#[case(quote!(ignore = "v1"), ApiVersion { group: None, version: Version { major: 1, level: None } })]
fn from_meta(#[case] input: proc_macro2::TokenStream, #[case] expected: ApiVersion) {
let meta = parse_meta(input).expect("valid attribute tokens");
let api_version = ApiVersion::from_meta(&meta).expect("version must parse from attribute");
assert_eq!(api_version, expected);
}
}
4 changes: 2 additions & 2 deletions crates/k8s-version/src/group.rs
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ impl FromStr for Group {
ensure!(group.len() <= MAX_GROUP_LENGTH, TooLongSnafu);
ensure!(API_GROUP_REGEX.is_match(group), InvalidFormatSnafu);

Ok(Self(group.to_string()))
Ok(Self(group.to_owned()))
}
}

impl fmt::Display for Group {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.0)
f.write_str(&*self)
}
}

Expand Down
3 changes: 2 additions & 1 deletion crates/stackable-operator/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ versioned = []

[dependencies]
stackable-telemetry = { path = "../stackable-telemetry", features = ["clap"] }
stackable-versioned = { path = "../stackable-versioned", features = ["k8s"] }
stackable-versioned = { path = "../stackable-versioned", features = ["k8s", "flux-converter"] }
stackable-operator-derive = { path = "../stackable-operator-derive" }
stackable-shared = { path = "../stackable-shared" }

Expand All @@ -28,6 +28,7 @@ dockerfile-parser.workspace = true
either.workspace = true
educe.workspace = true
futures.workspace = true
indoc.workspace = true
indexmap.workspace = true
json-patch.workspace = true
k8s-openapi.workspace = true
Expand Down
2 changes: 1 addition & 1 deletion crates/stackable-operator/src/commons/resources.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
//! crates(
//! kube_core = "stackable_operator::kube::core",
//! k8s_openapi = "stackable_operator::k8s_openapi",
//! schemars = "stackable_operator::schemars"
//! schemars = "stackable_operator::schemars",
//! )
//! )]
//! #[serde(rename_all = "camelCase")]
Expand Down
60 changes: 59 additions & 1 deletion crates/stackable-operator/src/crd/authentication/core/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ pub mod versioned {
crates(
kube_core = "kube::core",
k8s_openapi = "k8s_openapi",
schemars = "schemars"
schemars = "schemars",
)
))]
#[derive(
Expand Down Expand Up @@ -153,3 +153,61 @@ pub mod versioned {
oidc: Option<oidc::v1alpha1::ClientAuthenticationOptions<O>>,
}
}

#[cfg(test)]
impl stackable_versioned::flux_converter::test_utils::RoundtripTestData
for v1alpha1::AuthenticationClassSpec
{
fn get_roundtrip_test_data() -> Vec<Self> {
crate::utils::yaml_from_str_singleton_map(indoc::indoc! {"
- provider:
static:
userCredentialsSecret:
name: simple-users-credentials
- provider:
ldap:
hostname: my.ldap.server
port: 389
searchBase: ou=users,dc=example,dc=org
searchFilter: foo
bindCredentials:
secretClass: openldap-bind-credentials
ldapFieldNames:
email: email
givenName: givenName
group: group
surname: surname
uid: uid
tls:
verification:
server:
caCert:
secretClass: s3-cert
- provider:
oidc:
hostname: my.keycloak.server
port: 8080
rootPath: /realms/master
scopes:
- email
- openid
- profile
principalClaim: preferred_username
providerHint: Keycloak
tls:
verification:
server:
caCert:
secretClass: s3-cert
- provider:
tls: {}
- provider:
tls:
clientCertSecretClass: client-auth-tls
- provider:
kerberos:
kerberosSecretClass: kerberos-auth
"})
.expect("Failed to parse AuthenticationClassSpec YAML")
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ impl Default for FieldNames {
#[cfg(test)]
mod tests {
use super::*;
use crate::commons::secret_class::SecretClassVolume;
use crate::{commons::secret_class::SecretClassVolume, utils::yaml_from_str_singleton_map};

#[test]
fn minimal() {
Expand Down Expand Up @@ -213,9 +213,7 @@ mod tests {
caCert:
secretClass: ldap-ca-cert
"#;
let deserializer = serde_yaml::Deserializer::from_str(input);
let ldap: AuthenticationProvider =
serde_yaml::with::singleton_map_recursive::deserialize(deserializer).unwrap();
let ldap: AuthenticationProvider = yaml_from_str_singleton_map(input).unwrap();

assert_eq!(ldap.port(), 42);
assert!(ldap.tls.uses_tls());
Expand Down
6 changes: 2 additions & 4 deletions crates/stackable-operator/src/crd/git_sync/v1alpha1_impl.rs
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ mod tests {
use super::*;
use crate::{
config::fragment::validate, product_config_utils::env_vars_from,
product_logging::spec::default_container_log_config,
product_logging::spec::default_container_log_config, utils::yaml_from_str_singleton_map,
};

#[test]
Expand Down Expand Up @@ -435,9 +435,7 @@ mod tests {
--git-config: key:value,safe.directory:/safe-dir
"#;

let deserializer = serde_yaml::Deserializer::from_str(git_sync_spec);
let git_syncs: Vec<GitSync> =
serde_yaml::with::singleton_map_recursive::deserialize(deserializer).unwrap();
let git_syncs: Vec<GitSync> = yaml_from_str_singleton_map(git_sync_spec).unwrap();

let resolved_product_image = ResolvedProductImage {
image: "oci.stackable.tech/sdp/product:latest".to_string(),
Expand Down
21 changes: 21 additions & 0 deletions crates/stackable-operator/src/crd/listener/class/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,24 @@ pub mod versioned {
pub preferred_address_type: core_v1alpha1::PreferredAddressType,
}
}

#[cfg(test)]
impl stackable_versioned::flux_converter::test_utils::RoundtripTestData
for v1alpha1::ListenerClassSpec
{
fn get_roundtrip_test_data() -> Vec<Self> {
crate::utils::yaml_from_str_singleton_map(indoc::indoc! {"
- serviceType: ClusterIP
- serviceType: NodePort
- serviceType: LoadBalancer
- serviceType: ClusterIP
loadBalancerAllocateNodePorts: false
loadBalancerClass: foo
serviceAnnotations:
foo: bar
serviceExternalTrafficPolicy: Local
preferredAddressType: HostnameConservative
"})
.expect("Failed to parse ListenerClassSpec YAML")
}
}
Loading
Loading