Move CLI arg into KubernetesClusterInfoCliOpts struct

Author: sbernauer

crates/stackable-operator/src/cli.rs

@@ -115,7 +115,10 @@ use clap::Args;
 use product_config::ProductConfigManager;
 use snafu::{ResultExt, Snafu};
 
-use crate::{commons::networking::DomainName, logging::TracingTarget, namespace::WatchNamespace};
+use crate::{
+    logging::TracingTarget, namespace::WatchNamespace,
+    utils::cluster_info::KubernetesClusterInfoCliOpts,
+};
 
 pub const AUTHOR: &str = "Stackable GmbH - [email protected]";
 
@@ -171,16 +174,22 @@ pub enum Command<Run: Args = ProductOperatorRun> {
 ///     common: ProductOperatorRun,
 /// }
 /// use clap::Parser;
-/// use stackable_operator::logging::TracingTarget;
-/// use stackable_operator::namespace::WatchNamespace;
+/// use stackable_operator::{
+///     logging::TracingTarget,
+///     namespace::WatchNamespace,
+///     utils::cluster_info::KubernetesClusterInfoCliOpts
+/// };
+///
 /// let opts = Command::<Run>::parse_from(["foobar-operator", "run", "--name", "foo", "--product-config", "bar", "--watch-namespace", "foobar"]);
 /// assert_eq!(opts, Command::Run(Run {
 ///     name: "foo".to_string(),
 ///     common: ProductOperatorRun {
 ///         product_config: ProductConfigPath::from("bar".as_ref()),
 ///         watch_namespace: WatchNamespace::One("foobar".to_string()),
 ///         tracing_target: TracingTarget::None,
-///         kubernetes_cluster_domain: None,
+///         cluster_info_opts: KubernetesClusterInfoCliOpts {
+///             kubernetes_cluster_domain: None
+///         }
 ///     },
 /// }));
 /// ```
@@ -215,11 +224,8 @@ pub struct ProductOperatorRun {
     #[arg(long, env, default_value_t, value_enum)]
     pub tracing_target: TracingTarget,
 
-    /// Kubernetes cluster domain, usually this is `cluster.local`.
-    // We are not using a default value here, as operators will probably do an more advanced
-    // auto-detection of the cluster domain in case it is not specified in the future.
-    #[arg(long, env)]
-    pub kubernetes_cluster_domain: Option<DomainName>,
+    #[command(flatten)]
+    pub cluster_info_opts: KubernetesClusterInfoCliOpts,
 }
 
 /// A path to a [`ProductConfigManager`] spec file
@@ -393,7 +399,9 @@ mod tests {
                 product_config: ProductConfigPath::from("bar".as_ref()),
                 watch_namespace: WatchNamespace::One("foo".to_string()),
                 tracing_target: TracingTarget::None,
-                kubernetes_cluster_domain: None,
+                cluster_info_opts: KubernetesClusterInfoCliOpts {
+                    kubernetes_cluster_domain: None
+                }
             }
         );
 
@@ -405,7 +413,9 @@ mod tests {
                 product_config: ProductConfigPath::from("bar".as_ref()),
                 watch_namespace: WatchNamespace::All,
                 tracing_target: TracingTarget::None,
-                kubernetes_cluster_domain: None,
+                cluster_info_opts: KubernetesClusterInfoCliOpts {
+                    kubernetes_cluster_domain: None
+                }
             }
         );
 
@@ -418,7 +428,9 @@ mod tests {
                 product_config: ProductConfigPath::from("bar".as_ref()),
                 watch_namespace: WatchNamespace::One("foo".to_string()),
                 tracing_target: TracingTarget::None,
-                kubernetes_cluster_domain: None,
+                cluster_info_opts: KubernetesClusterInfoCliOpts {
+                    kubernetes_cluster_domain: None
+                }
             }
         );
     }

crates/stackable-operator/src/client.rs

@@ -20,8 +20,8 @@ use snafu::{OptionExt, ResultExt, Snafu};
 use tracing::trace;
 
 use crate::{
-    commons::networking::DomainName, kvp::LabelSelectorExt,
-    utils::cluster_info::KubernetesClusterInfo,
+    kvp::LabelSelectorExt,
+    utils::cluster_info::{KubernetesClusterInfo, KubernetesClusterInfoCliOpts},
 };
 
 pub type Result<T, E = Error> = std::result::Result<T, E>;
