compile-test.rs

#![feature(test)] // compiletest_rs requires this attribute
#![feature(once_cell)]
#![feature(is_sorted)]
#![feature(exit_status_error)]
#![cfg_attr(feature = "deny-warnings", deny(warnings))]
#![warn(rust_2018_idioms, unused_lifetimes)]

use compiletest::common::{Config, Hooks};
use std::collections::HashMap;
use std::env::{self, set_var};
use std::ffi::OsStr;
use std::fs;
use std::path::{Path, PathBuf};
use std::sync::{Arc, LazyLock};
use test_utils::IS_RUSTC_TEST_SUITE;

mod test_utils;

// whether to run internal tests or not
const RUN_INTERNAL_TESTS: bool = cfg!(feature = "internal");

/// All crates used in UI tests are listed here
static TEST_DEPENDENCIES: &[&str] = &[
    "clippy_lints",
    "clippy_utils",
    "derive_new",
    "futures",
    "if_chain",
    "itertools",
    "quote",
    "regex",
    "serde",
    "serde_derive",
    "syn",
    "tokio",
    "parking_lot",
    "rustc_semver",
];

// Test dependencies may need an `extern crate` here to ensure that they show up
// in the depinfo file (otherwise cargo thinks they are unused)
#[allow(unused_extern_crates)]
extern crate clippy_lints;
#[allow(unused_extern_crates)]
extern crate clippy_utils;
#[allow(unused_extern_crates)]
extern crate derive_new;
#[allow(unused_extern_crates)]
extern crate futures;
#[allow(unused_extern_crates)]
extern crate if_chain;
#[allow(unused_extern_crates)]
extern crate itertools;
#[allow(unused_extern_crates)]
extern crate parking_lot;
#[allow(unused_extern_crates)]
extern crate quote;
#[allow(unused_extern_crates)]
extern crate rustc_semver;
#[allow(unused_extern_crates)]
extern crate syn;
#[allow(unused_extern_crates)]
extern crate tokio;

/// Produces a string with an `--extern` flag for all UI test crate
/// dependencies.
///
/// The dependency files are located by parsing the depinfo file for this test
/// module. This assumes the `-Z binary-dep-depinfo` flag is enabled. All test
/// dependencies must be added to Cargo.toml at the project root. Test
/// dependencies that are not *directly* used by this test module require an
/// `extern crate` declaration.
static EXTERN_FLAGS: LazyLock<Vec<String>> = LazyLock::new(|| {
    let current_exe_depinfo = {
        let mut path = env::current_exe().unwrap();
        path.set_extension("d");
        fs::read_to_string(path).unwrap()
    };
    let mut crates: HashMap<&str, &str> = HashMap::with_capacity(TEST_DEPENDENCIES.len());
    for line in current_exe_depinfo.lines() {
        // each dependency is expected to have a Makefile rule like `/path/to/crate-hash.rlib:`
        let parse_name_path = || {
            if line.starts_with(char::is_whitespace) {
                return None;
            }
            let path_str = line.strip_suffix(':')?;
            let path = Path::new(path_str);
            if !matches!(path.extension()?.to_str()?, "rlib" | "so" | "dylib" | "dll") {
                return None;
            }
            let (name, _hash) = path.file_stem()?.to_str()?.rsplit_once('-')?;
            // the "lib" prefix is not present for dll files
            let name = name.strip_prefix("lib").unwrap_or(name);
            Some((name, path_str))
        };
        if let Some((name, path)) = parse_name_path() {
            if TEST_DEPENDENCIES.contains(&name) {
                // A dependency may be listed twice if it is available in sysroot,
                // and the sysroot dependencies are listed first. As of the writing,
                // this only seems to apply to if_chain.
                crates.insert(name, path);
            }
        }
    }
    let not_found: Vec<&str> = TEST_DEPENDENCIES
        .iter()
        .copied()
        .filter(|n| !crates.contains_key(n))
        .collect();
    assert!(
        not_found.is_empty(),
        "dependencies not found in depinfo: {not_found:?}\n\
        help: Make sure the `-Z binary-dep-depinfo` rust flag is enabled\n\
        help: Try adding to dev-dependencies in Cargo.toml\n\
        help: Be sure to also add `extern crate ...;` to tests/compile-test.rs",
    );
    crates
        .into_iter()
        .flat_map(|(name, path)| ["--extern".into(), format!("{name}={path}")])
        .collect()
});

