irc_lib 0.1.4

Simple IRC library with plugin support
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
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183

mod common;

use irc_lib::{IrcClient, IrcMessage, message};
use std::time::Duration;

#[test]
fn send_message() -> common::TestResult {
    let mut errors = Vec::new();
    let mut harness = common::TestHarness::new();
    harness.start_ircd();
    let host = &harness.get_host();
    let channel = "#test";

    let irc_sender = harness.register_client(
        IrcClient::new(host)
            .nick("sender")
            .channel(channel)
            .build()
            .run(),
    );
    let irc_receiver = harness.register_client(
        IrcClient::new(host)
            .nick("receiver")
            .channel(channel)
            .build()
            .run(),
    );

    let (sender, _sender_receiver) = irc_sender.channels();
    let (_receiver_sender, receiver) = irc_receiver.channels();

    let msg = IrcMessage::builder()
        .command(message::Command::PrivMsg)
        .param(message::Param::Channel(String::from(channel)))
        .param(irc_lib::message::Param::Message(String::from(
            "Hello, world!",
        )))
        .build()
        .unwrap();

    common::clear_buffer(receiver);

    sender
        .send(msg)
        .expect("MAIN THREAD COULDN'T SEND IRC MESSAGE");

    // Verify that the message was actually sent
    if let Ok(received_msg) = receiver.recv_timeout(Duration::from_secs(2)) {
        let expected = "Hello, world!";
        let actual = received_msg.get_message().unwrap();
        if expected != actual {
            errors.push(format!("Expected: {}, but got {}", expected, actual))
        }
    } else {
        errors.push(String::from("Did not receive message"));
    }

    if !errors.is_empty() {
        return Err(errors.join("; ").into());
    }

    Ok(())
}

#[test]
fn plugin_replies_to_messages() -> common::TestResult {
    let mut errors = Vec::new();
    let mut harness = common::TestHarness::new();
    harness.start_ircd();
    let host = &harness.get_host();
    let channel = "#test";

    let irc_sender = harness.register_client(
        IrcClient::new(host)
            .nick("sender")
            .channel(channel)
            .build()
            .run(),
    );
    // replier
    harness.register_client(
        IrcClient::new(host)
            .nick("receiver")
            .channel(channel)
            .register_plugin(common::EchoPlugin)
            .build()
            .run(),
    );

    let (sender, sender_receiver) = irc_sender.channels();

    let msg = IrcMessage::builder()
        .command(message::Command::PrivMsg)
        .param(message::Param::Channel(String::from("#test")))
        .param(irc_lib::message::Param::Message(String::from(
            "Hello, world!",
        )))
        .build()
        .unwrap();

    common::clear_buffer(sender_receiver);
    sender
        .send(msg)
        .expect("MAIN THREAD COULDN'T SEND IRC MESSAGE");

    // Check for the echoed message
    if let Ok(received_msg) = sender_receiver.recv_timeout(Duration::from_secs(2)) {
        let expected = "sender: Hello, world!";
        let actual = received_msg.get_message().unwrap();
        if expected != actual {
            errors.push(format!("Expected: {}, but got {}", expected, actual))
        }
    } else {
        errors.push(String::from("Did not receive echoed message"));
    }

    if !errors.is_empty() {
        return Err(errors.join("; ").into());
    }

    Ok(())
}

#[test]
fn send_multiple_messages() -> common::TestResult {
    let mut errors = Vec::new();
    let mut harness = common::TestHarness::new();
    harness.start_ircd();
    let host = &harness.get_host();
    let channel = "#test";

    let irc_sender = harness.register_client(
        IrcClient::new(host)
            .nick("sender")
            .channel(channel)
            .build()
            .run(),
    );
    let irc_receiver = harness.register_client(
        IrcClient::new(host)
            .nick("receiver")
            .channel(channel)
            .build()
            .run(),
    );

    let (sender, _sender_receiver) = irc_sender.channels();
    let (_receiver_sender, receiver) = irc_receiver.channels();

    common::clear_buffer(receiver);

    for i in 0..5 {
        let msg = IrcMessage::builder()
            .command(message::Command::PrivMsg)
            .param(message::Param::Channel(String::from(channel)))
            .param(irc_lib::message::Param::Message(format!("Message {}", i)))
            .build()
            .unwrap();

        sender
            .send(msg)
            .expect("MAIN THREAD COULDN'T SEND IRC MESSAGE");
    }

    // Verify that the messages were received by the server
    for i in 0..5 {
        if let Ok(received_msg) = receiver.recv_timeout(Duration::from_secs(2)) {
            let expected = &format!("Message {}", i);
            let actual = received_msg.get_message().unwrap();
            if expected != actual {
                errors.push(format!("Expected: {}, but got {}", expected, actual))
            }
        } else {
            errors.push(String::from("Did not receive message"));
        }
    }

    if !errors.is_empty() {
        return Err(errors.join("; ").into());
    }

    Ok(())
}