kanade_shared/manifest.rs
1use serde::{Deserialize, Serialize};
2
3use crate::ipc::jobs::JobCategory;
4use crate::wire::{RunAs, Shell, Staleness};
5
6/// YAML job manifest (= registered "what to run", v0.18.0+).
7///
8/// Owns only script-intrinsic fields. **Who** (`target`), **how to
9/// phase fanout** (`rollout`), and **when to stagger start**
10/// (`jitter`) all moved to the Schedule / exec request side — same
11/// script can now be fired against different targets / rollouts
12/// without copying the script body.
13///
14/// #492: these types are READ fleet-wide (agents decode them from
15/// BUCKET_JOBS / BUCKET_SCHEDULES and inside live Commands), so they
16/// must tolerate unknown fields — `deny_unknown_fields` here made a
17/// gradually-upgrading fleet's OLD agents reject the whole object
18/// the moment a newer backend added any field. Operator typo
19/// protection (the old reason for the attribute) lives at the WRITE
20/// boundaries instead: `kanade job/schedule create` and the backend
21/// POST extractor parse via [`crate::strict`], which rejects unknown
22/// keys with their full paths. The wire rule: new fields always get
23/// `#[serde(default)]` (+ `skip_serializing_if` while old readers
24/// may still be strict).
25#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
26pub struct Manifest {
27 pub id: String,
28 pub version: String,
29 #[serde(default)]
30 pub description: Option<String>,
31 pub execute: Execute,
32 #[serde(default)]
33 pub require_approval: bool,
34 /// Opt-in marker that this job produces a JSON inventory fact
35 /// payload on stdout. When present, the backend's results
36 /// projector parses `ExecResult.stdout` as JSON and upserts an
37 /// `inventory_facts` row keyed by `(pc_id, manifest.id)`. The
38 /// `display` sub-config drives the SPA's Inventory page render.
39 #[serde(default)]
40 pub inventory: Option<InventoryHint>,
41 /// Issue #246: opt-in marker that this job emits per-line
42 /// observability events on stdout (one JSON `ObsEvent` per
43 /// newline). When present, the agent — after the script exits
44 /// successfully — parses each non-empty stdout line as an
45 /// `ObsEvent`, publishes it on `obs.<pc_id>` via the
46 /// `obs_outbox`, and (intentionally) **omits the stdout from
47 /// the `ExecResult`** so the timeline data doesn't double up
48 /// in `execution_results.stdout` (which would multiply rows
49 /// by ~50/day/PC of noise).
50 ///
51 /// Distinct from `inventory:` (single JSON object → projector
52 /// upsert) — events are append-only timeline points consumed
53 /// by the dedicated `obs_events` table.
54 #[serde(default)]
55 pub emit: Option<EmitConfig>,
56 /// #290: opt-in marker that this job is an operator-defined
57 /// **health check** whose result feeds the Client App's Health
58 /// tab over KLP (`StateSnapshot.checks`). The script prints a
59 /// free-form JSON object on stdout (like any inventory job); the
60 /// agent reads the [`CheckHint::status_field`] value dynamically
61 /// into a [`crate::ipc::state::Check`] named `check.name`.
62 /// Cadence / windows / conditions come from
63 /// the job's Schedule (exactly like inventory) — there is
64 /// deliberately no interval here. **Composes with `inventory:`**:
65 /// the script's stdout is one JSON object, so a check can also
66 /// carry an `inventory:` block to project the rest of that object
67 /// (incl. `explode` sub-tables) for SPA fleet-querying. Only
68 /// `emit:` (NDJSON stdout) is incompatible.
69 #[serde(default)]
70 pub check: Option<CheckHint>,
71 /// v0.26: Layer 2 staleness policy (SPEC.md §2.6.2). Controls
72 /// what the agent does at fire time when it can't verify the
73 /// `script_current` / `script_status` KV values are fresh —
74 /// especially relevant for `runs_on: agent` schedules where
75 /// the agent may fire from cache while offline. Defaults to
76 /// `Staleness::Cached` (silently use cached values), which
77 /// matches every pre-v0.26 Manifest.
78 #[serde(default)]
79 pub staleness: Staleness,
80 /// #291: opt-in marker that this job is offered to **end users**
81 /// in the Client App's job tabs over KLP (`jobs.list` →
82 /// `jobs.execute`). Parallel to [`inventory`] / [`check`] /
83 /// [`emit`]: the block's mere presence is the opt-in, and it
84 /// groups the end-user presentation fields (name / category /
85 /// icon) that only make sense for a user-facing job. `None`
86 /// (the default) ⇒ an operator-only job — inventory, checks,
87 /// scheduled maintenance — that never surfaces in the catalog.
88 ///
89 /// The agent re-reads this at every `jobs.list` / `jobs.execute`
90 /// (SPEC §2.1), so removing the block takes a job out of a
91 /// running client on its next action.
92 ///
93 /// [`inventory`]: Manifest::inventory
94 /// [`check`]: Manifest::check
95 /// [`emit`]: Manifest::emit
96 #[serde(default, skip_serializing_if = "Option::is_none")]
97 pub client: Option<ClientHint>,
98}
99
100/// "Who + how + when-to-stagger" — the fanout-plan side of an exec.
101/// Used both as the POST `/api/exec/{job_id}` body and as the embedded
102/// `target` / `rollout` / `jitter` slot on [`Schedule`]. Centralising
103/// here keeps the validation + serialisation logic in one place.
104#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Default)]
105pub struct FanoutPlan {
106 #[serde(default)]
107 pub target: Target,
108 /// Optional wave rollout — when present, the backend publishes
109 /// each wave's group subject on its own delay schedule instead
110 /// of fanning out the `target` block in one go. `target` then
111 /// only labels the deploy for the audit log.
112 #[serde(default, skip_serializing_if = "Option::is_none")]
113 pub rollout: Option<Rollout>,
114 /// Optional humantime jitter; agent uses it to randomise
115 /// execution start. Lives here (not on the script) so different
116 /// schedules / ad-hoc fires of the same job can pick different
117 /// stagger windows.
118 #[serde(default, skip_serializing_if = "Option::is_none")]
119 pub jitter: Option<String>,
120 /// Absolute time the scheduler stamps on each emitted Command
121 /// when this exec was driven by a [`Schedule`] with
122 /// `starting_deadline`. Agents receiving a Command after this
123 /// instant publish a synthetic skipped-result instead of
124 /// running the script. `None` (default) = no deadline / catch
125 /// up whenever delivered. Operators don't usually set this
126 /// directly — the scheduler computes it from `tick_at +
127 /// starting_deadline`.
128 #[serde(default, skip_serializing_if = "Option::is_none")]
129 pub deadline_at: Option<chrono::DateTime<chrono::Utc>>,
130}
131
132/// Manifest sub-section: how the SPA should render the inventory
133/// facts this job produces. Each field name (`field`) is a top-level
134/// key in the stdout JSON, e.g. `hostname`, `ram_gb`.
135///
136/// Two render modes:
137/// * `display` — vertical "field / value" per PC, used by the
138/// `/inventory?pc=<id>` detail view. ALL columns the operator
139/// wants visible on the detail page.
140/// * `summary` — horizontal table across the fleet (row = PC,
141/// column = field) on `/inventory`. Optional; when omitted the
142/// SPA falls back to `display`, but operators usually want a
143/// trimmer "hostname / OS / CPU / RAM" set for the fleet view.
144#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
145pub struct InventoryHint {
146 /// Detail-view columns, in order.
147 pub display: Vec<DisplayField>,
148 /// Optional fleet-list columns (row = PC). Defaults to `display`
149 /// when omitted, but operators usually pick a 3-5 column subset.
150 #[serde(default, skip_serializing_if = "Option::is_none")]
151 pub summary: Option<Vec<DisplayField>>,
152 /// v0.31 / #40: payload arrays that should be exploded into
153 /// per-element rows of a derived SQLite table. Lets operators
154 /// answer cross-PC questions ("which PCs still have Chrome <
155 /// 120?", "C: >90% full") with normal SQL filters + indexes
156 /// instead of grepping JSON. The projector creates the derived
157 /// table on register and replaces this PC's rows on each result
158 /// (DELETE WHERE pc_id=? AND job_id=? + bulk INSERT). See
159 /// [`ExplodeSpec`] for the per-spec schema.
160 #[serde(default, skip_serializing_if = "Option::is_none")]
161 pub explode: Option<Vec<ExplodeSpec>>,
162 /// v0.35 / #93: top-level scalar fields whose changes the
163 /// projector logs to `inventory_history` (one event per
164 /// changed field per scan). Pairs with `explode[].track_history`
165 /// — that covers array elements; this covers single-valued
166 /// fields like `ram_bytes` / `os_version` / `cpu_model` /
167 /// `os_build` that operators want to track for "did the RAM
168 /// get upgraded?" / "when did Win 11 land on this PC?" /
169 /// "BIOS / firmware bumped?" questions. Field name = `field_path`
170 /// in the history row, `identity_json` is NULL, `before_json`
171 /// / `after_json` each carry `{"value": <prior or new value>}`.
172 /// First-ever observation of a scalar (no prior facts row)
173 /// emits `added`; subsequent value changes emit `changed`. No
174 /// `removed` events — a scalar disappearing from the payload
175 /// is rare and the operator can still see the last value via
176 /// the `before_json` of the most recent change.
177 #[serde(default, skip_serializing_if = "Option::is_none")]
178 pub history_scalars: Option<Vec<String>>,
179}
180
181/// Manifest sub-section (#290): marks a job as an operator-defined
182/// **health check**. Parallel to [`InventoryHint`] / `EmitConfig`.
183/// The stdout contract is a free-form JSON object (same as any
184/// inventory job) from which the agent reads `status_field` /
185/// `detail_field` to build the KLP [`crate::ipc::state::Check`] shown
186/// on the Client App's Health tab.
187///
188/// There is deliberately **no timing field** — when / how often /
189/// in which window a check runs is driven by the job's Schedule,
190/// exactly like inventory jobs, so operators get the full `when:` /
191/// rollout / `runs_on` expressiveness for free.
192///
193/// A check's stdout is a **free-form inventory object** (arbitrary
194/// key/value pairs + arrays) — same as any inventory job — that also
195/// carries a status field. `check:` adds only the health semantics on
196/// top: which field is the ok/warn/fail/unknown status, an optional
197/// one-line summary field, and a remediation job. Everything else
198/// (rich per-PC detail, `explode` sub-tables like a software list) is
199/// driven by a co-present [`InventoryHint`] and rendered with the
200/// SAME display logic the SPA Inventory page uses — on the Client App
201/// too. This keeps checks maximally expressive without a bespoke
202/// payload type.
203#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
204pub struct CheckHint {
205 /// Stable check id → [`Check.name`](crate::ipc::state::Check),
206 /// the SPA/Client React key + analytics label. Unique within the
207 /// fleet's check set.
208 pub name: String,
209 /// Top-level stdout field whose string value
210 /// (`ok`/`warn`/`fail`/`unknown`) becomes the Health-tab light
211 /// ([`CheckStatus`](crate::ipc::state::CheckStatus)). Defaults to
212 /// `"status"`; a missing / unparseable value → `unknown`.
213 #[serde(default = "default_status_field")]
214 pub status_field: String,
215 /// Top-level stdout field used as the Health-tab row's one-line
216 /// summary. Defaults to `"detail"`; absent in the payload → no
217 /// detail line (the rich breakdown lives in the inventory view).
218 #[serde(default = "default_detail_field")]
219 pub detail_field: String,
220 /// Optional remediation job id →
221 /// [`Check.troubleshoot`](crate::ipc::state::Check). The Client
222 /// App shows a "修復する" button when present; that job must be
223 /// `user_invokable`.
224 #[serde(default, skip_serializing_if = "Option::is_none")]
225 pub troubleshoot: Option<String>,
226 /// #290 PR-E: when `true` (default), the backend also projects this
227 /// check's `status` / `detail` into the `check_status` table so the
228 /// operator SPA gets a fleet-wide compliance view for free — no
229 /// `inventory:` block needed. Set `fleet: false` for a client-only
230 /// check the operator doesn't want surfaced across the fleet.
231 #[serde(default = "default_fleet")]
232 pub fleet: bool,
233}
234
235fn default_status_field() -> String {
236 "status".to_string()
237}
238
239fn default_detail_field() -> String {
240 "detail".to_string()
241}
242
243fn default_fleet() -> bool {
244 true
245}
246
247/// Manifest sub-section (#291): marks a job as **user-invokable**
248/// from the Client App and carries how it presents to the end user.
249/// Parallel to [`InventoryHint`] / [`CheckHint`] / `EmitConfig` —
250/// the block's presence is the opt-in (no separate boolean), and its
251/// required fields (`name`, `category`) are enforced by serde at
252/// parse time, so a half-filled catalog entry fails
253/// `kanade job create` instead of rendering a nameless / tab-less row.
254///
255/// The agent maps this 1:1 into the KLP
256/// [`UserInvokableJob`](crate::ipc::jobs::UserInvokableJob) wire shape
257/// that `jobs.list` returns; the Client App renders one row per job in
258/// the tab named by `category`.
259#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
260pub struct ClientHint {
261 /// End-user-facing title for the job row. The operator-internal
262 /// `Manifest::id` slug is rarely what an end user should read, so
263 /// this is required (and validated non-empty by
264 /// [`Manifest::validate`]). Maps to `UserInvokableJob::display_name`.
265 pub name: String,
266 /// Optional one-line subtitle under `name` in the Client App.
267 /// Distinct from the operator-facing top-level
268 /// [`Manifest::description`] — this one is written for the end
269 /// user. Maps to `UserInvokableJob::display_description`.
270 #[serde(default, skip_serializing_if = "Option::is_none")]
271 pub description: Option<String>,
272 /// Which Client App tab the job lives in (`software_update` →
273 /// アップデート, `troubleshoot` → 困ったとき, `catalog` → software
274 /// catalog). Required — without it the agent can't place the job
275 /// in a tab.
276 pub category: JobCategory,
277 /// Optional icon hint for the job row — a lucide-react icon name
278 /// or a `data:` URL. `None` ⇒ the Client App falls back to the
279 /// category's default icon. Surfaced verbatim in
280 /// `jobs.list[].icon`.
281 #[serde(default, skip_serializing_if = "Option::is_none")]
282 pub icon: Option<String>,
283}
284
285/// Issue #246 — `emit:` manifest block for jobs whose stdout is
286/// NDJSON observability events (one `ObsEvent` per line). Parallel
287/// to `inventory:` but for the append-only timeline pipeline; see
288/// `Manifest::emit` for the full contract.
289#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
290pub struct EmitConfig {
291 /// What kind of payload the agent should expect on stdout. Only
292 /// `events` is defined today (parses each non-empty line as
293 /// `ObsEvent` and publishes on `obs.<pc_id>`); future variants
294 /// (e.g. metrics streams, structured trace events) plug in here.
295 #[serde(rename = "type")]
296 pub kind: EmitKind,
297 /// Operator hint for where the script keeps its own state — the
298 /// watermark file the PowerShell / sh body reads + writes
299 /// between runs so it only emits NEW events since the last
300 /// poll. The agent doesn't read this; it's documentation that
301 /// the SPA (and `kanade job edit`) can surface to operators
302 /// reviewing the manifest. Optional; the script is allowed to
303 /// keep state anywhere (registry, env, etc.) — the field's
304 /// presence makes the convention discoverable.
305 #[serde(default, skip_serializing_if = "Option::is_none")]
306 pub watermark_path: Option<String>,
307}
308
309/// `emit.type` enum. Lowercase serde so manifests read
310/// `type: events` rather than `Events`.
311#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Copy, PartialEq, Eq)]
312#[serde(rename_all = "lowercase")]
313pub enum EmitKind {
314 /// Per-line `ObsEvent` JSON. Agent parses + publishes on
315 /// `obs.<pc_id>`, drops the stdout from the resulting
316 /// `ExecResult`.
317 Events,
318}
319
320/// v0.31 / #40: declarative "flatten this JSON array into a real
321/// SQLite table" spec on an inventory manifest. The projector
322/// creates the table on first registration (CREATE TABLE IF NOT
323/// EXISTS + indexes) and writes a row per element of
324/// `payload[field]` on every result, scoped by (pc_id, job_id) so
325/// each PC's rows replace cleanly without a per-PC schema.
326#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
327pub struct ExplodeSpec {
328 /// JSON array key under the payload to explode. E.g. `"apps"`
329 /// for `payload: { apps: [{...}, {...}] }`.
330 pub field: String,
331 /// Derived SQLite table name. Operators choose this — pick
332 /// something namespaced + stable (`inventory_sw_apps`, not
333 /// `apps`) so multiple inventory manifests don't collide on a
334 /// generic name.
335 pub table: String,
336 /// Element-level fields that uniquely identify a row inside one
337 /// PC's payload. The full PK is `(pc_id, job_id) + these
338 /// columns`. Required — operators must think about uniqueness
339 /// (e.g. `["name", "source"]` for installed apps because the
340 /// same name appears in multiple uninstall hives).
341 ///
342 /// v0.31 / #41: same tuple drives history identity. When
343 /// `track_history` is on, the projector serialises these
344 /// fields' values into `inventory_history.identity_json` for
345 /// every change event, so queries like "every PC that ever
346 /// installed Chrome (any source)" filter on identity_json
347 /// content without a per-manifest schema.
348 pub primary_key: Vec<String>,
349 /// Per-element fields that become columns in the derived table.
350 pub columns: Vec<ExplodeColumn>,
351 /// v0.31 / #41: when true (default false), the projector
352 /// diffs each PC's incoming payload against the prior rows
353 /// for the same (pc_id, job_id) BEFORE the DELETE-then-INSERT
354 /// replace, and writes added / removed / changed events into
355 /// `inventory_history`. Lets operators answer time-dimension
356 /// questions ("when did Chrome 120 first appear on PC X?",
357 /// "what's the Win 11 23H2 rollout curve") without storing
358 /// per-scan snapshots. Off by default so operators opt in
359 /// per-spec — history has a real storage cost on long-lived
360 /// deployments (mitigated by the 90-day default retention
361 /// sweeper, see `cleanup` module).
362 #[serde(default)]
363 pub track_history: bool,
364}
365
366/// One column in an [`ExplodeSpec`]'s derived table.
367#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
368pub struct ExplodeColumn {
369 /// JSON key under each array element. Becomes the column name
370 /// in the derived SQLite table — we don't rename.
371 pub field: String,
372 /// SQLite affinity: `"text"` (default), `"integer"`, `"real"`.
373 /// Storage maps directly via `sqlx::query.bind(...)`; type
374 /// mismatches at INSERT-time fail loudly rather than silently
375 /// dropping the row.
376 #[serde(default, skip_serializing_if = "Option::is_none")]
377 #[serde(rename = "type")]
378 pub kind: Option<String>,
379 /// When true, the projector creates a `CREATE INDEX` on this
380 /// column at table-creation time. Boost for the common-filter
381 /// columns (`name`, `version`) — operators mark them
382 /// explicitly, the projector won't guess.
383 #[serde(default)]
384 pub index: bool,
385}
386
387#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
388pub struct DisplayField {
389 /// Top-level key in the stdout JSON.
390 pub field: String,
391 /// Human-readable column header.
392 pub label: String,
393 /// Optional render hint — `"number"`, `"bytes"`, `"timestamp"`,
394 /// or `"table"` (#39). Defaults to plain text rendering on the
395 /// SPA side. `"table"` expects the field's value to be a JSON
396 /// array of objects and renders a nested sub-table on the
397 /// per-PC detail page using `columns` as the schema; the fleet
398 /// summary view falls back to showing the row count for
399 /// `"table"` cells so the wide list stays compact.
400 #[serde(default, skip_serializing_if = "Option::is_none")]
401 #[serde(rename = "type")]
402 pub kind: Option<String>,
403 /// v0.30 / #39: when `kind == "table"`, the SPA renders the
404 /// field's value (an array of objects like
405 /// `disks: [{ device_id, size_bytes, ... }]`) as a nested
406 /// sub-table using these columns. Each column is itself a
407 /// `DisplayField`, so the nested cells reuse the same render
408 /// hints (`bytes`, `number`, `timestamp`) — no parallel format
409 /// pipeline. Ignored for any other `kind`.
410 #[serde(default, skip_serializing_if = "Option::is_none")]
411 pub columns: Option<Vec<DisplayField>>,
412}
413
414#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
415pub struct Rollout {
416 #[serde(default)]
417 pub strategy: RolloutStrategy,
418 pub waves: Vec<Wave>,
419}
420
421#[derive(
422 Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Copy, PartialEq, Eq, Default,
423)]
424#[serde(rename_all = "lowercase")]
425pub enum RolloutStrategy {
426 #[default]
427 Wave,
428}
429
430#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
431pub struct Wave {
432 pub group: String,
433 /// humantime delay measured from the deploy's publish time. wave[0]
434 /// typically has "0s"; subsequent waves use minutes / hours.
435 pub delay: String,
436}
437
438#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Default)]
439pub struct Target {
440 #[serde(default)]
441 pub groups: Vec<String>,
442 #[serde(default)]
443 pub pcs: Vec<String>,
444 #[serde(default)]
445 pub all: bool,
446}
447
448impl Target {
449 /// At least one of all / groups / pcs is set.
450 pub fn is_specified(&self) -> bool {
451 self.all || !self.groups.is_empty() || !self.pcs.is_empty()
452 }
453}
454
455#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
456pub struct Execute {
457 pub shell: ExecuteShell,
458 /// Inline script body. Mutually exclusive with [`script_file`]
459 /// and [`script_object`]; exactly one of the three must be set
460 /// (enforced by [`Execute::validate_script_source`] at the
461 /// write-side parse boundaries — `kanade job create` and
462 /// `POST /api/jobs`).
463 ///
464 /// Empty string is treated as **unset** so operators can swap
465 /// to a `script_file:` / `script_object:` alternative just by
466 /// commenting out the body, without having to also drop the
467 /// `script:` key entirely.
468 ///
469 /// [`script_file`]: Self::script_file
470 /// [`script_object`]: Self::script_object
471 #[serde(default, skip_serializing_if = "Option::is_none")]
472 pub script: Option<String>,
473 /// Repo-local file path resolved by the operator-side CLI at
474 /// `kanade job create` time. The CLI reads the file, slots its
475 /// contents into `script`, and clears this field before
476 /// POSTing — so the backend / agents never see `script_file`
477 /// in stored manifests. SPEC §2.4.1.
478 ///
479 /// Resolver lands in a follow-up PR
480 /// (yukimemi/kanade#210); today this field passes parse-time
481 /// validation but the operator-side CLI bails with "not yet
482 /// implemented" until the resolver ships, so manifests that
483 /// reach the backend with `script_file` set are treated as a
484 /// schema-bug.
485 #[serde(default, skip_serializing_if = "Option::is_none")]
486 pub script_file: Option<String>,
487 /// Object Store reference (`<name>/<version>`) into the
488 /// `scripts` bucket (`OBJECT_SCRIPTS`). Agents fetch the body
489 /// at Execute time via `/api/script-objects/{name}/{version}`
490 /// and cache it locally. SPEC §2.4.1.
491 ///
492 /// Resolver lands in the same follow-up PR as `script_file`;
493 /// today this field passes parse-time validation but the
494 /// backend / agent exec paths bail with "not yet implemented"
495 /// when they see it.
496 #[serde(default, skip_serializing_if = "Option::is_none")]
497 pub script_object: Option<String>,
498 /// humantime duration string (e.g. "30s", "10m"). Script-intrinsic
499 /// — represents how long this script reasonably takes to run.
500 pub timeout: String,
501 /// Token + session combination the agent uses to launch the
502 /// script (v0.21). Default = [`RunAs::System`] (Session 0,
503 /// LocalSystem privileges, no GUI) — matches pre-v0.21 behavior.
504 #[serde(default)]
505 pub run_as: RunAs,
506 /// Working directory for the spawned child (v0.21.1). When
507 /// unset, the child inherits the agent's cwd — on Windows that
508 /// means `%SystemRoot%\System32` for the prod service, which is
509 /// almost never what operators actually want. Use an absolute
510 /// path; relative paths are passed through to the OS verbatim.
511 /// `%PROGRAMDATA%` works for `run_as: system`; for `run_as: user`
512 /// you'd want `%USERPROFILE%` (but expansion happens in the
513 /// shell, so write `$env:USERPROFILE` for PowerShell, or set
514 /// it via teravars before `kanade job create`).
515 #[serde(default, skip_serializing_if = "Option::is_none")]
516 pub cwd: Option<String>,
517}
518
519impl Execute {
520 /// Treat an empty `script:` body as "intentionally unset". Operators
521 /// commenting out a block-scalar tend to leave the key behind, and
522 /// failing the validator on `script: ""` would surprise them.
523 fn has_inline_script(&self) -> bool {
524 matches!(&self.script, Some(s) if !s.is_empty())
525 }
526
527 /// Enforce that exactly one of `script` / `script_file` /
528 /// `script_object` is set. Called at the write-side parse
529 /// boundaries (CLI `kanade job create` + backend
530 /// `POST /api/jobs`) so ambiguous YAML is rejected before it
531 /// reaches the JOBS KV. Read paths (projector, agent
532 /// scheduler, list endpoints) skip this check — they only ever
533 /// see what the write path already validated.
534 pub fn validate_script_source(&self) -> Result<(), String> {
535 let inline = self.has_inline_script();
536 let file = self.script_file.is_some();
537 let obj = self.script_object.is_some();
538 let set = [inline, file, obj].into_iter().filter(|b| *b).count();
539 match set {
540 1 => Ok(()),
541 0 => Err("execute: one of `script`, `script_file`, `script_object` must be set".into()),
542 _ => Err(format!(
543 "execute: only one of `script` / `script_file` / `script_object` may be set \
544 (got script={inline}, script_file={file}, script_object={obj})"
545 )),
546 }
547 }
548}
549
550impl Manifest {
551 /// Cross-field semantic checks that don't fit into pure serde
552 /// derive. Currently delegates to
553 /// [`Execute::validate_script_source`] — see that method's
554 /// docs for the rationale on which call sites should run this.
555 pub fn validate(&self) -> Result<(), String> {
556 self.execute.validate_script_source()?;
557 // Stdout-format compatibility. `inventory:` and `check:` both
558 // consume the SAME single JSON object — they COMPOSE: a check
559 // can extract `status`/`detail` for the Health tab while the
560 // projector explodes the rest into SPA sub-tables. `emit:` is
561 // different — its stdout is NDJSON and the agent omits it from
562 // the result entirely — so it can't be paired with either.
563 if self.emit.is_some() && (self.inventory.is_some() || self.check.is_some()) {
564 return Err(
565 "`emit:` is incompatible with `inventory:` / `check:` — emit's stdout is NDJSON \
566 timeline events (and omitted from the result), while inventory/check read a \
567 single JSON object from stdout"
568 .to_string(),
569 );
570 }
571 // A check's `name` is the Health-tab row id (React key); the
572 // field names tell the agent where to read status/detail.
573 // An empty value is an invisible runtime bug, and the serde
574 // defaults don't guard an operator who writes `status_field:
575 // ""` explicitly — reject all three here.
576 if let Some(check) = &self.check {
577 for (label, value) in [
578 ("check.name", &check.name),
579 ("check.status_field", &check.status_field),
580 ("check.detail_field", &check.detail_field),
581 ] {
582 if value.trim().is_empty() {
583 return Err(format!("{label} must not be empty"));
584 }
585 }
586 // A present-but-blank `troubleshoot` is a broken
587 // remediation job id (the "修復する" button would target
588 // an empty manifest id) — reject it too.
589 if let Some(troubleshoot) = &check.troubleshoot {
590 if troubleshoot.trim().is_empty() {
591 return Err("check.troubleshoot must not be empty when set".to_string());
592 }
593 }
594 }
595 // #291: a `client:` job is rendered in the Client App's
596 // catalog (`jobs.list` → `jobs.execute`). serde already makes
597 // `name` + `category` required at parse time; the only gap is
598 // a present-but-blank `name`, which would render an empty row
599 // title — reject it like the other display-id fields.
600 if let Some(client) = &self.client {
601 if client.name.trim().is_empty() {
602 return Err("client.name must not be empty".to_string());
603 }
604 // Optional display fields, when present, must be
605 // meaningful: a blank `description` renders an empty
606 // subtitle and a blank `icon` is a dangling lucide name.
607 // Same present-but-blank guard the `check:` block applies
608 // to its optional `troubleshoot` id.
609 for (label, value) in [
610 ("client.description", &client.description),
611 ("client.icon", &client.icon),
612 ] {
613 if let Some(v) = value {
614 if v.trim().is_empty() {
615 return Err(format!("{label} must not be empty when set"));
616 }
617 }
618 }
619 }
620 Ok(())
621 }
622}
623
624#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Copy, PartialEq, Eq)]
625#[serde(rename_all = "lowercase")]
626pub enum ExecuteShell {
627 Powershell,
628 Cmd,
629}
630
631impl From<ExecuteShell> for Shell {
632 fn from(s: ExecuteShell) -> Self {
633 match s {
634 ExecuteShell::Powershell => Shell::Powershell,
635 ExecuteShell::Cmd => Shell::Cmd,
636 }
637 }
638}
639
640#[cfg(test)]
641mod tests {
642 use super::*;
643
644 /// The example check-job + schedule YAMLs shipped under `configs/`
645 /// must stay valid as the schema evolves (#290 PR-C). `include_str!`
646 /// pins them at compile time so a breaking edit fails `cargo test`
647 /// rather than only `kanade job create` at deploy time.
648 #[test]
649 fn example_check_job_yamls_parse_and_validate() {
650 let jobs = [
651 (
652 "check-bitlocker",
653 include_str!("../../../configs/jobs/check-bitlocker.yaml"),
654 ),
655 (
656 "check-av-signature",
657 include_str!("../../../configs/jobs/check-av-signature.yaml"),
658 ),
659 (
660 "check-cert-expiry",
661 include_str!("../../../configs/jobs/check-cert-expiry.yaml"),
662 ),
663 ];
664 for (name, yaml) in jobs {
665 let m: Manifest =
666 serde_yaml::from_str(yaml).unwrap_or_else(|e| panic!("{name} parse: {e}"));
667 m.validate()
668 .unwrap_or_else(|e| panic!("{name} validate: {e}"));
669 let check = m
670 .check
671 .as_ref()
672 .unwrap_or_else(|| panic!("{name} must carry a check: hint"));
673 assert!(!check.name.trim().is_empty(), "{name} check.name empty");
674 // These three examples all read admin-only WMI namespaces,
675 // so they run_as system. NOTE: that's a property of these
676 // particular checks, NOT of the `check:` contract — a check
677 // probing user-session state could legitimately run_as user.
678 assert_eq!(
679 m.execute.run_as,
680 RunAs::System,
681 "{name} should run_as system"
682 );
683 }
684 }
685
686 /// The example user-invokable job YAMLs (#291) shipped under
687 /// `configs/jobs/` must stay valid as the `client:` schema
688 /// evolves. `include_str!` pins them at compile time so a breaking
689 /// edit fails `cargo test`, not `kanade job create` at deploy.
690 #[test]
691 fn example_client_job_yamls_parse_and_validate() {
692 let jobs = [
693 (
694 "fix-teams-cache",
695 JobCategory::Troubleshoot,
696 include_str!("../../../configs/jobs/fix-teams-cache.yaml"),
697 ),
698 (
699 "chrome-update",
700 JobCategory::SoftwareUpdate,
701 include_str!("../../../configs/jobs/chrome-update.yaml"),
702 ),
703 (
704 "install-slack",
705 JobCategory::Catalog,
706 include_str!("../../../configs/jobs/install-slack.yaml"),
707 ),
708 ];
709 for (id, category, yaml) in jobs {
710 let m: Manifest =
711 serde_yaml::from_str(yaml).unwrap_or_else(|e| panic!("{id} parse: {e}"));
712 m.validate()
713 .unwrap_or_else(|e| panic!("{id} validate: {e}"));
714 assert_eq!(m.id, id, "{id} id mismatch");
715 let client = m
716 .client
717 .as_ref()
718 .unwrap_or_else(|| panic!("{id} must carry a client: block"));
719 assert!(!client.name.trim().is_empty(), "{id} client.name empty");
720 assert_eq!(client.category, category, "{id} category");
721 }
722 }
723
724 #[test]
725 fn example_check_schedule_yamls_parse_and_validate() {
726 let schedules = [
727 (
728 "check-bitlocker",
729 include_str!("../../../configs/schedules/check-bitlocker.yaml"),
730 ),
731 (
732 "check-av-signature",
733 include_str!("../../../configs/schedules/check-av-signature.yaml"),
734 ),
735 (
736 "check-cert-expiry",
737 include_str!("../../../configs/schedules/check-cert-expiry.yaml"),
738 ),
739 ];
740 for (name, yaml) in schedules {
741 let s: Schedule =
742 serde_yaml::from_str(yaml).unwrap_or_else(|e| panic!("{name} schedule parse: {e}"));
743 s.validate()
744 .unwrap_or_else(|e| panic!("{name} schedule validate: {e}"));
745 assert_eq!(s.job_id, name, "{name} schedule must reference its job");
746 }
747 }
748
749 #[test]
750 fn target_is_specified_requires_at_least_one_field() {
751 let empty = Target::default();
752 assert!(!empty.is_specified());
753
754 let with_all = Target {
755 all: true,
756 ..Target::default()
757 };
758 assert!(with_all.is_specified());
759
760 let with_groups = Target {
761 groups: vec!["canary".into()],
762 ..Target::default()
763 };
764 assert!(with_groups.is_specified());
765
766 let with_pcs = Target {
767 pcs: vec!["pc-01".into()],
768 ..Target::default()
769 };
770 assert!(with_pcs.is_specified());
771 }
772
773 #[test]
774 fn manifest_deserialises_minimal_yaml() {
775 // Matches jobs/echo-test.yaml. v0.18: no target/rollout/jitter
776 // — those live on the schedule / exec request now.
777 let yaml = r#"
778id: echo-test
779version: 0.0.1
780execute:
781 shell: powershell
782 script: "echo 'kanade'"
783 timeout: 30s
784"#;
785 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
786 assert_eq!(m.id, "echo-test");
787 assert_eq!(m.version, "0.0.1");
788 assert!(matches!(m.execute.shell, ExecuteShell::Powershell));
789 assert_eq!(
790 m.execute.script.as_deref().map(str::trim),
791 Some("echo 'kanade'")
792 );
793 assert!(m.execute.script_file.is_none());
794 assert!(m.execute.script_object.is_none());
795 assert_eq!(m.execute.timeout, "30s");
796 assert!(!m.require_approval);
797 m.validate()
798 .expect("inline-script manifest passes validation");
799 }
800
801 #[test]
802 fn manifest_parses_check_job_and_validates() {
803 // An operator-defined health check (#290): a `check:` hint +
804 // a PowerShell script that prints {status, detail}.
805 let yaml = r#"
806id: check-bitlocker
807version: 0.1.0
808execute:
809 shell: powershell
810 run_as: system
811 timeout: 15s
812 script: |
813 [pscustomobject]@{ status = 'ok'; detail = 'all volumes protected' } | ConvertTo-Json -Compress
814check:
815 name: bitlocker
816 troubleshoot: fix-bitlocker
817"#;
818 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
819 let check = m.check.as_ref().expect("check hint present");
820 assert_eq!(check.name, "bitlocker");
821 assert_eq!(check.troubleshoot.as_deref(), Some("fix-bitlocker"));
822 // Field names default to the conventional "status" / "detail".
823 assert_eq!(check.status_field, "status");
824 assert_eq!(check.detail_field, "detail");
825 assert!(m.inventory.is_none() && m.emit.is_none());
826 m.validate().expect("check-only manifest passes validation");
827 }
828
829 #[test]
830 fn manifest_check_defaults_and_custom_fields() {
831 // Minimal: only `name`; status/detail fields default.
832 let m: Manifest = serde_yaml::from_str(
833 r#"
834id: check-disk
835version: 0.1.0
836execute:
837 shell: powershell
838 script: "[pscustomobject]@{ status = 'ok' } | ConvertTo-Json -Compress"
839 timeout: 10s
840check:
841 name: disk_free
842"#,
843 )
844 .expect("parse");
845 let c = m.check.as_ref().unwrap();
846 assert_eq!(c.name, "disk_free");
847 assert_eq!(c.status_field, "status");
848 assert_eq!(c.detail_field, "detail");
849 assert!(c.troubleshoot.is_none());
850 m.validate().expect("validates");
851
852 // The operator can point status/detail at any field of their
853 // free-form inventory object.
854 let m2: Manifest = serde_yaml::from_str(
855 r#"
856id: check-custom
857version: 0.1.0
858execute:
859 shell: powershell
860 script: "echo x"
861 timeout: 10s
862check:
863 name: patch_level
864 status_field: compliance
865 detail_field: summary
866"#,
867 )
868 .expect("parse");
869 let c2 = m2.check.as_ref().unwrap();
870 assert_eq!(c2.status_field, "compliance");
871 assert_eq!(c2.detail_field, "summary");
872 }
873
874 #[test]
875 fn manifest_allows_check_composed_with_inventory() {
876 // `check:` + `inventory:` COMPOSE on the same stdout object:
877 // status/detail → Health tab, the rest → SPA projection +
878 // explode sub-tables. Must pass validation.
879 let yaml = r#"
880id: check-bitlocker-detailed
881version: 0.1.0
882execute:
883 shell: powershell
884 script: "echo x"
885 timeout: 10s
886check:
887 name: bitlocker
888inventory:
889 display:
890 - { field: status, label: Status }
891"#;
892 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
893 assert!(m.check.is_some() && m.inventory.is_some());
894 m.validate().expect("check + inventory compose");
895 }
896
897 #[test]
898 fn manifest_rejects_check_combined_with_emit() {
899 // `emit:` stdout is NDJSON (and omitted from the result), so
900 // it can't pair with `check:` (which needs a single JSON
901 // object on stdout).
902 let yaml = r#"
903id: bad-mix
904version: 0.1.0
905execute:
906 shell: powershell
907 script: "echo x"
908 timeout: 10s
909check:
910 name: bitlocker
911emit:
912 type: events
913"#;
914 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
915 let err = m.validate().expect_err("emit + check must fail");
916 assert!(err.contains("incompatible"), "err: {err}");
917 }
918
919 #[test]
920 fn manifest_rejects_emit_combined_with_inventory() {
921 // The other half of the emit-incompatibility condition.
922 let yaml = r#"
923id: bad-mix-2
924version: 0.1.0
925execute:
926 shell: powershell
927 script: "echo x"
928 timeout: 10s
929emit:
930 type: events
931inventory:
932 display:
933 - { field: status, label: Status }
934"#;
935 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
936 let err = m.validate().expect_err("emit + inventory must fail");
937 assert!(err.contains("incompatible"), "err: {err}");
938 }
939
940 #[test]
941 fn manifest_rejects_empty_check_field_names() {
942 // Empty name / status_field / detail_field are invisible
943 // runtime bugs (empty React key, agent reads the wrong field)
944 // — reject them even though serde supplies non-empty defaults.
945 let base = |inner: &str| {
946 format!(
947 "id: c\nversion: 0.1.0\nexecute:\n shell: powershell\n script: \"echo x\"\n timeout: 10s\ncheck:\n{inner}"
948 )
949 };
950 for inner in [
951 " name: \"\"\n",
952 " name: ok\n status_field: \"\"\n",
953 " name: ok\n detail_field: \" \"\n",
954 // present-but-blank troubleshoot → broken remediation id.
955 " name: ok\n troubleshoot: \" \"\n",
956 ] {
957 let m: Manifest = serde_yaml::from_str(&base(inner)).expect("parse");
958 let err = m.validate().expect_err("empty field must fail");
959 assert!(err.contains("must not be empty"), "err: {err}");
960 }
961 }
962
963 #[test]
964 fn manifest_client_absent_by_default() {
965 // A plain operator job (the overwhelming majority) carries no
966 // `client:` block, so it never surfaces in the end-user
967 // catalog.
968 let yaml = r#"
969id: echo-test
970version: 0.0.1
971execute:
972 shell: powershell
973 script: "echo 'kanade'"
974 timeout: 30s
975"#;
976 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
977 assert!(m.client.is_none());
978 m.validate().expect("operator-only job validates");
979 }
980
981 #[test]
982 fn manifest_client_parses_and_validates() {
983 // The Client App "困ったとき" remediation job shape: a
984 // user-invokable troubleshoot job with the end-user fields the
985 // KLP `jobs.list` wire needs, grouped under `client:`.
986 let yaml = r#"
987id: fix-teams-cache
988version: 1.0.0
989execute:
990 shell: powershell
991 script: "echo clearing"
992 timeout: 60s
993client:
994 name: "Teams のキャッシュをクリア"
995 description: "Teams が重いときに試してください"
996 category: troubleshoot
997 icon: brush-cleaning
998"#;
999 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
1000 let c = m.client.as_ref().expect("client block present");
1001 assert_eq!(c.name, "Teams のキャッシュをクリア");
1002 assert_eq!(
1003 c.description.as_deref(),
1004 Some("Teams が重いときに試してください")
1005 );
1006 assert_eq!(c.category, JobCategory::Troubleshoot);
1007 assert_eq!(c.icon.as_deref(), Some("brush-cleaning"));
1008 m.validate().expect("user-invokable job validates");
1009 }
1010
1011 #[test]
1012 fn manifest_client_minimal_only_name_and_category() {
1013 // description + icon are optional; name + category are the
1014 // serde-required minimum.
1015 let yaml = r#"
1016id: install-slack
1017version: 1.0.0
1018execute:
1019 shell: powershell
1020 script: "echo install"
1021 timeout: 600s
1022client:
1023 name: Slack
1024 category: catalog
1025"#;
1026 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
1027 let c = m.client.as_ref().expect("client present");
1028 assert_eq!(c.category, JobCategory::Catalog);
1029 assert!(c.description.is_none() && c.icon.is_none());
1030 m.validate().expect("minimal client validates");
1031 }
1032
1033 #[test]
1034 fn manifest_client_rejects_blank_name() {
1035 // serde guarantees `name`/`category` are present; the one gap
1036 // is a present-but-blank name → empty catalog row title.
1037 let yaml = r#"
1038id: j
1039version: 1.0.0
1040execute:
1041 shell: powershell
1042 script: "echo x"
1043 timeout: 30s
1044client:
1045 name: " "
1046 category: catalog
1047"#;
1048 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
1049 let err = m.validate().expect_err("blank name must fail");
1050 assert!(err.contains("client.name"), "err: {err}");
1051 }
1052
1053 #[test]
1054 fn manifest_client_rejects_blank_optional_fields() {
1055 // description / icon are optional, but a present-but-blank
1056 // value is a bug (empty subtitle / dangling icon name) — reject
1057 // it, mirroring the check: block's troubleshoot guard.
1058 for (field, line) in [
1059 ("client.description", " description: \" \"\n"),
1060 ("client.icon", " icon: \"\"\n"),
1061 ] {
1062 let yaml = format!(
1063 "id: j\nversion: 1.0.0\nexecute:\n shell: powershell\n script: \"echo x\"\n timeout: 30s\nclient:\n name: A\n category: catalog\n{line}"
1064 );
1065 let m: Manifest = serde_yaml::from_str(&yaml).expect("parse");
1066 let err = m.validate().expect_err("blank optional field must fail");
1067 assert!(err.contains(field), "expected {field} in err: {err}");
1068 }
1069 }
1070
1071 #[test]
1072 fn manifest_client_requires_category_at_parse() {
1073 // A `client:` block missing `category` is a hard parse error
1074 // (serde required field) — no manual validate() needed.
1075 let yaml = r#"
1076id: j
1077version: 1.0.0
1078execute:
1079 shell: powershell
1080 script: "echo x"
1081 timeout: 30s
1082client:
1083 name: "A job"
1084"#;
1085 let r: Result<Manifest, _> = serde_yaml::from_str(yaml);
1086 assert!(
1087 r.is_err(),
1088 "missing category must be a parse error, got {r:?}"
1089 );
1090 }
1091
1092 #[test]
1093 fn manifest_client_rejects_unknown_field() {
1094 // #492: the strict create boundary catches a fat-fingered
1095 // `displayname:` (with its path) instead of silently
1096 // dropping it; the tolerant read path accepts it.
1097 let yaml = r#"
1098id: j
1099version: 1.0.0
1100execute:
1101 shell: powershell
1102 script: "echo x"
1103 timeout: 30s
1104client:
1105 name: "A job"
1106 category: catalog
1107 displayname: oops
1108"#;
1109 let r = crate::strict::from_yaml_str::<Manifest>(yaml);
1110 let err = r.expect_err("unknown client field must be rejected at the write boundary");
1111 // serde_ignored renders the Option layer as `?`:
1112 // `client.?.displayname`. Assert on the leaf key.
1113 assert!(err.contains("displayname"), "{err}");
1114 // The READ path tolerates the same payload (gradual-upgrade
1115 // contract: an old agent must accept a newer writer's field).
1116 let m: Manifest = serde_yaml::from_str(yaml).expect("tolerant read");
1117 assert_eq!(m.client.as_ref().map(|c| c.name.as_str()), Some("A job"));
1118 }
1119
1120 fn execute_with(
1121 script: Option<&str>,
1122 script_file: Option<&str>,
1123 script_object: Option<&str>,
1124 ) -> Execute {
1125 Execute {
1126 shell: ExecuteShell::Powershell,
1127 script: script.map(str::to_owned),
1128 script_file: script_file.map(str::to_owned),
1129 script_object: script_object.map(str::to_owned),
1130 timeout: "30s".into(),
1131 run_as: RunAs::default(),
1132 cwd: None,
1133 }
1134 }
1135
1136 #[test]
1137 fn validate_accepts_inline_script() {
1138 let e = execute_with(Some("echo hi"), None, None);
1139 assert!(e.validate_script_source().is_ok());
1140 }
1141
1142 #[test]
1143 fn validate_accepts_script_file_alone() {
1144 let e = execute_with(None, Some("scripts/cleanup.ps1"), None);
1145 assert!(e.validate_script_source().is_ok());
1146 }
1147
1148 #[test]
1149 fn validate_accepts_script_object_alone() {
1150 let e = execute_with(None, None, Some("cleanup/1.0.0"));
1151 assert!(e.validate_script_source().is_ok());
1152 }
1153
1154 #[test]
1155 fn validate_treats_empty_inline_script_as_unset() {
1156 // `script: ""` + `script_object` set is the natural shape
1157 // when an operator comments out the YAML block-scalar body
1158 // but leaves the key. Should pass.
1159 let e = execute_with(Some(""), None, Some("cleanup/1.0.0"));
1160 assert!(e.validate_script_source().is_ok());
1161 }
1162
1163 #[test]
1164 fn validate_rejects_zero_sources() {
1165 let e = execute_with(None, None, None);
1166 let err = e.validate_script_source().unwrap_err();
1167 assert!(err.contains("must be set"), "got: {err}");
1168 }
1169
1170 #[test]
1171 fn validate_rejects_empty_inline_only() {
1172 let e = execute_with(Some(""), None, None);
1173 let err = e.validate_script_source().unwrap_err();
1174 assert!(err.contains("must be set"), "got: {err}");
1175 }
1176
1177 #[test]
1178 fn validate_rejects_inline_plus_file() {
1179 let e = execute_with(Some("echo hi"), Some("scripts/cleanup.ps1"), None);
1180 let err = e.validate_script_source().unwrap_err();
1181 assert!(err.contains("only one of"), "got: {err}");
1182 }
1183
1184 #[test]
1185 fn validate_rejects_inline_plus_object() {
1186 let e = execute_with(Some("echo hi"), None, Some("cleanup/1.0.0"));
1187 let err = e.validate_script_source().unwrap_err();
1188 assert!(err.contains("only one of"), "got: {err}");
1189 }
1190
1191 #[test]
1192 fn validate_rejects_file_plus_object() {
1193 let e = execute_with(None, Some("scripts/cleanup.ps1"), Some("cleanup/1.0.0"));
1194 let err = e.validate_script_source().unwrap_err();
1195 assert!(err.contains("only one of"), "got: {err}");
1196 }
1197
1198 #[test]
1199 fn validate_rejects_all_three() {
1200 let e = execute_with(
1201 Some("echo hi"),
1202 Some("scripts/cleanup.ps1"),
1203 Some("cleanup/1.0.0"),
1204 );
1205 let err = e.validate_script_source().unwrap_err();
1206 assert!(err.contains("only one of"), "got: {err}");
1207 }
1208
1209 #[test]
1210 fn manifest_deserialises_script_object_yaml() {
1211 // SPEC §2.4.1 example shape with the Object Store
1212 // reference picked over inline.
1213 let yaml = r#"
1214id: cleanup-disk-temp
1215version: 1.0.1
1216execute:
1217 shell: powershell
1218 script_object: cleanup-disk-temp/1.0.1
1219 timeout: 600s
1220"#;
1221 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
1222 assert_eq!(
1223 m.execute.script_object.as_deref(),
1224 Some("cleanup-disk-temp/1.0.1")
1225 );
1226 assert!(m.execute.script.is_none());
1227 m.validate()
1228 .expect("script_object-only manifest passes validation");
1229 }
1230
1231 #[test]
1232 fn manifest_rejects_typo_in_script_field_name() {
1233 // #492: the strict create boundary catches `script_objectt`
1234 // and similar fat-fingers (with the full path) instead of
1235 // letting them silently fall through to "all three unset".
1236 let yaml = r#"
1237id: typo
1238version: 1.0.0
1239execute:
1240 shell: powershell
1241 script_objectt: oops
1242 timeout: 30s
1243"#;
1244 let err = crate::strict::from_yaml_str::<Manifest>(yaml)
1245 .expect_err("typo'd execute field must be rejected at the write boundary");
1246 assert!(err.contains("execute.script_objectt"), "{err}");
1247 }
1248
1249 #[test]
1250 fn schedule_carries_target_and_rollout() {
1251 let yaml = r#"
1252id: hourly-cleanup-canary
1253when:
1254 per_pc: { every: 1h }
1255job_id: cleanup
1256enabled: true
1257target:
1258 groups: [canary, wave1]
1259jitter: 30s
1260rollout:
1261 strategy: wave
1262 waves:
1263 - { group: canary, delay: 0s }
1264 - { group: wave1, delay: 5s }
1265"#;
1266 let s: Schedule = serde_yaml::from_str(yaml).expect("parse");
1267 assert_eq!(s.id, "hourly-cleanup-canary");
1268 assert_eq!(s.job_id, "cleanup");
1269 assert_eq!(s.plan.target.groups, vec!["canary", "wave1"]);
1270 assert_eq!(s.plan.jitter.as_deref(), Some("30s"));
1271 let rollout = s.plan.rollout.expect("rollout present");
1272 assert_eq!(rollout.waves.len(), 2);
1273 assert_eq!(rollout.waves[0].group, "canary");
1274 assert_eq!(rollout.waves[1].delay, "5s");
1275 assert_eq!(rollout.strategy, RolloutStrategy::Wave);
1276 }
1277
1278 #[test]
1279 fn schedule_minimal_target_all() {
1280 let yaml = r#"
1281id: kitting
1282when:
1283 per_pc: once
1284enabled: true
1285job_id: scheduled-echo
1286target: { all: true }
1287"#;
1288 let s: Schedule = serde_yaml::from_str(yaml).expect("parse");
1289 assert_eq!(s.id, "kitting");
1290 assert_eq!(s.when, When::PerPc(PerPolicy::Once(OnceLiteral::Once)));
1291 assert!(s.enabled);
1292 assert_eq!(s.job_id, "scheduled-echo");
1293 assert!(s.plan.target.all);
1294 assert!(s.plan.rollout.is_none());
1295 assert!(s.plan.jitter.is_none());
1296 assert!(s.active.is_empty());
1297 }
1298
1299 #[test]
1300 fn schedule_enabled_defaults_to_true() {
1301 let yaml = r#"
1302id: x
1303when:
1304 per_pc: once
1305job_id: y
1306target: { all: true }
1307"#;
1308 let s: Schedule = serde_yaml::from_str(yaml).expect("parse");
1309 assert!(s.enabled);
1310 }
1311
1312 // ---- `when` parsing (#418 Phase 1) ----
1313
1314 fn schedule_yaml_with(when_block: &str) -> String {
1315 format!(
1316 r#"
1317id: x
1318when:
1319{when_block}
1320job_id: y
1321target: {{ all: true }}
1322"#
1323 )
1324 }
1325
1326 #[test]
1327 fn when_per_pc_every_parses_unquoted_humantime() {
1328 // `6h` is digit-led but non-numeric → YAML string, same as
1329 // the old `cooldown: 6h` convention. No quotes needed.
1330 let s: Schedule =
1331 serde_yaml::from_str(&schedule_yaml_with(" per_pc: { every: 6h }")).expect("parse");
1332 assert_eq!(
1333 s.when,
1334 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() }))
1335 );
1336 }
1337
1338 #[test]
1339 fn when_per_target_every_parses() {
1340 let s: Schedule = serde_yaml::from_str(&schedule_yaml_with(" per_target: { every: 24h }"))
1341 .expect("parse");
1342 assert_eq!(
1343 s.when,
1344 When::PerTarget(PerPolicy::Every(EverySpec {
1345 every: "24h".into()
1346 }))
1347 );
1348 }
1349
1350 #[test]
1351 fn when_per_target_once_parses() {
1352 // Falls out of the shared PerPolicy shape and decide_fire
1353 // already implements it ("any one pc succeeds → skip the
1354 // target forever"), so it is allowed, not rejected.
1355 let s: Schedule =
1356 serde_yaml::from_str(&schedule_yaml_with(" per_target: once")).expect("parse");
1357 assert_eq!(s.when, When::PerTarget(PerPolicy::Once(OnceLiteral::Once)));
1358 }
1359
1360 #[test]
1361 fn when_calendar_time_parses() {
1362 let s: Schedule = serde_yaml::from_str(&schedule_yaml_with(
1363 " calendar:\n at: \"09:00\"\n days: [mon-fri]",
1364 ))
1365 .expect("parse");
1366 match &s.when {
1367 When::Calendar(c) => {
1368 assert_eq!(c.at, "09:00");
1369 assert_eq!(c.days, vec!["mon-fri"]);
1370 }
1371 other => panic!("expected calendar, got {other:?}"),
1372 }
1373 }
1374
1375 #[test]
1376 fn when_calendar_days_default_empty() {
1377 let s: Schedule =
1378 serde_yaml::from_str(&schedule_yaml_with(" calendar:\n at: \"09:00\""))
1379 .expect("parse");
1380 match &s.when {
1381 When::Calendar(c) => assert!(c.days.is_empty(), "days defaults to empty (= daily)"),
1382 other => panic!("expected calendar, got {other:?}"),
1383 }
1384 }
1385
1386 #[test]
1387 fn when_calendar_datetime_parses_all_separators() {
1388 // one-shot: date+time in hyphen / ISO-T / slash forms
1389 for at in ["2026-06-10 09:00", "2026-06-10T09:00", "2026/06/10 09:00"] {
1390 let block = format!(" calendar:\n at: \"{at}\"");
1391 let s: Schedule = serde_yaml::from_str(&schedule_yaml_with(&block))
1392 .unwrap_or_else(|e| panic!("parse '{at}': {e}"));
1393 match &s.when {
1394 When::Calendar(c) => {
1395 use chrono::Datelike;
1396 let p = c.parse_at().expect("parse_at");
1397 let d = p.date.expect("datetime at carries a date");
1398 assert_eq!((d.year(), d.month(), d.day()), (2026, 6, 10), "for '{at}'");
1399 }
1400 other => panic!("expected calendar, got {other:?}"),
1401 }
1402 }
1403 }
1404
1405 #[test]
1406 fn when_rejects_bad_once_keyword() {
1407 // `onec` must be a parse error, not a silently-absorbed
1408 // string (OnceLiteral is a single-variant enum for exactly
1409 // this reason).
1410 let r: Result<Schedule, _> = serde_yaml::from_str(&schedule_yaml_with(" per_pc: onec"));
1411 assert!(r.is_err(), "expected parse error, got {r:?}");
1412 }
1413
1414 #[test]
1415 fn when_rejects_unknown_key_in_every() {
1416 // `{ evry: 6h }` still fails on the tolerant read path: the
1417 // required `every` key is missing, so no PerPolicy variant
1418 // matches (#492 removed deny_unknown_fields, but required
1419 // keys keep the untagged disambiguation honest).
1420 let r: Result<Schedule, _> =
1421 serde_yaml::from_str(&schedule_yaml_with(" per_pc: { evry: 6h }"));
1422 assert!(r.is_err(), "expected parse error, got {r:?}");
1423 }
1424
1425 #[test]
1426 fn when_rejects_unknown_variant() {
1427 let r: Result<Schedule, _> =
1428 serde_yaml::from_str(&schedule_yaml_with(" per_galaxy: once"));
1429 assert!(r.is_err(), "expected parse error, got {r:?}");
1430 }
1431
1432 #[test]
1433 fn when_rejects_old_top_level_cron_field() {
1434 // Pre-#418 shape: top-level `cron:` + no `when:`. Must fail
1435 // loudly (missing `when`), which is what turns stale KV
1436 // blobs into warn-skips after the upgrade.
1437 let yaml = r#"
1438id: x
1439cron: "* * * * * *"
1440job_id: y
1441target: { all: true }
1442"#;
1443 let r: Result<Schedule, _> = serde_yaml::from_str(yaml);
1444 assert!(r.is_err(), "expected parse error, got {r:?}");
1445 }
1446
1447 #[test]
1448 fn when_rejects_retired_cron_escape_hatch() {
1449 // #418 Phase 2 retired `when: { cron: "..." }`. A raw cron
1450 // is now an unknown variant → parse error (operators use the
1451 // calendar form instead).
1452 let r: Result<Schedule, _> =
1453 serde_yaml::from_str(&schedule_yaml_with(" cron: \"0 0 9 * * mon-fri\""));
1454 assert!(
1455 r.is_err(),
1456 "expected parse error for retired cron, got {r:?}"
1457 );
1458 }
1459
1460 #[test]
1461 fn when_round_trips_json_and_yaml() {
1462 // Round-trip through the full Schedule: that is the wire
1463 // unit for both stores (JSON catalog KV + YAML mirror), and
1464 // it exercises the singleton_map field attribute that keeps
1465 // serde_yaml on the map shape instead of `!per_pc` tags.
1466 for when in [
1467 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
1468 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
1469 When::PerTarget(PerPolicy::Once(OnceLiteral::Once)),
1470 When::PerTarget(PerPolicy::Every(EverySpec {
1471 every: "24h".into(),
1472 })),
1473 calendar("09:00", &["mon-fri"]),
1474 calendar("2026-06-10 09:00", &[]),
1475 When::On(vec![OnTrigger::Startup]),
1476 When::On(vec![OnTrigger::Startup, OnTrigger::Logon]),
1477 When::On(vec![OnTrigger::Lock, OnTrigger::Unlock]),
1478 ] {
1479 // Event triggers are agent-only; the rest validate on backend.
1480 let runs_on = if matches!(when, When::On(_)) {
1481 RunsOn::Agent
1482 } else {
1483 RunsOn::Backend
1484 };
1485 let s = schedule_with(when.clone(), runs_on);
1486
1487 let json = serde_json::to_string(&s).expect("json serialise");
1488 let back: Schedule = serde_json::from_str(&json).expect("json deserialise");
1489 assert_eq!(back.when, when, "json round-trip for {when}");
1490
1491 let yaml = serde_yaml::to_string(&s).expect("yaml serialise");
1492 assert!(
1493 !yaml.contains('!'),
1494 "yaml must use the map shape, not tags: {yaml}"
1495 );
1496 let back: Schedule = serde_yaml::from_str(&yaml).expect("yaml deserialise");
1497 assert_eq!(back.when, when, "yaml round-trip for {when}");
1498 }
1499 }
1500
1501 #[test]
1502 fn when_once_serialises_as_bare_keyword() {
1503 // The wire shape operators see in the YAML mirror must stay
1504 // the ergonomic `per_pc: once`, not a one-variant map.
1505 let json = serde_json::to_value(When::PerPc(PerPolicy::Once(OnceLiteral::Once)))
1506 .expect("serialise");
1507 assert_eq!(json, serde_json::json!({ "per_pc": "once" }));
1508 }
1509
1510 #[test]
1511 fn when_displays_operator_summary() {
1512 for (when, expected) in [
1513 (
1514 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
1515 "per_pc once",
1516 ),
1517 (
1518 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
1519 "per_pc every 6h",
1520 ),
1521 (
1522 When::PerTarget(PerPolicy::Every(EverySpec {
1523 every: "24h".into(),
1524 })),
1525 "per_target every 24h",
1526 ),
1527 (calendar("09:00", &["mon-fri"]), "at 09:00 [mon-fri]"),
1528 (calendar("2026-06-10 09:00", &[]), "at 2026-06-10 09:00"),
1529 (When::On(vec![OnTrigger::Startup]), "on [startup]"),
1530 (
1531 When::On(vec![OnTrigger::Startup, OnTrigger::Logon]),
1532 "on [startup,logon]",
1533 ),
1534 (
1535 When::On(vec![OnTrigger::Lock, OnTrigger::Unlock]),
1536 "on [lock,unlock]",
1537 ),
1538 ] {
1539 assert_eq!(when.to_string(), expected);
1540 }
1541 }
1542
1543 // ---- lowering (#418: when → engine vocabulary) ----
1544
1545 fn schedule_with(when: When, runs_on: RunsOn) -> Schedule {
1546 Schedule {
1547 id: "x".into(),
1548 when,
1549 job_id: "y".into(),
1550 plan: FanoutPlan::default(),
1551 active: Active::default(),
1552 constraints: Constraints::default(),
1553 on_failure: OnFailure::default(),
1554 tz: ScheduleTz::default(),
1555 starting_deadline: None,
1556 runs_on,
1557 enabled: true,
1558 }
1559 }
1560
1561 fn calendar(at: &str, days: &[&str]) -> When {
1562 When::Calendar(CalendarSpec {
1563 at: at.into(),
1564 days: days.iter().map(|d| (*d).to_string()).collect(),
1565 })
1566 }
1567
1568 #[test]
1569 fn next_calendar_fire_returns_next_utc_occurrence() {
1570 use chrono::TimeZone;
1571 // Daily 09:00, evaluated in UTC. From 08:00 the same day, the
1572 // next strict occurrence is 09:00 that day.
1573 let mut s = schedule_with(calendar("09:00", &[]), RunsOn::Backend);
1574 s.tz = ScheduleTz::Utc;
1575 let now = chrono::Utc.with_ymd_and_hms(2026, 6, 9, 8, 0, 0).unwrap();
1576 let next = s.next_calendar_fire(now).expect("calendar has a next fire");
1577 assert_eq!(
1578 next,
1579 chrono::Utc.with_ymd_and_hms(2026, 6, 9, 9, 0, 0).unwrap()
1580 );
1581 }
1582
1583 #[test]
1584 fn next_calendar_fire_is_strictly_after_now() {
1585 use chrono::TimeZone;
1586 // Standing exactly on a fire instant must preview the *next*
1587 // one (inclusive = false), not the one firing right now.
1588 let mut s = schedule_with(calendar("09:00", &[]), RunsOn::Backend);
1589 s.tz = ScheduleTz::Utc;
1590 let on_fire = chrono::Utc.with_ymd_and_hms(2026, 6, 9, 9, 0, 0).unwrap();
1591 let next = s
1592 .next_calendar_fire(on_fire)
1593 .expect("calendar has a next fire");
1594 assert_eq!(
1595 next,
1596 chrono::Utc.with_ymd_and_hms(2026, 6, 10, 9, 0, 0).unwrap()
1597 );
1598 }
1599
1600 #[test]
1601 fn next_calendar_fire_none_for_reconcile_shapes() {
1602 // `per_pc` / `per_target` lower to the every-minute poll cron —
1603 // no discrete upcoming event to preview, so `None`.
1604 let now = chrono::Utc::now();
1605 for when in [
1606 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
1607 When::PerTarget(PerPolicy::Once(OnceLiteral::Once)),
1608 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
1609 When::PerTarget(PerPolicy::Every(EverySpec {
1610 every: "24h".into(),
1611 })),
1612 ] {
1613 let s = schedule_with(when, RunsOn::Backend);
1614 assert!(
1615 s.next_calendar_fire(now).is_none(),
1616 "reconcile shapes have no calendar fire",
1617 );
1618 }
1619 }
1620
1621 // ---- preview_fires (#418 dry-run / preview) ----
1622
1623 fn cal_utc(at: &str, days: &[&str]) -> Schedule {
1624 let mut s = schedule_with(calendar(at, days), RunsOn::Backend);
1625 s.tz = ScheduleTz::Utc; // host-independent assertions
1626 s
1627 }
1628
1629 #[test]
1630 fn preview_lists_next_calendar_occurrences() {
1631 use chrono::TimeZone;
1632 // Weekday 09:00, from Wed 2026-06-10 00:00 UTC: the next five
1633 // fires skip the weekend (Sat 13 / Sun 14).
1634 let s = cal_utc("09:00", &["mon-fri"]);
1635 let now = chrono::Utc.with_ymd_and_hms(2026, 6, 10, 0, 0, 0).unwrap();
1636 let got = s.preview_fires(now, 5);
1637 let want: Vec<_> = [
1638 (2026, 6, 10), // Wed
1639 (2026, 6, 11), // Thu
1640 (2026, 6, 12), // Fri
1641 (2026, 6, 15), // Mon (skips Sat 13 / Sun 14)
1642 (2026, 6, 16), // Tue
1643 ]
1644 .iter()
1645 .map(|(y, m, d)| chrono::Utc.with_ymd_and_hms(*y, *m, *d, 9, 0, 0).unwrap())
1646 .collect();
1647 assert_eq!(got, want);
1648 }
1649
1650 #[test]
1651 fn preview_handles_nth_and_last_weekday() {
1652 use chrono::TimeZone;
1653 let now = chrono::Utc.with_ymd_and_hms(2026, 6, 1, 0, 0, 0).unwrap();
1654 // 2nd Tuesday (Patch Tuesday): Jun 9, Jul 14 2026.
1655 let nth = cal_utc("09:00", &["tue#2"]).preview_fires(now, 2);
1656 assert_eq!(
1657 nth,
1658 vec![
1659 chrono::Utc.with_ymd_and_hms(2026, 6, 9, 9, 0, 0).unwrap(),
1660 chrono::Utc.with_ymd_and_hms(2026, 7, 14, 9, 0, 0).unwrap(),
1661 ]
1662 );
1663 // Last Friday of the month: Jun 26, Jul 31 2026.
1664 let last = cal_utc("22:00", &["friL"]).preview_fires(now, 2);
1665 assert_eq!(
1666 last,
1667 vec![
1668 chrono::Utc.with_ymd_and_hms(2026, 6, 26, 22, 0, 0).unwrap(),
1669 chrono::Utc.with_ymd_and_hms(2026, 7, 31, 22, 0, 0).unwrap(),
1670 ]
1671 );
1672 }
1673
1674 #[test]
1675 fn preview_is_empty_for_reconcile_and_zero_count() {
1676 let now = chrono::Utc::now();
1677 // reconcile shapes have no discrete fire times
1678 let recon = schedule_with(
1679 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
1680 RunsOn::Backend,
1681 );
1682 assert!(recon.preview_fires(now, 5).is_empty());
1683 // count == 0 yields nothing even for a calendar
1684 assert!(cal_utc("09:00", &[]).preview_fires(now, 0).is_empty());
1685 }
1686
1687 #[test]
1688 fn preview_skips_outside_active_window() {
1689 use chrono::TimeZone;
1690 // Daily 09:00, active only [2026-06-15, 2026-06-17). Occurrences
1691 // before `from` are skipped; `until` is exclusive, so 06-17's
1692 // fire is out — leaving exactly the 15th and 16th.
1693 let mut s = cal_utc("09:00", &[]);
1694 s.active = Active {
1695 from: Some("2026-06-15".into()),
1696 until: Some("2026-06-17".into()),
1697 };
1698 let now = chrono::Utc.with_ymd_and_hms(2026, 6, 10, 0, 0, 0).unwrap();
1699 let got = s.preview_fires(now, 5);
1700 assert_eq!(
1701 got,
1702 vec![
1703 chrono::Utc.with_ymd_and_hms(2026, 6, 15, 9, 0, 0).unwrap(),
1704 chrono::Utc.with_ymd_and_hms(2026, 6, 16, 9, 0, 0).unwrap(),
1705 ]
1706 );
1707 }
1708
1709 #[test]
1710 fn preview_empty_when_calendar_time_outside_window() {
1711 use chrono::TimeZone;
1712 // Fires at 09:00 but the maintenance window is overnight — it can
1713 // never run, so the preview is empty (matches
1714 // `calendar_outside_window`), and the scan still terminates.
1715 let mut s = cal_utc("09:00", &[]);
1716 s.constraints = Constraints {
1717 window: Some("22:00-05:00".into()),
1718 ..Constraints::default()
1719 };
1720 let now = chrono::Utc.with_ymd_and_hms(2026, 6, 10, 0, 0, 0).unwrap();
1721 assert!(s.preview_fires(now, 5).is_empty());
1722 // Every candidate tick is rejected, so this also exercises the
1723 // SCAN_CAP bound: a large `count` must still terminate (and
1724 // return empty) rather than spin (claude #578 review).
1725 assert!(s.preview_fires(now, 50).is_empty());
1726 }
1727
1728 #[test]
1729 fn preview_past_one_shot_is_empty() {
1730 use chrono::TimeZone;
1731 // A dated one-shot whose instant has passed never fires again.
1732 let s = cal_utc("2026-06-10 09:00", &[]);
1733 let now = chrono::Utc.with_ymd_and_hms(2026, 6, 11, 0, 0, 0).unwrap();
1734 assert!(s.preview_fires(now, 5).is_empty());
1735 // …but from before it, the single future fire shows up.
1736 let before = chrono::Utc.with_ymd_and_hms(2026, 6, 1, 0, 0, 0).unwrap();
1737 assert_eq!(
1738 s.preview_fires(before, 5),
1739 vec![chrono::Utc.with_ymd_and_hms(2026, 6, 10, 9, 0, 0).unwrap()]
1740 );
1741 }
1742
1743 #[test]
1744 fn lowering_matches_the_418_table() {
1745 let cases = [
1746 (
1747 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
1748 (POLL_CRON, ExecMode::OncePerPc, None),
1749 ),
1750 (
1751 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
1752 (POLL_CRON, ExecMode::OncePerPc, Some("6h")),
1753 ),
1754 (
1755 When::PerTarget(PerPolicy::Once(OnceLiteral::Once)),
1756 (POLL_CRON, ExecMode::OncePerTarget, None),
1757 ),
1758 (
1759 When::PerTarget(PerPolicy::Every(EverySpec {
1760 every: "24h".into(),
1761 })),
1762 (POLL_CRON, ExecMode::OncePerTarget, Some("24h")),
1763 ),
1764 // calendar repeating → 6-field cron
1765 (
1766 calendar("09:00", &["mon-fri"]),
1767 ("0 0 9 * * mon-fri", ExecMode::EveryTick, None),
1768 ),
1769 // calendar daily (no days) → DOW *
1770 (
1771 calendar("18:30", &[]),
1772 ("0 30 18 * * *", ExecMode::EveryTick, None),
1773 ),
1774 // calendar one-shot → 7-field year cron
1775 (
1776 calendar("2026-06-10 09:00", &[]),
1777 ("0 0 9 10 6 * 2026", ExecMode::EveryTick, None),
1778 ),
1779 ];
1780 for (when, (cron, mode, cooldown)) in cases {
1781 let l = schedule_with(when.clone(), RunsOn::Backend).lowered();
1782 assert_eq!(l.cron, cron, "cron for {when}");
1783 assert_eq!(l.mode, mode, "mode for {when}");
1784 assert_eq!(l.cooldown.as_deref(), cooldown, "cooldown for {when}");
1785 }
1786 }
1787
1788 #[test]
1789 fn lowered_carries_schedule_tz() {
1790 for (tz, want) in [
1791 (ScheduleTz::Local, ScheduleTz::Local),
1792 (ScheduleTz::Utc, ScheduleTz::Utc),
1793 ] {
1794 let mut s = schedule_with(calendar("09:00", &["mon-fri"]), RunsOn::Backend);
1795 s.tz = tz;
1796 assert_eq!(s.lowered().tz, want, "calendar carries tz");
1797 // reconcile shapes carry tz too (for the active-window check)
1798 let mut s = schedule_with(
1799 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
1800 RunsOn::Backend,
1801 );
1802 s.tz = tz;
1803 assert_eq!(s.lowered().tz, want, "reconcile carries tz");
1804 }
1805 }
1806
1807 #[test]
1808 fn poll_cron_is_accepted_by_the_engine_parser() {
1809 // POLL_CRON is system-generated — if the engine's parser
1810 // ever rejected it every reconcile schedule would die at
1811 // register time. Validate it with the same croner config
1812 // (Seconds::Required, dom_and_dow, year optional).
1813 croner::parser::CronParser::builder()
1814 .seconds(croner::parser::Seconds::Required)
1815 .dom_and_dow(true)
1816 .build()
1817 .parse(POLL_CRON)
1818 .expect("POLL_CRON must parse");
1819 }
1820
1821 // ---- Schedule::validate() (#418 decision F) ----
1822
1823 #[test]
1824 fn validate_accepts_reconcile_shapes() {
1825 for when in [
1826 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
1827 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
1828 When::PerTarget(PerPolicy::Once(OnceLiteral::Once)),
1829 When::PerTarget(PerPolicy::Every(EverySpec {
1830 every: "24h".into(),
1831 })),
1832 ] {
1833 schedule_with(when.clone(), RunsOn::Backend)
1834 .validate()
1835 .unwrap_or_else(|e| panic!("{when} should validate: {e}"));
1836 }
1837 }
1838
1839 #[test]
1840 fn validate_accepts_per_pc_on_agent() {
1841 schedule_with(
1842 When::PerPc(PerPolicy::Every(EverySpec { every: "1h".into() })),
1843 RunsOn::Agent,
1844 )
1845 .validate()
1846 .expect("per_pc + agent is the offline-inventory shape");
1847 }
1848
1849 // ---- #418 event triggers (when: { on }) ----
1850
1851 #[test]
1852 fn validate_accepts_event_on_agent() {
1853 for triggers in [
1854 vec![OnTrigger::Startup],
1855 vec![OnTrigger::Logon],
1856 vec![OnTrigger::Lock],
1857 vec![OnTrigger::Unlock],
1858 vec![
1859 OnTrigger::Startup,
1860 OnTrigger::Logon,
1861 OnTrigger::Lock,
1862 OnTrigger::Unlock,
1863 ],
1864 ] {
1865 schedule_with(When::On(triggers), RunsOn::Agent)
1866 .validate()
1867 .expect("when.on is valid on runs_on: agent");
1868 }
1869 }
1870
1871 #[test]
1872 fn validate_rejects_event_on_backend() {
1873 let err = schedule_with(When::On(vec![OnTrigger::Startup]), RunsOn::Backend)
1874 .validate()
1875 .unwrap_err();
1876 assert!(err.contains("when.on"), "got: {err}");
1877 assert!(err.contains("runs_on: agent"), "got: {err}");
1878 }
1879
1880 #[test]
1881 fn validate_rejects_empty_event_list() {
1882 let err = schedule_with(When::On(vec![]), RunsOn::Agent)
1883 .validate()
1884 .unwrap_err();
1885 assert!(err.contains("when.on"), "got: {err}");
1886 assert!(err.contains("at least one"), "got: {err}");
1887 }
1888
1889 #[test]
1890 fn event_schedule_lowers_to_event_mode_and_is_event() {
1891 let s = schedule_with(When::On(vec![OnTrigger::Startup]), RunsOn::Agent);
1892 assert!(s.is_event());
1893 assert_eq!(s.lowered().mode, ExecMode::Event);
1894 assert_eq!(s.event_triggers(), &[OnTrigger::Startup]);
1895 // non-event schedules report no triggers.
1896 let cal = schedule_with(calendar("09:00", &[]), RunsOn::Backend);
1897 assert!(!cal.is_event());
1898 assert!(cal.event_triggers().is_empty());
1899 }
1900
1901 #[test]
1902 fn validate_rejects_per_target_on_agent() {
1903 let err = schedule_with(
1904 When::PerTarget(PerPolicy::Every(EverySpec {
1905 every: "24h".into(),
1906 })),
1907 RunsOn::Agent,
1908 )
1909 .validate()
1910 .unwrap_err();
1911 assert!(err.contains("per_target"), "got: {err}");
1912 assert!(err.contains("runs_on: agent"), "got: {err}");
1913
1914 // per_target: once is also backend-only.
1915 let err = schedule_with(
1916 When::PerTarget(PerPolicy::Once(OnceLiteral::Once)),
1917 RunsOn::Agent,
1918 )
1919 .validate()
1920 .unwrap_err();
1921 assert!(err.contains("per_target"), "got (once): {err}");
1922 assert!(err.contains("runs_on: agent"), "got (once): {err}");
1923 }
1924
1925 #[test]
1926 fn validate_rejects_bad_every_duration() {
1927 let err = schedule_with(
1928 When::PerPc(PerPolicy::Every(EverySpec { every: "6x".into() })),
1929 RunsOn::Backend,
1930 )
1931 .validate()
1932 .unwrap_err();
1933 assert!(err.contains("when.every"), "got: {err}");
1934 }
1935
1936 #[test]
1937 fn validate_rejects_bad_jitter_and_starting_deadline() {
1938 let mut s = schedule_with(
1939 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
1940 RunsOn::Backend,
1941 );
1942 s.plan.jitter = Some("5x".into());
1943 let err = s.validate().unwrap_err();
1944 assert!(err.contains("jitter"), "got: {err}");
1945
1946 let mut s = schedule_with(
1947 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
1948 RunsOn::Backend,
1949 );
1950 s.starting_deadline = Some("soon".into());
1951 let err = s.validate().unwrap_err();
1952 assert!(err.contains("starting_deadline"), "got: {err}");
1953 }
1954
1955 #[test]
1956 fn validate_accepts_calendar_shapes() {
1957 for when in [
1958 calendar("09:00", &["mon-fri"]), // weekday morning
1959 calendar("00:00", &["sun"]), // weekly
1960 calendar("18:30", &[]), // daily
1961 calendar("2026-06-10 09:00", &[]), // one-shot
1962 calendar("2026/12/25 00:00", &[]), // one-shot, slash form
1963 ] {
1964 schedule_with(when.clone(), RunsOn::Backend)
1965 .validate()
1966 .unwrap_or_else(|e| panic!("{when} should validate: {e}"));
1967 }
1968 }
1969
1970 #[test]
1971 fn validate_rejects_bad_at() {
1972 for bad in ["25:00", "09:60", "9", "noon", "2026-13-01 09:00"] {
1973 let err = schedule_with(calendar(bad, &[]), RunsOn::Backend)
1974 .validate()
1975 .unwrap_err();
1976 assert!(err.contains("when.at"), "for '{bad}', got: {err}");
1977 }
1978 }
1979
1980 #[test]
1981 fn validate_rejects_datetime_at_with_days() {
1982 // A dated `at` is a one-shot — pairing it with days is a
1983 // contradiction (the date already pins the day).
1984 let err = schedule_with(calendar("2026-06-10 09:00", &["mon"]), RunsOn::Backend)
1985 .validate()
1986 .unwrap_err();
1987 assert!(
1988 err.contains("one-shot") && err.contains("days"),
1989 "got: {err}"
1990 );
1991 }
1992
1993 #[test]
1994 fn validate_rejects_bad_day_name() {
1995 // A garbage DOW token is caught by the days pre-flight and
1996 // reported against `when.days`, not the confusing
1997 // "when.at lowered to invalid cron" (claude #432 review).
1998 let err = schedule_with(calendar("09:00", &["funday"]), RunsOn::Backend)
1999 .validate()
2000 .unwrap_err();
2001 assert!(err.contains("when.days"), "got: {err}");
2002 assert!(err.contains("funday"), "names the bad token: {err}");
2003 // a degenerate range like `mon-` reports the whole token, not
2004 // a cryptic empty part (claude #432 follow-up)
2005 let err = schedule_with(calendar("09:00", &["mon-"]), RunsOn::Backend)
2006 .validate()
2007 .unwrap_err();
2008 assert!(err.contains("'mon-'"), "names the whole token: {err}");
2009 // valid names / ranges / numeric / * all pass
2010 for ok in [
2011 calendar("09:00", &["mon-fri"]),
2012 calendar("09:00", &["mon", "wed", "sun"]),
2013 calendar("09:00", &["1-5"]),
2014 ] {
2015 schedule_with(ok.clone(), RunsOn::Backend)
2016 .validate()
2017 .unwrap_or_else(|e| panic!("{ok} should validate: {e}"));
2018 }
2019 }
2020
2021 #[test]
2022 fn validate_accepts_nth_weekday() {
2023 // #418: nth-weekday (Patch Tuesday). validate() also lowers to
2024 // a cron and parses it with croner, so passing here proves the
2025 // whole chain — token → DOW field → engine-acceptable cron.
2026 for ok in [
2027 calendar("09:00", &["tue#2"]), // 2nd Tuesday
2028 calendar("09:00", &["fri#1"]), // 1st Friday
2029 calendar("03:00", &["sun#5"]), // 5th Sunday
2030 calendar("09:00", &["tue#2", "thu#2"]), // a list of nths
2031 calendar("09:00", &["2#2"]), // numeric DOW + ordinal
2032 // Case-insensitive both sides: validate lowercases, croner
2033 // upper-cases the whole pattern before aliasing (claude #547).
2034 calendar("09:00", &["TUE#2"]),
2035 ] {
2036 schedule_with(ok.clone(), RunsOn::Backend)
2037 .validate()
2038 .unwrap_or_else(|e| panic!("{ok} should validate: {e}"));
2039 }
2040 }
2041
2042 #[test]
2043 fn validate_rejects_bad_nth_weekday() {
2044 // ordinal out of 1..5, a range with #, and a bad day before #.
2045 for bad in ["tue#0", "tue#6", "tue#x", "mon-fri#2", "funday#2"] {
2046 let err = schedule_with(calendar("09:00", &[bad]), RunsOn::Backend)
2047 .validate()
2048 .unwrap_err();
2049 assert!(err.contains("when.days"), "for '{bad}', got: {err}");
2050 }
2051 }
2052
2053 #[test]
2054 fn validate_accepts_last_weekday() {
2055 // #418: last-weekday (`friL` = last Friday). Like the nth case,
2056 // validate() lowers to a cron and round-trips it through croner,
2057 // so passing proves token → DOW field → engine-acceptable cron
2058 // with the verified last-<dow>-of-month semantics.
2059 for ok in [
2060 calendar("09:00", &["friL"]), // last Friday
2061 calendar("03:00", &["sunL"]), // last Sunday
2062 calendar("22:00", &["5L"]), // numeric DOW + last
2063 calendar("00:00", &["0L"]), // numeric Sunday (0…
2064 calendar("00:00", &["7L"]), // …and its 7 alias)
2065 calendar("09:00", &["monL", "friL"]), // a list of last-weekdays
2066 // Case-insensitive both the weekday and the `L` suffix:
2067 // validate lowercases the day, croner upper-cases the whole
2068 // pattern before aliasing (claude #547).
2069 calendar("09:00", &["FRIL"]),
2070 calendar("09:00", &["fril"]),
2071 ] {
2072 schedule_with(ok.clone(), RunsOn::Backend)
2073 .validate()
2074 .unwrap_or_else(|e| panic!("{ok} should validate: {e}"));
2075 }
2076 }
2077
2078 #[test]
2079 fn validate_rejects_bad_last_weekday() {
2080 // bare `L` (no weekday — a footgun croner reads as Saturday), a
2081 // range with L, a bad day before L, and an internal space that
2082 // would otherwise leak a malformed cron downstream (gemini #560).
2083 for bad in ["L", "l", "mon-friL", "fundayL", "8L", "*L", "fri L"] {
2084 let err = schedule_with(calendar("09:00", &[bad]), RunsOn::Backend)
2085 .validate()
2086 .unwrap_err();
2087 assert!(err.contains("when.days"), "for '{bad}', got: {err}");
2088 }
2089 }
2090
2091 #[test]
2092 fn calendar_oneshot_instant_detects_past() {
2093 use chrono::TimeZone;
2094 // a dated `at` resolves to an absolute instant…
2095 let c = CalendarSpec {
2096 at: "2024-01-01 09:00".into(),
2097 days: vec![],
2098 };
2099 let t = c
2100 .oneshot_instant(ScheduleTz::Utc)
2101 .expect("one-shot instant");
2102 assert_eq!(
2103 t,
2104 chrono::Utc.with_ymd_and_hms(2024, 1, 1, 9, 0, 0).unwrap()
2105 );
2106 assert!(t < chrono::Utc::now(), "2024 is in the past");
2107 // …while a repeating (time-only) calendar has no instant
2108 let rep = CalendarSpec {
2109 at: "09:00".into(),
2110 days: vec!["mon-fri".into()],
2111 };
2112 assert!(rep.oneshot_instant(ScheduleTz::Utc).is_none());
2113 }
2114
2115 fn schedule_with_active(from: Option<&str>, until: Option<&str>) -> Schedule {
2116 let mut s = schedule_with(
2117 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
2118 RunsOn::Backend,
2119 );
2120 s.active = Active {
2121 from: from.map(str::to_owned),
2122 until: until.map(str::to_owned),
2123 };
2124 s
2125 }
2126
2127 #[test]
2128 fn validate_accepts_active_window() {
2129 schedule_with_active(Some("2026-07-01"), Some("2026-08-01T12:00:00+09:00"))
2130 .validate()
2131 .expect("date + rfc3339 bounds should validate");
2132 }
2133
2134 #[test]
2135 fn validate_rejects_unparseable_active_bound() {
2136 let err = schedule_with_active(Some("July 1st"), None)
2137 .validate()
2138 .unwrap_err();
2139 assert!(err.contains("active"), "got: {err}");
2140 }
2141
2142 #[test]
2143 fn validate_rejects_from_not_before_until() {
2144 let err = schedule_with_active(Some("2026-08-01"), Some("2026-07-01"))
2145 .validate()
2146 .unwrap_err();
2147 assert!(err.contains("strictly before"), "got: {err}");
2148
2149 let err = schedule_with_active(Some("2026-07-01"), Some("2026-07-01"))
2150 .validate()
2151 .unwrap_err();
2152 assert!(err.contains("strictly before"), "got: {err}");
2153 }
2154
2155 // ---- Active window semantics ----
2156
2157 #[test]
2158 fn active_window_is_half_open() {
2159 use chrono::TimeZone;
2160 let active = Active {
2161 from: Some("2026-07-01".into()),
2162 until: Some("2026-08-01".into()),
2163 };
2164 // UTC tz so the date bounds are UTC midnight.
2165 let at = |y, m, d, h| chrono::Utc.with_ymd_and_hms(y, m, d, h, 0, 0).unwrap();
2166 let c = |t| active.contains(t, ScheduleTz::Utc);
2167 assert!(!c(at(2026, 6, 30, 23)), "before from");
2168 assert!(c(at(2026, 7, 1, 0)), "at from (inclusive)");
2169 assert!(c(at(2026, 7, 15, 12)), "inside");
2170 assert!(!c(at(2026, 8, 1, 0)), "at until (exclusive)");
2171 assert!(!c(at(2026, 8, 2, 0)), "after until");
2172 }
2173
2174 #[test]
2175 fn active_empty_window_is_always_active() {
2176 assert!(Active::default().contains(chrono::Utc::now(), ScheduleTz::Local));
2177 }
2178
2179 #[test]
2180 fn active_rfc3339_bound_honours_offset_regardless_of_tz() {
2181 use chrono::TimeZone;
2182 let active = Active {
2183 from: Some("2026-07-01T09:00:00+09:00".into()),
2184 until: None,
2185 };
2186 // RFC3339 carries its own offset → tz arg is ignored.
2187 // 09:00 JST = 00:00 UTC.
2188 for tz in [ScheduleTz::Utc, ScheduleTz::Local] {
2189 assert!(
2190 !active.contains(
2191 chrono::Utc
2192 .with_ymd_and_hms(2026, 6, 30, 23, 59, 0)
2193 .unwrap(),
2194 tz
2195 )
2196 );
2197 assert!(active.contains(
2198 chrono::Utc.with_ymd_and_hms(2026, 7, 1, 0, 0, 0).unwrap(),
2199 tz
2200 ));
2201 }
2202 }
2203
2204 #[test]
2205 fn active_date_bound_respects_tz() {
2206 // A bare `YYYY-MM-DD` bound is midnight *in the schedule's
2207 // tz* (#418 Phase 2). The UTC interpretation is exact and
2208 // host-independent; assert that precisely.
2209 use chrono::TimeZone;
2210 let utc = Active::parse_bound("2026-07-01", ScheduleTz::Utc).expect("utc");
2211 assert_eq!(
2212 utc,
2213 chrono::Utc.with_ymd_and_hms(2026, 7, 1, 0, 0, 0).unwrap()
2214 );
2215
2216 // The local interpretation must equal what chrono::Local
2217 // computes for the same wall-clock midnight — proves the tz
2218 // path is wired to the host zone (the magnitude vs UTC is
2219 // host-dependent, so we compare against Local directly rather
2220 // than hard-coding the JST offset, keeping CI green on UTC
2221 // runners).
2222 let local = Active::parse_bound("2026-07-01", ScheduleTz::Local).expect("local");
2223 let want = chrono::Local
2224 .with_ymd_and_hms(2026, 7, 1, 0, 0, 0)
2225 .single()
2226 .expect("local midnight is unambiguous")
2227 .with_timezone(&chrono::Utc);
2228 assert_eq!(local, want, "date bound resolved in host-local tz");
2229 }
2230
2231 #[test]
2232 fn active_empty_is_skipped_when_serialising() {
2233 let s = schedule_with(
2234 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
2235 RunsOn::Backend,
2236 );
2237 let json = serde_json::to_value(&s).expect("serialise");
2238 assert!(
2239 json.get("active").is_none(),
2240 "empty active must not appear on the wire: {json}"
2241 );
2242 }
2243
2244 // ---- constraints.window (#418 Phase 3) ----
2245
2246 fn with_window(win: &str) -> Schedule {
2247 let mut s = schedule_with(
2248 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
2249 RunsOn::Backend,
2250 );
2251 s.constraints.window = Some(win.into());
2252 s
2253 }
2254
2255 #[test]
2256 fn constraints_window_parses_and_round_trips() {
2257 let yaml = r#"
2258id: x
2259when:
2260 per_pc: { every: 6h }
2261job_id: y
2262target: { all: true }
2263constraints:
2264 window: "22:00-05:00"
2265"#;
2266 let s: Schedule = serde_yaml::from_str(yaml).expect("parse");
2267 assert_eq!(s.constraints.window.as_deref(), Some("22:00-05:00"));
2268 let back: Schedule =
2269 serde_json::from_str(&serde_json::to_string(&s).expect("ser")).expect("de");
2270 assert_eq!(back.constraints.window.as_deref(), Some("22:00-05:00"));
2271 }
2272
2273 #[test]
2274 fn constraints_empty_is_skipped_when_serialising() {
2275 let s = schedule_with(
2276 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
2277 RunsOn::Backend,
2278 );
2279 let json = serde_json::to_value(&s).expect("serialise");
2280 assert!(
2281 json.get("constraints").is_none(),
2282 "empty constraints must not appear on the wire: {json}"
2283 );
2284 }
2285
2286 #[test]
2287 fn window_no_constraint_always_allows() {
2288 let c = Constraints::default();
2289 assert!(c.allows(chrono::Utc::now(), ScheduleTz::Local));
2290 }
2291
2292 #[test]
2293 fn window_same_day_is_half_open() {
2294 use chrono::TimeZone;
2295 let s = with_window("09:00-17:00");
2296 let at = |h, m| chrono::Utc.with_ymd_and_hms(2026, 6, 9, h, m, 0).unwrap();
2297 let a = |t| s.constraints.allows(t, ScheduleTz::Utc);
2298 assert!(!a(at(8, 59)), "before start");
2299 assert!(a(at(9, 0)), "at start (inclusive)");
2300 assert!(a(at(16, 59)), "inside");
2301 assert!(!a(at(17, 0)), "at end (exclusive)");
2302 assert!(!a(at(23, 0)), "after end");
2303 }
2304
2305 #[test]
2306 fn window_crossing_midnight() {
2307 use chrono::TimeZone;
2308 let s = with_window("22:00-05:00");
2309 let at = |h, m| chrono::Utc.with_ymd_and_hms(2026, 6, 9, h, m, 0).unwrap();
2310 let a = |t| s.constraints.allows(t, ScheduleTz::Utc);
2311 assert!(a(at(22, 0)), "at start tonight");
2312 assert!(a(at(23, 30)), "late tonight");
2313 assert!(a(at(3, 0)), "early tomorrow");
2314 assert!(!a(at(5, 0)), "at end (exclusive)");
2315 assert!(!a(at(12, 0)), "midday outside");
2316 assert!(!a(at(21, 59)), "just before start");
2317 }
2318
2319 #[test]
2320 fn window_respects_tz() {
2321 // The same instant is inside the window under one tz and may
2322 // be outside under another. Compare UTC vs Local via the
2323 // host's own offset (kept CI-green on UTC runners like the
2324 // active tz test does).
2325 use chrono::TimeZone;
2326 let s = with_window("09:00-17:00");
2327 let noon_utc = chrono::Utc.with_ymd_and_hms(2026, 6, 9, 12, 0, 0).unwrap();
2328 // Under UTC, 12:00 is inside 09:00-17:00.
2329 assert!(s.constraints.allows(noon_utc, ScheduleTz::Utc));
2330 // Under Local, the verdict tracks the host wall-clock time;
2331 // assert it matches a direct wall_time membership check.
2332 let local_t = noon_utc.with_timezone(&chrono::Local).time();
2333 let in_local = local_t >= chrono::NaiveTime::from_hms_opt(9, 0, 0).unwrap()
2334 && local_t < chrono::NaiveTime::from_hms_opt(17, 0, 0).unwrap();
2335 assert_eq!(s.constraints.allows(noon_utc, ScheduleTz::Local), in_local);
2336 }
2337
2338 #[test]
2339 fn validate_accepts_good_window() {
2340 for w in ["09:00-17:00", "22:00-05:00", "00:00-23:59"] {
2341 with_window(w)
2342 .validate()
2343 .unwrap_or_else(|e| panic!("'{w}' should validate: {e}"));
2344 }
2345 }
2346
2347 #[test]
2348 fn validate_rejects_bad_window() {
2349 for bad in ["9-5", "22:00", "22:00-22:00", "25:00-05:00", "09:00_17:00"] {
2350 let err = with_window(bad).validate().unwrap_err();
2351 assert!(
2352 err.contains("constraints.window"),
2353 "for '{bad}', got: {err}"
2354 );
2355 }
2356 }
2357
2358 // ---- constraints.skip_dates (#418 holiday exclusion) ----
2359
2360 fn with_skip_dates(dates: &[&str]) -> Schedule {
2361 let mut s = schedule_with(calendar("09:00", &[]), RunsOn::Backend);
2362 s.tz = ScheduleTz::Utc; // host-independent date assertions
2363 s.constraints.skip_dates = dates.iter().map(|d| (*d).to_string()).collect();
2364 s
2365 }
2366
2367 #[test]
2368 fn allows_blocks_listed_skip_date() {
2369 use chrono::TimeZone;
2370 let s = with_skip_dates(&["2026-06-10", "2026-12-25"]);
2371 // Any time on a listed date is blocked (whole day).
2372 let on = chrono::Utc.with_ymd_and_hms(2026, 6, 10, 9, 0, 0).unwrap();
2373 assert!(!s.constraints.allows(on, ScheduleTz::Utc));
2374 let on_midnight = chrono::Utc.with_ymd_and_hms(2026, 12, 25, 0, 0, 0).unwrap();
2375 assert!(!s.constraints.allows(on_midnight, ScheduleTz::Utc));
2376 // A date not in the list fires normally.
2377 let off = chrono::Utc.with_ymd_and_hms(2026, 6, 11, 9, 0, 0).unwrap();
2378 assert!(s.constraints.allows(off, ScheduleTz::Utc));
2379 }
2380
2381 #[test]
2382 fn allows_corrupt_skip_date_fails_closed() {
2383 use chrono::TimeZone;
2384 // A garbled entry (only reachable via hand-edited KV) blocks
2385 // rather than silently re-enabling fires — same posture as a
2386 // corrupt window.
2387 let s = with_skip_dates(&["not-a-date"]);
2388 let any = chrono::Utc.with_ymd_and_hms(2026, 6, 11, 9, 0, 0).unwrap();
2389 assert!(!s.constraints.allows(any, ScheduleTz::Utc));
2390 }
2391
2392 #[test]
2393 fn validate_accepts_good_skip_dates() {
2394 with_skip_dates(&["2026-01-01", "2026-12-25", "2027-05-03"])
2395 .validate()
2396 .expect("well-formed skip dates should validate");
2397 }
2398
2399 #[test]
2400 fn validate_rejects_bad_skip_date() {
2401 for bad in ["2026-13-01", "01-01-2026", "nope", "2026/01/01"] {
2402 let err = with_skip_dates(&[bad]).validate().unwrap_err();
2403 assert!(
2404 err.contains("constraints.skip_dates"),
2405 "for '{bad}', got: {err}"
2406 );
2407 }
2408 }
2409
2410 #[test]
2411 fn preview_skips_holidays() {
2412 use chrono::TimeZone;
2413 // Daily 09:00 with two of the next five days marked as holidays
2414 // — preview drops exactly those, since it gates on `allows`.
2415 let mut s = cal_utc("09:00", &[]);
2416 s.constraints.skip_dates = vec!["2026-06-11".into(), "2026-06-13".into()];
2417 let now = chrono::Utc.with_ymd_and_hms(2026, 6, 10, 0, 0, 0).unwrap();
2418 let got = s.preview_fires(now, 4);
2419 let want: Vec<_> = [
2420 (2026, 6, 10),
2421 (2026, 6, 12), // skips 06-11
2422 (2026, 6, 14), // skips 06-13
2423 (2026, 6, 15),
2424 ]
2425 .iter()
2426 .map(|(y, m, d)| chrono::Utc.with_ymd_and_hms(*y, *m, *d, 9, 0, 0).unwrap())
2427 .collect();
2428 assert_eq!(got, want);
2429 }
2430
2431 // ---- constraints.max_concurrent (#418) ----
2432
2433 fn with_max_concurrent(max: u32, runs_on: RunsOn) -> Schedule {
2434 let mut s = schedule_with(
2435 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
2436 runs_on,
2437 );
2438 s.constraints.max_concurrent = Some(max);
2439 s
2440 }
2441
2442 #[test]
2443 fn validate_accepts_backend_max_concurrent() {
2444 with_max_concurrent(5, RunsOn::Backend)
2445 .validate()
2446 .expect("backend max_concurrent should validate");
2447 }
2448
2449 #[test]
2450 fn validate_rejects_max_concurrent_on_agent() {
2451 // Decision E: a central running-instance cap needs a central
2452 // counter, which agents don't have.
2453 let err = with_max_concurrent(5, RunsOn::Agent)
2454 .validate()
2455 .unwrap_err();
2456 assert!(err.contains("constraints.max_concurrent"), "got: {err}");
2457 assert!(err.contains("runs_on: agent"), "got: {err}");
2458 }
2459
2460 #[test]
2461 fn validate_rejects_zero_max_concurrent() {
2462 let err = with_max_concurrent(0, RunsOn::Backend)
2463 .validate()
2464 .unwrap_err();
2465 assert!(err.contains("max_concurrent must be >= 1"), "got: {err}");
2466 }
2467
2468 #[test]
2469 fn max_concurrent_round_trips_and_skips_when_absent() {
2470 let s = with_max_concurrent(3, RunsOn::Backend);
2471 let json = serde_json::to_value(&s.constraints).expect("ser");
2472 assert_eq!(json.get("max_concurrent").and_then(|v| v.as_u64()), Some(3));
2473 // A schedule with no constraints omits the whole block.
2474 let bare = schedule_with(
2475 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
2476 RunsOn::Backend,
2477 );
2478 assert!(bare.constraints.is_empty());
2479 }
2480
2481 #[test]
2482 fn window_fail_closed_on_corrupt_blob() {
2483 // A malformed window (only reachable via a hand-edited KV
2484 // blob — validate() rejects it at create) must BLOCK, not
2485 // silently allow fires during a change-freeze (gemini #452).
2486 let s = with_window("22:00_05:00");
2487 assert!(
2488 !s.constraints.allows(chrono::Utc::now(), ScheduleTz::Utc),
2489 "corrupt window fails closed"
2490 );
2491 // …and the scheduler can surface why it's stuck.
2492 assert!(
2493 s.bad_window().is_some(),
2494 "bad_window reports the parse error"
2495 );
2496 assert!(with_window("22:00-05:00").bad_window().is_none());
2497 }
2498
2499 #[test]
2500 fn calendar_outside_window_is_flagged() {
2501 // at 09:00 can never fall in 22:00-05:00 → never fires.
2502 let mut s = schedule_with(calendar("09:00", &["mon-fri"]), RunsOn::Backend);
2503 s.constraints.window = Some("22:00-05:00".into());
2504 assert!(s.calendar_outside_window(), "09:00 is not in 22:00-05:00");
2505
2506 // at 23:00 IS inside the overnight window → fine.
2507 let mut s = schedule_with(calendar("23:00", &[]), RunsOn::Backend);
2508 s.constraints.window = Some("22:00-05:00".into());
2509 assert!(!s.calendar_outside_window(), "23:00 is in 22:00-05:00");
2510
2511 // reconcile shapes are never flagged (they poll every minute).
2512 let mut s = schedule_with(
2513 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
2514 RunsOn::Backend,
2515 );
2516 s.constraints.window = Some("22:00-05:00".into());
2517 assert!(!s.calendar_outside_window(), "reconcile is unaffected");
2518
2519 // no window → never flagged.
2520 let s = schedule_with(calendar("09:00", &[]), RunsOn::Backend);
2521 assert!(!s.calendar_outside_window());
2522 }
2523
2524 // ---- on_failure.retry (#418 Phase 4) ----
2525
2526 fn with_retry(max: u32, backoff: &str) -> Schedule {
2527 let mut s = schedule_with(
2528 When::PerPc(PerPolicy::Every(EverySpec { every: "6h".into() })),
2529 RunsOn::Backend,
2530 );
2531 s.on_failure.retry = Some(Retry {
2532 max,
2533 backoff: backoff.into(),
2534 });
2535 s
2536 }
2537
2538 #[test]
2539 fn on_failure_parses_and_round_trips() {
2540 let yaml = r#"
2541id: x
2542when:
2543 per_pc: { every: 6h }
2544job_id: y
2545target: { all: true }
2546on_failure:
2547 retry: { max: 3, backoff: 10m }
2548"#;
2549 let s: Schedule = serde_yaml::from_str(yaml).expect("parse");
2550 let r = s.on_failure.retry.as_ref().expect("retry present");
2551 assert_eq!(r.max, 3);
2552 assert_eq!(r.backoff, "10m");
2553 let back: Schedule =
2554 serde_json::from_str(&serde_json::to_string(&s).expect("ser")).expect("de");
2555 assert_eq!(back.on_failure, s.on_failure);
2556 }
2557
2558 #[test]
2559 fn on_failure_empty_is_skipped_when_serialising() {
2560 let s = schedule_with(
2561 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
2562 RunsOn::Backend,
2563 );
2564 let json = serde_json::to_value(&s).expect("serialise");
2565 assert!(
2566 json.get("on_failure").is_none(),
2567 "empty on_failure must not appear on the wire: {json}"
2568 );
2569 }
2570
2571 #[test]
2572 fn validate_accepts_good_retry() {
2573 for (max, backoff) in [(1, "30s"), (3, "10m"), (10, "1h")] {
2574 with_retry(max, backoff)
2575 .validate()
2576 .unwrap_or_else(|e| panic!("retry {{max:{max}, backoff:{backoff}}}: {e}"));
2577 }
2578 }
2579
2580 #[test]
2581 fn validate_rejects_bad_backoff() {
2582 let err = with_retry(3, "soon").validate().unwrap_err();
2583 assert!(err.contains("on_failure.retry.backoff"), "got: {err}");
2584 }
2585
2586 #[test]
2587 fn validate_rejects_sub_second_backoff() {
2588 // "500ms" parses as humantime but lowers to 0s on the wire —
2589 // reject it so the operator doesn't get a silent no-wait
2590 // (coderabbit #466).
2591 for bad in ["500ms", "0s", "999ms"] {
2592 let err = with_retry(3, bad).validate().unwrap_err();
2593 assert!(
2594 err.contains("on_failure.retry.backoff must be >= 1s"),
2595 "for '{bad}', got: {err}"
2596 );
2597 }
2598 }
2599
2600 #[test]
2601 fn validate_rejects_out_of_range_max() {
2602 for bad in [0u32, 11, 1000] {
2603 let err = with_retry(bad, "10m").validate().unwrap_err();
2604 assert!(
2605 err.contains("on_failure.retry.max"),
2606 "for max={bad}, got: {err}"
2607 );
2608 }
2609 }
2610
2611 #[test]
2612 fn lowered_retry_reduces_backoff_to_seconds() {
2613 let s = with_retry(3, "10m");
2614 let spec = s.on_failure.lowered_retry().expect("a retry policy");
2615 assert_eq!(spec.max, 3);
2616 assert_eq!(spec.backoff_secs, 600);
2617 }
2618
2619 #[test]
2620 fn lowered_retry_is_none_without_policy() {
2621 let s = schedule_with(
2622 When::PerPc(PerPolicy::Once(OnceLiteral::Once)),
2623 RunsOn::Backend,
2624 );
2625 assert!(s.on_failure.lowered_retry().is_none());
2626 }
2627
2628 // ---- global change-freeze (#418 Phase 5) ----
2629
2630 #[test]
2631 fn freeze_empty_window_is_always_active() {
2632 // The big-red-button shape: no bounds = frozen until cleared.
2633 let f = Freeze::default();
2634 assert!(f.is_active(chrono::Utc::now()));
2635 }
2636
2637 #[test]
2638 fn freeze_window_is_half_open() {
2639 use chrono::TimeZone;
2640 let f = Freeze {
2641 from: Some("2026-12-20T00:00:00+00:00".into()),
2642 until: Some("2027-01-05T00:00:00+00:00".into()),
2643 reason: Some("year-end".into()),
2644 tz: ScheduleTz::Utc,
2645 };
2646 let at = |y, mo, d| chrono::Utc.with_ymd_and_hms(y, mo, d, 0, 0, 0).unwrap();
2647 assert!(!f.is_active(at(2026, 12, 19)), "before from = not frozen");
2648 assert!(f.is_active(at(2026, 12, 20)), "from is inclusive");
2649 assert!(f.is_active(at(2026, 12, 31)), "inside window");
2650 assert!(!f.is_active(at(2027, 1, 5)), "until is exclusive");
2651 assert!(!f.is_active(at(2027, 1, 6)), "after until = not frozen");
2652 }
2653
2654 #[test]
2655 fn freeze_fails_closed_on_corrupt_bound() {
2656 // A freeze is a safety switch: an unparseable bound (only
2657 // reachable via a hand-edited KV blob) must read as FROZEN, not
2658 // "fire normally" (coderabbit #472) — the opposite of `active`,
2659 // which fail-opens.
2660 let f = Freeze {
2661 from: Some("not-a-date".into()),
2662 until: None,
2663 reason: None,
2664 tz: ScheduleTz::Utc,
2665 };
2666 assert!(f.is_active(chrono::Utc::now()), "corrupt bound → frozen");
2667 }
2668
2669 #[test]
2670 fn freeze_validate_accepts_good_bounds() {
2671 Freeze {
2672 from: Some("2026-12-20".into()),
2673 until: Some("2027-01-05T12:00:00+09:00".into()),
2674 reason: None,
2675 tz: ScheduleTz::Local,
2676 }
2677 .validate()
2678 .expect("date + rfc3339 bounds should validate");
2679 // Empty (indefinite) freeze is valid.
2680 Freeze::default().validate().expect("empty freeze is valid");
2681 }
2682
2683 #[test]
2684 fn freeze_validate_rejects_bad_bound_and_inverted_window() {
2685 let err = Freeze {
2686 from: Some("never".into()),
2687 ..Default::default()
2688 }
2689 .validate()
2690 .unwrap_err();
2691 assert!(err.contains("freeze:"), "got: {err}");
2692
2693 let inverted = Freeze {
2694 from: Some("2027-01-05".into()),
2695 until: Some("2026-12-20".into()),
2696 ..Default::default()
2697 }
2698 .validate()
2699 .unwrap_err();
2700 assert!(inverted.contains("freeze.from"), "got: {inverted}");
2701 }
2702
2703 #[test]
2704 fn freeze_round_trips_and_skips_empty_fields() {
2705 let f = Freeze {
2706 from: None,
2707 until: Some("2027-01-05".into()),
2708 reason: Some("INC-1234".into()),
2709 tz: ScheduleTz::Utc,
2710 };
2711 let json = serde_json::to_value(&f).expect("serialise");
2712 assert!(json.get("from").is_none(), "empty from omitted: {json}");
2713 let back: Freeze = serde_json::from_value(json).expect("round-trip");
2714 assert_eq!(back, f);
2715 }
2716
2717 #[test]
2718 fn shipped_schedule_configs_parse_and_validate() {
2719 // Every YAML under configs/schedules/ must parse with the
2720 // current Schedule serde AND pass validate() — keeps the
2721 // shipped examples from drifting out of sync with the model
2722 // (#418 removed back-compat, so drift = broken at create).
2723 let dir = std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("../../configs/schedules");
2724 let mut seen = 0;
2725 for entry in std::fs::read_dir(&dir).expect("read configs/schedules") {
2726 let path = entry.expect("dir entry").path();
2727 if path.extension().and_then(|e| e.to_str()) != Some("yaml") {
2728 continue;
2729 }
2730 let body = std::fs::read_to_string(&path).expect("read yaml");
2731 let s: Schedule = serde_yaml::from_str(&body)
2732 .unwrap_or_else(|e| panic!("{} failed to parse: {e}", path.display()));
2733 s.validate()
2734 .unwrap_or_else(|e| panic!("{} failed validate(): {e}", path.display()));
2735 seen += 1;
2736 }
2737 assert!(seen > 0, "no schedule YAMLs found in {}", dir.display());
2738 }
2739
2740 // ---- pre-existing enum wire formats (unchanged by #418) ----
2741
2742 #[test]
2743 fn exec_mode_serialises_snake_case() {
2744 for (mode, expected) in [
2745 (ExecMode::EveryTick, "every_tick"),
2746 (ExecMode::OncePerPc, "once_per_pc"),
2747 (ExecMode::OncePerTarget, "once_per_target"),
2748 ] {
2749 let s = serde_json::to_value(mode).expect("serialise");
2750 assert_eq!(s, serde_json::Value::String(expected.into()));
2751 let back: ExecMode = serde_json::from_value(serde_json::Value::String(expected.into()))
2752 .expect("deserialise");
2753 assert_eq!(back, mode, "round-trip for {expected}");
2754 }
2755 }
2756
2757 #[test]
2758 fn schedule_runs_on_defaults_to_backend() {
2759 let yaml = r#"
2760id: x
2761when:
2762 per_pc: once
2763job_id: y
2764target: { all: true }
2765"#;
2766 let s: Schedule = serde_yaml::from_str(yaml).expect("parse");
2767 assert_eq!(s.runs_on, RunsOn::Backend);
2768 }
2769
2770 #[test]
2771 fn schedule_runs_on_agent_parses() {
2772 let yaml = r#"
2773id: offline-inv
2774when:
2775 per_pc: { every: 1h }
2776job_id: inventory-hw
2777target: { all: true }
2778runs_on: agent
2779"#;
2780 let s: Schedule = serde_yaml::from_str(yaml).expect("parse");
2781 assert_eq!(s.runs_on, RunsOn::Agent);
2782 assert_eq!(s.lowered().mode, ExecMode::OncePerPc);
2783 }
2784
2785 #[test]
2786 fn runs_on_serialises_snake_case() {
2787 for (mode, expected) in [(RunsOn::Backend, "backend"), (RunsOn::Agent, "agent")] {
2788 let s = serde_json::to_value(mode).expect("serialise");
2789 assert_eq!(s, serde_json::Value::String(expected.into()));
2790 let back: RunsOn = serde_json::from_value(serde_json::Value::String(expected.into()))
2791 .expect("deserialise");
2792 assert_eq!(back, mode);
2793 }
2794 }
2795
2796 #[test]
2797 fn execute_shell_into_wire_shell() {
2798 assert_eq!(Shell::from(ExecuteShell::Powershell), Shell::Powershell);
2799 assert_eq!(Shell::from(ExecuteShell::Cmd), Shell::Cmd);
2800 }
2801
2802 #[test]
2803 fn manifest_staleness_defaults_to_cached() {
2804 let yaml = r#"
2805id: x
2806version: 1.0.0
2807execute:
2808 shell: powershell
2809 script: "echo"
2810 timeout: 1s
2811"#;
2812 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
2813 assert_eq!(m.staleness, Staleness::Cached);
2814 }
2815
2816 #[test]
2817 fn manifest_strict_staleness_parses() {
2818 let yaml = r#"
2819id: urgent-patch
2820version: 2.5.1
2821execute:
2822 shell: powershell
2823 script: Install-Hotfix
2824 timeout: 5m
2825staleness:
2826 mode: strict
2827 max_cache_age: 0s
2828"#;
2829 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
2830 match m.staleness {
2831 Staleness::Strict { max_cache_age } => assert_eq!(max_cache_age, "0s"),
2832 other => panic!("expected strict, got {other:?}"),
2833 }
2834 }
2835
2836 #[test]
2837 fn manifest_unchecked_staleness_parses() {
2838 let yaml = r#"
2839id: legacy
2840version: 0.1.0
2841execute:
2842 shell: cmd
2843 script: "echo"
2844 timeout: 1s
2845staleness:
2846 mode: unchecked
2847"#;
2848 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
2849 assert_eq!(m.staleness, Staleness::Unchecked);
2850 }
2851
2852 #[test]
2853 fn missing_required_field_errors() {
2854 // `id` missing.
2855 let yaml = r#"
2856version: 1.0.0
2857target: { all: true }
2858execute:
2859 shell: powershell
2860 script: "echo"
2861 timeout: 1s
2862"#;
2863 let r: Result<Manifest, _> = serde_yaml::from_str(yaml);
2864 assert!(r.is_err(), "expected error, got {:?}", r);
2865 }
2866
2867 #[test]
2868 fn display_field_table_kind_round_trips_with_nested_columns() {
2869 // #39: `type: table` + `columns:` on a DisplayField gets
2870 // round-tripped through serde so the SPA receives the
2871 // nested schema verbatim. Nested columns themselves are
2872 // DisplayFields so they can carry `type: bytes` /
2873 // `type: number` for cell formatting.
2874 let yaml = r#"
2875id: inv-hw
2876version: 1.0.0
2877execute:
2878 shell: powershell
2879 script: "echo"
2880 timeout: 60s
2881inventory:
2882 display:
2883 - field: hostname
2884 label: Hostname
2885 - field: disks
2886 label: Disks
2887 type: table
2888 columns:
2889 - field: device_id
2890 label: Drive
2891 - field: size_bytes
2892 label: Size
2893 type: bytes
2894 - field: free_bytes
2895 label: Free
2896 type: bytes
2897 - field: file_system
2898 label: FS
2899"#;
2900 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
2901 let inv = m.inventory.as_ref().expect("inventory hint");
2902 let disks = inv
2903 .display
2904 .iter()
2905 .find(|d| d.field == "disks")
2906 .expect("disks display row");
2907 assert_eq!(disks.kind.as_deref(), Some("table"));
2908 let cols = disks.columns.as_ref().expect("table needs columns");
2909 assert_eq!(cols.len(), 4);
2910 assert_eq!(cols[1].field, "size_bytes");
2911 assert_eq!(cols[1].kind.as_deref(), Some("bytes"));
2912 }
2913
2914 #[test]
2915 fn display_field_scalar_kind_keeps_columns_none() {
2916 // Defensive: when type is a scalar (`bytes` / `number` /
2917 // `timestamp`) the `columns` field stays None — the SPA
2918 // uses its presence as the "render nested table" signal,
2919 // so it must not leak in via serde defaults.
2920 let yaml = r#"
2921id: x
2922version: 1.0.0
2923execute:
2924 shell: powershell
2925 script: "echo"
2926 timeout: 5s
2927inventory:
2928 display:
2929 - { field: ram_bytes, label: RAM, type: bytes }
2930"#;
2931 let m: Manifest = serde_yaml::from_str(yaml).expect("parse");
2932 let inv = m.inventory.as_ref().unwrap();
2933 assert!(inv.display[0].columns.is_none());
2934 }
2935
2936 // ---- checked-in JSON Schema freshness (docs/schemas/) ----
2937
2938 /// The JSON Schemas under `docs/schemas/` must match what
2939 /// `schema_for!` produces today — a Cargo.lock-style freshness guard
2940 /// so a `Schedule` / `Manifest` field change can't silently drift
2941 /// the operator-facing schema. The SPA editor, the backend
2942 /// `/api/schemas/*` endpoints, and these files all read the same
2943 /// derived shape; this test fails CI if the checked-in copy lags.
2944 /// Regenerate with:
2945 /// `UPDATE_SCHEMAS=1 cargo test -p kanade-shared schema_files_are_current`
2946 #[test]
2947 fn schema_files_are_current() {
2948 assert_schema_file("schedule.schema.json", &schemars::schema_for!(Schedule));
2949 assert_schema_file("job.schema.json", &schemars::schema_for!(Manifest));
2950 }
2951
2952 fn assert_schema_file(name: &str, schema: &schemars::Schema) {
2953 let generated = serde_json::to_string_pretty(schema).expect("serialize schema") + "\n";
2954 let path = std::path::Path::new(env!("CARGO_MANIFEST_DIR"))
2955 .join("../../docs/schemas")
2956 .join(name);
2957 if std::env::var_os("UPDATE_SCHEMAS").is_some() {
2958 std::fs::create_dir_all(path.parent().unwrap()).expect("mkdir docs/schemas");
2959 std::fs::write(&path, &generated).unwrap_or_else(|e| panic!("write {path:?}: {e}"));
2960 return;
2961 }
2962 // Normalize CRLF→LF before comparing: `.gitattributes` already
2963 // pins these files to `eol=lf`, but a stray CRLF working-tree
2964 // copy (autocrlf, a tool rewrite) shouldn't turn a *content*-
2965 // freshness check into a confusing line-ending failure — that's
2966 // .gitattributes' job, not this test's (gemini #588).
2967 let on_disk = std::fs::read_to_string(&path)
2968 .unwrap_or_else(|e| {
2969 panic!(
2970 "read {path:?}: {e}\n\
2971 generate it with: UPDATE_SCHEMAS=1 cargo test -p kanade-shared schema_files_are_current"
2972 )
2973 })
2974 .replace("\r\n", "\n");
2975 assert_eq!(
2976 on_disk, generated,
2977 "{name} is stale — a Schedule/Manifest schema change isn't reflected in docs/schemas/. \
2978 Refresh with: UPDATE_SCHEMAS=1 cargo test -p kanade-shared schema_files_are_current"
2979 );
2980 }
2981}
2982
2983/// Periodic schedule (spec §2.4.3). v0.18.0 carries the fanout plan
2984/// (target + optional rollout + optional jitter) inline; the
2985/// referenced job (`job_id` → [`BUCKET_JOBS`]) supplies only the
2986/// script body. Two schedules of the same job can target different
2987/// groups on different cadences without copying the manifest.
2988///
2989/// #418 Phase 1: the cadence is the single [`When`] field. The old
2990/// `cron` × `mode` × `cooldown` × `auto_disable_when_done` quartet
2991/// is gone (no back-compat — pre-Phase-1 KV blobs fail to parse and
2992/// are warn-skipped; re-`schedule create` to upgrade them). The
2993/// engine underneath is unchanged: [`Schedule::lowered`] maps `when`
2994/// onto the same (cron, ExecMode, cooldown) trio the scheduler and
2995/// `decide_fire` always ran on.
2996#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone)]
2997pub struct Schedule {
2998 pub id: String,
2999 /// When to fire — a reconcile cadence (`per_pc` / `per_target`)
3000 /// or a calendar time trigger (`at` / `days`). See [`When`].
3001 ///
3002 /// `singleton_map`: serde_yaml 0.9 renders externally-tagged
3003 /// enums as `!per_pc` YAML tags by default; this keeps the
3004 /// operator-facing map shape (`when: { per_pc: once }`). JSON
3005 /// output is identical either way, and the schemars schema
3006 /// (external tagging = oneOf of single-key objects) already
3007 /// matches the singleton-map wire shape.
3008 #[serde(with = "serde_yaml::with::singleton_map")]
3009 #[schemars(with = "When")]
3010 pub when: When,
3011 /// Key into [`crate::kv::BUCKET_JOBS`]. Must equal a registered
3012 /// Manifest's `id`.
3013 pub job_id: String,
3014 /// Who + how-to-phase + when-to-stagger. The Manifest doesn't
3015 /// carry these any more — same job + different fanout = different
3016 /// schedule.
3017 #[serde(flatten)]
3018 pub plan: FanoutPlan,
3019 /// Optional validity window. Outside `[from, until)` the
3020 /// schedule is dormant — still registered, still visible, but
3021 /// every tick is skipped (deleted ≠ dormant: a campaign that
3022 /// ended stays inspectable and can be re-armed by editing the
3023 /// window). Checked at tick time on both the backend scheduler
3024 /// and the agent's local scheduler.
3025 #[serde(default, skip_serializing_if = "Active::is_empty")]
3026 pub active: Active,
3027 /// #418 operational constraints gating *when within an active
3028 /// period* a fire may happen: a maintenance `window`, a fleet
3029 /// `max_concurrent` cap, and `skip_dates` (holiday exclusion). The
3030 /// wall-clock ones are evaluated in the schedule's `tz`; future
3031 /// `require` (env gates) lands in the same namespace. Checked at
3032 /// tick time on both schedulers (and surfaced by `preview`).
3033 #[serde(default, skip_serializing_if = "Constraints::is_empty")]
3034 pub constraints: Constraints,
3035 /// #418 Phase 4: what to do after a fire's script comes back
3036 /// failed. Currently just `retry` (fixed-backoff in-process
3037 /// re-run); future `notify` / `disable` join the same namespace.
3038 /// Applied fire-side in `handle_command` (the retry policy is
3039 /// lowered onto every Command this schedule produces), so it
3040 /// covers both `runs_on` locations.
3041 #[serde(default, skip_serializing_if = "OnFailure::is_empty")]
3042 pub on_failure: OnFailure,
3043 /// #418 Phase 2: the timezone this schedule's wall-clock fields
3044 /// are evaluated in — both the calendar `at` firing time AND the
3045 /// `active.{from,until}` window bounds. `local` (default) = the
3046 /// running host's TZ (the agent's for `runs_on: agent`, the
3047 /// backend server's otherwise); `utc` for TZ-independent
3048 /// schedules. Reconcile shapes (`per_pc`/`per_target`) ignore it
3049 /// for firing (poll cron runs every minute regardless) but still
3050 /// honor it for the `active` window.
3051 #[serde(default)]
3052 pub tz: ScheduleTz,
3053 /// v0.22: optional humantime window after a cron tick during
3054 /// which the Command is still considered "live". The scheduler
3055 /// computes `tick_at + starting_deadline` and stamps it onto
3056 /// each Command as `deadline_at`; agents skip Commands they
3057 /// receive after that absolute time. `None` (default) = no
3058 /// deadline, meaning a Command queued in the broker / stream
3059 /// during agent downtime runs whenever the agent reconnects —
3060 /// good for kitting / inventory / cleanup. Set this for
3061 /// time-of-day notifications, lunch reminders, etc., where
3062 /// "fire 3 hours late" would be wrong.
3063 #[serde(default, skip_serializing_if = "Option::is_none")]
3064 pub starting_deadline: Option<String>,
3065 /// v0.23: where does the cron tick happen? `Backend` (default,
3066 /// historical) = backend's scheduler fires Commands via NATS;
3067 /// agents passively receive. `Agent` = each targeted agent runs
3068 /// its own internal cron and fires locally, so the schedule
3069 /// keeps ticking even when the broker is unreachable (laptop on
3070 /// the train, broker maintenance window, full WAN outage). The
3071 /// two locations are mutually exclusive — when `Agent`, the
3072 /// backend scheduler stays out and just keeps the definition in
3073 /// KV for agents to read.
3074 #[serde(default)]
3075 pub runs_on: RunsOn,
3076 #[serde(default = "default_true")]
3077 pub enabled: bool,
3078}
3079
3080/// v0.23 — where the cron tick fires from.
3081#[derive(
3082 Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Copy, PartialEq, Eq, Default,
3083)]
3084#[serde(rename_all = "snake_case")]
3085pub enum RunsOn {
3086 /// Backend's central scheduler ticks and publishes Commands to
3087 /// NATS. Historical default, what every pre-v0.23 schedule
3088 /// uses. Agent offline ⇒ Command queued in STREAM_EXEC; agent
3089 /// reconnects ⇒ catch-up via [`command_replay`](crate)
3090 /// (see kanade-agent's command_replay module).
3091 #[default]
3092 Backend,
3093 /// Each targeted agent runs the cron tick locally. Survives
3094 /// broker / WAN outages. Best for laptops / mobile devices that
3095 /// roam off the corporate network. Agent must be online for the
3096 /// initial schedule + job-catalog pull, but once cached the
3097 /// agent fires the script standalone.
3098 Agent,
3099}
3100
3101/// Per-pc/per-target dedup semantics for a [`Schedule`] (v0.19).
3102#[derive(
3103 Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Copy, PartialEq, Eq, Default,
3104)]
3105#[serde(rename_all = "snake_case")]
3106pub enum ExecMode {
3107 /// Fire on every cron tick at the whole target. Historical
3108 /// (pre-v0.19) behavior; no dedup.
3109 #[default]
3110 EveryTick,
3111 /// Fire at each pc until that pc succeeds; then skip it until
3112 /// the optional cooldown elapses (or forever if no cooldown).
3113 /// Use for kitting / first-boot / per-pc compliance checks.
3114 OncePerPc,
3115 /// Fire at the whole target until **any** pc succeeds; then
3116 /// skip the whole target until the optional cooldown elapses
3117 /// (or forever if no cooldown). Use for "one delegate is
3118 /// enough" tasks like license check-in.
3119 OncePerTarget,
3120 /// #418 OS-native event trigger (`when: { on: [...] }`). There is
3121 /// no cron — the agent fires it from an OS event source (boot /
3122 /// session-change), not a tick — so the scheduler skips
3123 /// `tokio-cron` registration for it. Each event occurrence fires
3124 /// once, gated by the standard freeze / active / window /
3125 /// skip_dates checks.
3126 Event,
3127}
3128
3129/// #418 Phase 1 — the single "when does this fire" axis.
3130///
3131/// Replaces the old `cron` + `mode` + `cooldown` trio whose
3132/// interactions were implicit (cron doubled as both a real
3133/// time-of-day trigger and a reconcile poll period; contradictory
3134/// combinations silently no-opped). Two shapes:
3135///
3136/// * **reconcile** (`per_pc` / `per_target`) — desired-state: "each
3137/// pc (or one delegate) should have run this within `every`".
3138/// The poll period is system-generated ([`POLL_CRON`], every
3139/// minute) and no longer the operator's concern.
3140/// * **calendar** (`{ at, days }`) — a wall-clock time trigger
3141/// (#418 Phase 2, replacing the old raw-cron escape hatch). Fires
3142/// the whole target at the given time, no dedup. `at: "09:00"` +
3143/// `days` repeats; `at: "2026-06-10 09:00"` (a date+time) fires
3144/// exactly once. Evaluated in the schedule's top-level `tz`.
3145#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, PartialEq, Eq)]
3146#[serde(rename_all = "snake_case")]
3147pub enum When {
3148 /// Fire at each targeted pc: `once` (kitting — succeed once,
3149 /// skip forever, forever catching brand-new / re-imaged pcs)
3150 /// or `{ every: <humantime> }` (patrol — re-arm per pc after
3151 /// the interval).
3152 PerPc(PerPolicy),
3153 /// Fire until **any** one pc of the target succeeds, then skip
3154 /// the whole target (`once`) or re-arm after `every`. Needs
3155 /// fleet-wide completion data, so it is backend-only —
3156 /// `runs_on: agent` + `per_target` is rejected by
3157 /// [`Schedule::validate`].
3158 PerTarget(PerPolicy),
3159 /// Calendar time trigger: `{ at: "09:00", days: [mon-fri] }`
3160 /// (repeating) or `{ at: "2026-06-10 09:00" }` (one-shot). Fires
3161 /// the whole target at that wall-clock time in the schedule's
3162 /// `tz` — no dedup, no cooldown.
3163 Calendar(CalendarSpec),
3164 /// #418 OS-native event trigger: `when: { on: [startup, logon] }`.
3165 /// Fires when the agent observes the listed OS event(s) rather than
3166 /// on a clock — there is no cron. `runs_on: agent` only (the agent
3167 /// owns the event source); [`Schedule::validate`] rejects it on
3168 /// `backend` and rejects an empty list. Each event occurrence fires
3169 /// once, gated by the same freeze / active / `constraints.window` /
3170 /// `skip_dates` checks as the cron path. `startup` fires once per OS
3171 /// boot (deduped via the host boot time); a `starting_deadline`, if
3172 /// set, limits it to "agent came up within that long after boot".
3173 On(Vec<OnTrigger>),
3174}
3175
3176/// An OS event the agent can fire a schedule on (#418 `when: { on }`).
3177/// `network_change` is a planned follow-up.
3178#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Copy, PartialEq, Eq, Hash)]
3179#[serde(rename_all = "snake_case")]
3180pub enum OnTrigger {
3181 /// Once per OS boot (the agent's first run for that boot). Catches
3182 /// freshly-imaged / reinstalled hosts at their next startup.
3183 Startup,
3184 /// On an interactive-session user logon — console, RDP, or
3185 /// auto-logon (Windows `WTS_SESSION_LOGON`). Does not fire for
3186 /// service / network / batch logons (no interactive session).
3187 Logon,
3188 /// When the workstation is locked (Win+L / idle lock; Windows
3189 /// `WTS_SESSION_LOCK`). Use for step-away compliance / cleanup.
3190 Lock,
3191 /// When the workstation is unlocked — the user returns to a locked
3192 /// session (Windows `WTS_SESSION_UNLOCK`). Use to re-check
3193 /// compliance / refresh state when work resumes.
3194 Unlock,
3195}
3196
3197/// Calendar time trigger (#418 Phase 2). `at` is either a time of
3198/// day (`"HH:MM"`, repeating — combine with `days`) or a full
3199/// date+time (`"YYYY-MM-DD HH:MM"`, a one-shot that fires once and
3200/// never again). Evaluated in the schedule's top-level `tz`.
3201#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, PartialEq, Eq)]
3202pub struct CalendarSpec {
3203 /// `"HH:MM"` (24h) for a repeating trigger, or
3204 /// `"YYYY-MM-DD HH:MM"` (hyphen / slash / `T` separators all
3205 /// accepted) for a one-shot. Parsed lazily —
3206 /// [`Schedule::validate`] rejects garbage at create time.
3207 pub at: String,
3208 /// Day-of-week filter for a time-of-day `at`: `["mon-fri"]`,
3209 /// `["mon","wed","fri"]`, … (passed verbatim to the cron DOW
3210 /// field, so ranges and names both work). An **nth-weekday**
3211 /// `["tue#2"]` fires only on the 2nd Tuesday of each month
3212 /// ("Patch Tuesday"); the ordinal is `1..5`. A **last-weekday**
3213 /// `["friL"]` fires only on the last Friday of each month (handy
3214 /// for monthly maintenance). Empty = every day. Must be empty
3215 /// when `at` carries a date (the date already pins the day).
3216 #[serde(default, skip_serializing_if = "Vec::is_empty")]
3217 pub days: Vec<String>,
3218}
3219
3220/// Parsed `CalendarSpec.at`: the wall-clock minute/hour, plus the
3221/// date for a one-shot (`None` = repeating time-of-day).
3222struct ParsedAt {
3223 minute: u32,
3224 hour: u32,
3225 date: Option<chrono::NaiveDate>,
3226}
3227
3228impl CalendarSpec {
3229 /// Parse `at`: a date+time (`YYYY-MM-DD HH:MM`, hyphen / slash /
3230 /// `T` separators) is a one-shot; a bare `HH:MM` is repeating.
3231 fn parse_at(&self) -> Result<ParsedAt, String> {
3232 use chrono::Timelike;
3233 let s = self.at.trim();
3234 for fmt in ["%Y-%m-%d %H:%M", "%Y-%m-%dT%H:%M", "%Y/%m/%d %H:%M"] {
3235 if let Ok(dt) = chrono::NaiveDateTime::parse_from_str(s, fmt) {
3236 return Ok(ParsedAt {
3237 minute: dt.minute(),
3238 hour: dt.hour(),
3239 date: Some(dt.date()),
3240 });
3241 }
3242 }
3243 if let Ok(t) = chrono::NaiveTime::parse_from_str(s, "%H:%M") {
3244 return Ok(ParsedAt {
3245 minute: t.minute(),
3246 hour: t.hour(),
3247 date: None,
3248 });
3249 }
3250 Err(format!(
3251 "when.at: unparseable '{}' (want HH:MM or YYYY-MM-DD HH:MM)",
3252 self.at
3253 ))
3254 }
3255
3256 /// Pre-flight check on the `days` tokens so a bad day name gives
3257 /// a `when.days:`-scoped error instead of croner's confusing
3258 /// "when.at lowered to invalid cron" (claude #432 review). Each
3259 /// token is a day name (`mon`..`sun`), a numeric DOW (`0`..`7`),
3260 /// `*`, a `-` range of those, an **nth-weekday** like `tue#2`
3261 /// (2nd Tuesday of the month — "Patch Tuesday"), or a
3262 /// **last-weekday** like `friL` (last Friday of the month).
3263 fn validate_days(&self) -> Result<(), String> {
3264 const NAMES: [&str; 7] = ["mon", "tue", "wed", "thu", "fri", "sat", "sun"];
3265 let is_day = |p: &str| NAMES.contains(&p) || p.parse::<u8>().is_ok_and(|n| n <= 7);
3266 for tok in &self.days {
3267 // Report the whole token on a malformed range like `mon-`
3268 // (which would otherwise split to a cryptic empty part —
3269 // claude #432 follow-up).
3270 let invalid = |reason: &str| {
3271 Err(format!(
3272 "when.days: invalid day token '{tok}' ({reason}; \
3273 want mon..sun, 0-7, a range like mon-fri, an nth-weekday \
3274 like tue#2, a last-weekday like friL, or *)"
3275 ))
3276 };
3277 // #418: nth-weekday suffix (`tue#2` = 2nd Tuesday). Croner
3278 // accepts `<dow>#<n>` (n = 1..5) in the DOW field, and
3279 // `to_cron` passes the token through verbatim, so the
3280 // engine fires only on that occurrence. It's a single
3281 // weekday + ordinal — not combinable with a range.
3282 if let Some((day_part, nth_part)) = tok.split_once('#') {
3283 // Normalize once and use `d` consistently (gemini #547);
3284 // the outer `invalid` already echoes the raw `tok`.
3285 let d = day_part.trim().to_ascii_lowercase();
3286 if d.contains('-') || !is_day(&d) {
3287 return invalid("the part before # must be a single weekday");
3288 }
3289 match nth_part.trim().parse::<u8>() {
3290 Ok(n) if (1..=5).contains(&n) => {}
3291 _ => return invalid("the # ordinal must be 1..5 (e.g. tue#2 = 2nd Tuesday)"),
3292 }
3293 continue;
3294 }
3295 // #418: last-weekday suffix (`friL` = last Friday of the
3296 // month — the monthly-maintenance sibling of Patch Tuesday).
3297 // Croner accepts `<dow>L` in the DOW field with verified
3298 // last-<dow>-of-month semantics, and `to_cron` passes it
3299 // through verbatim. A single weekday + `L` — bare `L` and
3300 // ranges are rejected (croner would read bare `L` as
3301 // Saturday, which is a confusing footgun).
3302 if let Some(day_part) = tok.strip_suffix(['L', 'l']) {
3303 // No `.trim()`: a cron DOW token can't carry internal
3304 // whitespace, so `"fri L"` must be *rejected* here (its
3305 // strip leaves `"fri "`, and `is_day` catches the space)
3306 // rather than trimmed into a clean `"fri"` that then
3307 // produces a malformed `fri L` cron downstream and a
3308 // confusing croner error (gemini #560).
3309 let d = day_part.to_ascii_lowercase();
3310 if d.is_empty() {
3311 return invalid("`L` (last-weekday) needs a weekday before it, e.g. friL");
3312 }
3313 if d.contains('-') || !is_day(&d) {
3314 return invalid(
3315 "the part before L must be a single weekday (e.g. friL = last Friday)",
3316 );
3317 }
3318 continue;
3319 }
3320 for part in tok.split('-') {
3321 let p = part.trim().to_ascii_lowercase();
3322 if p.is_empty() {
3323 return invalid("empty range bound");
3324 }
3325 if p != "*" && !is_day(&p) {
3326 return invalid(&format!("'{part}' is not a day"));
3327 }
3328 }
3329 }
3330 Ok(())
3331 }
3332
3333 /// For a one-shot (`at` carries a date), the absolute instant it
3334 /// fires in `tz`. `None` for a repeating calendar. Used to warn
3335 /// about a one-shot whose date is already in the past (it would
3336 /// never fire).
3337 pub fn oneshot_instant(&self, tz: ScheduleTz) -> Option<chrono::DateTime<chrono::Utc>> {
3338 let p = self.parse_at().ok()?;
3339 let date = p.date?;
3340 let naive = date.and_hms_opt(p.hour, p.minute, 0)?;
3341 tz.naive_to_utc(naive)
3342 }
3343
3344 /// The wall-clock time-of-day this calendar fires at (`None` if
3345 /// `at` is unparseable — validate() guards that). Used to detect
3346 /// a calendar whose fire time can never fall inside its
3347 /// `constraints.window` (claude #452 review).
3348 pub fn fire_time(&self) -> Option<chrono::NaiveTime> {
3349 let p = self.parse_at().ok()?;
3350 chrono::NaiveTime::from_hms_opt(p.hour, p.minute, 0)
3351 }
3352
3353 /// Lower to the cron string the scheduler engine runs. Repeating
3354 /// → 6-field `0 {min} {hour} * * {dow}`; one-shot → 7-field
3355 /// `0 {min} {hour} {day} {month} * {year}` (a past year never
3356 /// fires — that's what makes it one-shot).
3357 fn to_cron(&self) -> Result<String, String> {
3358 use chrono::Datelike;
3359 let ParsedAt { minute, hour, date } = self.parse_at()?;
3360 match date {
3361 Some(d) => {
3362 if !self.days.is_empty() {
3363 return Err(
3364 "when.at with a date is a one-shot and cannot be combined with days".into(),
3365 );
3366 }
3367 Ok(format!(
3368 "0 {minute} {hour} {} {} * {}",
3369 d.day(),
3370 d.month(),
3371 d.year()
3372 ))
3373 }
3374 None => {
3375 let dow = if self.days.is_empty() {
3376 "*".to_string()
3377 } else {
3378 self.validate_days()?;
3379 self.days.join(",")
3380 };
3381 Ok(format!("0 {minute} {hour} * * {dow}"))
3382 }
3383 }
3384 }
3385}
3386
3387/// The timezone a schedule's wall-clock fields (`when.at`,
3388/// `active.{from,until}`) are evaluated in (#418 Phase 2).
3389#[derive(
3390 Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Copy, PartialEq, Eq, Default,
3391)]
3392#[serde(rename_all = "snake_case")]
3393pub enum ScheduleTz {
3394 /// The running host's local timezone — the agent's for
3395 /// `runs_on: agent`, the backend server's otherwise. Default.
3396 #[default]
3397 Local,
3398 /// UTC — for timezone-independent schedules.
3399 Utc,
3400}
3401
3402impl ScheduleTz {
3403 /// Interpret a naive (zoneless) datetime as being in this tz and
3404 /// convert to UTC. On a DST *fold* (the local time occurs twice
3405 /// when clocks go back) we pick `.earliest()` rather than
3406 /// rejecting it; `None` is reserved for a true DST *gap* (a local
3407 /// time that never exists). `Utc` is fixed-offset so neither ever
3408 /// happens; `Local` is whatever timezone the running host is set
3409 /// to and *can* hit a gap/fold on any DST-observing host — not
3410 /// just the JST we run today (gemini + claude #432 review).
3411 fn naive_to_utc(self, naive: chrono::NaiveDateTime) -> Option<chrono::DateTime<chrono::Utc>> {
3412 use chrono::TimeZone;
3413 match self {
3414 ScheduleTz::Utc => Some(chrono::DateTime::from_naive_utc_and_offset(
3415 naive,
3416 chrono::Utc,
3417 )),
3418 ScheduleTz::Local => chrono::Local
3419 .from_local_datetime(&naive)
3420 .earliest()
3421 .map(|dt| dt.with_timezone(&chrono::Utc)),
3422 }
3423 }
3424
3425 /// The wall-clock time-of-day `now` reads as in this tz — used by
3426 /// [`Constraints::allows`] to test a maintenance window
3427 /// (#418 Phase 3). `Utc` is the naive UTC time; `Local` is the
3428 /// running host's local time.
3429 fn wall_time(self, now: chrono::DateTime<chrono::Utc>) -> chrono::NaiveTime {
3430 match self {
3431 ScheduleTz::Utc => now.time(),
3432 ScheduleTz::Local => now.with_timezone(&chrono::Local).time(),
3433 }
3434 }
3435
3436 /// The wall-clock *date* `now` reads as in this tz — used by
3437 /// [`Constraints::allows`] to test `skip_dates` (#418 holiday
3438 /// exclusion). Same tz semantics as [`Self::wall_time`].
3439 fn wall_date(self, now: chrono::DateTime<chrono::Utc>) -> chrono::NaiveDate {
3440 match self {
3441 ScheduleTz::Utc => now.date_naive(),
3442 ScheduleTz::Local => now.with_timezone(&chrono::Local).date_naive(),
3443 }
3444 }
3445
3446 /// Stable lowercase wire/display label (`local` / `utc`) — matches
3447 /// the serde `snake_case` representation. Used for the preview
3448 /// response's `tz` field so the JSON shape isn't coupled to the
3449 /// `Debug` repr (claude #578 review).
3450 pub fn as_str(self) -> &'static str {
3451 match self {
3452 ScheduleTz::Local => "local",
3453 ScheduleTz::Utc => "utc",
3454 }
3455 }
3456}
3457
3458impl std::fmt::Display for ScheduleTz {
3459 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
3460 f.write_str(self.as_str())
3461 }
3462}
3463
3464/// `once` vs `{ every: <humantime> }` — shared by `per_pc` /
3465/// `per_target`. Untagged so the YAML stays the bare keyword or a
3466/// one-key map, nothing more ceremonial.
3467#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, PartialEq, Eq)]
3468#[serde(untagged)]
3469pub enum PerPolicy {
3470 /// The bare string `once`: succeed once, then skip permanently
3471 /// (cooldown = infinity).
3472 Once(OnceLiteral),
3473 /// Re-arm after the humantime interval, e.g. `{ every: 6h }`.
3474 Every(EverySpec),
3475}
3476
3477/// Single-variant enum so serde accepts exactly the string `once`
3478/// (a free-form `String` would swallow typos like `onec`).
3479#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Copy, PartialEq, Eq)]
3480#[serde(rename_all = "snake_case")]
3481pub enum OnceLiteral {
3482 Once,
3483}
3484
3485/// `{ every: <humantime> }`. Standalone struct (not an inline
3486/// struct variant). `{ evry: 6h }` still fails to parse (the
3487/// required `every` key is missing), and the create boundaries
3488/// reject the unknown `evry` via [`crate::strict`] with its path —
3489/// while agents reading a future writer's extra fields tolerate
3490/// them (#492).
3491#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, PartialEq, Eq)]
3492pub struct EverySpec {
3493 /// Humantime interval (`10m`, `6h`, `1d`...). Parsed lazily —
3494 /// [`Schedule::validate`] rejects garbage at create time.
3495 pub every: String,
3496}
3497
3498impl PerPolicy {
3499 /// The cooldown this policy lowers to: `once` = `None`
3500 /// (permanent skip), `every` = the interval.
3501 fn cooldown(&self) -> Option<String> {
3502 match self {
3503 PerPolicy::Once(_) => None,
3504 PerPolicy::Every(EverySpec { every }) => Some(every.clone()),
3505 }
3506 }
3507}
3508
3509impl std::fmt::Display for When {
3510 /// Operator-facing one-liner (`per_pc once` / `per_pc every 6h`
3511 /// / `at 09:00 [mon-fri]` / `at 2026-06-10 09:00`) for log
3512 /// lines, audit payloads and the API's `ScheduleSummary`.
3513 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
3514 let policy = |p: &PerPolicy| match p {
3515 PerPolicy::Once(_) => "once".to_string(),
3516 PerPolicy::Every(EverySpec { every }) => format!("every {every}"),
3517 };
3518 match self {
3519 When::PerPc(p) => write!(f, "per_pc {}", policy(p)),
3520 When::PerTarget(p) => write!(f, "per_target {}", policy(p)),
3521 When::Calendar(c) if c.days.is_empty() => write!(f, "at {}", c.at),
3522 When::Calendar(c) => write!(f, "at {} [{}]", c.at, c.days.join(",")),
3523 When::On(triggers) => {
3524 let names: Vec<&str> = triggers.iter().map(|t| t.as_str()).collect();
3525 write!(f, "on [{}]", names.join(","))
3526 }
3527 }
3528 }
3529}
3530
3531impl OnTrigger {
3532 /// Lowercase wire/display label (matches the serde `snake_case`).
3533 pub fn as_str(self) -> &'static str {
3534 match self {
3535 OnTrigger::Startup => "startup",
3536 OnTrigger::Logon => "logon",
3537 OnTrigger::Lock => "lock",
3538 OnTrigger::Unlock => "unlock",
3539 }
3540 }
3541}
3542
3543/// Optional validity window for a [`Schedule`] (#418 decision G).
3544/// Half-open `[from, until)`; either bound may be omitted. Bounds
3545/// are `YYYY-MM-DD` (= that day's 00:00 in the schedule's `tz`) or
3546/// full RFC3339 (offset is honored as-is, `tz` ignored). Kept as
3547/// strings so the JSON Schema the SPA editor consumes stays two
3548/// plain string fields, mirroring `jitter` / `starting_deadline`.
3549///
3550/// #418 Phase 2: bounds are evaluated in the schedule's top-level
3551/// `tz` (was UTC-only in Phase 1) so `tz: local` makes both the
3552/// calendar `at` AND the `active` window local — one consistent
3553/// timezone per schedule.
3554#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Default, PartialEq, Eq)]
3555pub struct Active {
3556 /// Dormant before this instant.
3557 #[serde(default, skip_serializing_if = "Option::is_none")]
3558 pub from: Option<String>,
3559 /// Dormant from this instant on (exclusive).
3560 #[serde(default, skip_serializing_if = "Option::is_none")]
3561 pub until: Option<String>,
3562}
3563
3564impl Active {
3565 /// `skip_serializing_if` helper — an empty window means "always
3566 /// active" and is omitted from the wire format entirely.
3567 pub fn is_empty(&self) -> bool {
3568 self.from.is_none() && self.until.is_none()
3569 }
3570
3571 /// Parse one bound: RFC3339 first (offset honored, `tz`
3572 /// ignored), then bare `YYYY-MM-DD` (00:00 in `tz`).
3573 pub fn parse_bound(s: &str, tz: ScheduleTz) -> Result<chrono::DateTime<chrono::Utc>, String> {
3574 if let Ok(dt) = chrono::DateTime::parse_from_rfc3339(s) {
3575 return Ok(dt.with_timezone(&chrono::Utc));
3576 }
3577 if let Ok(d) = chrono::NaiveDate::parse_from_str(s, "%Y-%m-%d") {
3578 let midnight = d.and_hms_opt(0, 0, 0).expect("00:00:00 is always valid");
3579 return tz.naive_to_utc(midnight).ok_or_else(|| {
3580 format!("active: bound '{s}' falls in a DST gap for the schedule's tz")
3581 });
3582 }
3583 Err(format!(
3584 "active: unparseable bound '{s}' (want YYYY-MM-DD or RFC3339)"
3585 ))
3586 }
3587
3588 /// Is `now` inside the window? Unparseable bounds are treated
3589 /// as absent here (fail-open) — [`Schedule::validate`] is the
3590 /// place that rejects them loudly; this runs on every tick and
3591 /// must never panic on a stale KV blob.
3592 pub fn contains(&self, now: chrono::DateTime<chrono::Utc>, tz: ScheduleTz) -> bool {
3593 let bound = |s: &Option<String>| s.as_deref().and_then(|s| Self::parse_bound(s, tz).ok());
3594 if bound(&self.from).is_some_and(|from| now < from) {
3595 return false;
3596 }
3597 if bound(&self.until).is_some_and(|until| now >= until) {
3598 return false;
3599 }
3600 true
3601 }
3602}
3603
3604/// Operational constraints on a [`Schedule`] (#418 Phase 3). Where
3605/// [`Active`] decides *over what date range* a schedule is live,
3606/// `Constraints` decides *when, within an active period,* a fire is
3607/// allowed. `window` (a maintenance time-of-day window) and
3608/// `max_concurrent` (a fleet-wide running-instance cap) so far;
3609/// `require` (env gates) joins this struct in a later phase.
3610#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Default, PartialEq, Eq)]
3611pub struct Constraints {
3612 /// `"HH:MM-HH:MM"` wall-clock window (evaluated in the schedule's
3613 /// `tz`). Fires outside it are skipped — mainly for reconcile
3614 /// cadences ("patrol every 6h, but only fire overnight") and
3615 /// daytime change-freezes. `start > end` crosses midnight
3616 /// (`"22:00-05:00"` = 22:00 through 05:00 next morning). Parsed
3617 /// lazily; [`Schedule::validate`] rejects garbage at create time.
3618 #[serde(default, skip_serializing_if = "Option::is_none")]
3619 pub window: Option<String>,
3620 /// Fleet-wide cap on how many instances of this schedule's job may
3621 /// run **at the same time** (#418 "同時実行ハード上限"). The
3622 /// backend scheduler counts the job's still-in-flight runs
3623 /// (`execution_results.finished_at IS NULL`) each tick and only
3624 /// dispatches to as many remaining pcs as there are free slots —
3625 /// a rolling window that refills as runs complete. Useful for
3626 /// disk/CPU/network-heavy jobs you don't want hammering the whole
3627 /// fleet at once.
3628 ///
3629 /// **Backend-only** (it needs a central counter): combining it
3630 /// with `runs_on: agent` is rejected by [`Schedule::validate`]
3631 /// (#418 decision E — "中央上限には中央が要る"). Most meaningful
3632 /// for `per_pc` reconcile cadences, where the poll re-ticks and
3633 /// refills slots. `None` (default) = no cap.
3634 #[serde(default, skip_serializing_if = "Option::is_none")]
3635 pub max_concurrent: Option<u32>,
3636 /// Calendar dates the schedule must **not** fire on — holidays,
3637 /// blackout days, one-off freeze dates (#418 "祝日除外"). Each is
3638 /// `YYYY-MM-DD`, evaluated as a wall-clock date in the schedule's
3639 /// `tz`. Applies to every `when` shape (a reconcile cadence skips
3640 /// the whole day; a calendar fire landing on the date is
3641 /// suppressed) and is honored by both the live scheduler and
3642 /// `preview`, since both gate on [`Constraints::allows`]. Empty
3643 /// (default) = no skips. Operator-supplied: there is no built-in
3644 /// holiday calendar — list the dates you care about. Parsed lazily;
3645 /// [`Schedule::validate`] rejects a malformed date at create time.
3646 #[serde(default, skip_serializing_if = "Vec::is_empty")]
3647 pub skip_dates: Vec<String>,
3648}
3649
3650impl Constraints {
3651 /// `skip_serializing_if` helper — empty constraints are omitted
3652 /// from the wire format entirely.
3653 pub fn is_empty(&self) -> bool {
3654 self.window.is_none() && self.max_concurrent.is_none() && self.skip_dates.is_empty()
3655 }
3656
3657 /// The first unparseable `skip_dates` entry, if any — the
3658 /// scheduler logs it at register time so a fail-closed
3659 /// (never-firing) schedule from a hand-edited KV blob is
3660 /// diagnosable, mirroring [`Schedule::bad_window`].
3661 pub fn bad_skip_date(&self) -> Option<String> {
3662 self.skip_dates.iter().find_map(|s| {
3663 chrono::NaiveDate::parse_from_str(s.trim(), "%Y-%m-%d")
3664 .err()
3665 .map(|e| format!("constraints.skip_dates: invalid date '{s}': {e}"))
3666 })
3667 }
3668
3669 /// Parse `"HH:MM-HH:MM"` into `(start, end)`. Equal bounds are an
3670 /// error (a zero-width or all-day window is ambiguous — write no
3671 /// window for "always").
3672 pub fn parse_window(s: &str) -> Result<(chrono::NaiveTime, chrono::NaiveTime), String> {
3673 let (a, b) = s
3674 .split_once('-')
3675 .ok_or_else(|| format!("constraints.window: '{s}' must be 'HH:MM-HH:MM'"))?;
3676 let parse = |part: &str| {
3677 chrono::NaiveTime::parse_from_str(part.trim(), "%H:%M")
3678 .map_err(|e| format!("constraints.window: invalid time '{}': {e}", part.trim()))
3679 };
3680 let (start, end) = (parse(a)?, parse(b)?);
3681 if start == end {
3682 return Err(format!(
3683 "constraints.window: start and end are equal ('{s}'); omit window for 'always'"
3684 ));
3685 }
3686 Ok((start, end))
3687 }
3688
3689 /// Is a fire allowed at `now` (evaluated in `tz`)? No window =
3690 /// always allowed. Half-open `[start, end)`; `start > end`
3691 /// crosses midnight.
3692 ///
3693 /// **Fail-closed** on an unparseable window (returns `false`,
3694 /// gemini #452 review): a window is a *restrictive* constraint
3695 /// (change-freeze / overnight-only), so a corrupt one must NOT
3696 /// silently allow fires during the restricted hours. Bad windows
3697 /// are rejected at create time by [`Schedule::validate`]; this
3698 /// only bites a hand-edited KV blob, where blocking is the safe
3699 /// direction. The scheduler warns at register time
3700 /// ([`Schedule::bad_window`]) so a stuck schedule is diagnosable.
3701 /// The tick path never panics regardless.
3702 pub fn allows(&self, now: chrono::DateTime<chrono::Utc>, tz: ScheduleTz) -> bool {
3703 // #418 holiday / blackout dates: never fire on a listed wall
3704 // date (in `tz`). Checked before the window since a skipped day
3705 // overrides any within-window allowance. Fail-closed on a
3706 // corrupt entry (same posture as `window`): a skip date is a
3707 // *restrictive* constraint, so a garbled one must not silently
3708 // re-enable fires — it blocks until fixed (`validate` rejects it
3709 // at create time; `bad_skip_date` lets the scheduler warn).
3710 if !self.skip_dates.is_empty() {
3711 let today = tz.wall_date(now);
3712 let blocked = self.skip_dates.iter().any(|s| {
3713 match chrono::NaiveDate::parse_from_str(s.trim(), "%Y-%m-%d") {
3714 Ok(d) => d == today,
3715 Err(_) => true, // corrupt entry → fail-closed (block)
3716 }
3717 });
3718 if blocked {
3719 return false;
3720 }
3721 }
3722 match self.window.as_deref() {
3723 // No window → always allowed.
3724 None => true,
3725 // Window set: membership, or fail-closed if unparseable
3726 // (`window_contains` returns None for a corrupt window).
3727 Some(_) => self.window_contains(tz.wall_time(now)).unwrap_or(false),
3728 }
3729 }
3730
3731 /// Membership of a wall-clock time-of-day in the window. `None`
3732 /// when there is no window or it's unparseable (callers decide
3733 /// the failure direction). `start > end` crosses midnight.
3734 fn window_contains(&self, t: chrono::NaiveTime) -> Option<bool> {
3735 let (start, end) = Self::parse_window(self.window.as_deref()?).ok()?;
3736 Some(if start <= end {
3737 start <= t && t < end
3738 } else {
3739 t >= start || t < end
3740 })
3741 }
3742}
3743
3744/// What to do when a fire's script fails (#418 Phase 4 — the "高"
3745/// retry/backoff gap). Where [`Constraints`] gates *whether* a fire
3746/// happens, `OnFailure` decides what happens *after* one ran and
3747/// came back bad. Only `retry` so far; future `notify` / `disable`
3748/// would join the same namespace.
3749#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Default, PartialEq, Eq)]
3750pub struct OnFailure {
3751 /// Re-run the script in-process when it exits non-zero (or times
3752 /// out), up to a cap, with a fixed backoff between attempts.
3753 /// `None` (default) = no retry: a failed run is published as-is
3754 /// and (for reconcile cadences) simply re-fires on the next poll
3755 /// tick. See [`Retry`].
3756 #[serde(default, skip_serializing_if = "Option::is_none")]
3757 pub retry: Option<Retry>,
3758}
3759
3760impl OnFailure {
3761 /// `skip_serializing_if` helper — an empty policy is omitted from
3762 /// the wire format entirely.
3763 pub fn is_empty(&self) -> bool {
3764 self.retry.is_none()
3765 }
3766
3767 /// Lower the operator-facing `retry` (humantime backoff) onto the
3768 /// engine vocabulary the agent's executor runs on (backoff in
3769 /// whole seconds). Single seam shared by the backend command
3770 /// builder and the agent's local scheduler so the two stamp the
3771 /// same [`crate::wire::RetrySpec`] onto every Command. Returns
3772 /// `None` when there is no retry policy or the backoff is
3773 /// unparseable (validate() rejects the latter at create time;
3774 /// this stays fail-safe = "no retry" for a hand-edited KV blob
3775 /// rather than panicking on the fire path).
3776 pub fn lowered_retry(&self) -> Option<crate::wire::RetrySpec> {
3777 let r = self.retry.as_ref()?;
3778 let backoff_secs = humantime::parse_duration(&r.backoff).ok()?.as_secs();
3779 Some(crate::wire::RetrySpec {
3780 max: r.max,
3781 backoff_secs,
3782 })
3783 }
3784}
3785
3786/// Fixed-backoff retry policy (#418 Phase 4). `max` is the number of
3787/// *additional* attempts after the first run (so `max: 3` = up to 4
3788/// total executions); `backoff` is the humantime delay slept between
3789/// attempts. The retry happens fire-side (inside `kanade fire` /
3790/// `handle_command`) on every OS for the PoC — the Windows-native
3791/// "restart on failure" Task Scheduler path is deferred to the
3792/// native-delegation phase (#418 decision H).
3793#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, PartialEq, Eq)]
3794pub struct Retry {
3795 /// Max additional attempts after the first failure. Bounded
3796 /// `1..=10` by [`Schedule::validate`] — a typo'd `max: 1000`
3797 /// with a short backoff would otherwise pin a flapping script in
3798 /// a tight loop for the whole window.
3799 pub max: u32,
3800 /// Humantime delay slept between attempts (`"10m"`, `"30s"`).
3801 pub backoff: String,
3802}
3803
3804/// Fleet-wide change-freeze (#418 Phase 5 — the "メンテナンス窓 /
3805/// 変更凍結" gap's global half). Where [`Constraints::window`] is a
3806/// *per-schedule* time-of-day gate, a `Freeze` is a *single, fleet-
3807/// global* "stop all automated change" switch the operator flips
3808/// during an incident or a year-end change-freeze. It lives in its
3809/// own KV singleton ([`crate::kv::KEY_FREEZE`]); when present and
3810/// active, both the backend scheduler and every agent's local
3811/// scheduler skip *every* fire.
3812///
3813/// Shapes:
3814/// * `{}` (no bounds) — frozen indefinitely until the operator
3815/// clears it (incident "big red button").
3816/// * `{ from, until }` — frozen only within `[from, until)`,
3817/// evaluated in `tz` (planned change-freeze; auto-thaws).
3818///
3819/// The KV key being *absent* means "not frozen" — so clearing the
3820/// freeze is a KV delete, and `is_active` only ever runs on a freeze
3821/// the operator actually set.
3822#[derive(Serialize, Deserialize, schemars::JsonSchema, Debug, Clone, Default, PartialEq, Eq)]
3823pub struct Freeze {
3824 /// Frozen from this instant (RFC3339 or bare `YYYY-MM-DD` in
3825 /// `tz`). `None` ⇒ frozen from the beginning of time.
3826 #[serde(default, skip_serializing_if = "Option::is_none")]
3827 pub from: Option<String>,
3828 /// Thawed from this instant on, exclusive. `None` ⇒ frozen with
3829 /// no scheduled end (manual clear required).
3830 #[serde(default, skip_serializing_if = "Option::is_none")]
3831 pub until: Option<String>,
3832 /// Operator-supplied note surfaced on the freeze-skip log and the
3833 /// SPA banner ("year-end change freeze", "INC-1234"). Advisory.
3834 #[serde(default, skip_serializing_if = "Option::is_none")]
3835 pub reason: Option<String>,
3836 /// Timezone the bare-date bounds are evaluated in (RFC3339 bounds
3837 /// carry their own offset). Defaults to host-local like a
3838 /// schedule's `tz`.
3839 #[serde(default)]
3840 pub tz: ScheduleTz,
3841}
3842
3843impl Freeze {
3844 /// Is the fleet frozen at `now`? An empty window (`from`/`until`
3845 /// both absent) is frozen unconditionally; otherwise membership of
3846 /// `[from, until)` in `tz`. Half-open like [`Active::contains`],
3847 /// but **fails CLOSED** on an unparseable bound — a freeze is a
3848 /// safety switch, so a corrupt window (only reachable via a
3849 /// hand-edited KV blob; `validate` rejects it at set time) must
3850 /// mean "frozen", not "fire normally" (coderabbit #472). This is
3851 /// the one deliberate divergence from `active`'s fail-OPEN
3852 /// behaviour, where an unparseable bound dormant-skips a schedule.
3853 pub fn is_active(&self, now: chrono::DateTime<chrono::Utc>) -> bool {
3854 // Parse a bound; an unparseable one short-circuits the whole
3855 // check to `true` (frozen) via the closure's `None` sentinel
3856 // handled below.
3857 let bound = |s: &Option<String>| -> Result<Option<chrono::DateTime<chrono::Utc>>, ()> {
3858 match s.as_deref() {
3859 None => Ok(None),
3860 Some(raw) => Active::parse_bound(raw, self.tz).map(Some).map_err(|_| ()),
3861 }
3862 };
3863 let (from, until) = match (bound(&self.from), bound(&self.until)) {
3864 (Ok(f), Ok(u)) => (f, u),
3865 // Any corrupt bound → fail closed (frozen).
3866 _ => return true,
3867 };
3868 if from.is_some_and(|f| now < f) {
3869 return false;
3870 }
3871 if until.is_some_and(|u| now >= u) {
3872 return false;
3873 }
3874 true
3875 }
3876
3877 /// Reject unparseable bounds / `from >= until` at set time (the
3878 /// API + CLI counterpart to [`Schedule::validate`]).
3879 pub fn validate(&self) -> Result<(), String> {
3880 let from = self
3881 .from
3882 .as_deref()
3883 .map(|s| Active::parse_bound(s, self.tz))
3884 .transpose()
3885 .map_err(|e| e.replace("active:", "freeze:"))?;
3886 let until = self
3887 .until
3888 .as_deref()
3889 .map(|s| Active::parse_bound(s, self.tz))
3890 .transpose()
3891 .map_err(|e| e.replace("active:", "freeze:"))?;
3892 if let (Some(f), Some(u)) = (from, until) {
3893 if f >= u {
3894 return Err(format!(
3895 "freeze.from ({}) must be strictly before freeze.until ({})",
3896 self.from.as_deref().unwrap_or_default(),
3897 self.until.as_deref().unwrap_or_default(),
3898 ));
3899 }
3900 }
3901 Ok(())
3902 }
3903}
3904
3905/// The system-generated poll cadence every reconcile-shaped `when`
3906/// lowers to. Operators never write this: the real inter-run
3907/// spacing is the `every` cooldown; this only bounds "how soon do
3908/// we notice somebody is due" (#418 decision B took the poll
3909/// period away from the operator).
3910pub const POLL_CRON: &str = "0 * * * * *";
3911
3912/// What a [`When`] lowers to — the exact (cron, mode, cooldown)
3913/// trio the pre-#418 engine ran on. Keeping the engine vocabulary
3914/// unchanged is what lets Phase 1 swap the operator surface without
3915/// touching the tick / dedup machinery.
3916pub struct Lowered {
3917 /// Cron handed to `tokio-cron-scheduler` — [`POLL_CRON`] for
3918 /// reconcile shapes, a 6/7-field cron for calendar shapes.
3919 pub cron: String,
3920 /// Dedup semantics for `decide_fire`.
3921 pub mode: ExecMode,
3922 /// Humantime re-arm interval (`None` = succeed once, skip
3923 /// forever).
3924 pub cooldown: Option<String>,
3925 /// Timezone to evaluate `cron` in (#418 Phase 2). The scheduler
3926 /// passes this to `Job::new_async_tz`. Reconcile shapes carry
3927 /// the schedule's tz too even though POLL_CRON is tz-agnostic,
3928 /// so the same value drives the `active`-window check.
3929 pub tz: ScheduleTz,
3930}
3931
3932impl Schedule {
3933 /// The error message if this schedule's `constraints.window` is
3934 /// set but unparseable, else `None`. The scheduler logs this at
3935 /// register time so a fail-closed (never-firing) schedule from a
3936 /// hand-edited KV blob is diagnosable (gemini #452 review).
3937 pub fn bad_window(&self) -> Option<String> {
3938 let w = self.constraints.window.as_deref()?;
3939 Constraints::parse_window(w).err()
3940 }
3941
3942 /// True when this is a `calendar` schedule whose fire time can
3943 /// never fall inside its `constraints.window` — the cron fires,
3944 /// the window check rejects it, and (firing only at that
3945 /// time-of-day) it effectively never runs. An easy misconfig to
3946 /// set up by accident; the scheduler warns at register time
3947 /// (claude #452 review). Reconcile shapes poll every minute, so
3948 /// they always catch the window opening and aren't affected.
3949 pub fn calendar_outside_window(&self) -> bool {
3950 let When::Calendar(c) = &self.when else {
3951 return false;
3952 };
3953 let Some(t) = c.fire_time() else {
3954 return false;
3955 };
3956 matches!(self.constraints.window_contains(t), Some(false))
3957 }
3958
3959 /// Up to `count` future instants this schedule will fire, as
3960 /// absolute UTC, strictly after `now` — the dry-run / preview
3961 /// surface (#418 "ドライラン / プレビュー"). Only **calendar**
3962 /// schedules have discrete fire times; reconcile shapes
3963 /// (`per_pc`/`per_target`) poll every minute gated by cooldown, so
3964 /// they return an empty vec and the caller describes the cadence
3965 /// instead. Occurrences outside the `active.{from,until}` window or
3966 /// the `constraints.window` are **skipped**, so the list reflects
3967 /// when the schedule will ACTUALLY run, not the raw cron ticks.
3968 /// Evaluated in the schedule's `tz`, exactly like the scheduler's
3969 /// `Job::new_async_tz`, and with the same croner config the
3970 /// scheduler / [`Schedule::validate`] use, so a preview can never
3971 /// disagree with a real fire. A schedule that can never fire (a
3972 /// calendar time wholly outside its window, a past one-shot,
3973 /// `enabled: false` is *not* considered here — callers gate on
3974 /// `enabled` separately) yields an empty vec.
3975 pub fn preview_fires(
3976 &self,
3977 now: chrono::DateTime<chrono::Utc>,
3978 count: usize,
3979 ) -> Vec<chrono::DateTime<chrono::Utc>> {
3980 use croner::parser::{CronParser, Seconds};
3981 if !matches!(self.when, When::Calendar(_)) {
3982 return Vec::new();
3983 }
3984 // Same lowering + croner config as `next_calendar_fire` and the
3985 // live scheduler, so a preview can never disagree with a real
3986 // fire. `preview_fires` adds the N-occurrence walk and the
3987 // active / window filtering on top of that single seam.
3988 let lowered = self.lowered();
3989 let Ok(cron) = CronParser::builder()
3990 .seconds(Seconds::Required)
3991 .dom_and_dow(true)
3992 .build()
3993 .parse(&lowered.cron)
3994 else {
3995 return Vec::new();
3996 };
3997 let accept = |utc: chrono::DateTime<chrono::Utc>| {
3998 self.active.contains(utc, self.tz) && self.constraints.allows(utc, self.tz)
3999 };
4000 match self.tz {
4001 ScheduleTz::Utc => Self::next_occurrences(&cron, now, count, accept),
4002 ScheduleTz::Local => {
4003 Self::next_occurrences(&cron, now.with_timezone(&chrono::Local), count, accept)
4004 }
4005 }
4006 }
4007
4008 /// Walk croner forward from `after` collecting up to `count`
4009 /// accepted occurrences (converted to UTC). Generic over the tz the
4010 /// cron is evaluated in so `preview_fires` can run it in either
4011 /// `Utc` or `Local` without duplicating the loop.
4012 fn next_occurrences<Tz>(
4013 cron: &croner::Cron,
4014 after: chrono::DateTime<Tz>,
4015 count: usize,
4016 accept: impl Fn(chrono::DateTime<chrono::Utc>) -> bool,
4017 ) -> Vec<chrono::DateTime<chrono::Utc>>
4018 where
4019 Tz: chrono::TimeZone,
4020 {
4021 // Bound the scan so an `active`/window dead-end (every future
4022 // tick rejected) can't spin forever: ~4096 raw ticks covers
4023 // >10y of a daily calendar while staying instant for croner.
4024 const SCAN_CAP: usize = 4096;
4025 let mut out = Vec::with_capacity(count.min(SCAN_CAP));
4026 let mut cursor = after;
4027 let mut scanned = 0usize;
4028 while out.len() < count && scanned < SCAN_CAP {
4029 scanned += 1;
4030 let Ok(next) = cron.find_next_occurrence(&cursor, false) else {
4031 break;
4032 };
4033 let utc = next.with_timezone(&chrono::Utc);
4034 if accept(utc) {
4035 out.push(utc);
4036 }
4037 // `find_next_occurrence(.., inclusive = false)` already
4038 // advances strictly past `cursor`, so handing it `next`
4039 // verbatim gets the following occurrence — no manual +1s
4040 // nudge (and `DateTime<Tz>` is `Copy`, so no clone).
4041 cursor = next;
4042 }
4043 out
4044 }
4045
4046 /// Lower the operator-facing `when` onto the engine vocabulary.
4047 /// Single seam shared by the backend scheduler and the agent's
4048 /// local scheduler so the two can never drift.
4049 pub fn lowered(&self) -> Lowered {
4050 let tz = self.tz;
4051 match &self.when {
4052 When::PerPc(p) => Lowered {
4053 cron: POLL_CRON.into(),
4054 mode: ExecMode::OncePerPc,
4055 cooldown: p.cooldown(),
4056 tz,
4057 },
4058 When::PerTarget(p) => Lowered {
4059 cron: POLL_CRON.into(),
4060 mode: ExecMode::OncePerTarget,
4061 cooldown: p.cooldown(),
4062 tz,
4063 },
4064 // `to_cron` only fails on a malformed `at` (rejected by
4065 // validate() at create time). For a hand-edited KV blob
4066 // that slipped past, emit a deliberately-invalid cron so
4067 // register()'s Job::new_async_tz fails → warn+skip,
4068 // rather than firing at the wrong time.
4069 When::Calendar(c) => Lowered {
4070 cron: c
4071 .to_cron()
4072 .unwrap_or_else(|_| "# invalid calendar at".into()),
4073 mode: ExecMode::EveryTick,
4074 cooldown: None,
4075 tz,
4076 },
4077 // Event triggers have no cron — the agent fires them from an
4078 // OS event source. The `# event-trigger` cron is never
4079 // registered (the scheduler branches on `is_event()` first),
4080 // but keep it deliberately-invalid as a belt-and-suspenders
4081 // so a stray registration would fail rather than misfire.
4082 When::On(_) => Lowered {
4083 cron: "# event-trigger (no cron)".into(),
4084 mode: ExecMode::Event,
4085 cooldown: None,
4086 tz,
4087 },
4088 }
4089 }
4090
4091 /// True when this schedule fires from an OS event (`when: { on }`)
4092 /// rather than a clock — the agent skips `tokio-cron` registration
4093 /// for these and drives them from boot / session-change instead.
4094 pub fn is_event(&self) -> bool {
4095 matches!(self.when, When::On(_))
4096 }
4097
4098 /// The OS event triggers this schedule listens for, or `&[]` when it
4099 /// is not an event schedule.
4100 pub fn event_triggers(&self) -> &[OnTrigger] {
4101 match &self.when {
4102 When::On(t) => t,
4103 _ => &[],
4104 }
4105 }
4106
4107 /// The next absolute (UTC) time this schedule fires, or `None` when
4108 /// it has no discrete upcoming fire to preview.
4109 ///
4110 /// Used by the KLP `maintenance.list` preview ("what's about to
4111 /// happen on my PC", SPEC §2.1). Returns `None` for:
4112 ///
4113 /// - reconcile shapes (`per_pc` / `per_target`) — they lower to the
4114 /// every-minute [`POLL_CRON`] and re-converge state continuously,
4115 /// so "next fire" is always ~60s away and means nothing to a user
4116 /// previewing upcoming maintenance;
4117 /// - a calendar schedule whose lowered cron won't parse (a
4118 /// hand-edited KV blob that slipped past [`Schedule::validate`]);
4119 /// - a cron with no future occurrence.
4120 ///
4121 /// The wall-clock fire is evaluated in the schedule's own `tz`
4122 /// (matching the live tick's `Job::new_async_tz`) then normalised
4123 /// to UTC for the wire. `inclusive = false`: strictly the *next*
4124 /// fire after `now`, never one matching the current instant.
4125 pub fn next_calendar_fire(
4126 &self,
4127 now: chrono::DateTime<chrono::Utc>,
4128 ) -> Option<chrono::DateTime<chrono::Utc>> {
4129 if !matches!(self.when, When::Calendar(_)) {
4130 return None;
4131 }
4132 let lowered = self.lowered();
4133 // Same parser configuration tokio-cron-scheduler 0.15 uses
4134 // internally, so this can never compute a fire the live
4135 // scheduler wouldn't (seconds required, DOM-and-DOW honored).
4136 let cron = croner::parser::CronParser::builder()
4137 .seconds(croner::parser::Seconds::Required)
4138 .dom_and_dow(true)
4139 .build()
4140 .parse(&lowered.cron)
4141 .ok()?;
4142 match lowered.tz {
4143 ScheduleTz::Utc => cron.find_next_occurrence(&now, false).ok(),
4144 ScheduleTz::Local => {
4145 let now_local = now.with_timezone(&chrono::Local);
4146 cron.find_next_occurrence(&now_local, false)
4147 .ok()
4148 .map(|t| t.with_timezone(&chrono::Utc))
4149 }
4150 }
4151 }
4152
4153 /// Cross-field semantic checks that don't fit pure serde derive
4154 /// — the [`Manifest::validate`] counterpart (#418 decision F;
4155 /// pre-Phase-1 a broken schedule was accepted at create time
4156 /// and silently warn-skipped at tick time). Run at every create
4157 /// site: `kanade schedule create` (client-side) and
4158 /// `POST /api/schedules`. The job_id-exists check lives in the
4159 /// API handler instead — it needs the JOBS KV.
4160 pub fn validate(&self) -> Result<(), String> {
4161 if matches!(self.runs_on, RunsOn::Agent) && matches!(self.when, When::PerTarget(_)) {
4162 return Err(
4163 "when.per_target needs fleet-wide completion data and is backend-only; \
4164 it cannot be combined with runs_on: agent (each agent self-schedules, \
4165 so per-target dedup would be deduping across a target of 1)"
4166 .into(),
4167 );
4168 }
4169 // #418 event triggers: the agent owns the OS event source
4170 // (boot / session-change), so `when: { on }` is agent-only and
4171 // needs at least one trigger.
4172 if let When::On(triggers) = &self.when {
4173 if !matches!(self.runs_on, RunsOn::Agent) {
4174 return Err(
4175 "when.on (OS event trigger) is fired by the agent's own event \
4176 source, so it requires runs_on: agent"
4177 .into(),
4178 );
4179 }
4180 if triggers.is_empty() {
4181 return Err(
4182 "when.on must list at least one trigger (e.g. [startup, logon])".into(),
4183 );
4184 }
4185 }
4186 if let Some(cd) = self.lowered().cooldown.as_deref() {
4187 humantime::parse_duration(cd)
4188 .map_err(|e| format!("when.every: invalid duration '{cd}': {e}"))?;
4189 }
4190 if let When::Calendar(c) = &self.when {
4191 // Lower the calendar form to its cron (catches a bad `at`
4192 // and the date+days conflict), then validate that cron
4193 // with the same parser configuration tokio-cron-scheduler
4194 // 0.15 uses internally (croner, seconds required,
4195 // DOM-and-DOW both honored, year optional) — create-time
4196 // validation can never accept what register() rejects.
4197 let cron = c.to_cron()?;
4198 croner::parser::CronParser::builder()
4199 .seconds(croner::parser::Seconds::Required)
4200 .dom_and_dow(true)
4201 .build()
4202 .parse(&cron)
4203 .map_err(|e| format!("when.at lowered to invalid cron '{cron}': {e}"))?;
4204 }
4205 // The other humantime strings on the schedule (claude #419
4206 // review): runtime degrades gracefully on both (bad jitter →
4207 // silent no-op, bad starting_deadline → warn + skipped tick),
4208 // but "rejected at create time" should cover every field the
4209 // operator can typo, not just `when`.
4210 if let Some(j) = &self.plan.jitter {
4211 humantime::parse_duration(j)
4212 .map_err(|e| format!("jitter: invalid duration '{j}': {e}"))?;
4213 }
4214 if let Some(sd) = &self.starting_deadline {
4215 humantime::parse_duration(sd)
4216 .map_err(|e| format!("starting_deadline: invalid duration '{sd}': {e}"))?;
4217 }
4218 let from = self
4219 .active
4220 .from
4221 .as_deref()
4222 .map(|s| Active::parse_bound(s, self.tz))
4223 .transpose()?;
4224 let until = self
4225 .active
4226 .until
4227 .as_deref()
4228 .map(|s| Active::parse_bound(s, self.tz))
4229 .transpose()?;
4230 if let (Some(f), Some(u)) = (from, until) {
4231 if f >= u {
4232 return Err(format!(
4233 "active.from ({}) must be strictly before active.until ({})",
4234 self.active.from.as_deref().unwrap_or_default(),
4235 self.active.until.as_deref().unwrap_or_default(),
4236 ));
4237 }
4238 }
4239 // #418 Phase 3: a bad maintenance window is rejected at create
4240 // time (parse_window also catches equal bounds).
4241 if let Some(w) = self.constraints.window.as_deref() {
4242 Constraints::parse_window(w)?;
4243 }
4244 // #418 holiday exclusion: reject a malformed skip date at create
4245 // time so the fail-closed `allows` path only ever bites a
4246 // hand-edited KV blob, not a fresh `kanade schedule create`.
4247 if let Some(err) = self.constraints.bad_skip_date() {
4248 return Err(err);
4249 }
4250 // #418: constraints.max_concurrent is a central running-instance
4251 // cap, so it needs the backend's counter — reject it on
4252 // runs_on: agent (decision E), and reject a meaningless 0.
4253 if let Some(mc) = self.constraints.max_concurrent {
4254 // Check the structural incompatibility (agent has no central
4255 // counter) before the value range, so a `max_concurrent: 0`
4256 // + `runs_on: agent` combo reports the more fundamental
4257 // problem first (claude #542).
4258 if matches!(self.runs_on, RunsOn::Agent) {
4259 return Err(
4260 "constraints.max_concurrent needs a central counter and is backend-only; \
4261 it cannot be combined with runs_on: agent (each agent self-schedules, \
4262 so there is no fleet-wide count to cap against)"
4263 .into(),
4264 );
4265 }
4266 if mc == 0 {
4267 return Err(
4268 "constraints.max_concurrent must be >= 1 (0 would never fire; \
4269 omit it for no cap)"
4270 .into(),
4271 );
4272 }
4273 }
4274 // #418 Phase 4: a bad on_failure.retry is rejected at create
4275 // time — backoff must be valid humantime, and max is bounded
4276 // so a typo can't pin a flapping script in a tight loop.
4277 if let Some(r) = &self.on_failure.retry {
4278 let backoff = humantime::parse_duration(&r.backoff).map_err(|e| {
4279 format!(
4280 "on_failure.retry.backoff: invalid duration '{}': {e}",
4281 r.backoff
4282 )
4283 })?;
4284 // The wire form lowers backoff to whole seconds, so a
4285 // sub-second value would silently become a 0s no-wait
4286 // (coderabbit #466). Reject it rather than honour a backoff
4287 // the operator can't actually get.
4288 if backoff.as_secs() < 1 {
4289 return Err(format!(
4290 "on_failure.retry.backoff must be >= 1s (got '{}'); sub-second backoffs \
4291 round to 0 on the wire",
4292 r.backoff
4293 ));
4294 }
4295 if !(1..=10).contains(&r.max) {
4296 return Err(format!(
4297 "on_failure.retry.max must be 1..=10 (got {}); it counts additional \
4298 attempts after the first run",
4299 r.max
4300 ));
4301 }
4302 }
4303 Ok(())
4304 }
4305}
4306
4307fn default_true() -> bool {
4308 true
4309}