@@ -521,12 +521,20 @@ impl Client {
     /// use tokio::time::error::Elapsed;
     /// use kube::runtime::watcher;
     /// use k8s_openapi::api::core::v1::Pod;
-    /// use stackable_operator::client::{Client, initialize_operator};
+    /// use stackable_operator::{
+    ///     client::{Client, initialize_operator},
+    ///     utils::cluster_info::KubernetesClusterInfoCliOpts
+    /// };
     ///
     /// #[tokio::main]
-    /// async fn main(){
+    /// async fn main() {
     ///
-    /// let client: Client = initialize_operator(&None, None).await.expect("Unable to construct client.");
+    /// let cluster_info_cli_opts = KubernetesClusterInfoCliOpts {
+    ///     kubernetes_cluster_domain: None,
+    /// };
+    /// let client = initialize_operator(None, &cluster_info_cli_opts)
+    ///     .await
+    ///     .expect("Unable to construct client.");
     /// let watcher_config: watcher::Config =
     ///         watcher::Config::default().fields(&format!("metadata.name=nonexistent-pod"));
     ///
@@ -634,16 +642,16 @@ where
 }
 
 pub async fn initialize_operator(
-    cli_kubernetes_cluster_domain: &Option<DomainName>,
     field_manager: Option<String>,
+    cluster_info_cli_opts: &KubernetesClusterInfoCliOpts,
 ) -> Result<Client> {
     let kubeconfig: Config = kube::Config::infer()
         .await
         .map_err(kube::Error::InferConfig)
         .context(InferKubeConfigSnafu)?;
     let default_namespace = kubeconfig.default_namespace.clone();
     let client = kube::Client::try_from(kubeconfig).context(CreateKubeClientSnafu)?;
-    let cluster_info = KubernetesClusterInfo::new(cli_kubernetes_cluster_domain);
+    let cluster_info = KubernetesClusterInfo::new(cluster_info_cli_opts);
 
     Ok(Client::new(
         client,
@@ -668,10 +676,15 @@ mod tests {
     };
     use tokio::time::error::Elapsed;
 
+    use crate::utils::cluster_info::KubernetesClusterInfoCliOpts;
+
     #[tokio::test]
     #[ignore = "Tests depending on Kubernetes are not ran by default"]
     async fn k8s_test_wait_created() {
-        let client = super::initialize_operator(&None, None)
+        let cluster_info_cli_opts = KubernetesClusterInfoCliOpts {
+            kubernetes_cluster_domain: None,
+        };
+        let client = super::initialize_operator(None, &cluster_info_cli_opts)
             .await
             .expect("KUBECONFIG variable must be configured.");
 
@@ -749,7 +762,10 @@ mod tests {
     #[tokio::test]
     #[ignore = "Tests depending on Kubernetes are not ran by default"]
     async fn k8s_test_wait_created_timeout() {
-        let client = super::initialize_operator(&None, None)
+        let cluster_info_cli_opts = KubernetesClusterInfoCliOpts {
+            kubernetes_cluster_domain: None,
+        };
+        let client = super::initialize_operator(None, &cluster_info_cli_opts)
             .await
             .expect("KUBECONFIG variable must be configured.");
 
@@ -769,7 +785,10 @@ mod tests {
     #[tokio::test]
     #[ignore = "Tests depending on Kubernetes are not ran by default"]
     async fn k8s_test_list_with_label_selector() {
-        let client = super::initialize_operator(&None, None)
+        let cluster_info_cli_opts = KubernetesClusterInfoCliOpts {
+            kubernetes_cluster_domain: None,
+        };
+        let client = super::initialize_operator(None, &cluster_info_cli_opts)
             .await
             .expect("KUBECONFIG variable must be configured.");
 

crates/stackable-operator/src/utils/cluster_info.rs

@@ -9,9 +9,18 @@ pub struct KubernetesClusterInfo {
     pub cluster_domain: DomainName,
 }
 
+#[derive(clap::Parser, Debug, PartialEq, Eq)]
+pub struct KubernetesClusterInfoCliOpts {
+    /// Kubernetes cluster domain, usually this is `cluster.local`.
+    // We are not using a default value here, as operators will probably do an more advanced
+    // auto-detection of the cluster domain in case it is not specified in the future.
+    #[arg(long, env)]
+    pub kubernetes_cluster_domain: Option<DomainName>,
+}
+
 impl KubernetesClusterInfo {
-    pub fn new(cli_kubernetes_cluster_domain: &Option<DomainName>) -> Self {
-        let cluster_domain = match cli_kubernetes_cluster_domain {
+    pub fn new(cluster_info_cli_opts: &KubernetesClusterInfoCliOpts) -> Self {
+        let cluster_domain = match &cluster_info_cli_opts.kubernetes_cluster_domain {
             Some(cluster_domain) => {
                 tracing::info!(%cluster_domain, "Using configured Kubernetes cluster domain");