Add tidy check for list of proc-macro crate transitive dependencies

Author: clubby789

src/bootstrap/src/utils/proc_macro_deps.rs

@@ -0,0 +1,153 @@
+/// Holds all direct and indirect dependencies of proc-macro crates in tree. See #134863
+pub static CRATES: &[&str] = &[
+    // tidy-alphabetical-start
+    "annotate-snippets",
+    "anstyle",
+    "autocfg",
+    "basic-toml",
+    "bitflags",
+    "block-buffer",
+    "bumpalo",
+    "byteorder",
+    "cfg-if",
+    "clap_derive",
+    "color-print-proc-macro",
+    "cpufeatures",
+    "crossbeam-channel",
+    "crossbeam-deque",
+    "crossbeam-epoch",
+    "crossbeam-utils",
+    "crypto-common",
+    "darling",
+    "darling_core",
+    "darling_macro",
+    "derive-where",
+    "derive_builder_core",
+    "derive_setters",
+    "digest",
+    "displaydoc",
+    "either",
+    "equivalent",
+    "fluent-bundle",
+    "fluent-langneg",
+    "fluent-syntax",
+    "fnv",
+    "foldhash",
+    "futf",
+    "futures-macro",
+    "generic-array",
+    "getrandom",
+    "hashbrown",
+    "heck",
+    "hermit-abi",
+    "html5ever",
+    "icu_provider_macros",
+    "ident_case",
+    "indexmap",
+    "intl-memoizer",
+    "intl_pluralrules",
+    "itoa",
+    "libc",
+    "lock_api",
+    "log",
+    "mac",
+    "markup5ever",
+    "memchr",
+    "mime",
+    "mime_guess",
+    "minimal-lexical",
+    "new_debug_unreachable",
+    "nom",
+    "num_cpus",
+    "once_cell",
+    "parking_lot",
+    "parking_lot_core",
+    "pest",
+    "pest_generator",
+    "pest_meta",
+    "phf",
+    "phf_codegen",
+    "phf_generator",
+    "phf_shared",
+    "ppv-lite86",
+    "precomputed-hash",
+    "proc-macro-hack",
+    "proc-macro2",
+    "quote",
+    "rand",
+    "rand_chacha",
+    "rand_core",
+    "rayon",
+    "rayon-core",
+    "redox_syscall",
+    "rinja_derive",
+    "rinja_parser",
+    "rustc-hash",
+    "rustc-rayon",
+    "rustc-rayon-core",
+    "rustc_fluent_macro",
+    "rustc_index_macros",
+    "rustc_macros",
+    "rustc_type_ir_macros",
+    "rustfmt-config_proc_macro",
+    "rustversion",
+    "ryu",
+    "scopeguard",
+    "self_cell",
+    "serde",
+    "serde_derive",
+    "serde_json",
+    "sha2",
+    "siphasher",
+    "smallvec",
+    "stable_deref_trait",
+    "string_cache",
+    "string_cache_codegen",
+    "strsim",
+    "strum_macros",
+    "syn",
+    "synstructure",
+    "tendril",
+    "thiserror",
+    "thiserror-impl",
+    "tinystr",
+    "tracing-attributes",
+    "type-map",
+    "typenum",
+    "ucd-trie",
+    "unic-langid",
+    "unic-langid-impl",
+    "unic-langid-macros",
+    "unic-langid-macros-impl",
+    "unicase",
+    "unicode-ident",
+    "unicode-width",
+    "utf-8",
+    "version_check",
+    "wasi",
+    "wasm-bindgen-backend",
+    "wasm-bindgen-macro-support",
+    "wasm-bindgen-shared",
+    "windows-bindgen",
+    "windows-implement",
+    "windows-interface",
+    "windows-metadata",
+    "windows-targets",
+    "windows_aarch64_gnullvm",
+    "windows_aarch64_msvc",
+    "windows_i686_gnu",
+    "windows_i686_gnullvm",
+    "windows_i686_msvc",
+    "windows_x86_64_gnu",
+    "windows_x86_64_gnullvm",
+    "windows_x86_64_msvc",
+    "yoke",
+    "yoke-derive",
+    "zerocopy",
+    "zerocopy-derive",
+    "zerofrom",
+    "zerofrom-derive",
+    "zerovec",
+    "zerovec-derive",
+    // tidy-alphabetical-end
+];

src/tools/tidy/src/deps.rs

@@ -7,6 +7,9 @@ use std::path::Path;
 use build_helper::ci::CiEnv;
 use cargo_metadata::{Metadata, Package, PackageId};
 
+#[path = "../../../bootstrap/src/utils/proc_macro_deps.rs"]
+mod proc_macro_deps;
+
 /// These are licenses that are allowed for all crates, including the runtime,
 /// rustc, tools, etc.
 #[rustfmt::skip]
@@ -567,6 +570,8 @@ const PERMITTED_CRANELIFT_DEPENDENCIES: &[&str] = &[
 pub fn check(root: &Path, cargo: &Path, bad: &mut bool) {
     let mut checked_runtime_licenses = false;
 
+    check_proc_macro_dep_list(root, cargo, bad);
+
     for &(workspace, exceptions, permitted_deps, submodules) in WORKSPACES {
         if has_missing_submodule(root, submodules) {
             continue;
@@ -600,6 +605,37 @@ pub fn check(root: &Path, cargo: &Path, bad: &mut bool) {
     assert!(checked_runtime_licenses);
 }
 
+/// Ensure the list of proc-macro crate transitive dependencies is up to date
+fn check_proc_macro_dep_list(root: &Path, cargo: &Path, bad: &mut bool) {
+    let mut cmd = cargo_metadata::MetadataCommand::new();
+    cmd.cargo_path(cargo)
+        .manifest_path(root.join("Cargo.toml"))
+        .features(cargo_metadata::CargoOpt::AllFeatures)
+        .other_options(vec!["--locked".to_owned()]);
+    let metadata = t!(cmd.exec());
+    let is_proc_macro_pkg =
+        |pkg: &&Package| pkg.dependencies.iter().any(|dep| dep.name.as_str() == "proc-macro2");
+    let mut proc_macro_deps = HashSet::new();
+    for pkg in metadata.packages.iter().filter(is_proc_macro_pkg) {
+        deps_of(&metadata, &pkg.id, &mut proc_macro_deps);
+    }
+    let proc_macro_deps: HashSet<_> =
+        proc_macro_deps.into_iter().map(|dep| metadata[dep].name.clone()).collect();
+    let expected = proc_macro_deps::CRATES.iter().map(|s| s.to_string()).collect::<HashSet<_>>();
+    for missing in proc_macro_deps.difference(&expected) {
+        tidy_error!(
+            bad,
+            "proc-macro crate dependency `{missing}` is not registered in `src/bootstrap/src/utils/proc_macro_deps.rs`",
+        );
+    }
+    for extra in expected.difference(&proc_macro_deps) {
+        tidy_error!(
+            bad,
+            "`{extra}` is not registered in `src/bootstrap/src/utils/proc_macro_deps.rs`, but is not a proc-macro crate dependency",
+        );
+    }
+}
+
 /// Used to skip a check if a submodule is not checked out, and not in a CI environment.
 ///
 /// This helps prevent enforcing developers to fetch submodules for tidy.