veyron-sdk 0.1.0

//! Protocol-conformance tests for the SDK transport: framing round-trips,
//! zstd compression normalization, HMAC frame MACs, fragmentation
//! reassembly, raw-binary frames, and the Plugin trait receive loop.
//!
//! All tests run over `UnixStream::pair()` — no kernel required. Full
//! kernel-in-the-loop coverage lives in the main repository's
//! `tests/integration/test_sdk_rust.rs`.

use prost::Message;
use std::time::Duration;
use tokio::net::UnixStream;
use veyron_sdk::frame_mac::{compute_tag, derive_session_key, verify_tag};
use veyron_sdk::framing::{
    parse_frag_header, read_frame, serialize_header, write_frame_raw, Frame, COMPRESS_THRESHOLD,
    FLAG_FRAGMENTED, FLAG_MAC_PRESENT, FLAG_RAW_BINARY, FRAG_HEADER_SIZE, MAX_PAYLOAD_SIZE,
};
use veyron_sdk::proto::{
    envelope, Envelope, Event, Ping, PluginManifest, PluginRegisterAck, PluginShutdown,
};
use veyron_sdk::{Plugin, VeyronClient, VeyronError};

fn envelope_with_event(event_id: &str) -> Envelope {
    Envelope {
        payload: Some(envelope::Payload::Event(Event {
            event_id: event_id.into(),
            event_type: "test.event".into(),
            payload_json: b"{}".to_vec(),
            retry_count: 0,
        })),
        ..Default::default()
    }
}

fn decode(frame: &Frame) -> Envelope {
    Envelope::decode(frame.payload.as_ref()).expect("decode envelope")
}

#[tokio::test]
async fn send_recv_roundtrip() {
    let (a, b) = UnixStream::pair().unwrap();
    let mut client = VeyronClient::from_stream(a, None);
    let mut peer = VeyronClient::from_stream(b, None);

    client
        .send("kernel", envelope_with_event("evt-1"))
        .await
        .unwrap();
    let env = peer.recv().await.unwrap();
    match env.payload {
        Some(envelope::Payload::Event(ev)) => assert_eq!(ev.event_id, "evt-1"),
        other => panic!("unexpected payload: {other:?}"),
    }
}

#[tokio::test]
async fn large_payload_is_compressed_on_wire_and_normalized_on_read() {
    let (a, mut b) = UnixStream::pair().unwrap();
    let mut client = VeyronClient::from_stream(a, None);

    // Highly compressible payload above the threshold.
    let payload = vec![0x42u8; COMPRESS_THRESHOLD + 1024];
    let expected = payload.clone();
    let handle = tokio::spawn(async move {
        client.send_raw("peer", payload).await.unwrap();
        client
    });

    let frame = read_frame(&mut b).await.unwrap();
    handle.await.unwrap();

    // read_frame normalizes: plaintext payload, flags/length/crc32 describe it.
    assert_eq!(&*frame.payload, expected);
    assert_eq!(frame.length as usize, expected.len());
    assert_eq!(frame.crc32, crc32fast::hash(&expected));
    assert_eq!(frame.flags & veyron_sdk::framing::FLAG_COMPRESSED, 0);
}

