tatara_process/lifetime_clock.rs
1//! Ephemeral lifetime clock — TTL expiry + teardown-policy decisions.
2//!
3//! The reconciler consults this module at each phase tick to decide
4//! whether a Process should auto-terminate:
5//! - TTL is measured from `metadata.creation_timestamp` (the most
6//! deterministic anchor — phaseSince resets per phase).
7//! - Teardown policy applies on `Attested` or `Failed` per
8//! `EphemeralLifetime.teardown_policy`.
9//!
10//! Returning `AutoTerminate::Now { reason }` tells the caller to transition
11//! the Process to `Exiting`. The phase machine handles the SIGTERM path
12//! from there (children drained, finalizer guards owned resources).
13
14use chrono::{DateTime, Utc};
15use std::fmt;
16use std::time::Duration;
17
18use crate::crd::Process;
19use crate::lifetime::TeardownPolicy;
20use crate::phase::ProcessPhase;
21
22/// Decision the phase machine acts on.
23///
24/// Two-variant payload-carrying enum: `Skip` carries no payload (no-op
25/// signal to the controller), `Now` carries the typed [`TerminateReason`]
26/// that the controller stamps onto `status.message`. The
27/// (payload-carrying-enum, payload-stripped-typed-discriminator) split
28/// — `Now(reason)` on the wire-shape, [`AutoTerminateKind::Now`] for
29/// closed dispatch — is the same shape every sibling closed-set lift
30/// in this crate carries (see [`crate::lifetime_clock::TerminateReason`]
31/// → [`TerminateReasonKind`], [`crate::matrix::SelectStrategy`] →
32/// [`crate::matrix::SelectStrategyKind`]).
33#[derive(Debug, Clone, PartialEq, Eq)]
34pub enum AutoTerminate {
35 /// No auto-terminate signal — continue with the normal phase handler.
36 Skip,
37 /// Transition the Process to `Exiting` with the given operator-visible reason.
38 Now { reason: TerminateReason },
39}
40
41impl AutoTerminate {
42 /// Discriminator projection — strips the [`Now`]-variant payload and
43 /// returns the closed-set kind. Used by the kind-sweep tests and by
44 /// any future consumer that groups decisions by category (metrics
45 /// labels, dashboard enumeration, `status.conditions[].reason`
46 /// reason-keys) without pattern-matching the full payload.
47 ///
48 /// [`Now`]: AutoTerminate::Now
49 pub const fn kind(&self) -> AutoTerminateKind {
50 match self {
51 Self::Skip => AutoTerminateKind::Skip,
52 Self::Now { .. } => AutoTerminateKind::Now,
53 }
54 }
55
56 /// Reason projection — `Some(&reason)` when the decision is
57 /// [`Now`], `None` when [`Skip`]. The closed-set predicate dual:
58 /// callers that need only the payload (e.g. to stamp
59 /// `status.message`) reach through this projection instead of the
60 /// inline `if let AutoTerminate::Now { reason } = …` destructure,
61 /// so the variant-name → payload-field binding lives at ONE site.
62 /// Adding a third payload-carrying variant in the future updates
63 /// every consumer through this method's exhaustiveness check
64 /// rather than scattering destructures across the call graph.
65 ///
66 /// [`Now`]: AutoTerminate::Now
67 /// [`Skip`]: AutoTerminate::Skip
68 pub const fn reason(&self) -> Option<&TerminateReason> {
69 match self {
70 Self::Skip => None,
71 Self::Now { reason } => Some(reason),
72 }
73 }
74
75 /// `true` iff the decision is [`Now`]. Symmetric to [`Self::is_skip`].
76 ///
77 /// [`Now`]: AutoTerminate::Now
78 pub const fn is_now(&self) -> bool {
79 matches!(self, Self::Now { .. })
80 }
81
82 /// `true` iff the decision is [`Skip`]. Symmetric to [`Self::is_now`].
83 ///
84 /// [`Skip`]: AutoTerminate::Skip
85 pub const fn is_skip(&self) -> bool {
86 matches!(self, Self::Skip)
87 }
88}
89
90/// The closed set of [`AutoTerminate`] kinds — the discriminator view,
91/// payload-stripped, that sibling closed-set enums in this crate carry
92/// (see [`TerminateReasonKind`], [`crate::matrix::SelectStrategyKind`],
93/// [`crate::lifetime::LifetimeKind`]).
94///
95/// Drives the `as_str` / Display / `FromStr` triad over [`Self::ALL`] so
96/// a new variant added with an `ALL` entry automatically extends the
97/// parser, the canonical wire-format projection, and any future
98/// metrics-label / dashboard / `status.conditions[].reason` enumeration
99/// that needs to enumerate the decision categories. The `[Self; 2]`
100/// array literal forces the arity so a third variant cannot land
101/// without bumping the constant.
102#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, tatara_closed_set::DeriveClosedSet)]
103#[closed_set(via = "as_str", display, generate_unknown = "auto-terminate kind")]
104pub enum AutoTerminateKind {
105 /// The kind-view of [`AutoTerminate::Skip`].
106 Skip,
107 /// The kind-view of [`AutoTerminate::Now`] — the payload is
108 /// stripped at this projection.
109 Now,
110}
111
112impl AutoTerminateKind {
113 /// The closed set — single source of truth for `as_str` / Display /
114 /// `FromStr`.
115 pub const ALL: [Self; 2] = [Self::Skip, Self::Now];
116
117 /// Canonical PascalCase wire-format projection. Mirrors the
118 /// `tatara-process` PascalCase idiom used by every other closed-set
119 /// enum's `as_str` projection (e.g. [`ProcessPhase::as_str`],
120 /// [`TerminateReasonKind::as_str`]). A future metrics-label /
121 /// `status.conditions[].reason` field reads this projection
122 /// directly.
123 pub const fn as_str(self) -> &'static str {
124 match self {
125 Self::Skip => "Skip",
126 Self::Now => "Now",
127 }
128 }
129}
130
131// `impl fmt::Display for AutoTerminateKind` + `impl FromStr for
132// AutoTerminateKind` + `impl tatara_lisp::ClosedSet for
133// AutoTerminateKind` + `pub struct UnknownAutoTerminateKind(pub
134// String)` are generated by `#[derive(tatara_closed_set::DeriveClosedSet)]` +
135// `#[closed_set(via = "as_str", display, generate_unknown =
136// "auto-terminate kind")]` on the enum declaration above. The explicit
137// label pins the pre-lift wording (with hyphen) against the auto-
138// projection `pascal_to_spaced_lowercase("AutoTerminateKind")` →
139// "auto terminate kind" (no hyphen) — the operator-facing
140// `#[error("unknown auto-terminate kind: {0}")]` annotation stays byte-
141// for-byte identical to the pre-lift hand-roll. The inherent `as_str`
142// projection stays load-bearing — the PascalCase wire-format the
143// `evaluate` decision-projection's emitted reason reads — while the
144// trait method `label` gives generic consumers a STABLE name across
145// the workspace-wide closed-set implementors.
146
147/// Why the ephemeral lifetime clock fired.
148///
149/// Typed image of the two reason strings the pre-lift evaluator composed
150/// inline with `format!(…)`. Each variant carries the typed payload its
151/// `Display` formats against the canonical PascalCase projection of
152/// [`TeardownPolicy`] / [`ProcessPhase`], so the operator-visible reason
153/// is read off the typed surface rather than a free-form template that
154/// could drift on a variant rename. The reason string is the deliverable
155/// the reconciler stamps onto `status.message`; this enum is the source
156/// of truth.
157///
158/// Adding a third cause (e.g. parent-cascade from a SIGKILL'd parent in
159/// the hierarchical PID model, OOM-style memory-pressure pre-emption, or
160/// a future ResourceQuota gate) lands at one variant + one [`Display`]
161/// arm + one [`TerminateReasonKind`] entry — exhaustively checked by the
162/// compiler AND by the per-variant truth-table tests.
163///
164/// Sibling closed-set lifts on the same `tatara-process` axis:
165/// [`crate::intent::IntentKind::ALL`], [`crate::LifetimeKind::ALL`],
166/// [`crate::lifetime::TeardownPolicy::ALL`],
167/// [`crate::boundary::ConditionKind::ALL`],
168/// [`crate::phase::ProcessPhase::ALL`],
169/// [`crate::signal::ProcessSignal::ALL`].
170#[derive(Debug, Clone, PartialEq, Eq)]
171pub enum TerminateReason {
172 /// The Process reached a terminal-gate phase ([`ProcessPhase::Attested`]
173 /// or [`ProcessPhase::Failed`]) and the ephemeral lifetime's
174 /// [`TeardownPolicy`] elected to fire on that phase.
175 TeardownPolicy {
176 policy: TeardownPolicy,
177 phase: ProcessPhase,
178 },
179 /// The ephemeral lifetime's TTL elapsed in a non-terminal phase.
180 /// `ttl` carries the operator-authored `humantime` string verbatim
181 /// (e.g. `"1h"`, `"30m"`) so the reason surfaces the spec field as
182 /// it was written, not as it parsed. `elapsed` is the wall-clock
183 /// distance from `metadata.creation_timestamp` at evaluation time.
184 TtlExpired { ttl: String, elapsed: Duration },
185}
186
187impl TerminateReason {
188 /// Discriminator projection — strips the payload, yielding the
189 /// closed-set kind. Used by the reason-kind sweep tests and by any
190 /// future consumer that wants to group reasons by cause without
191 /// pattern-matching the full payload (e.g. metrics labels, future
192 /// `status.conditions` reason-keys).
193 pub const fn kind(&self) -> TerminateReasonKind {
194 match self {
195 Self::TeardownPolicy { .. } => TerminateReasonKind::TeardownPolicy,
196 Self::TtlExpired { .. } => TerminateReasonKind::TtlExpired,
197 }
198 }
199}
200
201impl fmt::Display for TerminateReason {
202 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
203 // LOAD-BEARING CONTRACT: the strings produced here are the
204 // operator-visible reasons the reconciler stamps onto
205 // `status.message` and `status.conditions[…].message`. They
206 // must match the pre-lift `format!(…)` output byte-for-byte
207 // so existing alerts, dashboards, and operator runbooks keep
208 // matching. Pinned by `terminate_reason_display_matches_pre_lift`.
209 match self {
210 Self::TeardownPolicy { policy, phase } => {
211 write!(
212 f,
213 "ephemeral lifetime: teardown_policy={} fired on {}",
214 policy.as_str(),
215 phase.as_str(),
216 )
217 }
218 Self::TtlExpired { ttl, elapsed } => {
219 write!(
220 f,
221 "ephemeral lifetime: ttl={} expired (elapsed={}s)",
222 ttl,
223 elapsed.as_secs(),
224 )
225 }
226 }
227 }
228}
229
230/// The closed set of [`TerminateReason`] kinds — the discriminator
231/// view, payload-stripped, that sibling closed-set enums in this
232/// crate carry (see [`ProcessPhase`], [`TeardownPolicy`]).
233///
234/// Drives the `as_str` / Display / `FromStr` triad over [`Self::ALL`] so
235/// a new variant added with an `ALL` entry automatically extends the
236/// parser, the canonical wire-format projection, and any future
237/// metrics-label / `status.conditions[].reason` enumeration that needs
238/// to enumerate the reason categories.
239#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, tatara_closed_set::DeriveClosedSet)]
240#[closed_set(via = "as_str", display, generate_unknown)]
241pub enum TerminateReasonKind {
242 TeardownPolicy,
243 TtlExpired,
244}
245
246impl TerminateReasonKind {
247 /// The closed set — single source of truth for `as_str` / Display /
248 /// `FromStr`. The `[Self; 2]` array literal forces the arity so a
249 /// third variant added without an `ALL` entry fails at the type
250 /// level before the test sweep below runs.
251 pub const ALL: [Self; 2] = [Self::TeardownPolicy, Self::TtlExpired];
252
253 /// Canonical PascalCase wire-format projection. Mirrors the
254 /// `tatara-process` PascalCase idiom used by every other closed-set
255 /// enum's `as_str` projection (e.g. [`ProcessPhase::as_str`],
256 /// [`TeardownPolicy::as_str`]). A future `status.conditions[].reason`
257 /// field reads this projection directly.
258 pub const fn as_str(self) -> &'static str {
259 match self {
260 Self::TeardownPolicy => "TeardownPolicy",
261 Self::TtlExpired => "TtlExpired",
262 }
263 }
264}
265
266// `impl fmt::Display for TerminateReasonKind` + `impl FromStr for
267// TerminateReasonKind` + `impl tatara_lisp::ClosedSet for
268// TerminateReasonKind` + `pub struct UnknownTerminateReasonKind(pub
269// String)` are generated by `#[derive(tatara_closed_set::DeriveClosedSet)]` +
270// `#[closed_set(via = "as_str", display, generate_unknown)]` on the
271// enum declaration above. The auto-derived label `"terminate reason
272// kind"` matches the prior hand-rolled `#[error("unknown terminate
273// reason kind: {0}")]` verbatim. The inherent `as_str` projection
274// stays load-bearing — the PascalCase wire-format the
275// `crate::lifetime_clock::evaluate` decision-projection's emitted
276// reason reads — while the trait method `label` gives generic
277// consumers a STABLE name across the workspace-wide closed-set
278// implementors.
279
280/// Inspect a Process at the given current phase and return whether the
281/// ephemeral lifetime clock fires now.
282///
283/// `now` is injected so unit tests can drive the clock deterministically.
284pub fn evaluate(
285 process: &Process,
286 current_phase: ProcessPhase,
287 now: DateTime<Utc>,
288) -> AutoTerminate {
289 // Closed-set projection: ambiguous → no-op; permanent → no-op;
290 // ephemeral → fall through to teardown / TTL checks. ONE
291 // `resolved_ephemeral` gate — the compound `variant().ok() +
292 // as_ephemeral` projection lifted to `impl Lifetime` — replaces
293 // the previous two-step match-then-match dance and shares the
294 // primitive with `requeue_with_ttl` below.
295 let Some(ephemeral) = process.spec.lifetime.resolved_ephemeral() else {
296 return AutoTerminate::Skip;
297 };
298
299 // 1. Teardown policy on terminal phases — ONE typed dispatch over
300 // `(TeardownPolicy, ProcessPhase)` replaces the previous pair of
301 // near-identical Attested/Failed branches. Non-terminal phases
302 // short-circuit inside `should_teardown_on`. The reason is the
303 // typed `TerminateReason::TeardownPolicy` variant whose `Display`
304 // composes the operator-visible string against the canonical
305 // PascalCase projection (`TeardownPolicy::as_str` +
306 // `ProcessPhase::as_str`), not a free-form template.
307 if ephemeral.teardown_policy.should_teardown_on(current_phase) {
308 return AutoTerminate::Now {
309 reason: TerminateReason::TeardownPolicy {
310 policy: ephemeral.teardown_policy,
311 phase: current_phase,
312 },
313 };
314 }
315
316 // 2. TTL expiry — applies in any non-terminal phase.
317 if !is_terminal_or_exit(current_phase) {
318 if let Some(creation) = process.metadata.creation_timestamp.as_ref() {
319 if let Ok(ttl) = humantime::parse_duration(&ephemeral.ttl) {
320 let elapsed = now.signed_duration_since(creation.0).to_std().ok();
321 if let Some(elapsed) = elapsed {
322 if elapsed >= ttl {
323 return AutoTerminate::Now {
324 reason: TerminateReason::TtlExpired {
325 ttl: ephemeral.ttl.clone(),
326 elapsed,
327 },
328 };
329 }
330 }
331 }
332 }
333 }
334
335 AutoTerminate::Skip
336}
337
338/// Phases past which TTL cannot meaningfully fire — the SIGTERM path
339/// is already in progress.
340fn is_terminal_or_exit(p: ProcessPhase) -> bool {
341 matches!(
342 p,
343 ProcessPhase::Exiting | ProcessPhase::Zombie | ProcessPhase::Reaped
344 )
345}
346
347/// Sleep budget the controller should requeue with for a Process whose
348/// `evaluate()` returned `Skip` — picks the smaller of HEARTBEAT and
349/// TTL-remaining so we don't oversleep past expiry.
350pub fn requeue_with_ttl(process: &Process, now: DateTime<Utc>, default: Duration) -> Duration {
351 // Shared `resolved_ephemeral` projection with [`evaluate`] — the
352 // "give me only the unambiguous ephemeral case" compound-lift
353 // primitive on `impl Lifetime`.
354 let Some(e) = process.spec.lifetime.resolved_ephemeral() else {
355 return default;
356 };
357 let Some(creation) = process.metadata.creation_timestamp.as_ref() else {
358 return default;
359 };
360 let Ok(ttl) = humantime::parse_duration(&e.ttl) else {
361 return default;
362 };
363 let elapsed = match now.signed_duration_since(creation.0).to_std() {
364 Ok(d) => d,
365 Err(_) => return default,
366 };
367 let remaining = ttl.checked_sub(elapsed).unwrap_or(Duration::from_secs(0));
368 // Never sleep less than 1s; never longer than the default heartbeat.
369 let pick = std::cmp::min(default, remaining);
370 std::cmp::max(pick, Duration::from_secs(1))
371}
372
373#[cfg(test)]
374mod tests {
375 use super::*;
376 use crate::classification::{Classification, ConvergencePointType, SubstrateType};
377 use crate::crd::ProcessSpec;
378 use crate::intent::{AplicacaoIntent, Intent};
379 use crate::lifetime::{EphemeralLifetime, Lifetime, TeardownPolicy};
380 use k8s_openapi::apimachinery::pkg::apis::meta::v1::Time;
381
382 fn ephemeral_process(ttl: &str, teardown: TeardownPolicy, age_secs: i64) -> Process {
383 let spec = ProcessSpec {
384 identity: Default::default(),
385 classification: Classification {
386 point_type: ConvergencePointType::Gate,
387 substrate: SubstrateType::Compute,
388 horizon: Default::default(),
389 calm: Default::default(),
390 data_classification: Default::default(),
391 },
392 intent: Intent {
393 aplicacao: Some(AplicacaoIntent {
394 chart_ref: "oci://x".into(),
395 version: "1".into(),
396 profile: String::new(),
397 values_overlay: serde_json::Value::Null,
398 release_name: None,
399 target_namespace: None,
400 install_timeout: None,
401 }),
402 ..Intent::default()
403 },
404 boundary: Default::default(),
405 compliance: Default::default(),
406 depends_on: vec![],
407 signals: Default::default(),
408 lifetime: Lifetime {
409 ephemeral: Some(EphemeralLifetime {
410 ttl: ttl.into(),
411 teardown_policy: teardown,
412 max_concurrent: 1,
413 exports: vec![],
414 }),
415 ..Lifetime::default()
416 },
417 routing: None,
418 encapsulates: None,
419 suspended: false,
420 };
421 let mut p = Process::new("e", spec);
422 p.metadata.namespace = Some("ns".into());
423 let creation = Utc::now() - chrono::Duration::seconds(age_secs);
424 p.metadata.creation_timestamp = Some(Time(creation));
425 p
426 }
427
428 fn permanent_process() -> Process {
429 let spec = ProcessSpec {
430 identity: Default::default(),
431 classification: Classification {
432 point_type: ConvergencePointType::Gate,
433 substrate: SubstrateType::Compute,
434 horizon: Default::default(),
435 calm: Default::default(),
436 data_classification: Default::default(),
437 },
438 intent: Intent {
439 aplicacao: Some(AplicacaoIntent {
440 chart_ref: "oci://x".into(),
441 version: "1".into(),
442 profile: String::new(),
443 values_overlay: serde_json::Value::Null,
444 release_name: None,
445 target_namespace: None,
446 install_timeout: None,
447 }),
448 ..Intent::default()
449 },
450 boundary: Default::default(),
451 compliance: Default::default(),
452 depends_on: vec![],
453 signals: Default::default(),
454 lifetime: Lifetime::default(),
455 routing: None,
456 encapsulates: None,
457 suspended: false,
458 };
459 Process::new("e", spec)
460 }
461
462 #[test]
463 fn permanent_never_auto_terminates() {
464 let p = permanent_process();
465 for phase in [
466 ProcessPhase::Pending,
467 ProcessPhase::Execing,
468 ProcessPhase::Running,
469 ProcessPhase::Attested,
470 ProcessPhase::Failed,
471 ] {
472 assert_eq!(evaluate(&p, phase, Utc::now()), AutoTerminate::Skip);
473 }
474 }
475
476 #[test]
477 fn always_teardown_fires_on_attested_and_failed() {
478 let p = ephemeral_process("1h", TeardownPolicy::Always, 60);
479 let now = Utc::now();
480 assert!(matches!(
481 evaluate(&p, ProcessPhase::Attested, now),
482 AutoTerminate::Now { .. }
483 ));
484 assert!(matches!(
485 evaluate(&p, ProcessPhase::Failed, now),
486 AutoTerminate::Now { .. }
487 ));
488 assert_eq!(
489 evaluate(&p, ProcessPhase::Running, now),
490 AutoTerminate::Skip
491 );
492 }
493
494 #[test]
495 fn on_attested_only_fires_on_attested() {
496 let p = ephemeral_process("1h", TeardownPolicy::OnAttested, 60);
497 let now = Utc::now();
498 assert!(matches!(
499 evaluate(&p, ProcessPhase::Attested, now),
500 AutoTerminate::Now { .. }
501 ));
502 assert_eq!(evaluate(&p, ProcessPhase::Failed, now), AutoTerminate::Skip);
503 }
504
505 #[test]
506 fn on_failed_only_fires_on_failed() {
507 let p = ephemeral_process("1h", TeardownPolicy::OnFailed, 60);
508 let now = Utc::now();
509 assert_eq!(
510 evaluate(&p, ProcessPhase::Attested, now),
511 AutoTerminate::Skip
512 );
513 assert!(matches!(
514 evaluate(&p, ProcessPhase::Failed, now),
515 AutoTerminate::Now { .. }
516 ));
517 }
518
519 #[test]
520 fn never_skips_phase_terminations_but_still_honors_ttl() {
521 let p = ephemeral_process("30s", TeardownPolicy::Never, 60);
522 let now = Utc::now();
523 // TTL elapsed → TTL fires regardless of policy.
524 assert!(matches!(
525 evaluate(&p, ProcessPhase::Running, now),
526 AutoTerminate::Now { .. }
527 ));
528 // But not on a terminal phase (already exiting).
529 assert_eq!(
530 evaluate(&p, ProcessPhase::Exiting, now),
531 AutoTerminate::Skip
532 );
533 }
534
535 #[test]
536 fn ttl_not_yet_elapsed_is_skip() {
537 let p = ephemeral_process("1h", TeardownPolicy::Never, 60);
538 assert_eq!(
539 evaluate(&p, ProcessPhase::Running, Utc::now()),
540 AutoTerminate::Skip
541 );
542 }
543
544 /// REASON-STRING CONTRACT: the operator-visible reason composes
545 /// the canonical PascalCase projection of `TeardownPolicy` and
546 /// `ProcessPhase` (via Display) rather than the Debug formatting
547 /// used pre-lift. A future variant rename of either enum updates
548 /// the reason string at ONE site (the `as_str` arm) instead of
549 /// drifting between the typed surface and the operator log.
550 #[test]
551 fn teardown_reason_string_uses_canonical_projection() {
552 let p = ephemeral_process("1h", TeardownPolicy::OnAttested, 60);
553 match evaluate(&p, ProcessPhase::Attested, Utc::now()) {
554 AutoTerminate::Now { reason } => {
555 let rendered = reason.to_string();
556 assert!(
557 rendered.contains("teardown_policy=OnAttested"),
558 "expected canonical PascalCase policy, got: {rendered}",
559 );
560 assert!(
561 rendered.contains("fired on Attested"),
562 "expected canonical PascalCase phase, got: {rendered}",
563 );
564 }
565 other => panic!("expected AutoTerminate::Now, got {other:?}"),
566 }
567
568 let p = ephemeral_process("1h", TeardownPolicy::Always, 60);
569 match evaluate(&p, ProcessPhase::Failed, Utc::now()) {
570 AutoTerminate::Now { reason } => {
571 let rendered = reason.to_string();
572 assert!(rendered.contains("teardown_policy=Always"));
573 assert!(rendered.contains("fired on Failed"));
574 }
575 other => panic!("expected AutoTerminate::Now, got {other:?}"),
576 }
577 }
578
579 // ── TerminateReason / TerminateReasonKind closed-set contracts ────
580
581 /// BYTE-FOR-BYTE PRE-LIFT CONTRACT: the Display impl on
582 /// `TerminateReason` must produce the exact string the pre-lift
583 /// inline `format!(…)` calls produced. Existing alerts, dashboards,
584 /// and operator runbooks that grep `status.message` for these
585 /// substrings keep matching. A future variant rename of
586 /// `TeardownPolicy` / `ProcessPhase` updates the rendered string
587 /// here automatically (Display reads `as_str` projection), but the
588 /// template — `"ephemeral lifetime: teardown_policy={} fired on {}"`
589 /// vs `"ephemeral lifetime: ttl={} expired (elapsed={}s)"` — is
590 /// pinned at the Display site.
591 #[test]
592 fn terminate_reason_display_matches_pre_lift() {
593 // TeardownPolicy variant — every combination of policy × phase
594 // sweeps both PascalCase projections.
595 for policy in TeardownPolicy::ALL {
596 for phase in ProcessPhase::ALL {
597 let reason = TerminateReason::TeardownPolicy { policy, phase };
598 let expected = format!(
599 "ephemeral lifetime: teardown_policy={} fired on {}",
600 policy.as_str(),
601 phase.as_str(),
602 );
603 assert_eq!(
604 reason.to_string(),
605 expected,
606 "Display drifted for ({policy:?}, {phase:?})",
607 );
608 }
609 }
610 // TtlExpired variant — pins the ttl-verbatim + elapsed-secs
611 // template against representative humantime strings the
612 // EphemeralLifetime.ttl field accepts.
613 for (ttl, elapsed_secs) in [("1h", 0u64), ("30m", 60), ("90s", 100), ("5m30s", 3600)] {
614 let reason = TerminateReason::TtlExpired {
615 ttl: ttl.to_string(),
616 elapsed: Duration::from_secs(elapsed_secs),
617 };
618 assert_eq!(
619 reason.to_string(),
620 format!("ephemeral lifetime: ttl={ttl} expired (elapsed={elapsed_secs}s)"),
621 );
622 }
623 }
624
625 /// Reason `kind()` projection — closed-set match so a future
626 /// variant triggers exhaustiveness checking at the projection
627 /// site rather than silently bucketing through a wildcard. Every
628 /// variant's `kind()` matches its `TerminateReasonKind` peer.
629 #[test]
630 fn terminate_reason_kind_truth_table() {
631 assert_eq!(
632 TerminateReason::TeardownPolicy {
633 policy: TeardownPolicy::Always,
634 phase: ProcessPhase::Attested,
635 }
636 .kind(),
637 TerminateReasonKind::TeardownPolicy,
638 );
639 assert_eq!(
640 TerminateReason::TtlExpired {
641 ttl: "1h".to_string(),
642 elapsed: Duration::from_secs(0),
643 }
644 .kind(),
645 TerminateReasonKind::TtlExpired,
646 );
647 }
648
649 /// `ALL` is the source of truth; a variant added without an `ALL`
650 /// entry fails here (uniqueness check) before any sweep test below
651 /// runs. Arity is asserted by the array type itself (`[Self; 2]`).
652 /// Exercise the substrate-wide [`tatara_lisp::ClosedSet`] contract on
653 /// [`TerminateReasonKind`] — pins the structural three-plus-one
654 /// (`ALL` is non-empty, every variant round-trips through
655 /// `label ↔ parse_label`, labels are pairwise distinct, `""` is
656 /// outside the closed set) at ONE call site. Replaces the
657 /// hand-derived `terminate_reason_kind_all_is_unique_and_complete`
658 /// + `terminate_reason_kind_roundtrip_via_as_str` + the empty-input
659 /// arm of `unknown_terminate_reason_kind_errors`. `FromStr`
660 /// delegates to `<Self as tatara_closed_set::ClosedSet>::parse_label`,
661 /// so this helper exercises the same code path the lifetime-clock
662 /// evaluator hits when parsing a typed reason back out of a
663 /// `status.conditions[].reason` slot.
664 #[test]
665 fn terminate_reason_kind_is_well_formed_closed_set() {
666 tatara_closed_set::assert_closed_set_well_formed::<TerminateReasonKind>();
667 }
668
669 /// `Display` IS `as_str` — pinning this lets future callers reach
670 /// for either projection without drift.
671 #[test]
672 fn terminate_reason_kind_display_matches_as_str() {
673 crate::tagged_union::assert_display_matches_label::<TerminateReasonKind>();
674 }
675
676 /// Every kind's `as_str` is in canonical PascalCase. The first
677 /// character is uppercase; no whitespace; no separators. The
678 /// `tatara-process` PascalCase idiom holds at one test site.
679 #[test]
680 fn terminate_reason_kind_as_str_is_pascal_case() {
681 for kind in TerminateReasonKind::ALL {
682 let s = kind.as_str();
683 assert!(!s.is_empty(), "as_str empty for {kind:?}");
684 assert!(
685 s.chars().next().unwrap().is_ascii_uppercase(),
686 "as_str not PascalCase for {kind:?}: {s}",
687 );
688 assert!(
689 !s.contains(|c: char| c.is_whitespace() || c == '_' || c == '-'),
690 "as_str carries separator for {kind:?}: {s}",
691 );
692 }
693 }
694
695 /// `FromStr` rejects strings outside the canonical projection
696 /// (lowercased / typo / cross-axis-leaked) and echoes the input
697 /// verbatim. The empty-string arm is covered by
698 /// `terminate_reason_kind_is_well_formed_closed_set` via the
699 /// [`tatara_lisp::ClosedSet`] contract; the verbatim-echo arms
700 /// stay here because they pin the `UnknownTerminateReasonKind`
701 /// newtype payload contract the trait's `make_unknown` cannot
702 /// see. Cross-axis inputs (ProcessPhase / TeardownPolicy variant
703 /// names) MUST fail — `TerminateReasonKind` is its own axis, not
704 /// a transparent reflection of either.
705 #[test]
706 fn unknown_terminate_reason_kind_errors() {
707 use std::str::FromStr;
708 for bad in [
709 "teardownPolicy",
710 "TEARDOWN_POLICY",
711 "Teardown",
712 "TtlExpire",
713 "ttl_expired",
714 "ttlExpired",
715 // Cross-axis-leaked — must NOT cross axes.
716 "Attested",
717 "Failed",
718 "Always",
719 "OnAttested",
720 "OnFailed",
721 "Never",
722 "Permanent",
723 "Ephemeral",
724 ] {
725 let err = TerminateReasonKind::from_str(bad).unwrap_err();
726 assert_eq!(err.0, bad, "error payload should echo input verbatim");
727 }
728 }
729
730 /// The reason `evaluate` returns under teardown maps to
731 /// `TerminateReasonKind::TeardownPolicy` AND its payload reflects
732 /// the spec's `(teardown_policy, current_phase)` verbatim — the
733 /// typed surface IS the source of truth, not an inline format
734 /// template. A future consumer that wants to group reasons by
735 /// kind in metrics labels reads `reason.kind()`, not a substring
736 /// match.
737 #[test]
738 fn evaluate_typed_reason_carries_teardown_payload() {
739 for (policy, phase) in [
740 (TeardownPolicy::Always, ProcessPhase::Attested),
741 (TeardownPolicy::Always, ProcessPhase::Failed),
742 (TeardownPolicy::OnAttested, ProcessPhase::Attested),
743 (TeardownPolicy::OnFailed, ProcessPhase::Failed),
744 ] {
745 let p = ephemeral_process("1h", policy, 60);
746 match evaluate(&p, phase, Utc::now()) {
747 AutoTerminate::Now { reason } => {
748 assert_eq!(reason.kind(), TerminateReasonKind::TeardownPolicy);
749 assert_eq!(
750 reason,
751 TerminateReason::TeardownPolicy { policy, phase },
752 "typed payload drift for ({policy:?}, {phase:?})",
753 );
754 }
755 other => {
756 panic!("expected AutoTerminate::Now for ({policy:?}, {phase:?}), got {other:?}",)
757 }
758 }
759 }
760 }
761
762 /// TTL expiry returns a `TtlExpired` reason whose `ttl` field is
763 /// the operator-authored humantime string verbatim (NOT the
764 /// parsed `Duration`'s pretty-print) and whose `elapsed` is the
765 /// wall-clock distance. Pinned here so a future evaluator change
766 /// that re-formats the ttl through `humantime::format_duration`
767 /// would fail.
768 #[test]
769 fn evaluate_typed_reason_carries_ttl_payload() {
770 let p = ephemeral_process("30s", TeardownPolicy::Never, 60);
771 let now = Utc::now();
772 match evaluate(&p, ProcessPhase::Running, now) {
773 AutoTerminate::Now { reason } => {
774 assert_eq!(reason.kind(), TerminateReasonKind::TtlExpired);
775 match reason {
776 TerminateReason::TtlExpired { ttl, elapsed } => {
777 assert_eq!(ttl, "30s", "ttl should be verbatim spec string");
778 assert!(
779 elapsed >= Duration::from_secs(30),
780 "elapsed should be at least the ttl",
781 );
782 }
783 other => panic!("expected TtlExpired, got {other:?}"),
784 }
785 }
786 other => panic!("expected AutoTerminate::Now, got {other:?}"),
787 }
788 }
789
790 // ── AutoTerminate / AutoTerminateKind closed-set contracts ────────
791
792 /// Exercise the substrate-wide [`tatara_lisp::ClosedSet`] contract on
793 /// [`AutoTerminateKind`] — pins the structural three-plus-one
794 /// (`ALL` is non-empty, every variant round-trips through
795 /// `label ↔ parse_label`, labels are pairwise distinct, `""` is
796 /// outside the closed set) at ONE call site. Replaces the
797 /// hand-derived uniqueness sweep in
798 /// `auto_terminate_kind_kind_projection_is_exhaustive_over_all`'s
799 /// pre-lift form + the `auto_terminate_kind_roundtrip_via_as_str`
800 /// hand-rolled sweep + the empty-input arm of
801 /// `unknown_auto_terminate_kind_errors`. `FromStr` delegates to
802 /// `<Self as tatara_closed_set::ClosedSet>::parse_label`, so this
803 /// helper exercises the same code path the lifetime-clock
804 /// evaluator hits when parsing a typed kind back out of a
805 /// `status.conditions[].reason` slot.
806 #[test]
807 fn auto_terminate_kind_is_well_formed_closed_set() {
808 tatara_closed_set::assert_closed_set_well_formed::<AutoTerminateKind>();
809 }
810
811 /// Every entry in `ALL` is reachable through a concrete
812 /// [`AutoTerminate`] value via [`AutoTerminate::kind`] — the
813 /// projection is exhaustive across the variant set. Pre-lift this
814 /// pin was bundled with a uniqueness HashSet sweep that
815 /// [`auto_terminate_kind_is_well_formed_closed_set`] now covers
816 /// generically through the [`tatara_lisp::ClosedSet`] contract;
817 /// post-lift this test keeps only the domain-specific
818 /// `kind()`-exhaustiveness contract (the (variant-name →
819 /// payload-stripped kind) binding the [`AutoTerminate`] surface
820 /// projects through). A future third payload-carrying
821 /// `AutoTerminate` variant updates this pin AND
822 /// [`AutoTerminate::kind`]'s exhaustiveness match together,
823 /// exhaustively checked by the compiler.
824 #[test]
825 fn auto_terminate_kind_kind_projection_is_exhaustive_over_all() {
826 let by_all: std::collections::HashSet<_> = AutoTerminateKind::ALL.iter().copied().collect();
827 let sample_reason = TerminateReason::TtlExpired {
828 ttl: "1h".into(),
829 elapsed: Duration::from_secs(0),
830 };
831 let by_concrete: std::collections::HashSet<_> = [
832 AutoTerminate::Skip.kind(),
833 AutoTerminate::Now {
834 reason: sample_reason,
835 }
836 .kind(),
837 ]
838 .into_iter()
839 .collect();
840 assert_eq!(
841 by_concrete, by_all,
842 "kind() projection not exhaustive over ALL"
843 );
844 }
845
846 /// BYTE-EXACT canonical wire-format pin — renaming either of the two
847 /// canonical strings is a wire-format change that fails this test
848 /// FIRST so it stays a deliberate change, not a silent rename that
849 /// drifts existing alerts / dashboards / operator runbooks.
850 #[test]
851 fn auto_terminate_kind_canonical_names_pinned() {
852 assert_eq!(AutoTerminateKind::Skip.as_str(), "Skip");
853 assert_eq!(AutoTerminateKind::Now.as_str(), "Now");
854 }
855
856 /// Every kind's `as_str` is in canonical PascalCase. The first
857 /// character is uppercase; no whitespace; no separators. The
858 /// `tatara-process` PascalCase idiom holds at one test site.
859 #[test]
860 fn auto_terminate_kind_as_str_is_pascal_case() {
861 for kind in AutoTerminateKind::ALL {
862 let s = kind.as_str();
863 assert!(!s.is_empty(), "as_str empty for {kind:?}");
864 assert!(
865 s.chars().next().unwrap().is_ascii_uppercase(),
866 "as_str not PascalCase for {kind:?}: {s}",
867 );
868 assert!(
869 !s.contains(|c: char| c.is_whitespace() || c == '_' || c == '-'),
870 "as_str carries separator for {kind:?}: {s}",
871 );
872 }
873 }
874
875 /// `Display` IS `as_str` — pinning this lets future callers reach
876 /// for either projection without drift.
877 #[test]
878 fn auto_terminate_kind_display_matches_as_str() {
879 crate::tagged_union::assert_display_matches_label::<AutoTerminateKind>();
880 }
881
882 /// `FromStr` rejects strings outside the canonical projection
883 /// (lowercased / typo / cross-axis-leaked) and echoes the input
884 /// verbatim. The empty-string arm AND the round-trip sweep are
885 /// covered by `auto_terminate_kind_is_well_formed_closed_set` via
886 /// the [`tatara_lisp::ClosedSet`] contract; the cases here pin the
887 /// `UnknownAutoTerminateKind` newtype payload contract the
888 /// trait's `make_unknown` cannot see. Cross-axis inputs
889 /// (ProcessPhase / TeardownPolicy / TerminateReasonKind variant
890 /// names) MUST fail — `AutoTerminateKind` is its own axis, not
891 /// a transparent reflection of any sibling enum.
892 #[test]
893 fn unknown_auto_terminate_kind_errors() {
894 use std::str::FromStr;
895 for bad in [
896 "skip",
897 "now",
898 "SKIP",
899 "NOW",
900 "S",
901 "N",
902 "no-op",
903 "terminate",
904 // Cross-axis-leaked — must NOT cross axes.
905 "Attested",
906 "Failed",
907 "TeardownPolicy",
908 "TtlExpired",
909 "Always",
910 "Permanent",
911 "Ephemeral",
912 ] {
913 let err = AutoTerminateKind::from_str(bad).unwrap_err();
914 assert_eq!(err.0, bad, "error payload should echo input verbatim");
915 }
916 }
917
918 /// `reason()` projection: `Now { reason }` returns `Some(&reason)`,
919 /// `Skip` returns `None`. The (variant-name → payload-field)
920 /// binding lives at ONE site so a future third payload-carrying
921 /// variant updates every consumer through this method's
922 /// exhaustiveness check rather than scattering destructures across
923 /// the call graph.
924 #[test]
925 fn auto_terminate_reason_projection() {
926 assert!(AutoTerminate::Skip.reason().is_none());
927
928 let reason = TerminateReason::TtlExpired {
929 ttl: "1h".into(),
930 elapsed: Duration::from_secs(0),
931 };
932 let now = AutoTerminate::Now {
933 reason: reason.clone(),
934 };
935 assert_eq!(now.reason(), Some(&reason));
936
937 let teardown = TerminateReason::TeardownPolicy {
938 policy: TeardownPolicy::OnAttested,
939 phase: ProcessPhase::Attested,
940 };
941 let now = AutoTerminate::Now {
942 reason: teardown.clone(),
943 };
944 assert_eq!(now.reason(), Some(&teardown));
945 }
946
947 /// `is_now` / `is_skip` are exact complements over the closed set —
948 /// `is_now ⊕ is_skip = true` for every variant. Locks the predicate
949 /// pair so a future third variant that's neither Skip nor Now must
950 /// extend BOTH predicates in lockstep (or this contract fails).
951 #[test]
952 fn auto_terminate_predicate_pair_is_exhaustive_complement() {
953 let reason = TerminateReason::TtlExpired {
954 ttl: "1h".into(),
955 elapsed: Duration::from_secs(0),
956 };
957 for decision in [
958 AutoTerminate::Skip,
959 AutoTerminate::Now {
960 reason: reason.clone(),
961 },
962 ] {
963 assert_ne!(
964 decision.is_now(),
965 decision.is_skip(),
966 "predicate pair drift for {decision:?}",
967 );
968 // The kind projection agrees with each predicate.
969 assert_eq!(decision.is_now(), decision.kind() == AutoTerminateKind::Now);
970 assert_eq!(
971 decision.is_skip(),
972 decision.kind() == AutoTerminateKind::Skip
973 );
974 // `reason()` agrees with `is_now`.
975 assert_eq!(decision.reason().is_some(), decision.is_now());
976 }
977 }
978
979 /// The `kind()` projection on the typed result of `evaluate` agrees
980 /// with the behavioural expectation: ephemeral-on-Attested with an
981 /// OnAttested policy returns `Now`, permanent never does. Closes
982 /// the loop between the closed-set view and the live decision so
983 /// any future kind-keyed metrics label (e.g.
984 /// `tatara_lifetime_clock_decisions_total{kind="Now"}`) reads the
985 /// typed projection rather than the inline destructure.
986 #[test]
987 fn evaluate_decision_kind_agrees_with_runtime_behaviour() {
988 let p = permanent_process();
989 for phase in [
990 ProcessPhase::Pending,
991 ProcessPhase::Running,
992 ProcessPhase::Attested,
993 ProcessPhase::Failed,
994 ] {
995 let decision = evaluate(&p, phase, Utc::now());
996 assert_eq!(
997 decision.kind(),
998 AutoTerminateKind::Skip,
999 "permanent Process must always Skip; got Now for phase={phase:?}",
1000 );
1001 assert!(decision.reason().is_none());
1002 }
1003
1004 let p = ephemeral_process("1h", TeardownPolicy::OnAttested, 60);
1005 let now = Utc::now();
1006 assert_eq!(
1007 evaluate(&p, ProcessPhase::Attested, now).kind(),
1008 AutoTerminateKind::Now,
1009 );
1010 assert_eq!(
1011 evaluate(&p, ProcessPhase::Running, now).kind(),
1012 AutoTerminateKind::Skip,
1013 );
1014 }
1015
1016 #[test]
1017 fn requeue_picks_min_of_default_and_remaining() {
1018 let p = ephemeral_process("5m", TeardownPolicy::Always, 60);
1019 let now = Utc::now();
1020 let d = requeue_with_ttl(&p, now, Duration::from_secs(30));
1021 // 5m total - 60s elapsed = 240s remaining; default 30s wins.
1022 assert_eq!(d, Duration::from_secs(30));
1023
1024 let p = ephemeral_process("90s", TeardownPolicy::Always, 80);
1025 let d = requeue_with_ttl(&p, now, Duration::from_secs(30));
1026 // 90s - 80s = 10s remaining; remaining wins.
1027 assert!(d <= Duration::from_secs(11) && d >= Duration::from_secs(9));
1028
1029 let p = ephemeral_process("90s", TeardownPolicy::Always, 91);
1030 let d = requeue_with_ttl(&p, now, Duration::from_secs(30));
1031 // Already past TTL — clamp to 1s, not 0.
1032 assert_eq!(d, Duration::from_secs(1));
1033 }
1034}