mdBook/tests/rendered_output.rs

extern crate env_logger;
extern crate mdbook;
extern crate tempdir;

mod dummy;
mod helpers;

use dummy::DummyBook;
use helpers::assert_contains_strings;
use mdbook::MDBook;


/// Make sure you can load the dummy book and build it without panicking.
#[test]
fn build_the_dummy_book() {
    let temp = DummyBook::default().build();
    let mut md = MDBook::new(temp.path());

    md.build().unwrap();
}

#[test]
fn by_default_mdbook_generates_rendered_content_in_the_book_directory() {
    let temp = DummyBook::default().build();
    let mut md = MDBook::new(temp.path());

    assert!(!temp.path().join("book").exists());
    md.build().unwrap();

    assert!(temp.path().join("book").exists());
    assert!(temp.path().join("book").join("index.html").exists());
}

#[test]
fn make_sure_bottom_level_files_contain_links_to_chapters() {
    let temp = DummyBook::default().build();
    let mut md = MDBook::new(temp.path());
    md.build().unwrap();

    let dest = temp.path().join("book");
    let links = vec![
        r#"href="intro.html""#,
        r#"href="./first/index.html""#,
        r#"href="./first/nested.html""#,
        r#"href="./second.html""#,
        r#"href="./conclusion.html""#,
    ];

    let files_in_bottom_dir = vec!["index.html", "intro.html", "second.html", "conclusion.html"];

    for filename in files_in_bottom_dir {
        assert_contains_strings(dest.join(filename), &links);
    }
}

#[test]
fn check_correct_cross_links_in_nested_dir() {
    let temp = DummyBook::default().build();
    let mut md = MDBook::new(temp.path());
    md.build().unwrap();

    let first = temp.path().join("book").join("first");
    let links = vec![
        r#"<base href="../">"#,
        r#"href="intro.html""#,
        r#"href="./first/index.html""#,
        r#"href="./first/nested.html""#,
        r#"href="./second.html""#,
        r#"href="./conclusion.html""#,
    ];

    let files_in_nested_dir = vec!["index.html", "nested.html"];

    for filename in files_in_nested_dir {
        assert_contains_strings(first.join(filename), &links);
    }

    assert_contains_strings(
        first.join("index.html"),
        &[
            r##"href="./first/index.html#some-section" id="some-section""##,
        ],
    );

    assert_contains_strings(
        first.join("nested.html"),
        &[
            r##"href="./first/nested.html#some-section" id="some-section""##,
        ],
    );
}

#[test]
fn rendered_code_has_playpen_stuff() {
    let temp = DummyBook::default().build();
    let mut md = MDBook::new(temp.path());
    md.build().unwrap();

    let nested = temp.path().join("book/first/nested.html");
    let playpen_class = vec![r#"class="playpen""#];

    assert_contains_strings(nested, &playpen_class);

    let book_js = temp.path().join("book/book.js");
    assert_contains_strings(book_js, &[".playpen"]);
}

#[test]
fn chapter_content_appears_in_rendered_document() {
    env_logger::init().ok();

    let content = vec![
        ("index.html", "Here's some interesting text"),
        ("second.html", "Second Chapter"),
        ("first/nested.html", "testable code"),
        ("first/index.html", "more text"),
        ("conclusion.html", "Conclusion"),
    ];

    let temp = DummyBook::default().build();
    let mut md = MDBook::new(temp.path());
    md.build().unwrap();

    let destination = temp.path().join("book");

    for (filename, text) in content {
        let path = destination.join(filename);
        assert_contains_strings(path, &[text]);
    }
}

#[test]
fn chapter_1_file_not_created_if_summary_already_exists() {
    let temp = DummyBook::default().build();

    let src = temp.path().join("src");
    let summary = src.join("SUMMARY.md");
    let chapter_1 = src.join("chapter_1.md");

    assert!(summary.exists());
    assert!(!chapter_1.exists());

    let mut md = MDBook::new(temp.path());
    md.build().unwrap();

    assert!(!chapter_1.exists());
}