#[tokio::test]
async fn mac_secured_registration_and_tagged_frames() {
    let secret = b"test-shared-secret";
    let nonce = b"0123456789abcdef".to_vec(); // 16 bytes
    let plugin_id = "mac-plugin";

    let (a, mut kernel_side) = UnixStream::pair().unwrap();
    let mut client = VeyronClient::from_stream(a, Some(secret.to_vec()));

    // Fake kernel: read the register frame, reply with an ack carrying a nonce.
    let nonce_clone = nonce.clone();
    let kernel = tokio::spawn(async move {
        let reg = read_frame(&mut kernel_side).await.unwrap();
        let env = decode(&reg);
        assert!(matches!(
            env.payload,
            Some(envelope::Payload::PluginRegister(_))
        ));

        let ack = Envelope {
            payload: Some(envelope::Payload::PluginRegisterAck(PluginRegisterAck {
                accepted: true,
                session_nonce: nonce_clone,
                ..Default::default()
            })),
            ..Default::default()
        };
        let mut buf = Vec::new();
        ack.encode(&mut buf).unwrap();
        let mut target = [0u8; 32];
        target[..plugin_id.len()].copy_from_slice(plugin_id.as_bytes());
        let frame = Frame {
            magic: 0x5652,
            flags: 0,
            length: buf.len() as u32,
            target,
            crc32: crc32fast::hash(&buf),
            payload: buf.into(),
            mac: None,
        };
        write_frame_raw(&mut kernel_side, &frame).await.unwrap();

        // Next frame from the client must carry a valid MAC.
        let secured = read_frame(&mut kernel_side).await.unwrap();
        assert_ne!(secured.flags & FLAG_MAC_PRESENT, 0, "MAC flag missing");
        let key = derive_session_key(secret, b"0123456789abcdef", plugin_id);
        let header = serialize_header(&secured);
        let tag = secured.mac.expect("tag missing");
        assert!(
            verify_tag(&key, &header, &secured.payload, &tag),
            "MAC verification failed on kernel side"
        );
    });

    let ack = client
        .register(plugin_id, PluginManifest::default())
        .await
        .unwrap();
    assert!(ack.accepted);
    assert!(client.is_secured(), "session key not derived from nonce");

    client.subscribe(vec!["*".into()]).await.unwrap();
    kernel.await.unwrap();
}

#[tokio::test]
async fn recv_rejects_untagged_frame_when_secured() {
    let secret = b"s3cret";
    let (a, mut kernel_side) = UnixStream::pair().unwrap();
    let mut client = VeyronClient::from_stream(a, Some(secret.to_vec()));

    let kernel = tokio::spawn(async move {
        let _reg = read_frame(&mut kernel_side).await.unwrap();
        let ack = Envelope {
            payload: Some(envelope::Payload::PluginRegisterAck(PluginRegisterAck {
                accepted: true,
                session_nonce: b"ffffffffffffffff".to_vec(),
                ..Default::default()
            })),
            ..Default::default()
        };
        let mut buf = Vec::new();
        ack.encode(&mut buf).unwrap();
        let frame = Frame {
            magic: 0x5652,
            flags: 0,
            length: buf.len() as u32,
            target: [0u8; 32],
            crc32: crc32fast::hash(&buf),
            payload: buf.into(),
            mac: None,
        };
        write_frame_raw(&mut kernel_side, &frame).await.unwrap();

        // Send a follow-up frame WITHOUT a MAC — the client must reject it.
        let mut buf2 = Vec::new();
        envelope_with_event("evt-untagged")
            .encode(&mut buf2)
            .unwrap();
        let frame2 = Frame {
            magic: 0x5652,
            flags: 0,
            length: buf2.len() as u32,
            target: [0u8; 32],
            crc32: crc32fast::hash(&buf2),
            payload: buf2.into(),
            mac: None,
        };
        write_frame_raw(&mut kernel_side, &frame2).await.unwrap();
        kernel_side
    });

    client
        .register("p", PluginManifest::default())
        .await
        .unwrap();
    assert!(client.is_secured());
    let err = client.recv().await.expect_err("untagged frame accepted");
    assert!(err.to_string().contains("MAC"));
    kernel.await.unwrap();
}

#[tokio::test]
async fn fragmentation_roundtrip_via_client_recv() {
    let (a, b) = UnixStream::pair().unwrap();
    let mut sender = VeyronClient::from_stream(a, None);
    let mut receiver = VeyronClient::from_stream(b, None);

    // A payload that needs several fragments at a small chunk size.
    let mut inner = Vec::new();
    envelope_with_event("evt-frag").encode(&mut inner).unwrap();
    let payload = inner.clone();

    let send = tokio::spawn(async move {
        sender.send_fragmented("peer", &payload, 7).await.unwrap();
        sender
    });

    let env = receiver.recv().await.unwrap();
    send.await.unwrap();
    match env.payload {
        Some(envelope::Payload::Event(ev)) => assert_eq!(ev.event_id, "evt-frag"),
        other => panic!("unexpected payload: {other:?}"),
    }
}