fn base_config(test_dir: &str) -> Config {
    let lib_path = fs::canonicalize(option_env!("RUSTC_LIB_PATH").unwrap_or(".")).unwrap();

    let current_exe_path = env::current_exe().unwrap();
    let deps_path = current_exe_path.parent().unwrap();
    let profile_path = deps_path.parent().unwrap();
    let root = env::current_dir().unwrap();

    let filters = env::var("TESTNAME")
        .iter()
        .flat_map(|test_name| test_name.split(','))
        .map(String::from)
        .collect();

    let na = || String::from("(N/A)");

    // TODO: check if any of this target flag stuff is still needed
    let mut target_rustcflags = vec![
        "--emit=metadata".into(),
        "-Dwarnings".into(),
        "-Zui-testing".into(),
        format!("-Ldependency={}", deps_path.display()),
    ];

    target_rustcflags.extend(EXTERN_FLAGS.iter().cloned());

    // TODO: Where does this come from?
    if let Some(host_libs) = option_env!("HOST_LIBS") {
        target_rustcflags.extend([
            "-L".into(),
            format!("dependency={}", Path::new(host_libs).join("deps").display()),
        ]);
    }

    Config {
        bless: false,
        compile_lib_path: lib_path.clone(),
        run_lib_path: lib_path.clone(),
        rustc_path: profile_path.join(if cfg!(windows) {
            "clippy-driver.exe"
        } else {
            "clippy-driver"
        }),
        rustdoc_path: None,
        rust_demangler_path: None,
        python: na(),
        jsondocck_path: None,
        jsondoclint_path: None,
        llvm_filecheck: None,
        llvm_bin_dir: None,
        valgrind_path: None,
        force_valgrind: false,
        run_clang_based_tests_with: None,
        source_root: root.clone(),
        src_base: root.join("tests").join(test_dir),
        build_base: profile_path.join("test").join(test_dir),
        stage_id: "stage-id".into(),
        mode: compiletest::common::Mode::Ui,
        no_expected_comments: true,
        suite: test_dir.into(),
        debugger: None,
        run_ignored: false,
        filters,
        skip: Vec::new(),
        filter_exact: false,
        force_pass_mode: None,
        run: None,
        logfile: None,
        runtool: None,
        host_rustcflags: Vec::new(),
        target_rustcflags,
        optimize_tests: false,
        target: env!("TARGET").into(),
        host: env!("HOST").into(),
        cdb: None,
        cdb_version: None,
        gdb: None,
        gdb_version: None,
        gdb_native_rust: false,
        lldb_version: None,
        lldb_native_rust: false,
        llvm_version: None,
        system_llvm: false,
        android_cross_path: na().into(),
        adb_path: na(),
        adb_test_dir: na(),
        adb_device_status: false,
        lldb_python_dir: None,
        verbose: false,
        quiet: false,
        color: compiletest::common::ColorConfig::AutoColor,
        remote_test_client: None,
        compare_mode: None,
        rustfix_coverage: false,
        has_tidy: false,
        channel: "nightly".into(),
        edition: Some("2021".into()),
        cc: na(),
        cxx: na(),
        cflags: na(),
        cxxflags: na(),
        ar: na(),
        linker: None,
        llvm_components: na(),
        nodejs: None,
        npm: None,
        force_rerun: true,
        target_cfg: Default::default(),
        hooks: Default::default(),
    }
}

fn run_ui() {
    compiletest::run_tests(base_config("ui"));

    check_rustfix_coverage();
}

fn run_ui_toml() {
    compiletest::run_tests(Config {
        hooks: Hooks {
            modify_compiler_command: Some(Arc::new(|path, command| {
                command.env("CLIPPY_CONF_DIR", path.parent().unwrap());
            })),
            ..Hooks::default()
        },
        ..base_config("ui-toml")
    });
}

fn run_ui_cargo() {
    if IS_RUSTC_TEST_SUITE {
        return;
    }

    compiletest::run_tests(Config {
        hooks: Hooks {
            exclude_file: Some(Arc::new(|path| {
                path.file_name().map_or(false, |filename| filename != "main.rs")
            })),
            modify_compiler_command: Some(Arc::new(|path, command| {
                // e.g. `[cargo_toml_dir]/src/main.rs` -> `[cargo_toml_dir]`
                let cargo_toml_dir = path.parent().unwrap().parent().unwrap();

                let cargo_toml_path = cargo_toml_dir.join("Cargo.toml");
                let cargo_content = fs::read(cargo_toml_path).unwrap();
                let cargo_parsed: toml::Value = toml::from_slice(&cargo_content).expect("Can't parse `Cargo.toml`");

                command
                    .env("CLIPPY_CONF_DIR", cargo_toml_dir)
                    .env(
                        "CARGO_PKG_RUST_VERSION",
                        cargo_parsed
                            .get("package")
                            .and_then(|p| p.get("rust-version"))
                            .and_then(toml::Value::as_str)
                            .unwrap_or(""),
                    )
                    .current_dir(cargo_toml_dir);
            })),
        },
        ..base_config("ui-cargo")
    });
}

fn run_internal_tests() {
    // only run internal tests with the internal-tests feature
    if !RUN_INTERNAL_TESTS {
        return;
    }

    compiletest::run_tests(base_config("ui-internal"));
}

#[test]
fn compile_test() {
    set_var("CLIPPY_DISABLE_DOCS_LINKS", "true");
    set_var("CLIPPY_CONF_DIR", fs::canonicalize("tests").unwrap());
    run_ui();
    run_ui_toml();
    run_ui_cargo();
    run_internal_tests();
}

