vinezombie 0.3.1

A modular IRCv3 framework
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
95
96
97
98
99

use std::{io::Cursor, time::Duration};

use super::{register_as_bot, HandlerError, Options};
use crate::{
    client::{
        auth::Clear,
        channel::SyncChannels,
        conn::Bidir,
        state::{Caps, ISupport},
        Client, ClientState,
    },
    string::{Key, Nick},
};

/// Test registration while ignoring the messages the handler sends.
fn static_register(msg: &[u8]) -> Result<ClientState, HandlerError> {
    let mut options: Options<Clear> = Options::new();
    options.nicks = vec![Nick::from_str("Me")];
    let reg = register_as_bot(); // Somewhat more deterministic.
    let io = Bidir::<Cursor<Vec<u8>>, _>(Cursor::new(msg.to_vec()), std::io::sink());
    let mut client = Client::new(io, SyncChannels);
    client.queue_mut().set_rate_limit(Duration::ZERO, 1);
    let (_, reg) = client.add(&reg, &options).unwrap();
    client.run().unwrap();
    reg.0.recv_now().expect("Handler should send on channel after success")?;
    Ok(std::mem::take(client.state_mut()))
}

#[test]
fn ircv2_reg() {
    // We should be able to handle any values for messages 001 through 003,
    // so we're just going to put silliness here.
    static_register(
        concat!(
            ":example.com NOTICE Me :senpai!\r\n",
            ":foo!bar@baz 001 Me :Hi, we're glad to have you.\r\n",
            ":foo!bar@baz 002 Me :I'm your host. You can get foo at the bar.\r\n",
            ":foo!bar@baz 003 Me :Someone wrote me in 2024.\r\n",
            // Omit the last param for testing reasons.
            ":foo!bar@baz 004 Me ircv2_reg.fn the-latest-one iw bnt\r\n",
            ":foo!bar@baz 422 Me :Nobody reads MOTDs anyway these days.\r\n",
        )
        .as_bytes(),
    )
    .expect("ircv2 reg failed");
}

#[test]
fn ircv3_reg_simple() {
    use crate::names::{cap::LABELED_RESPONSE, isupport::NETWORK};
    // TODO: Test more thoroughly.
    // We should be able to handle any values for messages 001 through 003,
    // so we're just going to put silliness here.
    let state = static_register(
        concat!(
            ":example.com CAP * LS :quickbrownfox/lazydogjumping labeled-response\r\n",
            ":example.com CAP * ACK :labeled-response\r\n",
            ":example.com 001 Me :Hi, we're glad to have you.\r\n",
            ":example.com 002 Me :I'm your host. You can get foo at the bar.\r\n",
            ":example.com 003 Me :Someone wrote me in 2024.\r\n",
            // Omit the last param for testing reasons.
            ":example.com 004 Me ircv2_reg.fn the-latest-one iw bnt\r\n",
            ":example.com 005 Me NETWORK=example.com FOXSAID=WHAT :are allegedly supported.\r\n",
            ":example.com NOTICE Me :senpai!\r\n",
            ":example.com 422 Me :Nobody reads MOTDs anyway these days.\r\n",
        )
        .as_bytes(),
    )
    .expect("ircv3 reg failed");
    let caps = state.get::<Caps>().expect("Handler should set Caps on success");
    let isupport = state.get::<ISupport>().expect("Handler should set ISupport on success");
    assert_eq!(caps.get_extra(LABELED_RESPONSE).copied(), Some(true));
    assert_eq!(
        caps.get_extra_raw(&Key::from_str("quickbrownfox/lazydogjumping")).copied(),
        Some(false)
    );
    let netname = isupport.get_parsed(NETWORK).expect("NETWORK should have a value").unwrap();
    assert_eq!(netname, b"example.com");
}

#[test]
fn bounce() {
    let testcases = [
        b":foo!bar@baz 005 :Try server example.com, port 6667\r\n".as_slice(),
        b":foo!bar@baz 005 * :Try server example.com, port 6667\r\n",
        b":foo!bar@baz 005 Me :Try server example.com, port 6667\r\n",
        b":foo!bar@baz 010 Me example.com 6667 :We now live in a yellow submarine\r\n",
    ];
    for testcase in testcases {
        match static_register(testcase) {
            Err(HandlerError::Redirect(serv, port, _)) => {
                assert_eq!(serv.to_utf8_lossy(), "example.com");
                assert_eq!(port, 6667);
            }
            Err(e) => panic!("wrong error: {e}"),
            Ok(_) => panic!("connection registration somehow succeeded"),
        }
    }
}