#[tokio::test]
async fn fragment_wire_format_matches_framing_doc() {
    let (a, mut b) = UnixStream::pair().unwrap();
    let mut sender = VeyronClient::from_stream(a, None);

    let payload = vec![9u8; 25]; // 3 fragments of 10 + header each
    let send = tokio::spawn(async move {
        sender.send_fragmented("peer", &payload, 10).await.unwrap();
    });

    for expected_seq in 0u16..3 {
        let frame = read_frame(&mut b).await.unwrap();
        assert_ne!(frame.flags & FLAG_FRAGMENTED, 0);
        let hdr = parse_frag_header(&frame.payload).expect("frag header");
        assert_eq!(hdr.sequence, expected_seq);
        assert_eq!(hdr.total, 3);
        let chunk_len = frame.payload.len() - FRAG_HEADER_SIZE;
        assert_eq!(chunk_len, if expected_seq < 2 { 10 } else { 5 });
    }
    send.await.unwrap();
}

#[tokio::test]
async fn send_fragmented_rejects_oversized_payload() {
    let (a, _b) = UnixStream::pair().unwrap();
    let mut sender = VeyronClient::from_stream(a, None);
    let payload = vec![0u8; MAX_PAYLOAD_SIZE + 1];
    let err = sender
        .send_fragmented("peer", &payload, 65536)
        .await
        .expect_err("oversized payload accepted");
    assert!(matches!(err, VeyronError::PayloadTooLarge(_)));
}

#[tokio::test]
async fn raw_binary_frame_bypasses_protobuf() {
    let (a, b) = UnixStream::pair().unwrap();
    let mut sender = VeyronClient::from_stream(a, None);
    let mut receiver = VeyronClient::from_stream(b, None);

    let pcm = vec![0x01u8, 0x02, 0x03, 0x04];
    sender.send_raw_audio("peer", pcm.clone()).await.unwrap();

    let frame = receiver.recv_frame().await.unwrap();
    assert_ne!(frame.flags & FLAG_RAW_BINARY, 0);
    assert_eq!(&*frame.payload, pcm);
}

#[tokio::test]
async fn recv_errors_on_raw_binary_frame() {
    let (a, b) = UnixStream::pair().unwrap();
    let mut sender = VeyronClient::from_stream(a, None);
    let mut receiver = VeyronClient::from_stream(b, None);

    sender.send_raw_audio("peer", vec![1, 2, 3]).await.unwrap();
    let err = receiver.recv().await.expect_err("raw frame decoded");
    assert!(err.to_string().contains("raw-binary"));
}

#[tokio::test]
async fn recv_timeout_returns_timeout_error() {
    let (a, _b) = UnixStream::pair().unwrap();
    let mut client = VeyronClient::from_stream(a, None);
    let err = client
        .recv_timeout(Duration::from_millis(50))
        .await
        .expect_err("recv returned without traffic");
    assert!(matches!(err, VeyronError::Timeout));
}

#[test]
fn mac_tag_roundtrip_over_serialized_header() {
    let key = derive_session_key(b"secret", b"0123456789abcdef", "p");
    let frame = Frame {
        magic: 0x5652,
        flags: FLAG_MAC_PRESENT,
        length: 5,
        target: [7u8; 32],
        crc32: 0xDEADBEEF,
        payload: b"hello".to_vec().into(),
        mac: None,
    };
    let header = serialize_header(&frame);
    let tag = compute_tag(&key, &header, &frame.payload);
    assert!(verify_tag(&key, &header, &frame.payload, &tag));
    assert!(!verify_tag(&key, &header, b"hellp", &tag));
}

// ── Plugin trait receive loop ───────────────────────────────────────

struct TestPlugin {
    events_seen: Vec<String>,
    init_called: bool,
    shutdown_called: bool,
}

impl Plugin for TestPlugin {
    fn id(&self) -> &str {
        "test-plugin"
    }

    fn version(&self) -> &str {
        "2.3.4"
    }

    fn manifest(&self) -> PluginManifest {
        PluginManifest::default()
    }

