summaryrefslogtreecommitdiffstats
path: root/tests/protocol.rs
blob: d829ba9aed9ab166aba4084ce4228233ec7268ed (plain) (blame)
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
use std::io::Cursor;
use zagan_bet::protocol::{
    FrameBuffer, FrameError, MAX_FRAME_LEN, Packet, encode_frame, event_line, io_failure_message,
    parse_packet, parse_request, reply_line, request_line,
};

fn framed(payload: &str) -> Vec<u8> {
    encode_frame(payload)
}

#[test]
fn decodes_every_complete_frame_and_keeps_the_remainder() {
    let mut buffer = FrameBuffer::new();
    let mut bytes = framed("RES 1 PONG 1700000000000");
    bytes.extend(framed("EVT 2 crash.tick session=cr1 t=1700000000100 m=1.5"));
    buffer.push(&bytes);

    assert_eq!(
        buffer.next_frame().unwrap().unwrap(),
        "RES 1 PONG 1700000000000"
    );
    assert_eq!(
        buffer.next_frame().unwrap().unwrap(),
        "EVT 2 crash.tick session=cr1 t=1700000000100 m=1.5"
    );
    assert!(buffer.next_frame().is_none());
    assert!(buffer.is_empty());
}

#[test]
fn waits_for_a_partial_frame() {
    let mut buffer = FrameBuffer::new();
    let bytes = framed("RES 7 OK");
    buffer.push(&bytes[..3]);
    assert!(buffer.next_frame().is_none());

    buffer.push(&bytes[3..7]);
    assert!(buffer.next_frame().is_none());

    buffer.push(&bytes[7..]);
    assert_eq!(buffer.next_frame().unwrap().unwrap(), "RES 7 OK");
}

#[test]
fn an_oversized_length_is_rejected_without_waiting_for_bytes() {
    let mut buffer = FrameBuffer::new();
    buffer.push(&((MAX_FRAME_LEN as u32 + 1).to_be_bytes()));
    match buffer.next_frame() {
        Some(Err(FrameError::TooLarge(length))) => {
            assert_eq!(length, MAX_FRAME_LEN + 1);
        }
        other => panic!("expected an oversize error, got {other:?}"),
    }
    assert!(buffer.is_empty(), "the buffer must not keep the bad frame");
}

#[test]
fn invalid_utf8_is_a_protocol_error() {
    let mut buffer = FrameBuffer::new();
    buffer.push(&1u32.to_be_bytes());
    buffer.push(&[0xff]);
    assert_eq!(buffer.next_frame(), Some(Err(FrameError::InvalidUtf8)));
}

#[test]
fn reads_frames_from_a_blocking_reader() {
    let mut bytes = framed("RES 1 OK");
    bytes.extend(framed("EVT 1 crash.tick session=cr1 t=1 m=1.0"));
    let mut reader = Cursor::new(bytes);
    let mut buffer = FrameBuffer::new();

    assert_eq!(
        buffer.read_frame(&mut reader).unwrap().as_deref(),
        Some("RES 1 OK")
    );
    assert_eq!(
        buffer.read_frame(&mut reader).unwrap().as_deref(),
        Some("EVT 1 crash.tick session=cr1 t=1 m=1.0")
    );
    assert_eq!(buffer.read_frame(&mut reader).unwrap(), None);
}

#[test]
fn builds_and_parses_the_envelope() {
    assert_eq!(
        request_line(42, None, "PLAY_START crash 50"),
        "REQ 42 PLAY_START crash 50"
    );
    assert_eq!(
        request_line(42, Some("abc123"), "PLAY_START crash 50"),
        "REQ 42 idem=abc123 PLAY_START crash 50"
    );

    let request = parse_request("REQ 42 idem=abc123 PLAY_START crash 50").unwrap();
    assert_eq!(request.id, 42);
    assert_eq!(request.idem.as_deref(), Some("abc123"));
    assert_eq!(request.payload, "PLAY_START crash 50");

    let request = parse_request("REQ 7 PING").unwrap();
    assert_eq!(request.id, 7);
    assert_eq!(request.idem, None);
    assert_eq!(request.payload, "PING");

    assert!(parse_request("PLAY_START crash 50").is_err());
    assert!(parse_request("REQ nope PING").is_err());
    assert!(parse_request("REQ 1 idem= PING").is_err());
}

#[test]
fn parses_replies_and_events() {
    assert_eq!(
        parse_packet(&reply_line(9, "ERROR Insufficient balance")).unwrap(),
        Packet::Reply {
            id: 9,
            body: "ERROR Insufficient balance".to_string()
        }
    );
    assert_eq!(
        parse_packet(&event_line(3, "CRASH_BUSTED {}")).unwrap(),
        Packet::Event {
            seq: 3,
            body: "CRASH_BUSTED {}".to_string()
        }
    );
    assert!(parse_packet("REQ 1 PING").is_err());
    assert!(parse_packet("RES nope OK").is_err());
}

#[test]
fn io_failures_are_reported_as_short_messages() {
    let timeout = std::io::Error::new(std::io::ErrorKind::TimedOut, "slow");
    assert_eq!(io_failure_message(&timeout), "ERROR Request timed out");

    let closed = std::io::Error::new(std::io::ErrorKind::UnexpectedEof, "gone");
    assert_eq!(io_failure_message(&closed), "ERROR Connection lost");
}