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
184
185
186
extern crate pulldown_cmark as cmark;

use std::env;
use std::fs::File;
use std::io::Error as IoError;
use std::io::{Read, Write};
use std::path::{PathBuf, Path};
use cmark::{Parser, Event, Tag};

pub fn generate_doc_tests(docs: &[&str]) {
    let out_dir = env::var("OUT_DIR").unwrap();
    let cargo_manifest_dir = env::var("CARGO_MANIFEST_DIR").unwrap();

    let mut out_file = PathBuf::from(out_dir);
    out_file.push("skeptic-tests.rs");
    
    let config = Config {
        root_dir: PathBuf::from(cargo_manifest_dir),
        out_file: out_file,
        docs: docs.iter().map(|s| s.to_string()).collect()
    };

    run(config);
}

struct Config {
    root_dir: PathBuf,
    out_file: PathBuf,
    docs: Vec<String>
}

fn run(ref config: Config) {
    let tests = extract_tests(config).unwrap();
    emit_tests(config, tests).unwrap();
}

struct Test {
    name: String,
    text: Vec<String>,
    ignore: bool,
    should_panic: bool
}

fn extract_tests(config: &Config) -> Result<Vec<Test>, IoError> {
    let mut tests = Vec::new();
    for doc in &config.docs {
        let ref mut path = config.root_dir.clone();
        path.push(doc);
        let new_tests = try!(extract_tests_from_file(path));
        tests.extend(new_tests.into_iter());
    }
    return Ok(tests);
}

fn extract_tests_from_file(path: &Path) -> Result<Vec<Test>, IoError> {
    let mut tests = Vec::new();

    let mut file = try!(File::open(path));
    let ref mut s = String::new();
    try!(file.read_to_string(s));
    let parser = Parser::new(s);

    let mut test_name_gen = TestNameGen::new(path);
    let mut test_buffer = None;

    for event in parser {
        match event {
            Event::Start(Tag::CodeBlock(ref info)) => {
                let code_block_info = parse_code_block_info(info);
                if code_block_info.is_rust {
                    test_buffer = Some(Vec::new());
                }
            }
            Event::Text(text) => {
                if let Some(ref mut buf) = test_buffer {
                    buf.push(text.to_string());
                }
            }
            Event::End(Tag::CodeBlock(ref info)) => {
                let code_block_info = parse_code_block_info(info);
                if let Some(buf) = test_buffer.take() {
                    tests.push(Test {
                        name: test_name_gen.advance(),
                        text: buf,
                        ignore: code_block_info.ignore,
                        should_panic: code_block_info.should_panic
                    });
                }
            }
            _ => ()
        }
    }
    return Ok(tests);
}

struct TestNameGen {
    root: String,
    count: i32
}

impl TestNameGen {
    fn new(path: &Path) -> TestNameGen {
        let ref file_stem = path.file_stem().unwrap().to_str().unwrap().to_string();
        TestNameGen {
            root: sanitize_test_name(file_stem),
            count: 0
        }
    }

    fn advance(&mut self) -> String {
        let count = self.count;
        self.count += 1;
        format!("{}_{}", self.root, count)
    }
}

fn sanitize_test_name(s: &str) -> String {
    s.to_lowercase().chars().map(|c| {
        if c.is_alphanumeric() {
            c
        } else {
            '_'
        }
    }).collect()
}

fn parse_code_block_info(info: &str) -> CodeBlockInfo {
    // Same as rustdoc
    let tokens = info.split(|c: char| {
        !(c == '_' || c == '-' || c.is_alphanumeric())
    });

    let mut seen_rust_tags = false;
    let mut seen_other_tags = false;
    let mut info = CodeBlockInfo {
        is_rust: true,
        should_panic: false,
        ignore: false,
    };
    
    for token in tokens {
        match token {
            "" => {}
            "rust" => { info.is_rust = true; seen_rust_tags = true }
            "should_panic" => { info.should_panic = true; seen_rust_tags = true }
            "ignore" => { info.ignore = true; seen_rust_tags = true }
            _ => { seen_other_tags = true }
        }
    }

    info.is_rust &= !seen_other_tags || seen_rust_tags;

    info
}

struct CodeBlockInfo {
    is_rust: bool,
    should_panic: bool,
    ignore: bool
}

fn emit_tests(config: &Config, tests: Vec<Test>) -> Result<(), IoError> {
    let mut file = try!(File::create(&config.out_file));
    for test in tests {
        if test.ignore {
            try!(writeln!(file, "#[ignore]"));
        }
        if test.should_panic {
            try!(writeln!(file, "#[should_panic]"));
        }
        try!(writeln!(file, "#[test] fn {}() {{", test.name));
        if test.ignore {
            try!(writeln!(file, "/*"));
        }
        for text in &test.text {
            try!(write!(file, "    {}", text));
        }
        if test.ignore {
            try!(writeln!(file, "*/"));
        }
        try!(writeln!(file, "}}"));
        try!(writeln!(file, ""));
    }

    Ok(())
}