    async fn on_init(&mut self, _client: &mut VeyronClient) -> Result<(), VeyronError> {
        self.init_called = true;
        Ok(())
    }

    async fn on_event(&mut self, event: Event) -> Result<Option<Envelope>, VeyronError> {
        self.events_seen.push(event.event_id);
        Ok(None)
    }

    async fn on_message(&mut self, _env: Envelope) -> Result<Option<Envelope>, VeyronError> {
        Ok(None)
    }

    async fn on_shutdown(&mut self) -> Result<(), VeyronError> {
        self.shutdown_called = true;
        Ok(())
    }
}

#[tokio::test]
async fn plugin_serve_loop_handles_ping_event_and_shutdown() {
    let (a, mut kernel_side) = UnixStream::pair().unwrap();
    let client = VeyronClient::from_stream(a, None);

    let kernel = tokio::spawn(async move {
        // Registration → ack.
        let reg = read_frame(&mut kernel_side).await.unwrap();
        let env = decode(&reg);
        match env.payload {
            Some(envelope::Payload::PluginRegister(r)) => {
                assert_eq!(r.plugin_id, "test-plugin");
                assert_eq!(r.version, "2.3.4");
            }
            other => panic!("expected register, got {other:?}"),
        }
        let ack = Envelope {
            payload: Some(envelope::Payload::PluginRegisterAck(PluginRegisterAck {
                accepted: true,
                ..Default::default()
            })),
            ..Default::default()
        };
        let mut buf = Vec::new();
        ack.encode(&mut buf).unwrap();
        let frame = Frame {
            magic: 0x5652,
            flags: 0,
            length: buf.len() as u32,
            target: [0u8; 32],
            crc32: crc32fast::hash(&buf),
            payload: buf.into(),
            mac: None,
        };
        write_frame_raw(&mut kernel_side, &frame).await.unwrap();

        let send_env = |env: Envelope| {
            let mut buf = Vec::new();
            env.encode(&mut buf).unwrap();
            Frame {
                magic: 0x5652,
                flags: 0,
                length: buf.len() as u32,
                target: [0u8; 32],
                crc32: crc32fast::hash(&buf),
                payload: buf.into(),
                mac: None,
            }
        };

        // Ping → expect Pong.
        let ping = Envelope {
            payload: Some(envelope::Payload::Ping(Ping { timestamp: 12345 })),
            ..Default::default()
        };
        write_frame_raw(&mut kernel_side, &send_env(ping))
            .await
            .unwrap();
        let pong_frame = read_frame(&mut kernel_side).await.unwrap();
        match decode(&pong_frame).payload {
            Some(envelope::Payload::Pong(p)) => assert_eq!(p.original_timestamp, 12345),
            other => panic!("expected pong, got {other:?}"),
        }

        // Event → expect EventAck.
        write_frame_raw(&mut kernel_side, &send_env(envelope_with_event("evt-42")))
            .await
            .unwrap();
        let ack_frame = read_frame(&mut kernel_side).await.unwrap();
        match decode(&ack_frame).payload {
            Some(envelope::Payload::EventAck(a)) => assert_eq!(a.event_id, "evt-42"),
            other => panic!("expected event ack, got {other:?}"),
        }

        // Shutdown → loop must exit.
        let shutdown = Envelope {
            payload: Some(envelope::Payload::PluginShutdown(PluginShutdown {
                reason: "test over".into(),
                grace_seconds: 0,
            })),
            ..Default::default()
        };
        write_frame_raw(&mut kernel_side, &send_env(shutdown))
            .await
            .unwrap();
    });

    let mut plugin = TestPlugin {
        events_seen: Vec::new(),
        init_called: false,
        shutdown_called: false,
    };
    tokio::time::timeout(Duration::from_secs(5), plugin.serve(client, ""))
        .await
        .expect("serve loop did not exit on PluginShutdown")
        .unwrap();

    assert!(plugin.init_called);
    assert!(plugin.shutdown_called);
    assert_eq!(plugin.events_seen, vec!["evt-42".to_string()]);
    kernel.await.unwrap();
}