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 // The creation-anchor probe rides through the ONE substrate
318 // `Process::created_at` primitive, sibling to the same-corner
319 // requeue-budget picker in `requeue_with_ttl` below and the
320 // stable-name claim-arbiter tie-break seed in
321 // `tatara-reconciler::table_controller`. Post-lift the two
322 // consumers here + downstream share the ONE
323 // `Option<DateTime<Utc>>` return shape.
324 if !is_terminal_or_exit(current_phase) {
325 if let Some(creation) = process.created_at() {
326 if let Ok(ttl) = humantime::parse_duration(&ephemeral.ttl) {
327 let elapsed = now.signed_duration_since(creation).to_std().ok();
328 if let Some(elapsed) = elapsed {
329 if elapsed >= ttl {
330 return AutoTerminate::Now {
331 reason: TerminateReason::TtlExpired {
332 ttl: ephemeral.ttl.clone(),
333 elapsed,
334 },
335 };
336 }
337 }
338 }
339 }
340 }
341
342 AutoTerminate::Skip
343}
344
345/// Phases past which TTL cannot meaningfully fire — the SIGTERM path
346/// is already in progress.
347fn is_terminal_or_exit(p: ProcessPhase) -> bool {
348 matches!(
349 p,
350 ProcessPhase::Exiting | ProcessPhase::Zombie | ProcessPhase::Reaped
351 )
352}
353
354/// Sleep budget the controller should requeue with for a Process whose
355/// `evaluate()` returned `Skip` — picks the smaller of HEARTBEAT and
356/// TTL-remaining so we don't oversleep past expiry.
357pub fn requeue_with_ttl(process: &Process, now: DateTime<Utc>, default: Duration) -> Duration {
358 // Shared `resolved_ephemeral` projection with [`evaluate`] — the
359 // "give me only the unambiguous ephemeral case" compound-lift
360 // primitive on `impl Lifetime`.
361 let Some(e) = process.spec.lifetime.resolved_ephemeral() else {
362 return default;
363 };
364 // Creation-anchor probe rides through the ONE substrate
365 // `Process::created_at` primitive (sibling to the TTL-expiry gate
366 // in `evaluate` above); the `let-else` short-circuits on the
367 // missing-slot corner to the caller's `default` sleep budget.
368 let Some(creation) = process.created_at() else {
369 return default;
370 };
371 let Ok(ttl) = humantime::parse_duration(&e.ttl) else {
372 return default;
373 };
374 let elapsed = match now.signed_duration_since(creation).to_std() {
375 Ok(d) => d,
376 Err(_) => return default,
377 };
378 let remaining = ttl.checked_sub(elapsed).unwrap_or(Duration::from_secs(0));
379 // Never sleep less than 1s; never longer than the default heartbeat.
380 let pick = std::cmp::min(default, remaining);
381 std::cmp::max(pick, Duration::from_secs(1))
382}
383
384#[cfg(test)]
385mod tests {
386 use super::*;
387 use crate::classification::{Classification, ConvergencePointType, SubstrateType};
388 use crate::crd::ProcessSpec;
389 use crate::intent::{AplicacaoIntent, Intent};
390 use crate::lifetime::{EphemeralLifetime, Lifetime, TeardownPolicy};
391 use k8s_openapi::apimachinery::pkg::apis::meta::v1::Time;
392
393 fn ephemeral_process(ttl: &str, teardown: TeardownPolicy, age_secs: i64) -> Process {
394 let spec = ProcessSpec {
395 identity: Default::default(),
396 classification: Classification {
397 point_type: ConvergencePointType::Gate,
398 substrate: SubstrateType::Compute,
399 horizon: Default::default(),
400 calm: Default::default(),
401 data_classification: Default::default(),
402 },
403 intent: Intent {
404 aplicacao: Some(AplicacaoIntent {
405 chart_ref: "oci://x".into(),
406 version: "1".into(),
407 profile: String::new(),
408 values_overlay: serde_json::Value::Null,
409 release_name: None,
410 target_namespace: None,
411 install_timeout: None,
412 }),
413 ..Intent::default()
414 },
415 boundary: Default::default(),
416 compliance: Default::default(),
417 depends_on: vec![],
418 signals: Default::default(),
419 lifetime: Lifetime {
420 ephemeral: Some(EphemeralLifetime {
421 ttl: ttl.into(),
422 teardown_policy: teardown,
423 max_concurrent: 1,
424 exports: vec![],
425 }),
426 ..Lifetime::default()
427 },
428 routing: None,
429 encapsulates: None,
430 suspended: false,
431 };
432 let mut p = Process::new("e", spec);
433 p.metadata.namespace = Some("ns".into());
434 let creation = Utc::now() - chrono::Duration::seconds(age_secs);
435 p.metadata.creation_timestamp = Some(Time(creation));
436 p
437 }
438
439 fn permanent_process() -> Process {
440 let spec = ProcessSpec {
441 identity: Default::default(),
442 classification: Classification {
443 point_type: ConvergencePointType::Gate,
444 substrate: SubstrateType::Compute,
445 horizon: Default::default(),
446 calm: Default::default(),
447 data_classification: Default::default(),
448 },
449 intent: Intent {
450 aplicacao: Some(AplicacaoIntent {
451 chart_ref: "oci://x".into(),
452 version: "1".into(),
453 profile: String::new(),
454 values_overlay: serde_json::Value::Null,
455 release_name: None,
456 target_namespace: None,
457 install_timeout: None,
458 }),
459 ..Intent::default()
460 },
461 boundary: Default::default(),
462 compliance: Default::default(),
463 depends_on: vec![],
464 signals: Default::default(),
465 lifetime: Lifetime::default(),
466 routing: None,
467 encapsulates: None,
468 suspended: false,
469 };
470 Process::new("e", spec)
471 }
472
473 #[test]
474 fn permanent_never_auto_terminates() {
475 let p = permanent_process();
476 for phase in [
477 ProcessPhase::Pending,
478 ProcessPhase::Execing,
479 ProcessPhase::Running,
480 ProcessPhase::Attested,
481 ProcessPhase::Failed,
482 ] {
483 assert_eq!(evaluate(&p, phase, Utc::now()), AutoTerminate::Skip);
484 }
485 }
486
487 #[test]
488 fn always_teardown_fires_on_attested_and_failed() {
489 let p = ephemeral_process("1h", TeardownPolicy::Always, 60);
490 let now = Utc::now();
491 assert!(matches!(
492 evaluate(&p, ProcessPhase::Attested, now),
493 AutoTerminate::Now { .. }
494 ));
495 assert!(matches!(
496 evaluate(&p, ProcessPhase::Failed, now),
497 AutoTerminate::Now { .. }
498 ));
499 assert_eq!(
500 evaluate(&p, ProcessPhase::Running, now),
501 AutoTerminate::Skip
502 );
503 }
504
505 #[test]
506 fn on_attested_only_fires_on_attested() {
507 let p = ephemeral_process("1h", TeardownPolicy::OnAttested, 60);
508 let now = Utc::now();
509 assert!(matches!(
510 evaluate(&p, ProcessPhase::Attested, now),
511 AutoTerminate::Now { .. }
512 ));
513 assert_eq!(evaluate(&p, ProcessPhase::Failed, now), AutoTerminate::Skip);
514 }
515
516 #[test]
517 fn on_failed_only_fires_on_failed() {
518 let p = ephemeral_process("1h", TeardownPolicy::OnFailed, 60);
519 let now = Utc::now();
520 assert_eq!(
521 evaluate(&p, ProcessPhase::Attested, now),
522 AutoTerminate::Skip
523 );
524 assert!(matches!(
525 evaluate(&p, ProcessPhase::Failed, now),
526 AutoTerminate::Now { .. }
527 ));
528 }
529
530 #[test]
531 fn never_skips_phase_terminations_but_still_honors_ttl() {
532 let p = ephemeral_process("30s", TeardownPolicy::Never, 60);
533 let now = Utc::now();
534 // TTL elapsed → TTL fires regardless of policy.
535 assert!(matches!(
536 evaluate(&p, ProcessPhase::Running, now),
537 AutoTerminate::Now { .. }
538 ));
539 // But not on a terminal phase (already exiting).
540 assert_eq!(
541 evaluate(&p, ProcessPhase::Exiting, now),
542 AutoTerminate::Skip
543 );
544 }
545
546 #[test]
547 fn ttl_not_yet_elapsed_is_skip() {
548 let p = ephemeral_process("1h", TeardownPolicy::Never, 60);
549 assert_eq!(
550 evaluate(&p, ProcessPhase::Running, Utc::now()),
551 AutoTerminate::Skip
552 );
553 }
554
555 /// REASON-STRING CONTRACT: the operator-visible reason composes
556 /// the canonical PascalCase projection of `TeardownPolicy` and
557 /// `ProcessPhase` (via Display) rather than the Debug formatting
558 /// used pre-lift. A future variant rename of either enum updates
559 /// the reason string at ONE site (the `as_str` arm) instead of
560 /// drifting between the typed surface and the operator log.
561 #[test]
562 fn teardown_reason_string_uses_canonical_projection() {
563 let p = ephemeral_process("1h", TeardownPolicy::OnAttested, 60);
564 match evaluate(&p, ProcessPhase::Attested, Utc::now()) {
565 AutoTerminate::Now { reason } => {
566 let rendered = reason.to_string();
567 assert!(
568 rendered.contains("teardown_policy=OnAttested"),
569 "expected canonical PascalCase policy, got: {rendered}",
570 );
571 assert!(
572 rendered.contains("fired on Attested"),
573 "expected canonical PascalCase phase, got: {rendered}",
574 );
575 }
576 other => panic!("expected AutoTerminate::Now, got {other:?}"),
577 }
578
579 let p = ephemeral_process("1h", TeardownPolicy::Always, 60);
580 match evaluate(&p, ProcessPhase::Failed, Utc::now()) {
581 AutoTerminate::Now { reason } => {
582 let rendered = reason.to_string();
583 assert!(rendered.contains("teardown_policy=Always"));
584 assert!(rendered.contains("fired on Failed"));
585 }
586 other => panic!("expected AutoTerminate::Now, got {other:?}"),
587 }
588 }
589
590 // ── TerminateReason / TerminateReasonKind closed-set contracts ────
591
592 /// BYTE-FOR-BYTE PRE-LIFT CONTRACT: the Display impl on
593 /// `TerminateReason` must produce the exact string the pre-lift
594 /// inline `format!(…)` calls produced. Existing alerts, dashboards,
595 /// and operator runbooks that grep `status.message` for these
596 /// substrings keep matching. A future variant rename of
597 /// `TeardownPolicy` / `ProcessPhase` updates the rendered string
598 /// here automatically (Display reads `as_str` projection), but the
599 /// template — `"ephemeral lifetime: teardown_policy={} fired on {}"`
600 /// vs `"ephemeral lifetime: ttl={} expired (elapsed={}s)"` — is
601 /// pinned at the Display site.
602 #[test]
603 fn terminate_reason_display_matches_pre_lift() {
604 // TeardownPolicy variant — every combination of policy × phase
605 // sweeps both PascalCase projections.
606 for policy in TeardownPolicy::ALL {
607 for phase in ProcessPhase::ALL {
608 let reason = TerminateReason::TeardownPolicy { policy, phase };
609 let expected = format!(
610 "ephemeral lifetime: teardown_policy={} fired on {}",
611 policy.as_str(),
612 phase.as_str(),
613 );
614 assert_eq!(
615 reason.to_string(),
616 expected,
617 "Display drifted for ({policy:?}, {phase:?})",
618 );
619 }
620 }
621 // TtlExpired variant — pins the ttl-verbatim + elapsed-secs
622 // template against representative humantime strings the
623 // EphemeralLifetime.ttl field accepts.
624 for (ttl, elapsed_secs) in [("1h", 0u64), ("30m", 60), ("90s", 100), ("5m30s", 3600)] {
625 let reason = TerminateReason::TtlExpired {
626 ttl: ttl.to_string(),
627 elapsed: Duration::from_secs(elapsed_secs),
628 };
629 assert_eq!(
630 reason.to_string(),
631 format!("ephemeral lifetime: ttl={ttl} expired (elapsed={elapsed_secs}s)"),
632 );
633 }
634 }
635
636 /// Reason `kind()` projection — closed-set match so a future
637 /// variant triggers exhaustiveness checking at the projection
638 /// site rather than silently bucketing through a wildcard. Every
639 /// variant's `kind()` matches its `TerminateReasonKind` peer.
640 #[test]
641 fn terminate_reason_kind_truth_table() {
642 assert_eq!(
643 TerminateReason::TeardownPolicy {
644 policy: TeardownPolicy::Always,
645 phase: ProcessPhase::Attested,
646 }
647 .kind(),
648 TerminateReasonKind::TeardownPolicy,
649 );
650 assert_eq!(
651 TerminateReason::TtlExpired {
652 ttl: "1h".to_string(),
653 elapsed: Duration::from_secs(0),
654 }
655 .kind(),
656 TerminateReasonKind::TtlExpired,
657 );
658 }
659
660 /// `ALL` is the source of truth; a variant added without an `ALL`
661 /// entry fails here (uniqueness check) before any sweep test below
662 /// runs. Arity is asserted by the array type itself (`[Self; 2]`).
663 /// Exercise the substrate-wide [`tatara_lisp::ClosedSet`] contract on
664 /// [`TerminateReasonKind`] — pins the structural three-plus-one
665 /// (`ALL` is non-empty, every variant round-trips through
666 /// `label ↔ parse_label`, labels are pairwise distinct, `""` is
667 /// outside the closed set) at ONE call site. Replaces the
668 /// hand-derived `terminate_reason_kind_all_is_unique_and_complete`
669 /// + `terminate_reason_kind_roundtrip_via_as_str` + the empty-input
670 /// arm of `unknown_terminate_reason_kind_errors`. `FromStr`
671 /// delegates to `<Self as tatara_closed_set::ClosedSet>::parse_label`,
672 /// so this helper exercises the same code path the lifetime-clock
673 /// evaluator hits when parsing a typed reason back out of a
674 /// `status.conditions[].reason` slot.
675 #[test]
676 fn terminate_reason_kind_is_well_formed_closed_set() {
677 tatara_closed_set::assert_closed_set_well_formed::<TerminateReasonKind>();
678 }
679
680 /// `Display` IS `as_str` — pinning this lets future callers reach
681 /// for either projection without drift.
682 #[test]
683 fn terminate_reason_kind_display_matches_as_str() {
684 crate::tagged_union::assert_display_matches_label::<TerminateReasonKind>();
685 }
686
687 /// Every kind's `as_str` is in canonical PascalCase. The first
688 /// character is uppercase; no whitespace; no separators. The
689 /// `tatara-process` PascalCase idiom holds at one test site.
690 #[test]
691 fn terminate_reason_kind_as_str_is_pascal_case() {
692 for kind in TerminateReasonKind::ALL {
693 let s = kind.as_str();
694 assert!(!s.is_empty(), "as_str empty for {kind:?}");
695 assert!(
696 s.chars().next().unwrap().is_ascii_uppercase(),
697 "as_str not PascalCase for {kind:?}: {s}",
698 );
699 assert!(
700 !s.contains(|c: char| c.is_whitespace() || c == '_' || c == '-'),
701 "as_str carries separator for {kind:?}: {s}",
702 );
703 }
704 }
705
706 /// `FromStr` rejects strings outside the canonical projection
707 /// (lowercased / typo / cross-axis-leaked) and echoes the input
708 /// verbatim. The empty-string arm is covered by
709 /// `terminate_reason_kind_is_well_formed_closed_set` via the
710 /// [`tatara_lisp::ClosedSet`] contract; the verbatim-echo arms
711 /// stay here because they pin the `UnknownTerminateReasonKind`
712 /// newtype payload contract the trait's `make_unknown` cannot
713 /// see. Cross-axis inputs (ProcessPhase / TeardownPolicy variant
714 /// names) MUST fail — `TerminateReasonKind` is its own axis, not
715 /// a transparent reflection of either.
716 #[test]
717 fn unknown_terminate_reason_kind_errors() {
718 use std::str::FromStr;
719 for bad in [
720 "teardownPolicy",
721 "TEARDOWN_POLICY",
722 "Teardown",
723 "TtlExpire",
724 "ttl_expired",
725 "ttlExpired",
726 // Cross-axis-leaked — must NOT cross axes.
727 "Attested",
728 "Failed",
729 "Always",
730 "OnAttested",
731 "OnFailed",
732 "Never",
733 "Permanent",
734 "Ephemeral",
735 ] {
736 let err = TerminateReasonKind::from_str(bad).unwrap_err();
737 assert_eq!(err.0, bad, "error payload should echo input verbatim");
738 }
739 }
740
741 /// The reason `evaluate` returns under teardown maps to
742 /// `TerminateReasonKind::TeardownPolicy` AND its payload reflects
743 /// the spec's `(teardown_policy, current_phase)` verbatim — the
744 /// typed surface IS the source of truth, not an inline format
745 /// template. A future consumer that wants to group reasons by
746 /// kind in metrics labels reads `reason.kind()`, not a substring
747 /// match.
748 #[test]
749 fn evaluate_typed_reason_carries_teardown_payload() {
750 for (policy, phase) in [
751 (TeardownPolicy::Always, ProcessPhase::Attested),
752 (TeardownPolicy::Always, ProcessPhase::Failed),
753 (TeardownPolicy::OnAttested, ProcessPhase::Attested),
754 (TeardownPolicy::OnFailed, ProcessPhase::Failed),
755 ] {
756 let p = ephemeral_process("1h", policy, 60);
757 match evaluate(&p, phase, Utc::now()) {
758 AutoTerminate::Now { reason } => {
759 assert_eq!(reason.kind(), TerminateReasonKind::TeardownPolicy);
760 assert_eq!(
761 reason,
762 TerminateReason::TeardownPolicy { policy, phase },
763 "typed payload drift for ({policy:?}, {phase:?})",
764 );
765 }
766 other => {
767 panic!("expected AutoTerminate::Now for ({policy:?}, {phase:?}), got {other:?}",)
768 }
769 }
770 }
771 }
772
773 /// TTL expiry returns a `TtlExpired` reason whose `ttl` field is
774 /// the operator-authored humantime string verbatim (NOT the
775 /// parsed `Duration`'s pretty-print) and whose `elapsed` is the
776 /// wall-clock distance. Pinned here so a future evaluator change
777 /// that re-formats the ttl through `humantime::format_duration`
778 /// would fail.
779 #[test]
780 fn evaluate_typed_reason_carries_ttl_payload() {
781 let p = ephemeral_process("30s", TeardownPolicy::Never, 60);
782 let now = Utc::now();
783 match evaluate(&p, ProcessPhase::Running, now) {
784 AutoTerminate::Now { reason } => {
785 assert_eq!(reason.kind(), TerminateReasonKind::TtlExpired);
786 match reason {
787 TerminateReason::TtlExpired { ttl, elapsed } => {
788 assert_eq!(ttl, "30s", "ttl should be verbatim spec string");
789 assert!(
790 elapsed >= Duration::from_secs(30),
791 "elapsed should be at least the ttl",
792 );
793 }
794 other => panic!("expected TtlExpired, got {other:?}"),
795 }
796 }
797 other => panic!("expected AutoTerminate::Now, got {other:?}"),
798 }
799 }
800
801 // ── AutoTerminate / AutoTerminateKind closed-set contracts ────────
802
803 /// Exercise the substrate-wide [`tatara_lisp::ClosedSet`] contract on
804 /// [`AutoTerminateKind`] — pins the structural three-plus-one
805 /// (`ALL` is non-empty, every variant round-trips through
806 /// `label ↔ parse_label`, labels are pairwise distinct, `""` is
807 /// outside the closed set) at ONE call site. Replaces the
808 /// hand-derived uniqueness sweep in
809 /// `auto_terminate_kind_kind_projection_is_exhaustive_over_all`'s
810 /// pre-lift form + the `auto_terminate_kind_roundtrip_via_as_str`
811 /// hand-rolled sweep + the empty-input arm of
812 /// `unknown_auto_terminate_kind_errors`. `FromStr` delegates to
813 /// `<Self as tatara_closed_set::ClosedSet>::parse_label`, so this
814 /// helper exercises the same code path the lifetime-clock
815 /// evaluator hits when parsing a typed kind back out of a
816 /// `status.conditions[].reason` slot.
817 #[test]
818 fn auto_terminate_kind_is_well_formed_closed_set() {
819 tatara_closed_set::assert_closed_set_well_formed::<AutoTerminateKind>();
820 }
821
822 /// Every entry in `ALL` is reachable through a concrete
823 /// [`AutoTerminate`] value via [`AutoTerminate::kind`] — the
824 /// projection is exhaustive across the variant set. Pre-lift this
825 /// pin was bundled with a uniqueness HashSet sweep that
826 /// [`auto_terminate_kind_is_well_formed_closed_set`] now covers
827 /// generically through the [`tatara_lisp::ClosedSet`] contract;
828 /// post-lift this test keeps only the domain-specific
829 /// `kind()`-exhaustiveness contract (the (variant-name →
830 /// payload-stripped kind) binding the [`AutoTerminate`] surface
831 /// projects through). A future third payload-carrying
832 /// `AutoTerminate` variant updates this pin AND
833 /// [`AutoTerminate::kind`]'s exhaustiveness match together,
834 /// exhaustively checked by the compiler.
835 #[test]
836 fn auto_terminate_kind_kind_projection_is_exhaustive_over_all() {
837 let by_all: std::collections::HashSet<_> = AutoTerminateKind::ALL.iter().copied().collect();
838 let sample_reason = TerminateReason::TtlExpired {
839 ttl: "1h".into(),
840 elapsed: Duration::from_secs(0),
841 };
842 let by_concrete: std::collections::HashSet<_> = [
843 AutoTerminate::Skip.kind(),
844 AutoTerminate::Now {
845 reason: sample_reason,
846 }
847 .kind(),
848 ]
849 .into_iter()
850 .collect();
851 assert_eq!(
852 by_concrete, by_all,
853 "kind() projection not exhaustive over ALL"
854 );
855 }
856
857 /// BYTE-EXACT canonical wire-format pin — renaming either of the two
858 /// canonical strings is a wire-format change that fails this test
859 /// FIRST so it stays a deliberate change, not a silent rename that
860 /// drifts existing alerts / dashboards / operator runbooks.
861 #[test]
862 fn auto_terminate_kind_canonical_names_pinned() {
863 assert_eq!(AutoTerminateKind::Skip.as_str(), "Skip");
864 assert_eq!(AutoTerminateKind::Now.as_str(), "Now");
865 }
866
867 /// Every kind's `as_str` is in canonical PascalCase. The first
868 /// character is uppercase; no whitespace; no separators. The
869 /// `tatara-process` PascalCase idiom holds at one test site.
870 #[test]
871 fn auto_terminate_kind_as_str_is_pascal_case() {
872 for kind in AutoTerminateKind::ALL {
873 let s = kind.as_str();
874 assert!(!s.is_empty(), "as_str empty for {kind:?}");
875 assert!(
876 s.chars().next().unwrap().is_ascii_uppercase(),
877 "as_str not PascalCase for {kind:?}: {s}",
878 );
879 assert!(
880 !s.contains(|c: char| c.is_whitespace() || c == '_' || c == '-'),
881 "as_str carries separator for {kind:?}: {s}",
882 );
883 }
884 }
885
886 /// `Display` IS `as_str` — pinning this lets future callers reach
887 /// for either projection without drift.
888 #[test]
889 fn auto_terminate_kind_display_matches_as_str() {
890 crate::tagged_union::assert_display_matches_label::<AutoTerminateKind>();
891 }
892
893 /// `FromStr` rejects strings outside the canonical projection
894 /// (lowercased / typo / cross-axis-leaked) and echoes the input
895 /// verbatim. The empty-string arm AND the round-trip sweep are
896 /// covered by `auto_terminate_kind_is_well_formed_closed_set` via
897 /// the [`tatara_lisp::ClosedSet`] contract; the cases here pin the
898 /// `UnknownAutoTerminateKind` newtype payload contract the
899 /// trait's `make_unknown` cannot see. Cross-axis inputs
900 /// (ProcessPhase / TeardownPolicy / TerminateReasonKind variant
901 /// names) MUST fail — `AutoTerminateKind` is its own axis, not
902 /// a transparent reflection of any sibling enum.
903 #[test]
904 fn unknown_auto_terminate_kind_errors() {
905 use std::str::FromStr;
906 for bad in [
907 "skip",
908 "now",
909 "SKIP",
910 "NOW",
911 "S",
912 "N",
913 "no-op",
914 "terminate",
915 // Cross-axis-leaked — must NOT cross axes.
916 "Attested",
917 "Failed",
918 "TeardownPolicy",
919 "TtlExpired",
920 "Always",
921 "Permanent",
922 "Ephemeral",
923 ] {
924 let err = AutoTerminateKind::from_str(bad).unwrap_err();
925 assert_eq!(err.0, bad, "error payload should echo input verbatim");
926 }
927 }
928
929 /// `reason()` projection: `Now { reason }` returns `Some(&reason)`,
930 /// `Skip` returns `None`. The (variant-name → payload-field)
931 /// binding lives at ONE site so a future third payload-carrying
932 /// variant updates every consumer through this method's
933 /// exhaustiveness check rather than scattering destructures across
934 /// the call graph.
935 #[test]
936 fn auto_terminate_reason_projection() {
937 assert!(AutoTerminate::Skip.reason().is_none());
938
939 let reason = TerminateReason::TtlExpired {
940 ttl: "1h".into(),
941 elapsed: Duration::from_secs(0),
942 };
943 let now = AutoTerminate::Now {
944 reason: reason.clone(),
945 };
946 assert_eq!(now.reason(), Some(&reason));
947
948 let teardown = TerminateReason::TeardownPolicy {
949 policy: TeardownPolicy::OnAttested,
950 phase: ProcessPhase::Attested,
951 };
952 let now = AutoTerminate::Now {
953 reason: teardown.clone(),
954 };
955 assert_eq!(now.reason(), Some(&teardown));
956 }
957
958 /// `is_now` / `is_skip` are exact complements over the closed set —
959 /// `is_now ⊕ is_skip = true` for every variant. Locks the predicate
960 /// pair so a future third variant that's neither Skip nor Now must
961 /// extend BOTH predicates in lockstep (or this contract fails).
962 #[test]
963 fn auto_terminate_predicate_pair_is_exhaustive_complement() {
964 let reason = TerminateReason::TtlExpired {
965 ttl: "1h".into(),
966 elapsed: Duration::from_secs(0),
967 };
968 for decision in [
969 AutoTerminate::Skip,
970 AutoTerminate::Now {
971 reason: reason.clone(),
972 },
973 ] {
974 assert_ne!(
975 decision.is_now(),
976 decision.is_skip(),
977 "predicate pair drift for {decision:?}",
978 );
979 // The kind projection agrees with each predicate.
980 assert_eq!(decision.is_now(), decision.kind() == AutoTerminateKind::Now);
981 assert_eq!(
982 decision.is_skip(),
983 decision.kind() == AutoTerminateKind::Skip
984 );
985 // `reason()` agrees with `is_now`.
986 assert_eq!(decision.reason().is_some(), decision.is_now());
987 }
988 }
989
990 /// The `kind()` projection on the typed result of `evaluate` agrees
991 /// with the behavioural expectation: ephemeral-on-Attested with an
992 /// OnAttested policy returns `Now`, permanent never does. Closes
993 /// the loop between the closed-set view and the live decision so
994 /// any future kind-keyed metrics label (e.g.
995 /// `tatara_lifetime_clock_decisions_total{kind="Now"}`) reads the
996 /// typed projection rather than the inline destructure.
997 #[test]
998 fn evaluate_decision_kind_agrees_with_runtime_behaviour() {
999 let p = permanent_process();
1000 for phase in [
1001 ProcessPhase::Pending,
1002 ProcessPhase::Running,
1003 ProcessPhase::Attested,
1004 ProcessPhase::Failed,
1005 ] {
1006 let decision = evaluate(&p, phase, Utc::now());
1007 assert_eq!(
1008 decision.kind(),
1009 AutoTerminateKind::Skip,
1010 "permanent Process must always Skip; got Now for phase={phase:?}",
1011 );
1012 assert!(decision.reason().is_none());
1013 }
1014
1015 let p = ephemeral_process("1h", TeardownPolicy::OnAttested, 60);
1016 let now = Utc::now();
1017 assert_eq!(
1018 evaluate(&p, ProcessPhase::Attested, now).kind(),
1019 AutoTerminateKind::Now,
1020 );
1021 assert_eq!(
1022 evaluate(&p, ProcessPhase::Running, now).kind(),
1023 AutoTerminateKind::Skip,
1024 );
1025 }
1026
1027 #[test]
1028 fn requeue_picks_min_of_default_and_remaining() {
1029 let p = ephemeral_process("5m", TeardownPolicy::Always, 60);
1030 let now = Utc::now();
1031 let d = requeue_with_ttl(&p, now, Duration::from_secs(30));
1032 // 5m total - 60s elapsed = 240s remaining; default 30s wins.
1033 assert_eq!(d, Duration::from_secs(30));
1034
1035 let p = ephemeral_process("90s", TeardownPolicy::Always, 80);
1036 let d = requeue_with_ttl(&p, now, Duration::from_secs(30));
1037 // 90s - 80s = 10s remaining; remaining wins.
1038 assert!(d <= Duration::from_secs(11) && d >= Duration::from_secs(9));
1039
1040 let p = ephemeral_process("90s", TeardownPolicy::Always, 91);
1041 let d = requeue_with_ttl(&p, now, Duration::from_secs(30));
1042 // Already past TTL — clamp to 1s, not 0.
1043 assert_eq!(d, Duration::from_secs(1));
1044 }
1045}