601ec251f8
This patch adds support for multiple rustdoc output formats to the test suite. This is a preparation for adding support for rustdoc’s JSON output.
93 lines
3.0 KiB
Rust
93 lines
3.0 KiB
Rust
// SPDX-FileCopyrightText: 2020 Robin Krahl <robin.krahl@ireas.org>
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
#[path = "../src/test_utils.rs"]
|
|
mod test_utils;
|
|
|
|
use std::env;
|
|
use std::path;
|
|
use std::process;
|
|
|
|
use assert_cmd::prelude::*;
|
|
|
|
use test_utils::{with_rustdoc, Format};
|
|
|
|
fn run(path: impl AsRef<path::Path>, args: &[&str]) -> assert_cmd::assert::Assert {
|
|
process::Command::cargo_bin(env!("CARGO_PKG_NAME"))
|
|
.unwrap()
|
|
.args(&["--no-default-sources", "--source"])
|
|
.arg(path.as_ref())
|
|
.args(&["--viewer", "plain"])
|
|
.args(&["--width", "100"])
|
|
.args(args)
|
|
.assert()
|
|
}
|
|
|
|
fn get_stdout(path: impl AsRef<path::Path>, args: &[&str]) -> String {
|
|
let cmd = run(path, args).success().stderr("");
|
|
String::from_utf8(cmd.get_output().stdout.clone()).unwrap()
|
|
}
|
|
|
|
macro_rules! generate_run {
|
|
($name:ident $version:literal $formats:expr; $args:expr) => {
|
|
#[test]
|
|
fn $name() {
|
|
with_rustdoc($version, $formats, |version, format, path| {
|
|
insta::assert_snapshot!(
|
|
format!("{}_{}_{}", version, format, std::stringify!($name)),
|
|
get_stdout(path, $args)
|
|
);
|
|
});
|
|
}
|
|
};
|
|
}
|
|
|
|
macro_rules! assert_doc {
|
|
($( $name:ident($version:literal, $formats:expr): $item:literal ),* $(,)? ) => {
|
|
$(
|
|
generate_run!($name $version $formats; &[$item]);
|
|
)*
|
|
};
|
|
}
|
|
|
|
macro_rules! assert_examples {
|
|
($( $name:ident($version:literal, $formats:expr): $item:literal ),* $(,)? ) => {
|
|
$(
|
|
generate_run!($name $version $formats; &["-e", $item]);
|
|
)*
|
|
};
|
|
}
|
|
|
|
assert_doc![
|
|
mod_anyhow("*", Format::all()): "anyhow",
|
|
macro_anyhow_anyhow("*", Format::all()): "anyhow::anyhow",
|
|
macro_anyhow_ensure("*", Format::all()): "anyhow::ensure",
|
|
struct_anyhow_error("<1.51.0", Format::all()): "anyhow::Error",
|
|
trait_anyhow_context("*", Format::all()): "anyhow::Context",
|
|
type_anyhow_result("*", Format::all()): "anyhow::Result",
|
|
];
|
|
|
|
assert_doc![
|
|
mod_log("*", Format::all()): "log",
|
|
macro_log_debug("*", Format::all()): "log::debug",
|
|
struct_log_metadata("*", Format::all()): "log::Metadata",
|
|
enum_log_level("*", Format::all()): "log::Level",
|
|
constant_log_static_max_level("*", Format::all()): "log::STATIC_MAX_LEVEL",
|
|
trait_log_log("*", Format::all()): "log::Log",
|
|
fn_log_logger("*", Format::all()): "log::logger",
|
|
fn_log_set_logger_racy("*", Format::all()): "log::set_logger_racy",
|
|
];
|
|
|
|
assert_doc![
|
|
mod_rand_core("*", Format::all()): "rand_core",
|
|
trait_rand_core_rngcore("*", Format::all()): "rand_core::RngCore",
|
|
trait_rand_core_seedablerng("*", Format::all()): "rand_core::SeedableRng",
|
|
struct_rand_core_block_blockrng("*", Format::all()): "rand_core::block::BlockRng",
|
|
];
|
|
|
|
assert_examples![
|
|
examples_mod_anyhow("*", Format::all()): "anyhow",
|
|
examples_mod_log(">1.40.0", Format::all()): "log",
|
|
examples_struct_rand_core_rngcore("*", Format::all()): "rand_core::RngCore",
|
|
];
|