Simplified config tests and added rustdoc test for README.md.

This commit is contained in:
Aaron Weiss 2014-12-05 10:27:58 -05:00
parent 4f7184afc4
commit 6b294036f2
3 changed files with 11 additions and 22 deletions

View file

@ -9,6 +9,7 @@ script:
- cargo build --verbose --features "encode ssl"
- cargo test --verbose
- cargo test --verbose --features "encode ssl"
- rustdoc --test README.md -L target
- cargo doc --verbose
- cargo doc --verbose --features "encode ssl"
notifications:

View file

@ -12,12 +12,17 @@ Cargo.toml file. From there, you can look to the examples and the documentation
proceed. Making a simple bot is easy though:
```rust
extern crate irc;
use irc::server::{IrcServer, Server};
use irc::server::utils::Wrapper;
fn main() {
let irc_server = IrcServer::connect("config.json").unwrap();
let irc_server = IrcServer::new("config.json").unwrap();
let server = Wrapper::new(&irc_server);
server.identify().unwrap();
for message in server.iter() {
process(&server, message)
// Do message processing.
}
}
```

View file

@ -139,6 +139,7 @@ impl Config {
mod test {
use super::Config;
use std::collections::HashMap;
use std::default::Default;
#[test]
fn load() {
@ -181,16 +182,7 @@ mod test {
fn is_owner() {
let cfg = Config {
owners: Some(vec![format!("test"), format!("test2")]),
nickname: Some(format!("test")),
username: Some(format!("test")),
realname: Some(format!("test")),
password: Some(String::new()),
server: Some(format!("irc.test.net")),
port: Some(6667),
use_ssl: Some(false),
encoding: Some(format!("UTF-8")),
channels: Some(vec![format!("#test"), format!("#test2")]),
options: Some(HashMap::new()),
.. Default::default()
};
assert!(cfg.is_owner("test"));
assert!(cfg.is_owner("test2"));
@ -200,21 +192,12 @@ mod test {
#[test]
fn get_option() {
let cfg = Config {
owners: Some(vec![format!("test")]),
nickname: Some(format!("test")),
username: Some(format!("test")),
realname: Some(format!("test")),
password: Some(String::new()),
server: Some(format!("irc.test.net")),
port: Some(6667),
use_ssl: Some(false),
encoding: Some(format!("UTF-8")),
channels: Some(vec![format!("#test"), format!("#test2")]),
options: {
let mut map = HashMap::new();
map.insert(format!("testing"), format!("test"));
Some(map)
},
.. Default::default()
};
assert_eq!(cfg.get_option("testing"), "test");
}