macroonz-compiler 0.2.0

//! The two declaration roads, exercised from outside: a lawful body in, the builder or exploration module out, and every malformed clause refused at capture.
//!
//! The positive lanes hold the emitted text to the shapes the grammars promise; the refusal lanes reverse one clause each — an undeclared key, a doubled name, a foreign endpoint, an unreadable phrase, a missing fact, an empty declaration, a separator separating nothing.
//! The target also hosts, as named modules with their own doors, the codec owner's generated behavior, the harness-facing descriptor vocabulary, the descriptor output oracle, and the rendered-path magnitude.

mod codec_generated_behavior;
mod descriptor_vocabulary;
mod descriptor_output_oracle;
mod path_magnitude;
#[path = "../support/mod.rs"]
mod support;

use macroonz_compiler::descriptor::Grammar;
use macroonz_compiler::descriptor::concurrency::ConcurrencyModule;
use macroonz_compiler::descriptor::door;
use macroonz_compiler::descriptor::network::NetworkModule;
use macroonz_compiler::diagnostic::Door as DiagnosticDoor;
use macroonz_compiler::kind::Kind;
use macroonz_compiler::request::Door as RequestDoor;
use macroonz_compiler::{CrateBinding, Diagnostic, Door, Expansion, Phase, Producer, TextCapture};

/// The one value that says who is asking.
const DOOR: Door = Door::declared(
    "lane",
    "lane.declared.grammar",
    "lane::declared",
    CrateBinding::declared("demo"),
    Producer {
        namespace: "lane",
        name: "declared",
    },
);

/// Every approved public path names the one request-owned type.
const _: RequestDoor = DOOR;
const _: DiagnosticDoor = DOOR;
const _: Door = DOOR;

/// The network grammar this lane registers.
const NETWORK: Grammar = Grammar {
    attribute: "network",
};

/// The concurrency grammar this lane registers.
const CONCURRENCY: Grammar = Grammar {
    attribute: "concurrency",
};

/// One lawful network declaration body.
const NETWORK_BODY: &str = r#"
    module = net,
    namespace = "lane",
    nodes = [client, server],
    link forward = client to server,
    link back = server to client,
    schedule quiet = [],
    schedule outage = [
        drop forward at 0,
        delay forward at 1 by 2,
        duplicate back at 0,
        partition forward from 0 until 3,
    ],
"#;

/// One lawful concurrency declaration body.
const CONCURRENCY_BODY: &str = r#"
    module = explorations,
    namespace = "lane",
    transfers_hold {
        population = "transfer-orders",
        interleavings = 16,
        samples = 32,
        seed = 11,
    },
"#;

/// The network road walked over one source, or nothing where the lane's own source did not capture.
fn networked(source: &str) -> Option<Result<Expansion<NetworkModule>, Diagnostic>> {
    let bound = format!("harness = renamed_facade::harness, {source}");
    networked_raw(&bound)
}

/// The network road walked over an already-bound source.
fn networked_raw(source: &str) -> Option<Result<Expansion<NetworkModule>, Diagnostic>> {
    let read = TextCapture::read(source).ok()?;
    Some(door::network(read.input().clone(), NETWORK, &DOOR))
}

/// The concurrency road walked over one source, on the same terms.
fn concurrent(source: &str) -> Option<Result<Expansion<ConcurrencyModule>, Diagnostic>> {
    let bound = format!("harness = renamed_facade::harness, {source}");
    concurrent_raw(&bound)
}

/// The concurrency road walked over an already-bound source.
fn concurrent_raw(source: &str) -> Option<Result<Expansion<ConcurrencyModule>, Diagnostic>> {
    let read = TextCapture::read(source).ok()?;
    Some(door::concurrency(read.input().clone(), CONCURRENCY, &DOOR))
}

/// The declaration-site text one expansion emits.
fn emitted<K: Kind>(expansion: &Expansion<K>) -> Option<String> {
    expansion
        .emit()
        .tokens()
        .map(macroonz_compiler::GeneratedTree::inspected)
}

/// A lawful network declaration becomes one builder module: the fault enum, the topology, and one function per schedule.
#[test]
fn a_network_declaration_becomes_its_builder_module() -> Result<(), ()> {
    let expansion = networked(NETWORK_BODY).ok_or(())?.ok().ok_or(())?;
    let text = emitted(&expansion).ok_or(())?;
    for spelled in [
        ":: renamed_facade :: harness",
        "pub mod net",
        "pub enum Fault",
        "pub fn topology",
        "pub fn quiet",
        "pub fn outage",
        "Topology",
        "NetworkSchedule",
        "LinkDiscipline",
        "DropAt",
        "DelayAt",
        "DuplicateAt",
        "Partition",
        "TickSpan",
    ] {
        assert!(
            text.contains(spelled),
            "the module does not spell {spelled}"
        );
    }
    assert_eq!(text.matches("pub fn").count(), 3usize);
    Ok(())
}

