mirror of
https://github.com/rust-lang/mdBook.git
synced 2025-12-27 09:05:40 -05:00
797112ef36
This does a little cleanup around the usage of filesystem functions: - Add `mdbook_core::utils::fs::read_to_string` as a wrapper around `std::fs::read_to_string` to provide better error messages. Use this wherever a file is read. - Add `mdbook_core::utils::fs::create_dir_all` as a wrapper around `std::fs::create_dir_all` to provide better error messages. Use this wherever a file is read. - Replace `mdbook_core::utils::fs::write_file` with `write` to mirror the `std::fs::write` API. - Remove `mdbook_core::utils::fs::create_file`. It was generally not used anymore. - Scrub the usage of `std::fs` to use the new wrappers. This doesn't remove it 100%, but it is now significantly reduced.
88 lines
2.5 KiB
Rust
88 lines
2.5 KiB
Rust
//! General build tests.
|
|
//!
|
|
//! More specific tests should usually go into a module based on the feature.
|
|
//! This module should just have general build tests, or misc small things.
|
|
|
|
use crate::prelude::*;
|
|
|
|
// Simple smoke test that building works.
|
|
#[test]
|
|
fn basic_build() {
|
|
BookTest::from_dir("build/basic_build").run("build", |cmd| {
|
|
cmd.expect_stderr(str![[r#"
|
|
INFO Book building has started
|
|
INFO Running the html backend
|
|
INFO HTML book written to `[ROOT]/book`
|
|
|
|
"#]]);
|
|
});
|
|
}
|
|
|
|
// Ensure building fails if `create-missing` is false and one of the files does
|
|
// not exist.
|
|
#[test]
|
|
fn failure_on_missing_file() {
|
|
BookTest::from_dir("build/missing_file").run("build", |cmd| {
|
|
cmd.expect_failure().expect_stderr(str![[r#"
|
|
ERROR failed to read chapter `./chapter_1.md`
|
|
[TAB]Caused by: [NOT_FOUND]
|
|
|
|
"#]]);
|
|
});
|
|
}
|
|
|
|
// Ensure a missing file is created if `create-missing` is true.
|
|
#[test]
|
|
fn create_missing() {
|
|
let test = BookTest::from_dir("build/create_missing");
|
|
assert!(test.dir.join("src/SUMMARY.md").exists());
|
|
assert!(!test.dir.join("src/chapter_1.md").exists());
|
|
test.load_book();
|
|
assert!(test.dir.join("src/chapter_1.md").exists());
|
|
}
|
|
|
|
// Checks that it fails if the summary has a reserved filename.
|
|
#[test]
|
|
fn no_reserved_filename() {
|
|
BookTest::from_dir("build/no_reserved_filename").run("build", |cmd| {
|
|
cmd.expect_failure().expect_stderr(str![[r#"
|
|
INFO Book building has started
|
|
INFO Running the html backend
|
|
ERROR Rendering failed
|
|
[TAB]Caused by: print.md is reserved for internal use
|
|
|
|
"#]]);
|
|
});
|
|
}
|
|
|
|
// Build without book.toml should be OK.
|
|
#[test]
|
|
fn book_toml_isnt_required() {
|
|
let mut test = BookTest::init(|_| {});
|
|
std::fs::remove_file(test.dir.join("book.toml")).unwrap();
|
|
test.build();
|
|
test.check_main_file(
|
|
"book/chapter_1.html",
|
|
str![[r##"<h1 id="chapter-1"><a class="header" href="#chapter-1">Chapter 1</a></h1>"##]],
|
|
);
|
|
}
|
|
|
|
// Dest dir relative path behavior.
|
|
#[test]
|
|
fn dest_dir_relative_path() {
|
|
let mut test = BookTest::from_dir("build/basic_build");
|
|
let current_dir = test.dir.join("work");
|
|
std::fs::create_dir_all(¤t_dir).unwrap();
|
|
test.run("build", |cmd| {
|
|
cmd.args(&["--dest-dir", "foo", ".."])
|
|
.current_dir(¤t_dir)
|
|
.expect_stderr(str![[r#"
|
|
INFO Book building has started
|
|
INFO Running the html backend
|
|
INFO HTML book written to `[ROOT]/work/foo`
|
|
|
|
"#]]);
|
|
});
|
|
assert!(current_dir.join("foo/index.html").exists());
|
|
}
|