Merge pull request #741 from mattico/fix-mdbook-test

Fix `mdbook test`
rust-lang · Jul 25, 2018 · b4e15e5 · b4e15e5
2 parents 35c2d1f + 1d1d4d7
commit b4e15e5
Show file tree

Hide file tree

Showing 10 changed files with 600 additions and 166 deletions.
diff --git a/src/book/mod.rs b/src/book/mod.rs
@@ -213,12 +213,13 @@ impl MDBook {
             .flat_map(|x| vec![x.0, x.1])
             .collect();
 
-        let temp_dir = TempFileBuilder::new().prefix("mdbook").tempdir()?;
+        let temp_dir = TempFileBuilder::new().prefix("mdbook-").tempdir()?;
 
         let preprocess_context = PreprocessorContext::new(self.root.clone(), self.config.clone());
 
         LinkPreprocessor::new().run(&preprocess_context, &mut self.book)?;
-        IndexPreprocessor::new().run(&preprocess_context, &mut self.book)?;
+        // Index Preprocessor is disabled so that chapter paths continue to point to the
+        // actual markdown files.
 
         for item in self.iter() {
             if let BookItem::Chapter(ref ch) = *item {

diff --git a/src/cmd/mod.rs b/src/cmd/mod.rs
@@ -1,4 +1,4 @@
-/// Subcommand modules for the `mdbook` binary.
+//! Subcommand modules for the `mdbook` binary.
 
 pub mod build;
 pub mod clean;

diff --git a/src/cmd/serve.rs b/src/cmd/serve.rs
@@ -5,13 +5,13 @@ extern crate ws;
 use self::iron::{
     status, AfterMiddleware, Chain, Iron, IronError, IronResult, Request, Response, Set,
 };
+#[cfg(feature = "watch")]
+use super::watch;
 use clap::{App, ArgMatches, SubCommand};
 use mdbook::errors::*;
 use mdbook::utils;
 use mdbook::MDBook;
 use std;
-#[cfg(feature = "watch")]
-use super::watch;
 use {get_book_dir, open};
 
 struct ErrorRecover;

diff --git a/src/renderer/html_handlebars/hbs_renderer.rs b/src/renderer/html_handlebars/hbs_renderer.rs
@@ -370,7 +370,8 @@ impl Renderer for HtmlHandlebars {
             .chain_err(|| "Unable to copy across additional CSS and JS")?;
 
         // Render search index
-        #[cfg(feature = "search")] {
+        #[cfg(feature = "search")]
+        {
             let search = html_config.search.unwrap_or_default();
             if search.enable {
                 super::search::create_files(&search, &destination, &book)?;

diff --git a/tests/dummy_book/mod.rs b/tests/dummy_book/mod.rs
@@ -47,7 +47,7 @@ impl DummyBook {
     /// Write a book to a temporary directory using the provided settings.
     pub fn build(&self) -> Result<TempDir> {
         let temp = TempFileBuilder::new()
-            .prefix("dummy_book")
+            .prefix("dummy_book-")
             .tempdir()
             .chain_err(|| "Unable to create temp directory")?;
 

diff --git a/tests/dummy_book/src/README.md b/tests/dummy_book/src/README.md
@@ -0,0 +1,5 @@
+# Dummy Book
+
+This file is just here to cause the index preprocessor to run.
+
+Does a pretty good job, too.
diff --git a/tests/dummy_book/src/SUMMARY.md b/tests/dummy_book/src/SUMMARY.md
@@ -1,5 +1,6 @@
 # Summary
 
+[Dummy Book](README.md)
 [Introduction](intro.md)
 
 - [First Chapter](first/index.md)

diff --git a/tests/rendered_output.rs b/tests/rendered_output.rs
@@ -27,6 +27,7 @@ const TOC_TOP_LEVEL: &[&'static str] = &[
     "1. First Chapter",
     "2. Second Chapter",
     "Conclusion",
+    "Dummy Book",
     "Introduction",
 ];
 const TOC_SECOND_LEVEL: &[&'static str] =
@@ -126,7 +127,8 @@ fn rendered_code_has_playpen_stuff() {
 #[test]
 fn chapter_content_appears_in_rendered_document() {
     let content = vec![
-        ("index.html", "Here's some interesting text"),
+        ("index.html", "This file is just here to cause the"),
+        ("intro.html", "Here's some interesting text"),
         ("second.html", "Second Chapter"),
         ("first/nested.html", "testable code"),
         ("first/index.html", "more text"),
@@ -437,7 +439,7 @@ mod search {
         assert_eq!(docs[&some_section]["body"], "");
         assert_eq!(
             docs[&summary]["body"],
-            "Introduction First Chapter Nested Chapter Includes Recursive Second Chapter Conclusion"
+            "Dummy Book Introduction First Chapter Nested Chapter Includes Recursive Second Chapter Conclusion"
         );
         assert_eq!(docs[&summary]["breadcrumbs"], "First Chapter » Summary");
         assert_eq!(docs[&conclusion]["body"], "I put &lt;HTML&gt; in here!");