cargo/tests/testsuite/rustdocflags.rs

use cargotest::support::{execs, project};
use hamcrest::assert_that;

#[test]
fn parses_env() {
    let p = project("foo")
        .file(
            "Cargo.toml",
            r#"
            [package]
            name = "foo"
            version = "0.0.1"
            authors = []
        "#,
        )
        .file("src/lib.rs", "")
        .build();

    assert_that(
        p.cargo("doc").env("RUSTDOCFLAGS", "--cfg=foo").arg("-v"),
        execs()
            .with_status(0)
            .with_stderr_contains("[RUNNING] `rustdoc [..] --cfg=foo[..]`"),
    );
}

#[test]
fn parses_config() {
    let p = project("foo")
        .file(
            "Cargo.toml",
            r#"
            [package]
            name = "foo"
            version = "0.0.1"
            authors = []
        "#,
        )
        .file("src/lib.rs", "")
        .file(
            ".cargo/config",
            r#"
            [build]
            rustdocflags = ["--cfg", "foo"]
        "#,
        )
        .build();

    assert_that(
        p.cargo("doc").arg("-v"),
        execs()
            .with_status(0)
            .with_stderr_contains("[RUNNING] `rustdoc [..] --cfg foo[..]`"),
    );
}

#[test]
fn bad_flags() {
    let p = project("foo")
        .file(
            "Cargo.toml",
            r#"
            [package]
            name = "foo"
            version = "0.0.1"
            authors = []
        "#,
        )
        .file("src/lib.rs", "")
        .build();

    assert_that(
        p.cargo("doc").env("RUSTDOCFLAGS", "--bogus"),
        execs().with_status(101),
    );
}

#[test]
fn rerun() {
    let p = project("foo")
        .file(
            "Cargo.toml",
            r#"
            [package]
            name = "foo"
            version = "0.0.1"
            authors = []
        "#,
        )
        .file("src/lib.rs", "")
        .build();

    assert_that(
        p.cargo("doc").env("RUSTDOCFLAGS", "--cfg=foo"),
        execs().with_status(0),
    );
    assert_that(
        p.cargo("doc").env("RUSTDOCFLAGS", "--cfg=foo"),
        execs()
            .with_status(0)
            .with_stderr("[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]"),
    );
    assert_that(
        p.cargo("doc").env("RUSTDOCFLAGS", "--cfg=bar"),
        execs().with_status(0).with_stderr(
            "\
[DOCUMENTING] foo v0.0.1 ([..])
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]
",
        ),
    );
}

#[test]
fn rustdocflags_passed_to_rustdoc_through_cargo_test() {
    let p = project("foo")
        .file(
            "Cargo.toml",
            r#"
            [package]
            name = "foo"
            version = "0.0.1"
        "#,
        )
        .file(
            "src/lib.rs",
            r#"
            //! ```
            //! assert!(cfg!(do_not_choke));
            //! ```
        "#,
        )
        .build();

    assert_that(
        p.cargo("test")
            .arg("--doc")
            .env("RUSTDOCFLAGS", "--cfg do_not_choke"),
        execs().with_status(0),
    );
}

#[test]
fn rustdocflags_passed_to_rustdoc_through_cargo_test_only_once() {
    let p = project("foo")
        .file(
            "Cargo.toml",
            r#"
            [package]
            name = "foo"
            version = "0.0.1"
        "#,
        )
        .file("src/lib.rs", "")
        .build();

    assert_that(
        p.cargo("test")
            .arg("--doc")
            .env("RUSTDOCFLAGS", "--markdown-no-toc"),
        execs().with_status(0),
    );
}