/// A lawful concurrency declaration becomes one exploration module: the fault enum and one generic function per row.
#[test]
fn a_concurrency_declaration_becomes_its_exploration_module() -> Result<(), ()> {
    let expansion = concurrent(CONCURRENCY_BODY).ok_or(())?.ok().ok_or(())?;
    let text = emitted(&expansion).ok_or(())?;
    for spelled in [
        ":: renamed_facade :: harness",
        "pub mod explorations",
        "pub enum Fault",
        "pub fn transfers_hold",
        "StrandSet",
        "TransitionContract",
        "ExplorationBound",
        "PopulationRef",
        "RootSeed",
        "concluded",
    ] {
        assert!(
            text.contains(spelled),
            "the module does not spell {spelled}"
        );
    }
    assert_eq!(text.matches("pub fn").count(), 1usize);
    Ok(())
}

/// A direct harness binding is required, singular, bounded, and a fully consumed Rust path.
#[test]
fn a_direct_harness_binding_refuses_every_unwritable_shape() -> Result<(), ()> {
    let malformed = [
        NETWORK_BODY.to_owned(),
        format!("harness = , {NETWORK_BODY}"),
        format!("harness = type, {NETWORK_BODY}"),
        format!("harness = renamed:harness, {NETWORK_BODY}"),
        format!("harness = renamed::, {NETWORK_BODY}"),
        format!("harness = one, harness = two, {NETWORK_BODY}"),
        format!("harness = a::b::c::d::e::f::g::h::i, {NETWORK_BODY}"),
    ];
    for source in &malformed {
        let refusal = networked_raw(source).ok_or(())?.err().ok_or(())?;
        assert_eq!(refusal.phase(), Phase::Capture, "{source} did not refuse");
        assert!(
            refusal.summary().contains("(at "),
            "{source} carries no coordinate"
        );
    }

    let concurrency_without_binding = CONCURRENCY_BODY;
    let refusal = concurrent_raw(concurrency_without_binding)
        .ok_or(())?
        .err()
        .ok_or(())?;
    assert_eq!(refusal.phase(), Phase::Capture);
    assert!(refusal.summary().contains("(at "));
    Ok(())
}

/// The direct binding moves the declaration's own content commitment and the exact generated path.
#[test]
fn a_direct_harness_binding_is_committed_content() -> Result<(), ()> {
    let one_source = format!("harness = mh, {NETWORK_BODY}");
    let facade_source = format!("harness = renamed_facade::harness, {NETWORK_BODY}");
    let one = networked_raw(&one_source).ok_or(())?.ok().ok_or(())?;
    let facade = networked_raw(&facade_source).ok_or(())?.ok().ok_or(())?;

    assert_ne!(
        one.plan().account().content_commitment(),
        facade.plan().account().content_commitment()
    );
    assert!(emitted(&one).ok_or(())?.contains(":: mh :: network"));
    assert!(
        emitted(&facade)
            .ok_or(())?
            .contains(":: renamed_facade :: harness :: network")
    );
    Ok(())
}

/// A malformed network declaration refuses at capture, clause by clause.
#[test]
fn a_malformed_network_declaration_refuses_at_capture() -> Result<(), ()> {
    let missing_module = r#"
        namespace = "lane",
        nodes = [client, server],
        link forward = client to server,
    "#;
    let doubled_node = r#"
        module = net,
        namespace = "lane",
        nodes = [client, client],
        link forward = client to client,
    "#;
    let foreign_endpoint = r#"
        module = net,
        namespace = "lane",
        nodes = [client, server],
        link forward = client to stranger,
    "#;
    let undrawn_link = r#"
        module = net,
        namespace = "lane",
        nodes = [client, server],
        link forward = client to server,
        schedule outage = [drop sideways at 0],
    "#;
    let unread_phrase = r#"
        module = net,
        namespace = "lane",
        nodes = [client, server],
        link forward = client to server,
        schedule outage = [scramble forward at 0],
    "#;
    let undeclared_key = r#"
        module = net,
        namespace = "lane",
        nodes = [client, server],
        link forward = client to server,
        latency = 3,
    "#;
    let empty_then_stated_nodes = r#"
        module = net,
        namespace = "lane",
        nodes = [],
        nodes = [client, server],
        link forward = client to server,
    "#;
    let unseparated_nodes = r#"
        module = net,
        namespace = "lane",
        nodes = [client server],
        link forward = client to server,
    "#;
    let reserved_schedule = r#"
        module = net,
        namespace = "lane",
        nodes = [client, server],
        link forward = client to server,
        schedule topology = [],
    "#;
    let keyword_module = r#"
        module = type,
        namespace = "lane",
        nodes = [client, server],
        link forward = client to server,
    "#;
    let malformed_assignment = r#"
        module : net,
        namespace = "lane",
        nodes = [client, server],
        link forward = client to server,
    "#;
    let oversized_position = r#"
        module = net,
        namespace = "lane",
        nodes = [client, server],
        link forward = client to server,
        schedule outage = [drop forward at 4294967296],
    "#;
    for source in [
        missing_module,
        doubled_node,
        foreign_endpoint,
        undrawn_link,
        unread_phrase,
        undeclared_key,
        empty_then_stated_nodes,
        unseparated_nodes,
        reserved_schedule,
        keyword_module,
        malformed_assignment,
        oversized_position,
    ] {
        let refusal = networked(source).ok_or(())?.err().ok_or(())?;
        assert_eq!(refusal.phase(), Phase::Capture, "{source} did not refuse");
    }
    Ok(())
}

