Skip to main content

microvms_core/control/
mod.rs

1// SPDX-License-Identifier: Apache-2.0
2//! The control-plane client: SigV4-signed rest-json, and every trap closed before the
3//! request leaves the process.
4//!
5//! # The shape of the thing
6//!
7//! [`ControlPlane`] is the whole surface. It holds a [`transport::Transport`] (signed and
8//! real, or a contract recorder in a test), a [`Region`], and a [`Clock`] — and every
9//! operation is a method on it. There is no builder, no config struct, and no partially
10//! constructed state: [`ControlPlane::new`] resolves credentials and either yields a
11//! usable client or says why not.
12//!
13//! # What is closed here, and how strongly
14//!
15//! * **TRAP-1** — [`token`]: image tokens are always fresh. Run tokens are fresh unless
16//!   explicitly persisted for recovery of one launch. Never reuse them for a new VM.
17//! * **TRAP-2** — [`image`]: a build stuck in `CREATING` past the stall grace with every
18//!   build `PENDING` is rejected naming the replay signature. S2.
19//! * **TRAP-3** — [`CreateImageRequest::repair_guest_identity`] is a `bool`, and the
20//!   request injects `["ALL"]` itself. There is no capability list to put
21//!   `CAP_SYS_ADMIN` in. S1.
22//! * **TRAP-4** — [`connector::ConnectorIntent`]: connectors are derived ARNs from a
23//!   closed intent enum. S1.
24//! * **TRAP-5** — [`RunHookPayload`]: 4096 bytes inclusive, checked before any call. S2,
25//!   and the type means an unchecked string cannot reach the field.
26//! * **TRAP-8** — [`ControlPlane::wait_for_running`]: a terminal state before RUNNING is
27//!   rejected with the state *and* `stateReason` attached. S2.
28//! * **TRAP-11, revised again** — `mint_shell_auth_token` exists now, and the guard
29//!   changed ground with it: the closure is no longer the method's absence but the exec
30//!   path's separation from it, which is why the test still counts the calls a full
31//!   lifecycle made and asserts zero shell operations among them. The connector half is
32//!   unchanged: `SHELL_INGRESS` is a [`connector::ConnectorIntent`] variant, and the
33//!   lifecycle test asserts a launch carries exactly the connectors its caller asked
34//!   for. See [`connector`].
35//!
36//! # TRAP-11 is the one that needs saying out loud
37//!
38//! `CreateMicrovmShellAuthToken` is implemented — issue #69 builds `microvm shell` on
39//! it, and [`ControlPlane::mint_shell_auth_token`] is its one door. The original reason
40//! for staying away entirely — that the shell gates a console-only debugging flow, not
41//! a programmatic exec path — did not survive measurement: `docs/PLATFORM.md`
42//! (2026-08-15) found a real PTY over a WebSocket, programmatically drivable. What
43//! holds is narrower: **one interactive session is not programmatic exec** — no exec
44//! ids, no idempotency, no separated stdout/stderr, no exit codes — so the exec path
45//! never requests the shell connector and never mints a shell token, and the shell is
46//! its own surface ([`crate::session::shell`]) rather than a method the exec path can
47//! wander into.
48//!
49//! # Nothing in this module reads the service model at runtime
50//!
51//! Every constraint is a constant in [`crate::constants`], checked by the build gate
52//! against the pinned model (TRAP-12). That matters because botocore's
53//! `VALIDATED_METADATA_ATTRS` is `{required, min, document, union}` — `max`, `pattern`,
54//! and `enum` violations go to the wire — so every guard in this module is load-bearing
55//! rather than belt-and-braces, and "the SDK validates the model already" was never true.
56//!
57//! # And "botocore validates `min`" was never true *of this client*
58//!
59//! The sentence above is about `max`, `pattern`, and `enum`, and for a while it left `min`
60//! implicitly exempt: `min` **is** in `VALIDATED_METADATA_ATTRS`, so a `min` violation really is
61//! refused before the wire — by botocore. This client does not use botocore. It signs with
62//! `aws-sigv4` and sends with `reqwest`, and `validate.py` is nowhere in the dependency graph.
63//! That reasoning came from the deleted Python client, where it held, and it did not survive the
64//! port; issue #24 measured the consequence, `maxIdleDurationSeconds: 59` on the wire.
65//!
66//! So the rule is simpler than it was: **every constraint the model states on a member this
67//! client sends is enforced by this module or by nothing.** The guards below are the whole of it:
68//!
69//! * [`require_valid_image_name`] — `ImageName` (1..=64, `[a-zA-Z0-9-_]+`).
70//! * [`require_duration_in_range`] — `maximumDurationInSeconds` (1..=28800).
71//! * [`require_valid_version`] — `Version` (1..=2048, `[^\s]+`).
72//! * [`require_non_blank`] — `NonBlankString`, the model's most-reused shape.
73//! * [`require_valid_identifier`] — `MicrovmIdentifier`/`MicrovmImageIdentifier` (1..=256).
74//! * [`require_valid_role_arn`] — `RoleArn` (20..=2048, plus the twelve-digit account).
75//! * [`require_valid_port`] — `PortNumber`/`HooksPortInteger` (`min: 1`; 0 is not a port).
76//! * [`require_idle_duration`] — `maxIdleDurationSeconds` (`min: 60`).
77//! * [`require_valid_tags`] — `TagKey`/`TagValue`, two ceilings and two minima.
78//!
79//! Three constraints are closed by a **type** rather than by a function, which is the stronger
80//! form: [`RunHookPayload`] cannot hold over 4096 bytes, [`ops::VersionStatus`] and
81//! [`ops::HookState`] cannot spell a value the enum does not have, and
82//! [`connector::ConnectorIntent`] cannot name a connector the platform does not publish. A
83//! constraint the type system enforces cannot be forgotten at a call site.
84
85pub mod artifact;
86pub mod connector;
87pub mod context;
88pub mod ensure;
89pub mod image;
90pub mod microvm;
91pub mod ops;
92pub mod services;
93pub mod token;
94pub mod transport;
95
96use std::sync::Arc;
97use std::time::Duration;
98
99pub use artifact::{
100    BaseImage, Ecosystem, ProjectFiles, WrapOptions, artifact_content_hash, build_artifact,
101    default_dockerfile, wrap_dockerfile,
102};
103pub use connector::{
104    ConnectorIntent, EgressPosture, PLATFORM_HONOURS_OMITTED_EGRESS, egress_posture_for,
105};
106pub use context::{BuildContext, ContextEntry};
107pub use ensure::{EnsureImageRequest, EnsuredImage};
108pub use image::{Image, WaitOpts};
109pub use microvm::{Microvm, MicrovmFilter, ProxyToken, RunHookPayload};
110pub use services::{BuildServices, SignedBuildServices};
111
112use crate::error::{Error, ErrorKind};
113use crate::hooks::{BuildHookTimeout, RunHookTimeout};
114use crate::region::Region;
115use crate::sizing::SizeClass;
116
117/// The default agent port, matching the daemon's own default.
118pub const DEFAULT_AGENT_PORT: u16 = 9000;
119
120/// Monotonic time and sleeping, injectable so a wait can be tested without waiting.
121///
122/// # Why a trait rather than `tokio::time::pause`
123///
124/// Because the waits here are driven by *elapsed* comparisons against a deadline and a
125/// stall grace, and a test has to be able to say "now 300 seconds have passed" between two
126/// polls of a fake control plane. A paused tokio clock can do that, but only for code that
127/// sleeps on tokio — and it makes every test in the file share one global clock state.
128/// A [`Clock`] parameter makes the dependency visible in the signature.
129///
130/// Monotonic rather than wall-clock, and this is the same reasoning the Python client's
131/// injectable `time.monotonic` carries: the suspended window is a *duration*, and a wall
132/// clock that steps backward would reopen a closed one.
133pub trait Clock: Send + Sync {
134    /// Monotonic elapsed time since this clock started. Never decreases.
135    fn elapsed(&self) -> Duration;
136
137    /// Sleeps for `duration`.
138    fn sleep(
139        &self,
140        duration: Duration,
141    ) -> std::pin::Pin<Box<dyn std::future::Future<Output = ()> + Send + '_>>;
142}
143
144/// The real clock: `Instant` and `tokio::time::sleep`.
145#[derive(Debug)]
146pub struct SystemClock {
147    started: std::time::Instant,
148}
149
150impl SystemClock {
151    pub fn new() -> Self {
152        Self {
153            started: std::time::Instant::now(),
154        }
155    }
156}
157
158impl Default for SystemClock {
159    fn default() -> Self {
160        Self::new()
161    }
162}
163
164impl Clock for SystemClock {
165    fn elapsed(&self) -> Duration {
166        self.started.elapsed()
167    }
168
169    fn sleep(
170        &self,
171        duration: Duration,
172    ) -> std::pin::Pin<Box<dyn std::future::Future<Output = ()> + Send + '_>> {
173        Box::pin(tokio::time::sleep(duration))
174    }
175}
176
177/// The control-plane client.
178///
179/// The transport and clock sit behind `Arc`, so a caller holding one across tasks does not
180/// need a second credential chain.
181pub struct ControlPlane {
182    transport: Arc<dyn transport::Transport>,
183    region: Region,
184    clock: Arc<dyn Clock>,
185    /// The agent port, which the hooks block and the proxy token both need.
186    port: u16,
187}
188
189impl std::fmt::Debug for ControlPlane {
190    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
191        f.debug_struct("ControlPlane")
192            .field("region", &self.region)
193            .field("port", &self.port)
194            .finish_non_exhaustive()
195    }
196}
197
198impl ControlPlane {
199    /// Resolves credentials for `region` and returns a usable client.
200    ///
201    /// The region is a [`Region`], so an unsupported one is either a compile error or a
202    /// visible [`Region::unlisted`] at the call site — TRAP-6 is closed by the type before
203    /// this function is reached, which is why there is no region check here.
204    pub async fn new(region: Region) -> Result<Self, Error> {
205        let transport = transport::SignedTransport::new(region.clone()).await?;
206        Ok(Self {
207            transport: Arc::new(transport),
208            region,
209            clock: Arc::new(SystemClock::new()),
210            port: DEFAULT_AGENT_PORT,
211        })
212    }
213
214    /// A client over a caller-supplied transport and clock.
215    ///
216    /// The seam every test uses, and the reason it is public rather than `cfg(test)`: the
217    /// state-machine lane (T-W3-6) drives a `ControlPlane` and needs the same seam to test
218    /// its own lifecycle without AWS. A caller who passes a real transport here gets
219    /// exactly what [`ControlPlane::new`] builds.
220    pub fn with_transport(
221        transport: Arc<dyn transport::Transport>,
222        region: Region,
223        clock: Arc<dyn Clock>,
224    ) -> Self {
225        Self {
226            transport,
227            region,
228            clock,
229            port: DEFAULT_AGENT_PORT,
230        }
231    }
232
233    /// Sets the agent port the hooks block and the proxy token name.
234    ///
235    /// # Why this is fallible where every other builder method is not
236    ///
237    /// Because `port` is the one value on this type that the model bounds, and 0 is a value a
238    /// caller reaches for on purpose. `PortNumber` and `HooksPortInteger` are both `min: 1`;
239    /// `u16` closes the ceiling and nothing closed the floor, so before this returned a `Result`
240    /// the port set here landed in two places on the wire — `hooks.port` on every
241    /// `CreateMicrovmImage` built through the plane, and `allowedPorts: [{"port": 0}]` on every
242    /// token it minted (issue #24).
243    ///
244    /// Both of those are guarded at the call itself as well ([`require_valid_port`] in
245    /// [`ControlPlane::create_image`] and in [`ControlPlane::mint_auth_token_for`]), so the
246    /// constraint would be closed without this. It is fallible anyway because the two refusals
247    /// arrive a long way from the mistake: the create one after an artifact upload, and the mint
248    /// one at the moment a session needs a credential. Refusing here means `--port 0` fails
249    /// before a control plane is even usable, which is the difference between "that port is not
250    /// legal" and "your launch failed".
251    ///
252    /// Zero rather than the ceiling is what this actually catches, and it is not a typo case: 0
253    /// is what "let the kernel choose" means to a listener, so it is the value a caller passes
254    /// when they have a socket they have not bound yet.
255    pub fn with_port(mut self, port: u16) -> Result<Self, Error> {
256        require_valid_port("port", port)?;
257        self.port = port;
258        Ok(self)
259    }
260
261    /// The region every ARN in a request is derived for.
262    pub fn region(&self) -> &Region {
263        &self.region
264    }
265
266    /// The agent port.
267    pub fn port(&self) -> u16 {
268        self.port
269    }
270
271    pub(crate) fn transport(&self) -> &dyn transport::Transport {
272        self.transport.as_ref()
273    }
274
275    pub(crate) fn clock(&self) -> &dyn Clock {
276        self.clock.as_ref()
277    }
278}
279
280/// Everything `CreateMicrovmImage` needs, with the traps closed in the type.
281///
282/// # What is deliberately not here
283///
284/// A `client_token` field. See [`token`] for the fifteen-hour wedge that absence prevents;
285/// [`CreateImageRequest::token_scope`] is a **label** folded in beside a fresh nonce and
286/// cannot become the token.
287///
288/// A `capabilities` list. See `repair_guest_identity`.
289///
290/// An `architecture` field. The model's enum has exactly one value, so the only thing a
291/// field could express is a rejected request — and the rejection arrives *after* the
292/// artifact upload, reported as a constraint on a field the caller thought was a choice.
293/// `ARM_64` is injected. A caller who built an x86 binary finds out from `doctor`'s ELF
294/// check, not from a build cycle.
295#[derive(Clone, Debug)]
296pub struct CreateImageRequest {
297    /// The image name. Validated against `ImageName` (1..=64, `[a-zA-Z0-9-_]+`) before the
298    /// artifact is uploaded, because AWS's rejection arrives *after* the upload.
299    pub name: String,
300    /// The base image, pairing the `baseImageArn` with the Dockerfile `FROM`.
301    pub base_image: BaseImage,
302    /// `baseImageVersion`, or `None` to take whatever the service currently defaults to.
303    ///
304    /// # Why pinning is worth a field
305    ///
306    /// Without it a build floats. The managed base's version list is not static — `al2023-1`
307    /// carried one version in June and two by July (`"0"` and `"1"`, measured 2026-08-16) — so
308    /// two builds of identical inputs weeks apart can sit on different bases, and neither
309    /// recorded which. That is a reproducibility hole with no local symptom: the build
310    /// succeeds either way, and the difference appears in the guest.
311    ///
312    /// `None` is the default and stays the default, because pinning without knowing the legal
313    /// values is how a caller pins to a version that has been withdrawn.
314    /// [`ControlPlane::managed_base_versions`] is what answers that, and the version strings
315    /// are **bare integers** for a managed base where a custom image's are `"1.0"` — the two
316    /// are not comparable, so a value from anywhere else does not belong here.
317    ///
318    /// Checked against the `Version` shape before the call, because the create happens after
319    /// the artifact upload.
320    pub base_image_version: Option<String>,
321    /// The Dockerfile, or `None` for the derived default.
322    ///
323    /// A caller-supplied one is checked against `base_image`'s `docker_ref`: the two
324    /// disagreeing builds against a base none of the measured platform behaviour applies
325    /// to.
326    pub dockerfile: Option<String>,
327    /// The daemon binary's bytes, zipped into the artifact.
328    pub binary: Vec<u8>,
329    /// The project's dependency files — the lockfile plus its manifest — zipped into the
330    /// artifact beside the Dockerfile, or `None` for an image with no environment layer.
331    ///
332    /// This is what lets the derived Dockerfile's install step (`uv sync --locked`,
333    /// `npm ci`, `cargo fetch` per [`Ecosystem`]) see the files it installs from (#74).
334    /// The entry names are fixed by the ecosystem; there is no way to put an arbitrary
335    /// file into the shared snapshot through this field, which is the TRAP-5 property
336    /// restated as a type.
337    pub project_files: Option<ProjectFiles>,
338    /// Where the artifact is uploaded to. `create_image` does not upload: the caller puts
339    /// the bytes there and passes the URI. [`crate::sandbox::Sandbox::ensure_image`] is the
340    /// path that uploads for itself ([`services`]).
341    pub code_artifact_uri: String,
342    /// The build role, which must grant logs on `/aws/lambda-microvms/*`.
343    pub build_role_arn: String,
344    /// The size class. Selects a documented baseline; it does not size the VM (TRAP-10).
345    pub size: SizeClass,
346    /// Whether to repair guest identity (TRAP-3).
347    ///
348    /// # Why a bool and not a capability list
349    ///
350    /// Measured 2026-08-06: without the capability, a guest running as root still gets
351    /// `EPERM` from `sethostname` and from a bind mount over
352    /// `/proc/sys/kernel/random/boot_id`, because the MicroVM drops `CAP_SYS_ADMIN` by
353    /// default. Writing `/etc/machine-id` needs no capability and succeeds either way,
354    /// which is what makes the gap easy to miss — identity repair looks like it works
355    /// until you check the two steps that need the kernel's permission rather than the
356    /// filesystem's.
357    ///
358    /// `Capability`'s enum is exactly `["ALL"]`, so there is no way to ask for
359    /// `CAP_SYS_ADMIN` alone. A list parameter would let a caller write
360    /// `["CAP_SYS_ADMIN"]` — the request AWS rejects *after* the artifact upload — so the
361    /// intent is a boolean and the request injects `["ALL"]` itself.
362    pub repair_guest_identity: bool,
363    /// Whether the daemon should inherit the image's `WORKDIR`.
364    ///
365    /// Rejected when nothing declares one: most public ARM64 bases leave it empty, so the
366    /// inheritance silently resolves to `/` and the symptom appears in the guest a build
367    /// cycle later.
368    pub inherit_workdir: bool,
369    /// The run-family hook timeout: `run`, `resume`, `suspend`, `terminate`. Caps at 60s,
370    /// and the type is what keeps a build-sized value out of it.
371    pub run_hook_timeout: RunHookTimeout,
372    /// The build-family hook timeout: `ready`, `validate`. Caps at 3600s.
373    pub build_hook_timeout: BuildHookTimeout,
374    /// Tags, or none.
375    pub tags: std::collections::BTreeMap<String, String>,
376    /// `logging.cloudWatch.logGroup`, or `None` for the service default — a
377    /// service-created group under `/aws/lambda-microvms/<image-name>` with random stream
378    /// names.
379    ///
380    /// Checked against `CloudWatchLoggingLogGroupString` (1..=512, `[a-zA-Z0-9_\-/.#]+`)
381    /// before the artifact upload. The build role must be able to write to whatever this
382    /// names: the conformance account's role grants logs only on
383    /// `/aws/lambda-microvms/*`, so a group outside that prefix builds with no logs at
384    /// all — the same failure mode as the wrong-prefix policy (docs/PLATFORM.md).
385    pub log_group: Option<String>,
386    /// `logging.cloudWatch.logStream` — a stream-name **prefix**, never the exact name.
387    ///
388    /// # The client always appends a per-build discriminator
389    ///
390    /// The wire member is an EXACT stream name (prefixes unsupported — measured 2026-08,
391    /// docs/PLATFORM.md 'An image build is three VMs and three log streams'), and one
392    /// build emits three streams. A fixed configured name collapses all three of every
393    /// build into one stream, so [`ControlPlane::create_image`] sends
394    /// `<this>/<16 hex>` with fresh CSPRNG per create attempt — the same mechanism as
395    /// the `clientToken` nonce (TRAP-1) — and the resolved name comes back on
396    /// [`image::Image::log_stream`] so the caller can find their logs.
397    ///
398    /// Capped at [`crate::constants::MAX_USER_LOG_STREAM_LEN`] (495) so the resolved name
399    /// fits the shape's 512, and refused when it carries `:` or `*` (the pattern is
400    /// `[^:*]*`). Requires [`Self::log_group`]: a stream inside a group the service
401    /// chose randomly is a stream nobody can predict the location of.
402    pub log_stream: Option<String>,
403    /// A **label** folded into the create token for CloudTrail readability, defaulting to
404    /// the image name. Not the token, and cannot become it (TRAP-1).
405    pub token_scope: Option<String>,
406}
407
408impl CreateImageRequest {
409    /// A request with the measured defaults: the al2023 base, the default size class, the
410    /// derived Dockerfile, identity repair off, and 30-second hook timeouts.
411    ///
412    /// The hook timeouts are `expect`ed rather than propagated because 30 is legal for both
413    /// families by construction — it is below the run family's 60s ceiling, which is the
414    /// lower of the two — and a `Result` here would put a `?` on every call site for a
415    /// value this function chose itself.
416    pub fn new(
417        name: impl Into<String>,
418        binary: Vec<u8>,
419        code_artifact_uri: impl Into<String>,
420        build_role_arn: impl Into<String>,
421    ) -> Self {
422        Self {
423            name: name.into(),
424            base_image: BaseImage::al2023(),
425            base_image_version: None,
426            dockerfile: None,
427            binary,
428            project_files: None,
429            code_artifact_uri: code_artifact_uri.into(),
430            build_role_arn: build_role_arn.into(),
431            size: SizeClass::DEFAULT,
432            repair_guest_identity: false,
433            inherit_workdir: false,
434            run_hook_timeout: RunHookTimeout::try_new(30).expect("30s is under the 60s ceiling"),
435            build_hook_timeout: BuildHookTimeout::try_new(30)
436                .expect("30s is under the 3600s ceiling"),
437            tags: std::collections::BTreeMap::new(),
438            log_group: None,
439            log_stream: None,
440            token_scope: None,
441        }
442    }
443}
444
445/// Everything `RunMicrovm` needs.
446///
447/// `run_hook_payload` is a [`RunHookPayload`], which cannot hold an over-ceiling value —
448/// so TRAP-5 is closed before this struct exists rather than checked when it is used.
449#[derive(Clone, Debug)]
450pub struct RunMicrovmRequest {
451    /// The image ARN or ID to launch.
452    pub image_identifier: String,
453    /// `imageVersion`, or `None` for the image's own latest active version.
454    ///
455    /// # The launch half of blue/green
456    ///
457    /// `None` is what this client always sent, and it means "whatever
458    /// `latestActiveImageVersion` is now" — which is right for the ordinary case and wrong for
459    /// the two that matter. A canary wants to launch against exactly the version it is
460    /// testing, not against whatever became latest while it was starting. And a rollback wants
461    /// to re-pin to the known-good version, which "latest" cannot express at all once a bad
462    /// version is the latest one.
463    ///
464    /// With [`ControlPlane::set_image_version_status`] the three moves compose: build v2,
465    /// canary-launch pinned to v2, and on failure set v2 INACTIVE and re-pin to v1. A version
466    /// set INACTIVE refuses to launch when pinned here, which is what makes the retire real
467    /// rather than advisory.
468    ///
469    /// Checked against the `Version` shape before the call — see
470    /// [`require_valid_version`] on why a rollback is the worst moment for a rejection about
471    /// the request.
472    pub image_version: Option<String>,
473    /// The execution role. Optional in the model; every real launch needs one.
474    pub execution_role_arn: Option<String>,
475    /// The connectors to request, as intents (TRAP-4). Ingress is required for a session
476    /// to work at all; omitting egress omits the connector from the request (measured
477    /// 2026-09-12: the platform gave the VM outbound network anyway, `docs/PLATFORM.md`).
478    pub connectors: Vec<ConnectorIntent>,
479    /// Customer-managed Lambda VPC egress connector ARNs, created through `lambda-core`.
480    /// Cannot be combined with [`ConnectorIntent::Egress`]. Internet isolation requires
481    /// a VPC without an internet gateway or NAT gateway; an ARN alone proves no isolation.
482    pub egress_network_connectors: Vec<String>,
483    /// The already-validated payload carrying the agent token.
484    pub run_hook_payload: RunHookPayload,
485    /// `maximumDurationInSeconds`, checked against 1..=28800 when the request is sent.
486    pub max_duration_sec: u32,
487    /// `idlePolicy.maxIdleDurationSeconds`, checked against the model's `min: 60` before the call.
488    ///
489    /// This comment used to say the guard was deliberately absent, because `min` is one of the four
490    /// keys botocore's `VALIDATED_METADATA_ATTRS` enforces locally. True of botocore, and this
491    /// client never touches it — see [`require_idle_duration`]. `59` reached the wire.
492    pub max_idle_sec: u32,
493    /// `idlePolicy.suspendedDurationSeconds`.
494    ///
495    /// The model's `min` is **0**, so every `u32` satisfies it and there is no guard — an absence
496    /// with a reason rather than an oversight, and the drift gate pins the 0 so a future floor is
497    /// noticed. Its ceiling is unstated.
498    ///
499    /// The requested value drives the local resume window. The service also reports its
500    /// active policy in [`Microvm::idle_policy`].
501    pub suspended_sec: u32,
502    /// `idlePolicy.autoResumeEnabled`.
503    pub auto_resume: bool,
504    /// A label for the run token, defaulting to the image identifier (TRAP-1).
505    pub token_scope: Option<String>,
506    /// Optional durable launch idempotency key. Reuse only for retries of one launch,
507    /// with identical parameters and run-hook payload. None preserves fresh defaults.
508    /// Never derive this from an image name or reuse it for a different VM.
509    pub client_token: Option<String>,
510    /// Per-VM `logging`: a CloudWatch group (and optional exact stream) or disabled.
511    /// `None` leaves the service's default destination in place (#201).
512    pub logging: Option<ops::Logging>,
513}
514
515impl RunMicrovmRequest {
516    /// A launch with the measured defaults: ingress only, ten-minute idle and suspended
517    /// windows, a one-hour maximum duration, no auto-resume.
518    pub fn new(image_identifier: impl Into<String>, run_hook_payload: RunHookPayload) -> Self {
519        Self {
520            image_identifier: image_identifier.into(),
521            image_version: None,
522            execution_role_arn: None,
523            connectors: vec![ConnectorIntent::AllIngress],
524            egress_network_connectors: Vec::new(),
525            run_hook_payload,
526            max_duration_sec: 3_600,
527            max_idle_sec: 600,
528            suspended_sec: 600,
529            auto_resume: false,
530            token_scope: None,
531            client_token: None,
532            logging: None,
533        }
534    }
535
536    /// Requests the managed internet egress connector. Omission does not block internet access.
537    #[must_use]
538    pub fn with_egress(mut self) -> Self {
539        if !self.connectors.contains(&ConnectorIntent::Egress) {
540            self.connectors.push(ConnectorIntent::Egress);
541        }
542        self
543    }
544
545    /// Routes egress through a customer-managed Lambda network connector.
546    #[must_use]
547    pub fn with_egress_network_connector(mut self, arn: impl Into<String>) -> Self {
548        self.egress_network_connectors.push(arn.into());
549        self
550    }
551
552    /// Requests a shell-capable launch: the ingress set becomes the measured pair,
553    /// `[HTTP_INGRESS, SHELL_INGRESS]`.
554    ///
555    /// **Replaces** `ALL_INGRESS` rather than adding beside it, because the platform
556    /// forbids the combination and says so only at token-mint time — the VM launches,
557    /// reaches RUNNING, and bills before the failure appears (`docs/PLATFORM.md`,
558    /// 2026-08-15). `[HTTP_INGRESS, SHELL_INGRESS]` is the set measured to both launch
559    /// and mint a shell token, and `HTTP_INGRESS` stays in the pair so the daemon
560    /// endpoint keeps working. Egress is untouched: shell access and outbound network
561    /// are separate questions.
562    #[must_use]
563    pub fn with_shell(mut self) -> Self {
564        self.connectors
565            .retain(|intent| *intent != ConnectorIntent::AllIngress);
566        for wanted in [ConnectorIntent::HttpIngress, ConnectorIntent::ShellIngress] {
567            if !self.connectors.contains(&wanted) {
568                self.connectors.push(wanted);
569            }
570        }
571        self
572    }
573
574    /// Pins the launch to one `imageVersion`. See the field for why that matters.
575    #[must_use]
576    pub fn with_image_version(mut self, version: impl Into<String>) -> Self {
577        self.image_version = Some(version.into());
578        self
579    }
580}
581
582/// Rejects a `maximumDurationInSeconds` outside the service range.
583///
584/// 28800 is eight hours and the hard ceiling on any single VM's life. A longer session
585/// needs a second VM, not a larger number — which is what the message says, because
586/// "outside the accepted range" alone invites someone to look for the flag that raises it.
587pub fn require_duration_in_range(seconds: u32) -> Result<u32, Error> {
588    if (1..=crate::constants::MAX_DURATION_SEC).contains(&seconds) {
589        return Ok(seconds);
590    }
591    Err(Error::invalid_arg(format!(
592        "maximumDurationInSeconds={seconds} is outside the accepted range 1..{} (service model \
593         {}) — {} seconds is eight hours, the hard ceiling on any one VM's life. A longer \
594         session needs a second VM, not a larger number.",
595        crate::constants::MAX_DURATION_SEC,
596        crate::constants::MODEL_API_VERSION,
597        crate::constants::MAX_DURATION_SEC,
598    )))
599}
600
601/// Rejects a `Version`/`NonBlankString` value the service would reject.
602///
603/// # Why this one is checked locally when so many are not
604///
605/// The model's `Version` shape is `min: 1, max: 2048, pattern: [^\s]+`, and issue #24 lists
606/// `NonBlankString` as its most-reused unguarded shape. Two of the three constraints are ones
607/// botocore would not catch even if this client used it (`max` and `pattern` are outside
608/// `VALIDATED_METADATA_ATTRS`), and this client uses `aws-sigv4` plus `reqwest` and never
609/// touches botocore's validator at all.
610///
611/// What makes it worth a guard rather than a comment is *where* the two callers sit.
612/// `CreateMicrovmImage.baseImageVersion` is sent **after** the artifact upload, so the
613/// service's rejection costs the caller the upload — the same argument
614/// [`require_valid_image_name`] makes. And `RunMicrovm.imageVersion` is the pinned-launch
615/// half of a rollback: a blank there is a `ValidationException` at the moment someone is
616/// trying to re-pin away from a bad version, which is the worst possible time for the failure
617/// to be about the request rather than about the version.
618///
619/// The pattern is `[^\s]+` — **no whitespace anywhere**, not merely "not blank". A version
620/// copied out of a terminal with a trailing newline satisfies "non-empty" and fails the
621/// pattern, so the message names the character rather than saying the value is invalid.
622pub fn require_valid_version(member: &str, version: &str) -> Result<(), Error> {
623    let model = crate::constants::MODEL_API_VERSION;
624    if version.is_empty() {
625        return Err(Error::invalid_arg(format!(
626            "{member} is empty, but the Version shape requires at least 1 character (service \
627             model {model}). Omit the member entirely to let the service choose — an absent \
628             version and a blank one are different requests, and only the first is legal."
629        )));
630    }
631    if version.len() > crate::constants::MAX_VERSION_LEN {
632        return Err(Error::invalid_arg(format!(
633            "{member} is {} characters, over the Version ceiling of {} (service model {model}).",
634            version.len(),
635            crate::constants::MAX_VERSION_LEN,
636        )));
637    }
638    if let Some(found) = version.chars().find(char::is_ascii_whitespace) {
639        return Err(Error::invalid_arg(format!(
640            "{member} {version:?} contains whitespace ({found:?}), which the Version pattern \
641             {:?} forbids anywhere in the value (service model {model}). A version pasted from \
642             a terminal carries a trailing newline and looks fine; this is that.",
643            crate::constants::VERSION_PATTERN,
644        )));
645    }
646    Ok(())
647}
648
649/// Rejects a `NonBlankString` value the service would reject.
650///
651/// # The model's most-reused shape, and the three members this client sends
652///
653/// `NonBlankString` is `min: 1, max: 2048, pattern: [^\s]+` and 45 members name it. Most are
654/// responses; the three this client puts on the wire are `CodeArtifact.uri`,
655/// `CreateMicrovmImage.baseImageArn`, and `ListMicrovmImages.nameFilter`, and issue #24 named
656/// all three as reachable with no guard.
657///
658/// Each of the three fails in its own expensive way. `codeArtifact.uri` and `baseImageArn` ride
659/// on the create call, which happens **after** the artifact upload — the ordering
660/// [`ControlPlane::create_image`] is arranged around, so a rejection about either costs the
661/// caller the upload. `nameFilter` is worse in a quieter way: it goes in the **query string**,
662/// so a blank one is a `nameFilter=` that either 400s or silently filters differently from what
663/// was meant, and [`ControlPlane::find_image_by_name`] is the resolver a launch depends on.
664///
665/// # `[^\s]+` forbids whitespace *anywhere*
666///
667/// Not merely "not blank". An S3 URI pasted from a console with a trailing newline satisfies
668/// "non-empty" and fails the pattern, which is why the message names the character it found
669/// rather than saying the value is invalid. The same reading [`require_valid_version`] documents
670/// for `Version`, which is the identical constraint triple on a different shape.
671///
672/// A separate function from [`require_valid_version`] even though the two shapes agree today,
673/// for the reason [`crate::constants::MAX_NON_BLANK_LEN`] gives: they are two shapes, AWS can
674/// move one, and one guard serving both would silently stop being about whichever moved.
675pub fn require_non_blank(member: &str, value: &str) -> Result<(), Error> {
676    let model = crate::constants::MODEL_API_VERSION;
677    if value.is_empty() {
678        return Err(Error::invalid_arg(format!(
679            "{member} is empty, but the NonBlankString shape requires at least 1 character \
680             (service model {model}). The shape's own documentation reads 'a string which is not \
681             empty or blank (only whitespace)'."
682        )));
683    }
684    if value.len() > crate::constants::MAX_NON_BLANK_LEN {
685        return Err(Error::invalid_arg(format!(
686            "{member} is {} characters, over the NonBlankString ceiling of {} (service model \
687             {model}).",
688            value.len(),
689            crate::constants::MAX_NON_BLANK_LEN,
690        )));
691    }
692    if let Some(found) = value.chars().find(char::is_ascii_whitespace) {
693        return Err(Error::invalid_arg(format!(
694            "{member} {value:?} contains whitespace ({found:?}), which the NonBlankString \
695             pattern {:?} forbids anywhere in the value (service model {model}). A URI pasted \
696             from a console carries a trailing newline and looks fine; this is that.",
697            crate::constants::NON_BLANK_PATTERN,
698        )));
699    }
700    Ok(())
701}
702
703/// Rejects a `MicrovmIdentifier`/`MicrovmImageIdentifier` the service would reject.
704///
705/// # Twelve members across every implemented operation
706///
707/// Both shapes are `min: 1, max: 256`, and between them they bound the identifier on
708/// `GetMicrovm`, `SuspendMicrovm`, `ResumeMicrovm`, `TerminateMicrovm`,
709/// `CreateMicrovmAuthToken`, `GetMicrovmImage`, `DeleteMicrovmImage`,
710/// `DeleteMicrovmImageVersion`, `GetMicrovmImageVersion`, `UpdateMicrovmImageVersion`,
711/// `GetMicrovmImageBuild`, the three listings, and `RunMicrovm.imageIdentifier`. Issue #24
712/// counted six implemented operations for each shape; every one of them is guarded here.
713///
714/// # An empty identifier is the case that pays for this
715///
716/// Ten of those members are **URI parameters**, and an empty one does not produce a validation
717/// error about a blank field: it collapses the path. `GET /2025-09-09/microvms/` addresses the
718/// *listing*, not a VM, so an empty id sent to `get_microvm` asks a different question and can
719/// get a 200 back for it — and `DELETE` on a collapsed path is worse. That failure mode is
720/// invisible in the service's answer, which is the strongest argument for a local refusal
721/// anywhere in this module.
722///
723/// # The model contradicts itself, and this is the side that can be guarded
724///
725/// `MicrovmImageArn` permits 2048 and is what the service *answers* with, so the model allows a
726/// legal response value that is an illegal request value — see
727/// [`crate::constants::MAX_IDENTIFIER_LEN`] for the whole account. The message says so, because
728/// a caller who hit it by echoing an ARN back is looking at a service inconsistency rather than
729/// at their own mistake, and telling them "shorten it" would be useless advice about a value
730/// they did not choose.
731pub fn require_valid_identifier(member: &str, identifier: &str) -> Result<(), Error> {
732    let model = crate::constants::MODEL_API_VERSION;
733    if identifier.is_empty() {
734        return Err(Error::invalid_arg(format!(
735            "{member} is empty, but the identifier shapes require at least 1 character (service \
736             model {model}). An empty identifier is not refused as a blank field — most of these \
737             are URI parameters, so it collapses the path onto the collection: \
738             `/microvms/` is the listing rather than one VM, and a request that addresses the \
739             wrong resource can succeed."
740        )));
741    }
742    if identifier.len() > crate::constants::MAX_IDENTIFIER_LEN {
743        return Err(Error::invalid_arg(format!(
744            "{member} is {} characters, over the {} the MicrovmIdentifier and \
745             MicrovmImageIdentifier shapes allow (service model {model}). Note the model \
746             disagrees with itself here: MicrovmImageArn permits {}, and that is the shape the \
747             service answers with on GetMicrovm's imageArn — so if this value came back from a \
748             response rather than being chosen here, it is a service-side inconsistency worth \
749             reporting rather than a length to shorten.",
750            identifier.len(),
751            crate::constants::MAX_IDENTIFIER_LEN,
752            crate::constants::MAX_IMAGE_ARN_LEN,
753        )));
754    }
755    Ok(())
756}
757
758/// Rejects a `RoleArn` the service would reject, before the artifact upload.
759///
760/// # Why the build role in particular
761///
762/// `CreateMicrovmImage.buildRoleArn` is sent on the create call, and the create call happens
763/// **after** the caller has uploaded the artifact. So the service's rejection of a malformed
764/// role ARN arrives having already cost the upload, which is the exact ordering
765/// [`ControlPlane::create_image`] exists to protect against and the reason issue #24 singled
766/// this member out. `RunMicrovm.executionRoleArn` is cheaper to get wrong but wrong in a
767/// confusing place: it is optional in the model, so a malformed one is a `ValidationException`
768/// on a member a caller may not know is being filled from their infra config.
769///
770/// # Three constraints, three messages
771///
772/// `min: 20`, `max: 2048`, and the pattern. They get separate messages because the pattern's
773/// wording ("this does not look like an IAM role ARN") is unhelpful for a value that is merely
774/// 3000 characters, and the length wording is unhelpful for a role *name* — which is the most
775/// common mistake and is short.
776///
777/// See [`crate::constants::is_valid_role_arn`] for what the structural check decides. It cannot
778/// tell you the role exists or grants the right log permissions; those are the failures that
779/// actually happen most and none of them is knowable without IAM.
780pub fn require_valid_role_arn(member: &str, arn: &str) -> Result<(), Error> {
781    let model = crate::constants::MODEL_API_VERSION;
782    if arn.len() < crate::constants::MIN_ROLE_ARN_LEN {
783        return Err(Error::invalid_arg(format!(
784            "{member} {arn:?} is {} characters, under the RoleArn minimum of {} (service model \
785             {model}). A value this short is almost always a role *name* where the ARN was \
786             wanted — `arn:aws:iam::<12-digit-account>:role/{arn}` is the shape.",
787            arn.len(),
788            crate::constants::MIN_ROLE_ARN_LEN,
789        )));
790    }
791    if arn.len() > crate::constants::MAX_ROLE_ARN_LEN {
792        return Err(Error::invalid_arg(format!(
793            "{member} is {} characters, over the RoleArn ceiling of {} (service model {model}).",
794            arn.len(),
795            crate::constants::MAX_ROLE_ARN_LEN,
796        )));
797    }
798    if !crate::constants::is_valid_role_arn(arn) {
799        return Err(Error::invalid_arg(format!(
800            "{member} {arn:?} does not match the RoleArn pattern {:?} (service model {model}). \
801             It wants `arn:aws:iam::` then **exactly twelve digits** of account id then `:role/` \
802             and a name — so the three things this catches are a role name passed as an ARN, an \
803             ARN for some other service, and an account id with a digit dropped. Rejected here \
804             rather than by AWS because for buildRoleArn the create call happens *after* the \
805             artifact upload, so the service's answer costs you the upload first. Whether the \
806             role exists and grants logs on {}/* is not checkable locally and is still the \
807             service's answer to give.",
808            crate::constants::ROLE_ARN_PATTERN,
809            image::BUILD_LOG_GROUP_PREFIX,
810        )));
811    }
812    Ok(())
813}
814
815/// Rejects a `logging.cloudWatch.logGroup` the service would reject, before the artifact
816/// upload.
817///
818/// The shape is `CloudWatchLoggingLogGroupString`: 1..=512, pattern `[a-zA-Z0-9_\-/.#]+`.
819/// The character the pattern excludes that a caller writes first is the colon — a group
820/// pasted as an ARN (`arn:aws:logs:...`) fails here with the pattern named, rather than as
821/// a `ValidationException` after the upload.
822pub fn require_valid_log_group(group: &str) -> Result<(), Error> {
823    let model = crate::constants::MODEL_API_VERSION;
824    if group.is_empty() {
825        return Err(Error::invalid_arg(format!(
826            "logging.cloudWatch.logGroup is empty, but the CloudWatchLoggingLogGroupString \
827             shape requires at least 1 character (service model {model}). Omit the setting \
828             entirely to take the service default — a service-created group under \
829             {}/<image-name>.",
830            image::BUILD_LOG_GROUP_PREFIX,
831        )));
832    }
833    if group.len() > crate::constants::MAX_LOG_GROUP_LEN {
834        return Err(Error::invalid_arg(format!(
835            "logging.cloudWatch.logGroup is {} characters, over the \
836             CloudWatchLoggingLogGroupString ceiling of {} (service model {model}).",
837            group.len(),
838            crate::constants::MAX_LOG_GROUP_LEN,
839        )));
840    }
841    if !crate::constants::is_valid_log_group(group) {
842        return Err(Error::invalid_arg(format!(
843            "logging.cloudWatch.logGroup {group:?} does not match the \
844             CloudWatchLoggingLogGroupString pattern {:?} (service model {model}) — letters, \
845             digits, and `_ - / . #` only. A colon usually means an ARN was pasted where the \
846             group *name* was wanted. Rejected here rather than by AWS because the create call \
847             happens after the artifact upload, so the service's answer costs you the upload \
848             first.",
849            crate::constants::LOG_GROUP_PATTERN,
850        )));
851    }
852    Ok(())
853}
854
855/// Rejects a caller-supplied `logging.cloudWatch.logStream` prefix the resolved name could
856/// not legally carry, before the artifact upload.
857///
858/// The shape is `CloudWatchLoggingLogStreamString`: 1..=512, pattern `[^:*]*` — anything
859/// but `:` and `*`. The caller's value is capped at
860/// [`crate::constants::MAX_USER_LOG_STREAM_LEN`] (495) rather than 512, because this
861/// client always appends `/<16 hex>` of per-build discriminator before the value reaches
862/// the wire — see [`CreateImageRequest::log_stream`] for why a verbatim stream name is
863/// never sent — and 495 + 17 is exactly the shape's ceiling.
864pub fn require_valid_log_stream(stream: &str) -> Result<(), Error> {
865    let model = crate::constants::MODEL_API_VERSION;
866    if stream.is_empty() {
867        return Err(Error::invalid_arg(format!(
868            "logging.cloudWatch.logStream is empty, but the CloudWatchLoggingLogStreamString \
869             shape requires at least 1 character (service model {model}). Omit the setting to \
870             let the service name the streams inside the configured group."
871        )));
872    }
873    if stream.len() > crate::constants::MAX_USER_LOG_STREAM_LEN {
874        return Err(Error::invalid_arg(format!(
875            "logging.cloudWatch.logStream is {} characters, over this client's ceiling of {}. \
876             The shape's own ceiling is {} (service model {model}), and the client always \
877             appends a 17-character per-build discriminator (`/` + 16 hex) — one image build \
878             is three VMs writing three streams, and the member is an exact stream name, so a \
879             fixed configured name would collapse every build's streams into one. The \
880             discriminator is what keeps them tellable apart, and it needs its room.",
881            stream.len(),
882            crate::constants::MAX_USER_LOG_STREAM_LEN,
883            crate::constants::MAX_LOG_STREAM_LEN,
884        )));
885    }
886    if let Some(found) = stream.chars().find(|c| matches!(c, ':' | '*')) {
887        return Err(Error::invalid_arg(format!(
888            "logging.cloudWatch.logStream {stream:?} contains {found:?}, which the \
889             CloudWatchLoggingLogStreamString pattern {:?} forbids anywhere in the value \
890             (service model {model}). A `*` usually means a prefix or glob was intended — the \
891             member is an exact stream name, prefixes are unsupported, and this client's own \
892             per-build suffix is how a configured name behaves like one.",
893            crate::constants::LOG_STREAM_PATTERN,
894        )));
895    }
896    Ok(())
897}
898
899/// Rejects a port the `PortNumber` or `HooksPortInteger` shapes would reject. **Minimum 1.**
900///
901/// # Port 0 is representable and means something else
902///
903/// Zero is what "let the kernel pick a port" means to a listener, so it is the value a caller
904/// reaches for when they do not have a port yet — and issue #24 measured that
905/// [`ControlPlane::with_port`]`(0)` was representable and produced `allowedPorts: [{"port": 0}]`
906/// on the wire, plus a `hooks.port` of 0 on every image built through that plane. Neither is a
907/// port the platform can forward to.
908///
909/// # There is no ceiling check here, and that is the type's doing rather than an omission
910///
911/// `PortNumber.max` and `HooksPortInteger.max` are both 65535, which is `u16::MAX` — so a `max`
912/// branch against the constant would be `port > u16::MAX`, a comparison that is false for every
913/// input. Clippy's `absurd_extreme_comparisons` says so, and it is right for the reason
914/// [`ControlPlane::create_image`] gives about the absent `hooks.port` check: a branch no input can
915/// reach reads as protection, appears in a coverage report as protection, and no test can make it
916/// fire.
917///
918/// The ceiling is still *pinned* — [`crate::constants::MAX_PORT`] is in the drift gate, and
919/// `the_port_floor_is_one_and_the_ceiling_is_what_a_u16_holds` asserts the equality with
920/// `u16::MAX` that makes this reasoning valid. If AWS ever lowers the ceiling below 65535 the gate
921/// goes red, that test goes red, and a real branch belongs here.
922pub fn require_valid_port(member: &str, port: u16) -> Result<(), Error> {
923    if port >= crate::constants::MIN_PORT {
924        return Ok(());
925    }
926    Err(Error::invalid_arg(format!(
927        "{member} is {port}, under the PortNumber minimum of {} (service model {}). Port 0 means \
928         'let the kernel choose' to a listener and is not a port the platform can forward to — a \
929         proxy token minted for it authorizes nothing, and an image whose hooks block names it has \
930         no reachable hook endpoint. Name the port the daemon actually listens on \
931         ({DEFAULT_AGENT_PORT} by default).",
932        crate::constants::MIN_PORT,
933        crate::constants::MODEL_API_VERSION,
934    )))
935}
936
937/// Rejects an `idlePolicy.maxIdleDurationSeconds` under the model's `min: 60`.
938///
939/// # The exemption this replaces was inherited from a client that no longer exists
940///
941/// [`RunMicrovmRequest::max_idle_sec`] and `constants.rs` both used to say there was
942/// deliberately no guard here, because `min` is one of the four keys in botocore's
943/// `VALIDATED_METADATA_ATTRS` and botocore therefore refuses it locally with a clear message.
944/// The premise is true and the conclusion does not apply: this client never touches botocore.
945/// `ControlPlane` signs with `aws-sigv4` and sends with `reqwest`, so `validate.py` is not on
946/// the path, and issue #24 measured `max_idle_sec: 59` reaching the wire.
947///
948/// It is the one place in this module where the *reason* for having no guard was wrong rather
949/// than the number, which is worth saying because the same reasoning would exempt every `min` in
950/// the model — `Version`'s, `NonBlankString`'s, the identifiers', `allowedPorts`'s. All of them
951/// are now guarded, and none of them by botocore.
952///
953/// No maximum, because the model states none. The bound that actually ends a VM's life is
954/// `maximumDurationInSeconds` ([`require_duration_in_range`]).
955pub fn require_idle_duration(seconds: u32) -> Result<(), Error> {
956    if seconds >= crate::constants::MIN_IDLE_DURATION_SEC {
957        return Ok(());
958    }
959    Err(Error::invalid_arg(format!(
960        "idlePolicy.maxIdleDurationSeconds={seconds} is under the minimum of {} (service model \
961         {}). This used to be documented as a constraint botocore enforced locally, which was \
962         true of the deleted Python client and never of this one — it signs with aws-sigv4 and \
963         sends with reqwest, so nothing validates a request before the wire except this crate.",
964        crate::constants::MIN_IDLE_DURATION_SEC,
965        crate::constants::MODEL_API_VERSION,
966    )))
967}
968
969/// Rejects a tag map the service would reject, naming the key and the half that failed.
970///
971/// # Sent since tags existed, checked by nothing
972///
973/// [`CreateImageRequest::tags`] goes straight onto `CreateMicrovmImage.tags` and was never
974/// validated (issue #24). Same ordering argument as everything else on that call: the rejection
975/// lands after the artifact upload.
976///
977/// # The key and the value have different rules, so the message says which
978///
979/// `TagKey` is `min: 1, max: 128`; `TagValue` is `min: 0, max: 256`. So an empty **value** is
980/// legal and an empty **key** is not, and the ceilings differ by 2x. They share one pattern.
981/// Every message here names the offending key, because a caller applying a dozen tags from a
982/// config file needs to know which one — a message that only said "a tag is invalid" would send
983/// them to read all twelve.
984///
985/// The key is quoted in the message even when the key itself is the problem, which is the
986/// deliberate choice: a key with a stray newline or a zero-width character in it is
987/// indistinguishable from a good one until it is printed with `{:?}`.
988pub fn require_valid_tags(tags: &std::collections::BTreeMap<String, String>) -> Result<(), Error> {
989    let model = crate::constants::MODEL_API_VERSION;
990    for (key, value) in tags {
991        if key.is_empty() {
992            return Err(Error::invalid_arg(format!(
993                "a tag key is empty, but TagKey requires at least 1 character (service model \
994                 {model}). Note TagValue's minimum is 0, so an empty tag *value* is legal and an \
995                 empty key is not."
996            )));
997        }
998        if key.len() > crate::constants::MAX_TAG_KEY_LEN {
999            return Err(Error::invalid_arg(format!(
1000                "the tag key {key:?} is {} characters, over the TagKey ceiling of {} (service \
1001                 model {model}). TagValue allows {}, so the two halves are not \
1002                 interchangeable.",
1003                key.len(),
1004                crate::constants::MAX_TAG_KEY_LEN,
1005                crate::constants::MAX_TAG_VALUE_LEN,
1006            )));
1007        }
1008        if !crate::constants::is_valid_tag_component(key) {
1009            return Err(Error::invalid_arg(format!(
1010                "the tag key {key:?} has a character outside the TagKey pattern {:?} (service \
1011                 model {model}). Letters, digits, separators, and `_ . : / = + - @` — spaces and \
1012                 non-Latin scripts are fine, commas and `#` and `%` are not, and neither is a \
1013                 newline (it is a control character, not a separator).",
1014                crate::constants::TAG_COMPONENT_PATTERN,
1015            )));
1016        }
1017        if value.len() > crate::constants::MAX_TAG_VALUE_LEN {
1018            return Err(Error::invalid_arg(format!(
1019                "the value of tag {key:?} is {} characters, over the TagValue ceiling of {} \
1020                 (service model {model}).",
1021                value.len(),
1022                crate::constants::MAX_TAG_VALUE_LEN,
1023            )));
1024        }
1025        if !crate::constants::is_valid_tag_component(value) {
1026            return Err(Error::invalid_arg(format!(
1027                "the value of tag {key:?} has a character outside the TagValue pattern {:?} \
1028                 (service model {model}). It is the same character set the key takes; the value \
1029                 differs only in allowing an empty string.",
1030                crate::constants::TAG_COMPONENT_PATTERN,
1031            )));
1032        }
1033    }
1034    Ok(())
1035}
1036
1037/// Rejects an image name the service would reject, before the artifact upload.
1038///
1039/// The three cases get their own messages because the pattern message ("no dots, no
1040/// slashes") is actively misleading for a 70-character name that contains neither.
1041pub fn require_valid_image_name(name: &str) -> Result<(), Error> {
1042    let model = crate::constants::MODEL_API_VERSION;
1043    if name.is_empty() {
1044        return Err(Error::invalid_arg(format!(
1045            "the image name is empty, but ImageName requires at least 1 character (service \
1046             model {model})."
1047        )));
1048    }
1049    if name.len() > crate::constants::MAX_IMAGE_NAME_LEN {
1050        return Err(Error::invalid_arg(format!(
1051            "the image name is {} characters, over the ImageName ceiling of {} (service model \
1052             {model}). Rejected here rather than by AWS, because the create call happens \
1053             *after* the artifact upload — so the service's answer costs you the upload first.",
1054            name.len(),
1055            crate::constants::MAX_IMAGE_NAME_LEN,
1056        )));
1057    }
1058    if !crate::constants::is_valid_image_name(name) {
1059        return Err(Error::invalid_arg(format!(
1060            "the image name {name:?} does not match the ImageName pattern {:?} (service model \
1061             {model}). Letters, digits, hyphen, and underscore only — no dots and no slashes, \
1062             which are the two separators a namespaced name reaches for first.",
1063            crate::constants::IMAGE_NAME_PATTERN,
1064        )));
1065    }
1066    Ok(())
1067}
1068
1069/// The `Hooks` block with all six hooks enabled and both timeout families set.
1070///
1071/// All six because `ready` and `validate` are image-*build* hooks: the build calls them to
1072/// decide whether the snapshot it just produced is usable, before any instance exists and
1073/// therefore before any token has been delivered. Gating them on bootstrap state fails the
1074/// *build* rather than the run, which is a confusing place to discover the mistake.
1075///
1076/// The two timeouts are separate types, so the 60x gap cannot be crossed by passing one
1077/// number twice — see [`crate::hooks`].
1078/// `ENABLED` is [`ops::HookState::Enabled`] rather than a `&str` local, which is issue #24's
1079/// point about this function: the literal appeared six times with no constant naming either
1080/// value, so a typo in one of the six was a `ValidationException` on a create call made after
1081/// the artifact upload. It is now a compile error.
1082pub fn hooks_block(port: u16, run: RunHookTimeout, build: BuildHookTimeout) -> ops::Hooks {
1083    const ENABLED: ops::HookState = ops::HookState::Enabled;
1084    ops::Hooks {
1085        port,
1086        microvm_hooks: ops::MicrovmHooks {
1087            run: ENABLED,
1088            run_timeout_in_seconds: run.as_secs(),
1089            resume: ENABLED,
1090            resume_timeout_in_seconds: run.as_secs(),
1091            suspend: ENABLED,
1092            suspend_timeout_in_seconds: run.as_secs(),
1093            terminate: ENABLED,
1094            terminate_timeout_in_seconds: run.as_secs(),
1095        },
1096        microvm_image_hooks: ops::MicrovmImageHooks {
1097            ready: ENABLED,
1098            ready_timeout_in_seconds: build.as_secs(),
1099            validate: ENABLED,
1100            validate_timeout_in_seconds: build.as_secs(),
1101        },
1102    }
1103}
1104
1105/// A deadline elapsed on the client side. The remote resource is untouched.
1106pub(crate) fn timed_out(what: &str, waited: Duration) -> Error {
1107    Error::new(
1108        ErrorKind::Timeout,
1109        format!(
1110            "{what} within {:.0}s. This is a client-side deadline: nothing was cancelled, so \
1111             the resource is in whatever state the service last reported.",
1112            waited.as_secs_f64()
1113        ),
1114    )
1115}
1116
1117#[cfg(test)]
1118pub(crate) mod fake;
1119
1120#[cfg(test)]
1121mod posture_fuzz;
1122
1123#[cfg(test)]
1124mod tests {
1125    use super::*;
1126
1127    /// The three image-name rejections each get their own message, because the pattern
1128    /// wording is misleading for a name that is merely long.
1129    #[test]
1130    fn each_image_name_rejection_explains_its_own_case() {
1131        let empty = require_valid_image_name("").expect_err("min is 1");
1132        assert!(
1133            empty.to_string().contains("at least 1 character"),
1134            "{empty}"
1135        );
1136
1137        let long = require_valid_image_name(&"a".repeat(65)).expect_err("max is 64");
1138        let message = long.to_string();
1139        assert!(message.contains("65 characters"), "{message}");
1140        assert!(
1141            message.contains("after* the artifact upload"),
1142            "the reason to check locally is the cost: {message}"
1143        );
1144        assert!(
1145            !message.contains("no dots"),
1146            "the pattern wording is misleading for a merely-long name: {message}"
1147        );
1148
1149        let dotted = require_valid_image_name("my.image").expect_err("dots are not in the pattern");
1150        let message = dotted.to_string();
1151        assert!(message.contains("no dots and no slashes"), "{message}");
1152        assert!(message.contains("[a-zA-Z0-9-_]+"), "{message}");
1153    }
1154
1155    /// The boundaries are inclusive on both sides, and every rejection is an `InvalidArg`
1156    /// so the CLI reports it as refused-locally rather than as a platform failure.
1157    #[test]
1158    fn an_image_name_at_the_ceiling_is_accepted_and_one_past_it_is_not() {
1159        require_valid_image_name(&"a".repeat(64)).expect("64 is the ceiling");
1160        require_valid_image_name("a").expect("1 is the minimum");
1161        for bad in ["", &"a".repeat(65), "my.image", "team/image", "a b"] {
1162            let error = require_valid_image_name(bad).expect_err("rejected");
1163            assert_eq!(error.kind(), ErrorKind::InvalidArg, "{bad:?}");
1164        }
1165    }
1166
1167    /// The duration range, at both boundaries. 28801 is the value the botocore gap was
1168    /// confirmed with, and the message has to say a second VM rather than a bigger number.
1169    #[test]
1170    fn the_duration_range_is_inclusive_and_names_the_eight_hour_ceiling() {
1171        assert_eq!(require_duration_in_range(1).expect("1 fits"), 1);
1172        assert_eq!(
1173            require_duration_in_range(28_800).expect("the ceiling fits"),
1174            28_800
1175        );
1176
1177        for bad in [0, 28_801, u32::MAX] {
1178            let error = require_duration_in_range(bad).expect_err("outside 1..28800");
1179            assert_eq!(error.kind(), ErrorKind::InvalidArg, "{bad}");
1180            let message = error.to_string();
1181            assert!(message.contains("eight hours"), "{message}");
1182            assert!(
1183                message.contains("a second VM, not a larger number"),
1184                "{message}"
1185            );
1186        }
1187    }
1188
1189    /// The hooks block enables all six hooks, and the two families carry their own
1190    /// timeouts — which is the whole reason they are two types.
1191    #[test]
1192    fn the_hooks_block_enables_all_six_with_the_two_families_kept_apart() {
1193        let hooks = hooks_block(
1194            9000,
1195            RunHookTimeout::try_new(45).expect("45s is a legal run timeout"),
1196            BuildHookTimeout::try_new(1800).expect("1800s is a legal build timeout"),
1197        );
1198
1199        assert_eq!(hooks.port, 9000);
1200        for state in [
1201            hooks.microvm_hooks.run,
1202            hooks.microvm_hooks.resume,
1203            hooks.microvm_hooks.suspend,
1204            hooks.microvm_hooks.terminate,
1205            hooks.microvm_image_hooks.ready,
1206            hooks.microvm_image_hooks.validate,
1207        ] {
1208            assert_eq!(state, ops::HookState::Enabled, "all six hooks are served");
1209            // The wire spelling too, against a literal: the variant name and the string the
1210            // service reads are two different things, and `HookState::Enabled` rendering as
1211            // anything but `ENABLED` is a rejected create on six fields at once.
1212            assert_eq!(state.as_str(), "ENABLED");
1213        }
1214
1215        assert_eq!(hooks.microvm_hooks.run_timeout_in_seconds, 45);
1216        assert_eq!(hooks.microvm_hooks.terminate_timeout_in_seconds, 45);
1217        assert_eq!(hooks.microvm_image_hooks.ready_timeout_in_seconds, 1800);
1218        assert_eq!(
1219            hooks.microvm_image_hooks.validate_timeout_in_seconds, 1800,
1220            "1800 is legal for the build family and illegal for the run one, which is why \
1221             one shared number cannot serve both"
1222        );
1223    }
1224
1225    /// The default request carries the measured defaults, and identity repair is **off** —
1226    /// a capability granted by default is a capability nobody asked for.
1227    #[test]
1228    fn the_default_create_request_repairs_no_identity_and_takes_the_default_size() {
1229        let request = CreateImageRequest::new("img", vec![1, 2, 3], "s3://b/k", "arn:role");
1230        assert!(!request.repair_guest_identity);
1231        assert!(!request.inherit_workdir);
1232        assert_eq!(request.size, SizeClass::DEFAULT);
1233        assert_eq!(request.base_image, BaseImage::al2023());
1234        assert_eq!(request.token_scope, None);
1235        assert_eq!(request.dockerfile, None);
1236    }
1237
1238    /// The default launch requests ingress and **not** egress: the right default for a
1239    /// daemon that needs none. What the omission buys is measured in `docs/PLATFORM.md`
1240    /// (2026-09-12: the platform gave the connector-less VM outbound network anyway).
1241    #[test]
1242    fn the_default_launch_requests_ingress_only() {
1243        let payload = RunHookPayload::for_agent_token("token").expect("a token fits");
1244        let request = RunMicrovmRequest::new("arn:image", payload);
1245        assert_eq!(request.connectors, vec![ConnectorIntent::AllIngress]);
1246
1247        let with_egress = request.with_egress();
1248        assert_eq!(
1249            with_egress.connectors,
1250            vec![ConnectorIntent::AllIngress, ConnectorIntent::Egress]
1251        );
1252    }
1253
1254    /// Asking for egress twice does not send it twice. `NetworkConnectorList` caps at 10
1255    /// and a duplicate is a wasted slot at best.
1256    #[test]
1257    fn asking_for_egress_twice_adds_it_once() {
1258        let payload = RunHookPayload::for_agent_token("token").expect("a token fits");
1259        let request = RunMicrovmRequest::new("arn:image", payload)
1260            .with_egress()
1261            .with_egress();
1262        assert_eq!(request.connectors.len(), 2);
1263    }
1264
1265    /// `with_shell` **replaces** `ALL_INGRESS` with the measured pair rather than adding
1266    /// beside it: the platform accepts `ALL_INGRESS` + finer ingress at launch and
1267    /// refuses it only when a shell token is minted, after the VM has run and billed —
1268    /// and `run_microvm` refuses the combination client-side, so a `with_shell` that
1269    /// merely appended would build a request this client's own validation rejects.
1270    ///
1271    /// **Falsification** — watched fail 2026-08-31: dropping the `retain` from
1272    /// `with_shell` fails the first assertion with `ALL_INGRESS` still in the set.
1273    #[test]
1274    fn with_shell_replaces_all_ingress_with_the_measured_pair() {
1275        let payload = RunHookPayload::for_agent_token("token").expect("a token fits");
1276        let request = RunMicrovmRequest::new("arn:image", payload).with_shell();
1277        assert_eq!(
1278            request.connectors,
1279            vec![ConnectorIntent::HttpIngress, ConnectorIntent::ShellIngress]
1280        );
1281
1282        // Egress is a separate question and survives in either order.
1283        let payload = RunHookPayload::for_agent_token("token").expect("a token fits");
1284        let both = RunMicrovmRequest::new("arn:image", payload)
1285            .with_egress()
1286            .with_shell()
1287            .with_shell();
1288        assert_eq!(
1289            both.connectors,
1290            vec![
1291                ConnectorIntent::Egress,
1292                ConnectorIntent::HttpIngress,
1293                ConnectorIntent::ShellIngress
1294            ],
1295            "egress survives, and asking twice adds nothing"
1296        );
1297    }
1298
1299    /// A client-side deadline is an `ErrorKind::Timeout` and says the resource was not
1300    /// touched — because the caller's next question is whether to clean something up.
1301    #[test]
1302    fn a_client_side_deadline_says_the_resource_is_untouched() {
1303        let error = timed_out("the image did not become usable", Duration::from_secs(300));
1304        assert_eq!(error.kind(), ErrorKind::Timeout);
1305        let message = error.to_string();
1306        assert!(message.contains("300s"), "{message}");
1307        assert!(message.contains("nothing was cancelled"), "{message}");
1308    }
1309
1310    /// The default port matches the daemon's, and a caller can change it.
1311    #[test]
1312    fn the_agent_port_defaults_to_nine_thousand_and_is_overridable() {
1313        let plane = ControlPlane::with_transport(
1314            Arc::new(fake::FakeControlPlane::new()),
1315            Region::UsEast1,
1316            Arc::new(fake::TestClock::new()),
1317        );
1318        assert_eq!(plane.port(), DEFAULT_AGENT_PORT);
1319        assert_eq!(plane.port(), 9000);
1320        assert_eq!(
1321            plane.with_port(8080).expect("8080 is a legal port").port(),
1322            8080
1323        );
1324    }
1325
1326    /// **TRAP-1, the compile surface.** Image requests cannot carry
1327    /// a caller-supplied token.
1328    ///
1329    /// Asserted by destructuring rather than by grep: a struct pattern must name every
1330    /// field, so an image `client_token` added later fails to compile this test. That is the
1331    /// closest a test can get to asserting an absence.
1332    #[test]
1333    fn image_requests_forbid_tokens_and_run_requests_require_explicit_opt_in() {
1334        let CreateImageRequest {
1335            name: _,
1336            base_image: _,
1337            base_image_version: _,
1338            dockerfile: _,
1339            binary: _,
1340            // Dependency-file *bytes* under ecosystem-fixed entry names — nothing
1341            // token-shaped, and no field a caller could name an arbitrary file into.
1342            project_files: _,
1343            code_artifact_uri: _,
1344            build_role_arn: _,
1345            size: _,
1346            repair_guest_identity: _,
1347            inherit_workdir: _,
1348            run_hook_timeout: _,
1349            build_hook_timeout: _,
1350            tags: _,
1351            // The logging pair. The stream is a *prefix* the create call suffixes with a
1352            // fresh nonce — the caller cannot name the exact wire stream, which is the
1353            // same closure shape as the token's.
1354            log_group: _,
1355            log_stream: _,
1356            // A *label*, folded in beside a fresh nonce. The only token-adjacent field,
1357            // and it cannot become the token.
1358            token_scope: _,
1359        } = CreateImageRequest::new("img", Vec::new(), "s3://b/k", "arn:role");
1360
1361        let RunMicrovmRequest {
1362            image_identifier: _,
1363            image_version: _,
1364            execution_role_arn: _,
1365            connectors: _,
1366            egress_network_connectors: _,
1367            run_hook_payload: _,
1368            max_duration_sec: _,
1369            max_idle_sec: _,
1370            suspended_sec: _,
1371            auto_resume: _,
1372            token_scope: _,
1373            // A per-VM log destination: a group name and an exact stream, never a token.
1374            logging: _,
1375            client_token,
1376        } = RunMicrovmRequest::new(
1377            "arn:image",
1378            RunHookPayload::for_agent_token("t").expect("fits"),
1379        );
1380        assert!(client_token.is_none());
1381    }
1382
1383    /// **TRAP-1's last mile.** The wire types' `client_token` fields are `pub(crate)`, so a
1384    /// caller outside this crate cannot build a request body with a token of their own.
1385    ///
1386    /// Worth its own test because the hole was real and I opened it: `ops` is a public module
1387    /// and the wire structs are public, so `pub client_token` on them meant an external
1388    /// caller could bypass `CreateImageRequest` entirely, hand-build a
1389    /// `CreateMicrovmImageWire` with a content digest, and serialize it — the wedge with one
1390    /// extra step, past a request type that has no such field.
1391    ///
1392    /// This test can only observe the *inside* of the boundary, since a compile failure
1393    /// outside the crate is not something an inline test can assert. What it pins is that the
1394    /// field is reachable from here and that the value in it came from the minter — so a
1395    /// later widening back to `pub` is at least a visible diff against a test that documents
1396    /// why it is narrow. The external half is enforced by the compiler.
1397    #[test]
1398    fn the_wire_types_token_field_is_crate_private_and_minted() {
1399        let wire = ops::RunMicrovmWire {
1400            image_identifier: "arn:image".to_string(),
1401            image_version: None,
1402            execution_role_arn: None,
1403            ingress_network_connectors: Vec::new(),
1404            egress_network_connectors: None,
1405            idle_policy: ops::IdlePolicy {
1406                max_idle_duration_seconds: 600,
1407                suspended_duration_seconds: 600,
1408                auto_resume_enabled: false,
1409            },
1410            maximum_duration_in_seconds: 3_600,
1411            run_hook_payload: String::new(),
1412            logging: None,
1413            // Reachable from inside the crate, and only ever populated this way.
1414            client_token: token::run_token("arn:image"),
1415        };
1416        assert!(wire.client_token.starts_with("run-"));
1417        assert!(wire.client_token.len() <= crate::constants::MAX_CLIENT_TOKEN_LEN);
1418        assert_ne!(
1419            wire.client_token,
1420            token::run_token("arn:image"),
1421            "two mints of the same scope differ, which is the property the narrowing protects"
1422        );
1423    }
1424
1425    // ── issue #24's guards, at the message level ─────────────────────────────
1426    //
1427    // Each of these asserts the *refusal and its wording*; the zero-call proofs live beside
1428    // the operations they protect, in `image.rs` and `microvm.rs`, because only there can a
1429    // test observe that no control-plane call happened.
1430
1431    /// The three `NonBlankString` rejections each explain their own case, and the pattern one
1432    /// names the character it found.
1433    ///
1434    /// The whitespace message has to name the character, because the whole class of failure this
1435    /// catches is a value that *looks* right: a URI or a filter pasted out of a console carries a
1436    /// trailing newline, satisfies "non-empty", and fails the pattern.
1437    ///
1438    /// **Guard proof.** Delete the `is_empty` branch and the blank case returns `Ok`; delete the
1439    /// whitespace branch and the `"s3://b/k\n"` case does.
1440    #[test]
1441    fn each_non_blank_rejection_explains_its_own_case() {
1442        let blank = require_non_blank("codeArtifact.uri", "").expect_err("min is 1");
1443        assert_eq!(blank.kind(), ErrorKind::InvalidArg);
1444        assert!(
1445            blank.to_string().contains("at least 1 character"),
1446            "{blank}"
1447        );
1448        assert!(
1449            blank.to_string().contains("NonBlankString"),
1450            "the shape has to be named: {blank}"
1451        );
1452
1453        let long = require_non_blank("baseImageArn", &"a".repeat(2049)).expect_err("max is 2048");
1454        let message = long.to_string();
1455        assert!(message.contains("2049 characters"), "{message}");
1456        assert!(message.contains("ceiling of 2048"), "{message}");
1457
1458        let newline = require_non_blank("codeArtifact.uri", "s3://bucket/key.zip\n")
1459            .expect_err("whitespace anywhere is refused");
1460        let message = newline.to_string();
1461        assert!(
1462            message.contains(r"'\n'"),
1463            "the message must name the character it found: {message}"
1464        );
1465        assert!(message.contains("trailing newline"), "{message}");
1466
1467        // Whitespace in the middle, not only at the end: `[^\s]+` forbids it anywhere.
1468        let inner =
1469            require_non_blank("nameFilter", "coding agents").expect_err("an inner space too");
1470        assert!(
1471            inner.to_string().contains("anywhere in the value"),
1472            "{inner}"
1473        );
1474
1475        // And the legal values pass, so the guard is not refusing everything.
1476        require_non_blank("codeArtifact.uri", "s3://bucket/agentd.zip").expect("a real URI");
1477        require_non_blank(
1478            "baseImageArn",
1479            "arn:aws:lambda:us-east-1:aws:microvm-image:al2023-1",
1480        )
1481        .expect("a real base ARN");
1482        require_non_blank("nameFilter", "coding-agents").expect("a real filter");
1483        require_non_blank("imageVersion", &"9".repeat(2048)).expect("2048 is the ceiling");
1484    }
1485
1486    /// The identifier guard's two cases, and the over-long one names the model's own
1487    /// contradiction rather than telling the caller to shorten a value they may not have chosen.
1488    ///
1489    /// The empty message is the one that carries the reason this guard exists at all: ten of the
1490    /// twelve members are URI parameters, so an empty one collapses the path onto the collection
1491    /// and addresses the wrong resource — which the service can answer 200 to.
1492    ///
1493    /// **Guard proof.** Delete the `is_empty` branch and the blank case returns `Ok`; drop the
1494    /// `MicrovmImageArn` clause and the assertion on `2048` goes red.
1495    #[test]
1496    fn the_identifier_guard_names_the_collapsed_path_and_the_models_contradiction() {
1497        let blank = require_valid_identifier("microvmIdentifier", "").expect_err("min is 1");
1498        assert_eq!(blank.kind(), ErrorKind::InvalidArg);
1499        let message = blank.to_string();
1500        assert!(message.contains("at least 1 character"), "{message}");
1501        assert!(
1502            message.contains("collapses the path"),
1503            "the reason an empty URI parameter is dangerous has to be in the message: {message}"
1504        );
1505
1506        let long =
1507            require_valid_identifier("imageIdentifier", &"a".repeat(257)).expect_err("max is 256");
1508        let message = long.to_string();
1509        assert!(message.contains("257 characters"), "{message}");
1510        assert!(message.contains("256"), "{message}");
1511        assert!(
1512            message.contains("MicrovmImageArn permits 2048"),
1513            "the model's own contradiction has to be named, or the advice is 'shorten a value \
1514             the service gave you': {message}"
1515        );
1516
1517        require_valid_identifier(
1518            "imageIdentifier",
1519            "arn:aws:lambda:us-east-1:1:microvm-image:i",
1520        )
1521        .expect("a real ARN");
1522        require_valid_identifier("microvmIdentifier", "mvm-abc123").expect("a real id");
1523        require_valid_identifier("imageIdentifier", &"a".repeat(256)).expect("256 is the ceiling");
1524    }
1525
1526    /// The role-ARN guard's three cases, and the short one guesses the actual mistake.
1527    ///
1528    /// A value under 20 characters is almost always a role *name*, so the message renders the ARN
1529    /// the caller probably meant rather than restating the bound. That is the difference between
1530    /// a diagnostic and a validation error.
1531    ///
1532    /// **Guard proof.** Delete the `is_valid_role_arn` branch and the eleven-digit case returns
1533    /// `Ok` — which is the case nothing else catches.
1534    #[test]
1535    fn the_role_arn_guard_guesses_the_mistake_a_short_value_is() {
1536        let name = require_valid_role_arn("buildRoleArn", "build-role").expect_err("min is 20");
1537        assert_eq!(name.kind(), ErrorKind::InvalidArg);
1538        let message = name.to_string();
1539        assert!(message.contains("role *name*"), "{message}");
1540        assert!(
1541            message.contains("arn:aws:iam::<12-digit-account>:role/build-role"),
1542            "the message renders the ARN they probably meant: {message}"
1543        );
1544
1545        let long = require_valid_role_arn(
1546            "executionRoleArn",
1547            &format!("arn:aws:iam::123456789012:role/{}", "a".repeat(2048)),
1548        )
1549        .expect_err("max is 2048");
1550        assert!(long.to_string().contains("ceiling of 2048"), "{long}");
1551
1552        // Eleven digits, which is the case no eyeball and no other check catches.
1553        let eleven = require_valid_role_arn("buildRoleArn", "arn:aws:iam::12345678901:role/build")
1554            .expect_err("the account id is eleven digits");
1555        let message = eleven.to_string();
1556        assert!(
1557            message.contains("exactly twelve digits"),
1558            "the digit count is the whole value of this check: {message}"
1559        );
1560        assert!(
1561            message.contains("after* the artifact upload"),
1562            "the reason to check locally is the cost: {message}"
1563        );
1564        assert!(
1565            message.contains("/aws/lambda-microvms/*"),
1566            "and the message says what is still the service's answer to give: {message}"
1567        );
1568
1569        require_valid_role_arn(
1570            "buildRoleArn",
1571            "arn:aws:iam::392583147479:role/bonk-sandbox-microvm-build",
1572        )
1573        .expect("the conformance account's real build role");
1574    }
1575
1576    /// The port guard refuses 0 and says what 0 means, because 0 is not a typo.
1577    ///
1578    /// The ceiling branch cannot fire from a `u16` call site — `MAX_PORT` is `u16::MAX` — so what
1579    /// is asserted here is the floor and the two legal boundaries.
1580    ///
1581    /// **Guard proof.** Change the comparison to `port < 0` (or delete the branch) and the zero
1582    /// case returns `Ok`.
1583    #[test]
1584    fn the_port_guard_refuses_zero_and_says_what_zero_means() {
1585        let zero = require_valid_port("allowedPorts[].port", 0).expect_err("min is 1");
1586        assert_eq!(zero.kind(), ErrorKind::InvalidArg);
1587        let message = zero.to_string();
1588        assert!(
1589            message.contains("let the kernel choose"),
1590            "0 is a value a caller passes on purpose, so the message has to say why it is not a \
1591             port: {message}"
1592        );
1593        assert!(
1594            message.contains("authorizes nothing"),
1595            "the proxy-token consequence: {message}"
1596        );
1597        assert!(message.contains("9000"), "the default is named: {message}");
1598
1599        require_valid_port("port", 1).expect("1 is the minimum");
1600        require_valid_port("port", 9000).expect("the agent port");
1601        require_valid_port("port", 65_535).expect("65535 is the ceiling");
1602    }
1603
1604    /// The idle-duration guard refuses 59 and says the botocore reasoning did not transfer.
1605    ///
1606    /// The message names the wrong premise on purpose. The exemption was not a wrong number, it
1607    /// was a correct fact about a client that no longer exists — and a reader who deletes this
1608    /// guard will do it by reasoning that `min` is validated locally, which is exactly the
1609    /// sentence the message answers.
1610    ///
1611    /// **Guard proof.** Delete the call in `run_microvm` and the zero-call test in `microvm.rs`
1612    /// goes red; invert the comparison here and 600 is refused while 59 passes.
1613    #[test]
1614    fn the_idle_guard_refuses_fifty_nine_and_names_the_premise_that_did_not_transfer() {
1615        let under = require_idle_duration(59).expect_err("min is 60");
1616        assert_eq!(under.kind(), ErrorKind::InvalidArg);
1617        let message = under.to_string();
1618        assert!(message.contains("59"), "{message}");
1619        assert!(message.contains("minimum of 60"), "{message}");
1620        assert!(
1621            message.contains("botocore"),
1622            "the message has to name the premise, because the premise is what was wrong: \
1623             {message}"
1624        );
1625        assert!(
1626            message.contains("aws-sigv4"),
1627            "and say what this client actually does instead: {message}"
1628        );
1629
1630        require_idle_duration(60).expect("60 is the minimum");
1631        require_idle_duration(600).expect("the default");
1632        // No maximum in the model, and the client adds none.
1633        require_idle_duration(u32::MAX).expect("the model states no ceiling");
1634    }
1635
1636    /// Every tag rejection names the offending key, and the key and the value keep their
1637    /// different rules.
1638    ///
1639    /// The two asymmetries are the content of this test: an empty value is legal and an empty key
1640    /// is not, and the ceilings are 128 against 256. A guard that used one rule for both would
1641    /// pass a 200-character key or refuse a 200-character value, and neither is what the service
1642    /// does.
1643    ///
1644    /// **Guard proof.** Use `MAX_TAG_KEY_LEN` for the value branch and the 256-character-value
1645    /// case fails; drop the `key` from any message and the assertion naming it goes red.
1646    #[test]
1647    fn every_tag_rejection_names_the_key_and_the_two_halves_keep_their_own_rules() {
1648        use std::collections::BTreeMap;
1649
1650        let one = |key: &str, value: &str| {
1651            let mut tags = BTreeMap::new();
1652            tags.insert(key.to_string(), value.to_string());
1653            tags
1654        };
1655
1656        // An empty **value** is legal. TagValue's min is 0.
1657        require_valid_tags(&one("owner", "")).expect("an empty tag value is legal");
1658        // An empty **key** is not. TagKey's min is 1.
1659        let blank = require_valid_tags(&one("", "conformance")).expect_err("TagKey min is 1");
1660        assert_eq!(blank.kind(), ErrorKind::InvalidArg);
1661        assert!(
1662            blank.to_string().contains("TagValue's minimum is 0"),
1663            "the asymmetry is the thing to say: {blank}"
1664        );
1665
1666        // The two ceilings differ by 2x, and a 256-character *value* is legal.
1667        require_valid_tags(&one("owner", &"v".repeat(256))).expect("TagValue max is 256");
1668        let long_value = require_valid_tags(&one("owner", &"v".repeat(257)))
1669            .expect_err("257 is one past TagValue");
1670        assert!(long_value.to_string().contains("\"owner\""), "{long_value}");
1671        assert!(
1672            long_value.to_string().contains("257 characters"),
1673            "{long_value}"
1674        );
1675
1676        require_valid_tags(&one(&"k".repeat(128), "v")).expect("TagKey max is 128");
1677        let long_key =
1678            require_valid_tags(&one(&"k".repeat(129), "v")).expect_err("129 is one past TagKey");
1679        let message = long_key.to_string();
1680        assert!(message.contains("129 characters"), "{message}");
1681        assert!(
1682            message.contains("TagValue allows 256"),
1683            "the message says the two halves are not interchangeable: {message}"
1684        );
1685
1686        // The pattern, both halves, with the key named either way.
1687        let bad_key = require_valid_tags(&one("cost,centre", "x")).expect_err("a comma");
1688        let message = bad_key.to_string();
1689        assert!(message.contains("\"cost,centre\""), "{message}");
1690        assert!(
1691            message.contains("commas and `#` and `%` are not"),
1692            "{message}"
1693        );
1694
1695        let bad_value = require_valid_tags(&one("owner", "50%")).expect_err("a percent");
1696        let message = bad_value.to_string();
1697        assert!(
1698            message.contains("the value of tag \"owner\""),
1699            "the message says which half as well as which key: {message}"
1700        );
1701
1702        // A newline in a key: legal-looking, and the reason keys are printed with `{:?}`.
1703        let newline = require_valid_tags(&one("owner\n", "x")).expect_err("a control character");
1704        assert!(
1705            newline.to_string().contains(r#""owner\n""#),
1706            "a key with a stray newline is indistinguishable from a good one until it is quoted: \
1707             {newline}"
1708        );
1709
1710        // And a realistic tag set passes, including a space and a non-Latin key.
1711        let mut real = BTreeMap::new();
1712        real.insert("owner".to_string(), "conformance".to_string());
1713        real.insert("cost centre".to_string(), "team/agents".to_string());
1714        real.insert("所有者".to_string(), "らいす".to_string());
1715        real.insert("empty".to_string(), String::new());
1716        require_valid_tags(&real).expect("a realistic tag set");
1717
1718        // An empty map is not a tag problem, and `create_image` omits the member entirely.
1719        require_valid_tags(&BTreeMap::new()).expect("no tags is not an invalid tag");
1720    }
1721
1722    /// **Issue #24's `HookState` half.** The two values are named by a type, so neither can be
1723    /// misspelled, and the block this client sends is six `Enabled`s.
1724    ///
1725    /// The wire spellings are asserted against literals rather than derived from the variant
1726    /// names, because the variant name and the string the service reads are two different things
1727    /// — the same reason `ops::VersionStatus` does it that way.
1728    ///
1729    /// **Guard proof.** Change `HookState::Enabled`'s rename to `"ENABLE"` and this fails on the
1730    /// serialization assertion; add a third variant and the `HOOK_STATES` comparison fails.
1731    #[test]
1732    fn the_hook_state_enum_is_the_models_two_values_and_nothing_else() {
1733        assert_eq!(ops::HookState::Disabled.as_str(), "DISABLED");
1734        assert_eq!(ops::HookState::Enabled.as_str(), "ENABLED");
1735        assert_eq!(ops::HookState::Enabled.to_string(), "ENABLED");
1736
1737        // Through serde, which is what actually reaches the wire — `as_str` could be right while
1738        // the `rename` is wrong.
1739        assert_eq!(
1740            serde_json::to_value(ops::HookState::Enabled).expect("serialises"),
1741            serde_json::json!("ENABLED")
1742        );
1743        assert_eq!(
1744            serde_json::to_value(ops::HookState::Disabled).expect("serialises"),
1745            serde_json::json!("DISABLED")
1746        );
1747
1748        // The typed spelling and the drift gate's array agree, or one of them is checking
1749        // something the other does not send.
1750        let spelled = [ops::HookState::Disabled, ops::HookState::Enabled];
1751        let mut wire: Vec<&str> = spelled.iter().map(|state| state.as_str()).collect();
1752        wire.sort_unstable();
1753        let mut pinned = crate::constants::HOOK_STATES.to_vec();
1754        pinned.sort_unstable();
1755        assert_eq!(wire, pinned);
1756
1757        // And the misspellings a `String` field allowed are now parse failures on the way in,
1758        // which is the closest an inline test gets to asserting they are compile errors on the
1759        // way out.
1760        for typo in ["\"ENABLE\"", "\"Enabled\"", "\"ACTIVE\"", "\"enabled\""] {
1761            serde_json::from_str::<ops::HookState>(typo)
1762                .expect_err(&format!("{typo} is not a HookState"));
1763        }
1764    }
1765}