const RUSTFIX_COVERAGE_KNOWN_EXCEPTIONS: &[&str] = &[
    "assign_ops2.rs",
    "borrow_deref_ref_unfixable.rs",
    "cast_size_32bit.rs",
    "char_lit_as_u8.rs",
    "cmp_owned/without_suggestion.rs",
    "dbg_macro.rs",
    "deref_addrof_double_trigger.rs",
    "doc/unbalanced_ticks.rs",
    "eprint_with_newline.rs",
    "explicit_counter_loop.rs",
    "iter_skip_next_unfixable.rs",
    "let_and_return.rs",
    "literals.rs",
    "map_flatten.rs",
    "map_unwrap_or.rs",
    "match_bool.rs",
    "mem_replace_macro.rs",
    "needless_arbitrary_self_type_unfixable.rs",
    "needless_borrow_pat.rs",
    "needless_for_each_unfixable.rs",
    "nonminimal_bool.rs",
    "print_literal.rs",
    "print_with_newline.rs",
    "redundant_static_lifetimes_multiple.rs",
    "ref_binding_to_reference.rs",
    "repl_uninit.rs",
    "result_map_unit_fn_unfixable.rs",
    "search_is_some.rs",
    "single_component_path_imports_nested_first.rs",
    "string_add.rs",
    "suspicious_to_owned.rs",
    "toplevel_ref_arg_non_rustfix.rs",
    "unit_arg.rs",
    "unnecessary_clone.rs",
    "unnecessary_lazy_eval_unfixable.rs",
    "write_literal.rs",
    "write_literal_2.rs",
    "write_with_newline.rs",
];

fn check_rustfix_coverage() {
    let missing_coverage_path = Path::new("debug/test/ui/rustfix_missing_coverage.txt");
    let missing_coverage_path = if let Ok(target_dir) = std::env::var("CARGO_TARGET_DIR") {
        PathBuf::from(target_dir).join(missing_coverage_path)
    } else {
        missing_coverage_path.to_path_buf()
    };

    if let Ok(missing_coverage_contents) = std::fs::read_to_string(missing_coverage_path) {
        assert!(RUSTFIX_COVERAGE_KNOWN_EXCEPTIONS.iter().is_sorted_by_key(Path::new));

        for rs_file in missing_coverage_contents.lines() {
            let rs_path = Path::new(rs_file);
            if rs_path.starts_with("tests/ui/crashes") {
                continue;
            }
            assert!(rs_path.starts_with("tests/ui/"), "{rs_file:?}");
            let filename = rs_path.strip_prefix("tests/ui/").unwrap();
            assert!(
                RUSTFIX_COVERAGE_KNOWN_EXCEPTIONS
                    .binary_search_by_key(&filename, Path::new)
                    .is_ok(),
                "`{rs_file}` runs `MachineApplicable` diagnostics but is missing a `run-rustfix` annotation. \
                Please either add `// run-rustfix` at the top of the file or add the file to \
                `RUSTFIX_COVERAGE_KNOWN_EXCEPTIONS` in `tests/compile-test.rs`.",
            );
        }
    }
}

#[test]
fn rustfix_coverage_known_exceptions_accuracy() {
    for filename in RUSTFIX_COVERAGE_KNOWN_EXCEPTIONS {
        let rs_path = Path::new("tests/ui").join(filename);
        assert!(
            rs_path.exists(),
            "`{}` does not exist",
            rs_path.strip_prefix(env!("CARGO_MANIFEST_DIR")).unwrap().display()
        );
        let fixed_path = rs_path.with_extension("fixed");
        assert!(
            !fixed_path.exists(),
            "`{}` exists",
            fixed_path.strip_prefix(env!("CARGO_MANIFEST_DIR")).unwrap().display()
        );
    }
}

#[test]
fn ui_cargo_toml_metadata() {
    let ui_cargo_path = Path::new("tests/ui-cargo");
    let cargo_common_metadata_path = ui_cargo_path.join("cargo_common_metadata");
    let publish_exceptions =
        ["fail_publish", "fail_publish_true", "pass_publish_empty"].map(|path| cargo_common_metadata_path.join(path));

    for entry in walkdir::WalkDir::new(ui_cargo_path) {
        let entry = entry.unwrap();
        let path = entry.path();
        if path.file_name() != Some(OsStr::new("Cargo.toml")) {
            continue;
        }

        let toml = fs::read_to_string(path).unwrap().parse::<toml::Value>().unwrap();

        let package = toml.as_table().unwrap().get("package").unwrap().as_table().unwrap();

        let name = package.get("name").unwrap().as_str().unwrap().replace('-', "_");
        assert!(
            path.parent()
                .unwrap()
                .components()
                .map(|component| component.as_os_str().to_string_lossy().replace('-', "_"))
                .any(|s| *s == name)
                || path.starts_with(&cargo_common_metadata_path),
            "{path:?} has incorrect package name"
        );

        let publish = package.get("publish").and_then(toml::Value::as_bool).unwrap_or(true);
        assert!(
            !publish || publish_exceptions.contains(&path.parent().unwrap().to_path_buf()),
            "{path:?} lacks `publish = false`"
        );
    }
}