/// A separator separating nothing refuses at its own comma — leading or doubled — while a trailing comma stays ordinary Rust.
#[test]
fn a_network_separator_separating_nothing_refuses() -> Result<(), ()> {
    let leading_separator = r#"
        , module = net,
        namespace = "lane",
        nodes = [client, server],
        link forward = client to server,
    "#;
    let doubled_separator = r#"
        module = net,,
        namespace = "lane",
        nodes = [client, server],
        link forward = client to server,
    "#;
    for source in [leading_separator, doubled_separator] {
        let refusal = networked(source).ok_or(())?.err().ok_or(())?;
        assert_eq!(refusal.phase(), Phase::Capture, "{source} did not refuse");
        assert!(
            refusal
                .summary()
                .contains("a separator stands where no clause does"),
            "{source} does not name the dangling separator"
        );
        assert!(
            refusal.summary().contains("(at "),
            "{source} carries no coordinate"
        );
    }
    Ok(())
}

/// A concurrency separator separating nothing refuses at its own comma, named as such — at the declaration level and inside a row body.
#[test]
fn a_concurrency_separator_separating_nothing_refuses() -> Result<(), ()> {
    let doubled_separator = r#"
        module = explorations,,
        namespace = "lane",
        transfers_hold { population = "a", interleavings = 1, samples = 1, seed = 1 },
    "#;
    let dangling_row_separator = r#"
        module = explorations,
        namespace = "lane",
        transfers_hold { population = "a", interleavings = 1,, samples = 1, seed = 1 },
    "#;
    for source in [doubled_separator, dangling_row_separator] {
        let refusal = concurrent(source).ok_or(())?.err().ok_or(())?;
        assert_eq!(refusal.phase(), Phase::Capture, "{source} did not refuse");
        assert!(
            refusal
                .summary()
                .contains("a separator stands where no clause does"),
            "{source} does not name the dangling separator"
        );
        assert!(
            refusal.summary().contains("(at "),
            "{source} carries no coordinate"
        );
    }
    Ok(())
}

/// A malformed concurrency declaration refuses at capture, clause by clause.
#[test]
fn a_malformed_concurrency_declaration_refuses_at_capture() -> Result<(), ()> {
    let missing_fact = r#"
        module = explorations,
        namespace = "lane",
        transfers_hold {
            population = "transfer-orders",
            interleavings = 16,
            samples = 32,
        },
    "#;
    let doubled_row = r#"
        module = explorations,
        namespace = "lane",
        transfers_hold { population = "a", interleavings = 1, samples = 1, seed = 1 },
        transfers_hold { population = "b", interleavings = 1, samples = 1, seed = 1 },
    "#;
    let no_rows = r#"
        module = explorations,
        namespace = "lane",
    "#;
    let unread_number = r#"
        module = explorations,
        namespace = "lane",
        transfers_hold { population = "a", interleavings = many, samples = 1, seed = 1 },
    "#;
    let oversized_number = r#"
        module = explorations,
        namespace = "lane",
        transfers_hold { population = "a", interleavings = 4294967296, samples = 1, seed = 1 },
    "#;
    let keyword_module = r#"
        module = type,
        namespace = "lane",
        transfers_hold { population = "a", interleavings = 1, samples = 1, seed = 1 },
    "#;
    let keyword_row = r#"
        module = explorations,
        namespace = "lane",
        type { population = "a", interleavings = 1, samples = 1, seed = 1 },
    "#;
    for source in [
        missing_fact,
        doubled_row,
        no_rows,
        unread_number,
        oversized_number,
        keyword_module,
        keyword_row,
    ] {
        let refusal = concurrent(source).ok_or(())?.err().ok_or(())?;
        assert_eq!(refusal.phase(), Phase::Capture, "{source} did not refuse");
    }
    Ok(())
}