mdbook/src/cmd/test.rs

use crate::get_book_dir;
use clap::{arg, App, Arg, ArgMatches};
use mdbook::errors::Result;
use mdbook::MDBook;

// Create clap subcommand arguments
pub fn make_subcommand<'help>() -> App<'help> {
    App::new("test")
        .about("Tests that a book's Rust code samples compile")
        .arg(
            Arg::new("dest-dir")
                .short('d')
                .long("dest-dir")
                .value_name("dest-dir")
                .help(
                    "Output directory for the book{n}\
                    Relative paths are interpreted relative to the book's root directory.{n}\
                    If omitted, mdBook uses build.build-dir from book.toml or defaults to `./book`.",
                ),
        ).arg(
            Arg::new("chapter")
                .short('c')
                .long("chapter")
                .value_name("chapter")
                .help(
                    "Only test the specified chapter{n}\
                    Where the name of the chapter is defined in the SUMMARY.md file.{n}\
                    Use the special name \"?\" to the list of chapter names."
                )
        )
        .arg(arg!([dir]
            "Root directory for the book{n}\
            (Defaults to the Current Directory when omitted)"
        ))
        .arg(Arg::new("library-path")
            .short('L')
            .long("library-path")
            .value_name("dir")
            .takes_value(true)
            .use_delimiter(true)
            .require_delimiter(true)
            .multiple_values(true)
            .multiple_occurrences(true)
            .forbid_empty_values(true)
            .help("A comma-separated list of directories to add to {n}the crate search path when building tests"))
}

// test command implementation
pub fn execute(args: &ArgMatches) -> Result<()> {
    let library_paths: Vec<&str> = args
        .values_of("library-path")
        .map(std::iter::Iterator::collect)
        .unwrap_or_default();
    let chapter: Option<&str> = args.value_of("chapter");

    let book_dir = get_book_dir(args);
    let mut book = MDBook::load(&book_dir)?;

    if let Some(dest_dir) = args.value_of("dest-dir") {
        book.config.build.build_dir = dest_dir.into();
    }
    match chapter {
        Some(_) => book.test_chapter(library_paths, chapter),
        None => book.test(library_paths),
    }?;

    Ok(())
}