refactor: consolidate error handling

Author: maltesander

rust/operator-binary/src/spark_k8s_controller.rs

@@ -2,7 +2,6 @@ use std::sync::Arc;
 
 use snafu::{ResultExt, Snafu};
 use stackable_operator::{
-    builder::{self},
     k8s_openapi::api::{
         batch::v1::Job,
         core::v1::{ConfigMap, ServiceAccount},
@@ -15,13 +14,12 @@ use stackable_operator::{
     },
     logging::controller::ReconcilerError,
     shared::time::Duration,
-    v2::config_file_writer::PropertiesWriterError,
 };
 use strum::{EnumDiscriminants, IntoStaticStr};
 
 use crate::{
     Ctx,
-    crd::{constants::*, roles::SparkApplicationRole, v1alpha1},
+    crd::{constants::*, v1alpha1},
 };
 
 pub mod build;
@@ -38,8 +36,8 @@ pub enum Error {
     #[snafu(display("failed to validate SparkApplication"))]
     ValidateSparkApplication { source: validate::Error },
 
-    #[snafu(display("missing secret lifetime"))]
-    MissingSecretLifetime,
+    #[snafu(display("failed to build SparkApplication resources"))]
+    BuildSparkApplication { source: build::Error },
 
     #[snafu(display("failed to apply role ServiceAccount"))]
     ApplyServiceAccount {
@@ -56,54 +54,12 @@ pub enum Error {
         source: stackable_operator::client::Error,
     },
 
-    #[snafu(display("failed to build stark-submit command"))]
-    BuildCommand { source: crate::crd::Error },
-
-    #[snafu(display("failed to build the pod template config map"))]
-    PodTemplateConfigMap {
-        source: stackable_operator::builder::configmap::Error,
-    },
-
-    #[snafu(display("pod template serialization"))]
-    PodTemplateSerde { source: serde_yaml::Error },
-
-    #[snafu(display("failed to resolve and merge config"))]
-    FailedToResolveConfig { source: crate::crd::Error },
-
-    #[snafu(display("vector agent is enabled but vector aggregator ConfigMap is missing"))]
-    VectorAggregatorConfigMapMissing,
-
-    #[snafu(display("failed to validate the logging configuration"))]
-    ValidateLoggingConfig {
-        source: stackable_operator::v2::product_logging::framework::Error,
-    },
-
-    #[snafu(display("failed to serialize [{JVM_SECURITY_PROPERTIES_FILE}] for {}", role))]
-    JvmSecurityProperties {
-        source: PropertiesWriterError,
-        role: SparkApplicationRole,
-    },
-
-    #[snafu(display("invalid submit config"))]
-    SubmitConfig { source: crate::crd::Error },
-
-    #[snafu(display("failed to create Volumes for SparkApplication"))]
-    CreateVolumes { source: crate::crd::Error },
-
     #[snafu(display("Failed to update status for application {name:?}"))]
     ApplySparkApplicationStatus {
         source: stackable_operator::client::Error,
         name: String,
     },
 
-    #[snafu(display("failed to add needed volume"))]
-    AddVolume { source: builder::pod::Error },
-
-    #[snafu(display("failed to add needed volumeMount"))]
-    AddVolumeMount {
-        source: builder::pod::container::Error,
-    },
-
     #[snafu(display("SparkApplication object is invalid"))]
     InvalidSparkApplication {
         // boxed because otherwise Clippy warns about a large enum variant
@@ -168,7 +124,7 @@ pub async fn reconcile(
     // No more mutating operations after this point (except for status).
     tracing::debug!("reconciling spark application [{spark_application:?}]");
 
-    let resources = build::build(&validated)?;
+    let resources = build::build(&validated).context(BuildSparkApplicationSnafu)?;
 
     // Apply the ServiceAccount and RoleBinding first, then the ConfigMaps, and finally the Job:
     // the Job runs under the ServiceAccount and mounts the ConfigMaps, so they must exist first.

rust/operator-binary/src/spark_k8s_controller/build/mod.rs

@@ -1,16 +1,34 @@
 pub mod pod;
 pub mod resource;
 
-use snafu::ResultExt;
+use resource::{config_map, job};
+use snafu::{ResultExt, Snafu};
 
 use crate::{
     crd::roles::SparkApplicationRole,
-    spark_k8s_controller::{
-        BuildCommandSnafu, FailedToResolveConfigSnafu, Result, SparkResources, SubmitConfigSnafu,
-        validate::ValidatedSparkApplication,
-    },
+    spark_k8s_controller::{SparkResources, validate::ValidatedSparkApplication},
 };
 
+#[derive(Snafu, Debug)]
+pub enum Error {
+    #[snafu(display("failed to resolve and merge config"))]
+    FailedToResolveConfig { source: crate::crd::Error },
+
+    #[snafu(display("failed to build stark-submit command"))]
+    BuildCommand { source: crate::crd::Error },
+
+    #[snafu(display("invalid submit config"))]
+    SubmitConfig { source: crate::crd::Error },
+
+    #[snafu(display("failed to build ConfigMap"))]
+    BuildConfigMap { source: config_map::Error },
+
+    #[snafu(display("failed to build Job"))]
+    BuildJob { source: job::Error },
+}
+
+type Result<T, E = Error> = std::result::Result<T, E>;
+
 /// Builds every Kubernetes resource for the given validated SparkApplication.
 pub fn build(validated: &ValidatedSparkApplication) -> Result<SparkResources> {
     let spark_application = &validated.spark_application;
@@ -19,7 +37,7 @@ pub fn build(validated: &ValidatedSparkApplication) -> Result<SparkResources> {
     let resolved_product_image = &validated.resolved_product_image;
 
     let (service_account, role_binding) =
-        resource::serviceaccount::build_spark_role_serviceaccount(validated)?;
+        resource::serviceaccount::build_spark_role_serviceaccount(validated);
 
     let env_vars = spark_application.env(opt_s3conn, logdir);
 
@@ -41,7 +59,8 @@ pub fn build(validated: &ValidatedSparkApplication) -> Result<SparkResources> {
         &driver_config_overrides,
         &env_vars,
         &service_account,
-    )?;
+    )
+    .context(BuildConfigMapSnafu)?;
 
     let executor_config = spark_application
         .executor_config()
@@ -61,7 +80,8 @@ pub fn build(validated: &ValidatedSparkApplication) -> Result<SparkResources> {
         &executor_config_overrides,
         &env_vars,
         &service_account,
-    )?;
+    )
+    .context(BuildConfigMapSnafu)?;
 
     let job_commands = spark_application
         .build_command(opt_s3conn, logdir, &resolved_product_image.image)
@@ -79,15 +99,17 @@ pub fn build(validated: &ValidatedSparkApplication) -> Result<SparkResources> {
         .unwrap_or_default();
 
     let submit_job_config_map =
-        resource::config_map::submit_job_config_map(validated, &submit_config_overrides)?;
+        resource::config_map::submit_job_config_map(validated, &submit_config_overrides)
+            .context(BuildConfigMapSnafu)?;
 
     let job = resource::job::spark_job(
         validated,
         &service_account,
         &env_vars,
         &job_commands,
         &submit_config,
-    )?;
+    )
+    .context(BuildJobSnafu)?;
 
     Ok(SparkResources {
         service_account,

rust/operator-binary/src/spark_k8s_controller/build/pod.rs

@@ -1,6 +1,6 @@
 use std::str::FromStr;
 
-use snafu::{OptionExt, ResultExt};
+use snafu::{OptionExt, ResultExt, Snafu};
 use stackable_operator::{
     builder::{
         meta::ObjectMetaBuilder,
@@ -38,12 +38,32 @@ use crate::{
         roles::{RoleConfig, SparkApplicationRole, SparkContainer},
         tlscerts,
     },
-    spark_k8s_controller::{
-        AddVolumeMountSnafu, AddVolumeSnafu, Result, ValidateLoggingConfigSnafu,
-        VectorAggregatorConfigMapMissingSnafu, validate,
-    },
+    spark_k8s_controller::validate,
 };
 
+#[derive(Snafu, Debug)]
+pub enum Error {
+    #[snafu(display("failed to add needed volumeMount"))]
+    AddVolumeMount {
+        source: stackable_operator::builder::pod::container::Error,
+    },
+
+    #[snafu(display("failed to add needed volume"))]
+    AddVolume {
+        source: stackable_operator::builder::pod::Error,
+    },
+
+    #[snafu(display("failed to validate the logging configuration"))]
+    ValidateLoggingConfig {
+        source: stackable_operator::v2::product_logging::framework::Error,
+    },
+
+    #[snafu(display("vector agent is enabled but vector aggregator ConfigMap is missing"))]
+    VectorAggregatorConfigMapMissing,
+}
+
+type Result<T, E = Error> = std::result::Result<T, E>;
+
 fn init_containers(
     validated: &validate::ValidatedSparkApplication,
     logging: &Logging<SparkContainer>,

rust/operator-binary/src/spark_k8s_controller/build/resource/config_map.rs

@@ -1,4 +1,4 @@
-use snafu::{OptionExt, ResultExt};
+use snafu::{OptionExt, ResultExt, Snafu};
 use stackable_operator::{
     builder::{configmap::ConfigMapBuilder, pod::volume::VolumeBuilder},
     k8s_openapi::api::core::v1::{ConfigMap, EnvVar, ServiceAccount},
@@ -20,12 +20,39 @@ use crate::{
     },
     product_logging::{self},
     spark_k8s_controller::{
-        CreateVolumesSnafu, JvmSecurityPropertiesSnafu, MissingSecretLifetimeSnafu,
-        PodTemplateConfigMapSnafu, PodTemplateSerdeSnafu, Result, build::pod::pod_template,
+        build::pod::{self, pod_template},
         validate,
     },
 };
 
+#[derive(Snafu, Debug)]
+pub enum Error {
+    #[snafu(display("failed to build the pod template"))]
+    BuildPodTemplate { source: pod::Error },
+
+    #[snafu(display("pod template serialization"))]
+    PodTemplateSerde { source: serde_yaml::Error },
+
+    #[snafu(display("failed to serialize [{JVM_SECURITY_PROPERTIES_FILE}] for {}", role))]
+    JvmSecurityProperties {
+        source: stackable_operator::v2::config_file_writer::PropertiesWriterError,
+        role: SparkApplicationRole,
+    },
+
+    #[snafu(display("failed to build the pod template config map"))]
+    PodTemplateConfigMap {
+        source: stackable_operator::builder::configmap::Error,
+    },
+
+    #[snafu(display("missing secret lifetime"))]
+    MissingSecretLifetime,
+
+    #[snafu(display("failed to create Volumes for SparkApplication"))]
+    CreateVolumes { source: crate::crd::Error },
+}
+
+type Result<T, E = Error> = std::result::Result<T, E>;
+
 pub(crate) fn pod_template_config_map(
     validated: &validate::ValidatedSparkApplication,
     role: SparkApplicationRole,
@@ -75,7 +102,8 @@ pub(crate) fn pod_template_config_map(
         volumes.as_ref(),
         env,
         service_account,
-    )?;
+    )
+    .context(BuildPodTemplateSnafu)?;
 
     let mut cm_builder = ConfigMapBuilder::new();
 

rust/operator-binary/src/spark_k8s_controller/build/resource/job.rs

@@ -1,4 +1,4 @@
-use snafu::{OptionExt, ResultExt};
+use snafu::{OptionExt, ResultExt, Snafu};
 use stackable_operator::{
     builder::{meta::ObjectMetaBuilder, pod::volume::VolumeBuilder},
     k8s_openapi::{
@@ -17,12 +17,25 @@ use crate::{
         roles::{SparkApplicationRole, SparkContainer, SubmitConfig},
         tlscerts,
     },
-    spark_k8s_controller::{
-        AddVolumeMountSnafu, CreateVolumesSnafu, MissingSecretLifetimeSnafu, Result,
-        build::pod::security_context, validate,
-    },
+    spark_k8s_controller::{build::pod::security_context, validate},
 };
 
+#[derive(Snafu, Debug)]
+pub enum Error {
+    #[snafu(display("failed to add needed volumeMount"))]
+    AddVolumeMount {
+        source: stackable_operator::builder::pod::container::Error,
+    },
+
+    #[snafu(display("missing secret lifetime"))]
+    MissingSecretLifetime,
+
+    #[snafu(display("failed to create Volumes for SparkApplication"))]
+    CreateVolumes { source: crate::crd::Error },
+}
+
+type Result<T, E = Error> = std::result::Result<T, E>;
+
 pub(crate) fn spark_job(
     validated: &validate::ValidatedSparkApplication,
     serviceaccount: &ServiceAccount,

rust/operator-binary/src/spark_k8s_controller/build/resource/serviceaccount.rs

@@ -6,18 +6,15 @@ use stackable_operator::k8s_openapi::{
     },
 };
 
-use crate::{
-    crd::constants::*,
-    spark_k8s_controller::{Result, validate},
-};
+use crate::{crd::constants::*, spark_k8s_controller::validate};
 
 /// For a given SparkApplication, we create a ServiceAccount with a RoleBinding to the ClusterRole
 /// that allows the driver to create pods etc.
 /// Both objects have an owner reference to the SparkApplication, as well as the same name as the app.
 /// They are deleted when the job is deleted.
 pub(crate) fn build_spark_role_serviceaccount(
     validated: &validate::ValidatedSparkApplication,
-) -> Result<(ServiceAccount, RoleBinding)> {
+) -> (ServiceAccount, RoleBinding) {
     let sa_name = validated.name.to_string();
     let sa = ServiceAccount {
         metadata: validated.object_meta(&sa_name, "service-account").build(),
@@ -38,5 +35,5 @@ pub(crate) fn build_spark_role_serviceaccount(
             namespace: sa.metadata.namespace.clone(),
         }]),
     };
-    Ok((sa, binding))
+    (sa, binding)
 }