phoxal 0.59.1

Phoxal - production-oriented autonomous robot framework: the runtime engine and model (the api contract tree lives in phoxal-api, the typed bus in phoxal-bus).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

//! The contract surface this crate owns: the participant launch contract.
//!
//! A supervised participant's whole process boundary on the way in is its
//! argv. The record below is read out of the clap definition itself rather
//! than restated beside it, so a renamed flag, a newly optional argument, or an
//! option that started accepting repetition changes the surface by
//! construction - there is no second list to forget to update.

use clap::CommandFactory;
use phoxal_runtime_contract::contract_surface::{
    ContractRecord, ContractSurface, LaunchArgument, LaunchValueShape,
};

use crate::participant::launch::SupervisedLaunch;

/// The canonical rendering of this crate's contract surface.
#[must_use]
pub fn contract_surface() -> String {
    ContractSurface::new([ContractRecord::launch(launch_arguments())]).canonical_json()
}

/// Read the declared arguments off the parser, in its own declaration order.
fn launch_arguments() -> Vec<LaunchArgument> {
    SupervisedLaunch::command()
        .get_arguments()
        .map(|argument| {
            LaunchArgument::new(
                // Every launch argument is long-only, which the parser's own
                // tests pin; an argument without a long spelling would show up
                // here as its clap id rather than being silently dropped.
                argument
                    .get_long()
                    .map_or_else(|| argument.get_id().to_string(), ToString::to_string),
                argument.is_required_set(),
                matches!(argument.get_action(), clap::ArgAction::Append),
                if argument.get_action().takes_values() {
                    LaunchValueShape::Text
                } else {
                    LaunchValueShape::Flag
                },
            )
        })
        .collect()
}

#[cfg(test)]
mod tests {
    use super::{contract_surface, launch_arguments};
    use phoxal_runtime_contract::contract_surface::{
        ContractRecord, ContractSurface, LaunchArgument, LaunchValueShape,
    };

    /// The launch record is derived from the live clap definition, so this
    /// states the record that definition is expected to produce. A change to
    /// the process boundary - a flag renamed, an argument made optional, an
    /// option made repeatable - shows up here as a diff a reviewer has to
    /// accept on purpose.
    #[test]
    fn the_launch_record_is_the_supervisor_owned_argv_contract() {
        let expected = ContractSurface::new([ContractRecord::launch([
            LaunchArgument::new("execution-id", true, false, LaunchValueShape::Text),
            LaunchArgument::new("participant-id", true, false, LaunchValueShape::Text),
            LaunchArgument::new("bundle-root", true, false, LaunchValueShape::Text),
            LaunchArgument::new("connect", true, true, LaunchValueShape::Text),
            LaunchArgument::new("execution-origin", false, false, LaunchValueShape::Text),
            LaunchArgument::new("shutdown-grace-ms", false, false, LaunchValueShape::Text),
        ])]);
        assert_eq!(contract_surface(), expected.canonical_json());
    }

    /// Two calls produce the same bytes, which is what lets a checker compare
    /// the surface with a stored baseline by string equality.
    #[test]
    fn the_surface_is_deterministic_json() {
        let rendered = contract_surface();
        serde_json::from_str::<serde_json::Value>(&rendered).expect("the surface is JSON");
        assert_eq!(contract_surface(), rendered);
        assert!(rendered.contains(r#""record":"launch""#), "{rendered}");
    }

    /// Every supervisor-owned argument consumes an argv token; the launch
    /// contract has no bare switches of its own.
    #[test]
    fn every_supervisor_owned_argument_consumes_a_value() {
        for argument in launch_arguments() {
            assert_eq!(
                argument.value,
                LaunchValueShape::Text,
                "{} is not a value-taking option",
                argument.name
            );
        }
    }
}