refactor!: Change PodBuilder::termination_grace_period to take Duration struct

CHANGELOG.md

@@ -7,8 +7,10 @@ All notable changes to this project will be documented in this file.
 ### Changed
 
 - Convert the format of the Vector configuration from TOML to YAML ([#670]).
+- BREAKING: Rename `PodBuilder::termination_grace_period_seconds` to `termination_grace_period`, and change it to take `Duration` struct ([#672]).
 
 [#670]: https://github.com/stackabletech/operator-rs/pull/670
+[#672]: https://github.com/stackabletech/operator-rs/pull/672
 
 ## [0.54.0] - 2023-10-10
 

src/builder/pod/mod.rs

@@ -4,6 +4,7 @@ pub mod security;
 pub mod volume;
 
 use std::collections::BTreeMap;
+use std::num::TryFromIntError;
 
 use crate::builder::meta::ObjectMetaBuilder;
 use crate::commons::affinity::StackableAffinity;
@@ -12,7 +13,8 @@ use crate::commons::resources::{
     ComputeResource, ResourceRequirementsExt, ResourceRequirementsType, LIMIT_REQUEST_RATIO_CPU,
     LIMIT_REQUEST_RATIO_MEMORY,
 };
-use crate::error::{Error, OperatorResult};
+use crate::duration::Duration;
+use crate::error::{self, OperatorResult};
 
 use super::{ListenerOperatorVolumeSourceBuilder, ListenerReference, VolumeBuilder};
 use k8s_openapi::{
@@ -25,8 +27,18 @@ use k8s_openapi::{
 };
 use tracing::warn;
 
+#[derive(Debug, thiserror::Error, PartialEq)]
+pub enum Error {
+    #[error("The duration {duration} is too long to put it into the Pods terminationGracePeriodSeconds. The maximum duration is {}", Duration::from_secs(i64::MAX as u64))]
+    DurationTooLong {
+        source: TryFromIntError,
+        duration: Duration,
+    },
+}
+pub type Result<T> = std::result::Result<T, Error>;
+
 /// A builder to build [`Pod`] or [`PodTemplateSpec`] objects.
-#[derive(Clone, Default)]
+#[derive(Clone, Debug, Default, PartialEq)]
 pub struct PodBuilder {
     containers: Vec<Container>,
     host_network: Option<bool>,
@@ -452,19 +464,27 @@ impl PodBuilder {
         self
     }
 
-    pub fn termination_grace_period_seconds(
+    pub fn termination_grace_period(
         &mut self,
-        termination_grace_period_seconds: i64,
-    ) -> &mut Self {
+        termination_grace_period: &Duration,
+    ) -> Result<&mut Self> {
+        let termination_grace_period_seconds = termination_grace_period
+            .as_secs()
+            .try_into()
+            .map_err(|err| Error::DurationTooLong {
+                source: err,
+                duration: *termination_grace_period,
+            })?;
+
         self.termination_grace_period_seconds = Some(termination_grace_period_seconds);
-        self
+        Ok(self)
     }
 
     /// Consumes the Builder and returns a constructed [`Pod`]
     pub fn build(&self) -> OperatorResult<Pod> {
         Ok(Pod {
             metadata: match self.metadata {
-                None => return Err(Error::MissingObjectKey { key: "metadata" }),
+                None => return Err(error::Error::MissingObjectKey { key: "metadata" }),
                 Some(ref metadata) => metadata.clone(),
             },
             spec: Some(self.build_spec()),
@@ -637,7 +657,8 @@ mod tests {
                     .with_config_map("configmap")
                     .build(),
             )
-            .termination_grace_period_seconds(42)
+            .termination_grace_period(&Duration::from_secs(42))
+            .unwrap()
             .build()
             .unwrap();
 
@@ -691,4 +712,19 @@ mod tests {
             .unwrap();
         assert_eq!(pod.spec.unwrap().restart_policy.unwrap(), "Always");
     }
+
+    #[test]
+    fn test_pod_builder_too_long_termination_grace_period() {
+        let too_long_duration = Duration::from_secs(i64::MAX as u64 + 1);
+        let mut pod_builder = PodBuilder::new();
+
+        let result = pod_builder.termination_grace_period(&too_long_duration);
+        assert!(matches!(
+            result,
+            Err(Error::DurationTooLong {
+                source: TryFromIntError { .. },
+                duration,
+            }) if duration == too_long_duration
+        ));
+    }
 }