Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Filter linkcheck spurious failure #63927

Merged
merged 4 commits into from
Sep 7, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 54 additions & 34 deletions src/tools/rustbook/src/main.rs
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
use clap::{crate_version};
use clap::crate_version;

use std::env;
use std::path::{Path, PathBuf};

use clap::{App, ArgMatches, SubCommand, AppSettings};
use clap::{App, AppSettings, ArgMatches, SubCommand};

use mdbook::errors::Result as Result3;
use mdbook::MDBook;
use mdbook::errors::{Result as Result3};

#[cfg(feature = "linkcheck")]
use failure::Error;
#[cfg(feature = "linkcheck")]
use mdbook::renderer::RenderContext;
#[cfg(feature = "linkcheck")]
use mdbook_linkcheck::{self, errors::BrokenLinks};
use failure::Error;

fn main() {
let d_message = "-d, --dest-dir=[dest-dir]
Expand All @@ -21,18 +22,22 @@ fn main() {
'A directory for your book{n}(Defaults to Current Directory when omitted)'";

let matches = App::new("rustbook")
.about("Build a book with mdBook")
.author("Steve Klabnik <[email protected]>")
.version(&*format!("v{}", crate_version!()))
.setting(AppSettings::SubcommandRequired)
.subcommand(SubCommand::with_name("build")
.about("Build the book from the markdown files")
.arg_from_usage(d_message)
.arg_from_usage(dir_message))
.subcommand(SubCommand::with_name("linkcheck")
.about("Run linkcheck with mdBook 3")
.arg_from_usage(dir_message))
.get_matches();
.about("Build a book with mdBook")
.author("Steve Klabnik <[email protected]>")
.version(&*format!("v{}", crate_version!()))
.setting(AppSettings::SubcommandRequired)
.subcommand(
SubCommand::with_name("build")
.about("Build the book from the markdown files")
.arg_from_usage(d_message)
.arg_from_usage(dir_message),
)
.subcommand(
SubCommand::with_name("linkcheck")
.about("Run linkcheck with mdBook 3")
.arg_from_usage(dir_message),
)
.get_matches();

// Check which subcomamnd the user ran...
match matches.subcommand() {
Expand All @@ -46,23 +51,44 @@ fn main() {

::std::process::exit(101);
}
},
}
("linkcheck", Some(sub_matches)) => {
if let Err(err) = linkcheck(sub_matches) {
eprintln!("Error: {}", err);

#[cfg(feature = "linkcheck")]
{
if let Ok(broken_links) = err.downcast::<BrokenLinks>() {
for cause in broken_links.links().iter() {
eprintln!("\tCaused By: {}", cause);
}
#[cfg(feature = "linkcheck")]
{
if let Err(err) = linkcheck(sub_matches) {
eprintln!("Error: {}", err);

// HACK: ignore timeouts
let actually_broken = err
.downcast::<BrokenLinks>()
.map(|broken_links| {
broken_links
.links()
.iter()
.inspect(|cause| eprintln!("\tCaused By: {}", cause))
.fold(false, |already_broken, cause| {
already_broken || !format!("{}", cause).contains("timed out")
})
})
.unwrap_or(false);

if actually_broken {
std::process::exit(101);
} else {
std::process::exit(0);
}
}
mark-i-m marked this conversation as resolved.
Show resolved Hide resolved
}

::std::process::exit(101);
#[cfg(not(feature = "linkcheck"))]
{
// This avoids the `unused_binding` lint.
println!(
"mdbook-linkcheck is disabled, but arguments were passed: {:?}",
sub_matches
);
}
},
}
(_, _) => unreachable!(),
};
}
Expand All @@ -77,12 +103,6 @@ pub fn linkcheck(args: &ArgMatches<'_>) -> Result<(), Error> {
mdbook_linkcheck::check_links(&render_ctx)
}

#[cfg(not(feature = "linkcheck"))]
pub fn linkcheck(_args: &ArgMatches<'_>) -> Result<(), Error> {
println!("mdbook-linkcheck is disabled.");
Ok(())
}

// Build command implementation
pub fn build(args: &ArgMatches<'_>) -> Result3<()> {
let book_dir = get_book_dir(args);
Expand Down