Skip to content

Commit

Permalink
Fix tidy
Browse files Browse the repository at this point in the history
  • Loading branch information
@bjorn3
bjorn3 committed Sep 10, 2020
1 parent 3bef430 commit 30488fb
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 38 deletions.
11 changes: 2 additions & 9 deletions library/Cargo.lock
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,6 @@ dependencies = [
"rand_xorshift",
]

[[package]]
name = "autocfg"
version = "1.0.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "cdb031dd78e28731d87d56cc8ffef4a8f36ca26c38fe2de700543e627f8a464a"

[[package]]
name = "cc"
version = "1.0.59"
Expand Down Expand Up @@ -127,11 +121,10 @@ dependencies = [

[[package]]
name = "hashbrown"
version = "0.8.2"
version = "0.9.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e91b62f79061a0bc2e046024cb7ba44b08419ed238ecbd9adbd787434b9e8c25"
checksum = "00d63df3d41950fb462ed38308eea019113ad1508da725bbedcd0fa5a85ef5f7"
dependencies = [
"autocfg",
"compiler_builtins",
"rustc-std-workspace-alloc",
"rustc-std-workspace-core",
Expand Down
78 changes: 64 additions & 14 deletions src/tools/tidy/src/deps.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ const EXCEPTIONS: &[(&str, &str)] = &[
("arrayref", "BSD-2-Clause"), // cargo-miri/directories/.../rust-argon2 (redox)
("instant", "BSD-3-Clause"), // rustc_driver/tracing-subscriber/parking_lot
("snap", "BSD-3-Clause"), // rustc
];

const RUNTIME_EXCEPTIONS: &[(&str, &str)] = &[
// FIXME: this dependency violates the documentation comment above:
("fortanix-sgx-abi", "MPL-2.0"), // libstd but only for `sgx` target
];
Expand Down Expand Up @@ -79,7 +82,6 @@ const PERMITTED_DEPENDENCIES: &[&str] = &[
"chalk-ir",
"cloudabi",
"cmake",
"compiler_builtins",
"crc32fast",
"crossbeam-deque",
"crossbeam-epoch",
Expand All @@ -88,15 +90,13 @@ const PERMITTED_DEPENDENCIES: &[&str] = &[
"datafrog",
"difference",
"digest",
"dlmalloc",
"either",
"ena",
"env_logger",
"expect-test",
"fake-simd",
"filetime",
"flate2",
"fortanix-sgx-abi",
"fuchsia-zircon",
"fuchsia-zircon-sys",
"generic-array",
Expand Down Expand Up @@ -144,7 +144,6 @@ const PERMITTED_DEPENDENCIES: &[&str] = &[
"rand_core",
"rand_hc",
"rand_pcg",
"rand_xorshift",
"redox_syscall",
"regex",
"regex-syntax",
Expand Down Expand Up @@ -190,6 +189,37 @@ const PERMITTED_DEPENDENCIES: &[&str] = &[
"winapi-x86_64-pc-windows-gnu",
];

/// Crates the runtime is allowed to depend on. Avoid adding to the list if possible.
///
/// This list is here to provide a speed-bump to adding a new dependency to
/// the runtime. Please check with the compiler team before adding an entry.
const PERMITTED_RUNTIME_DEPENDENCIES: &[&str] = &[
"addr2line",
"adler",
"cc",
"cfg-if",
"compiler_builtins",
"dlmalloc",
"fortanix-sgx-abi",
"getopts",
"getrandom",
"gimli",
"hashbrown",
"hermit-abi",
"libc",
"miniz_oxide",
"object",
"ppv-lite86",
"rand",
"rand_chacha",
"rand_core",
"rand_hc",
"rand_xorshift",
"rustc-demangle",
"unicode-width",
"wasi",
];

/// Dependency checks.
///
/// `root` is path to the directory with the root `Cargo.toml` (for the workspace). `cargo` is path
Expand All @@ -200,17 +230,32 @@ pub fn check(root: &Path, cargo: &Path, bad: &mut bool) {
.manifest_path(root.join("Cargo.toml"))
.features(cargo_metadata::CargoOpt::AllFeatures);
let metadata = t!(cmd.exec());
check_exceptions(&metadata, bad);
check_dependencies(&metadata, bad);
check_exceptions(&metadata, EXCEPTIONS, false, bad);
check_dependencies(&metadata, PERMITTED_DEPENDENCIES, RESTRICTED_DEPENDENCY_CRATES, bad);
check_crate_duplicate(&metadata, bad);

let mut cmd = cargo_metadata::MetadataCommand::new();
cmd.cargo_path(cargo)
.manifest_path(root.join("library").join("Cargo.toml"))
.features(cargo_metadata::CargoOpt::AllFeatures);
let metadata = t!(cmd.exec());
check_exceptions(&metadata, RUNTIME_EXCEPTIONS, true, bad);
check_dependencies(&metadata, PERMITTED_RUNTIME_DEPENDENCIES, RUNTIME_CRATES, bad);
// Not running `check_crate_duplicate`, as the crates that don't allow duplicates are not used
// by the runtime.
}

/// Check that all licenses are in the valid list in `LICENSES`.
///
/// Packages listed in `EXCEPTIONS` are allowed for tools.
fn check_exceptions(metadata: &Metadata, bad: &mut bool) {
fn check_exceptions(
metadata: &Metadata,
exceptions: &[(&str, &str)],
is_runtime: bool,
bad: &mut bool,
) {
// Validate the EXCEPTIONS list hasn't changed.
for (name, license) in EXCEPTIONS {
for (name, license) in exceptions {
// Check that the package actually exists.
if !metadata.packages.iter().any(|p| p.name == *name) {
println!(
Expand Down Expand Up @@ -257,8 +302,8 @@ fn check_exceptions(metadata: &Metadata, bad: &mut bool) {
}
}

let exception_names: Vec<_> = EXCEPTIONS.iter().map(|(name, _license)| *name).collect();
let runtime_ids = compute_runtime_crates(metadata);
let exception_names: Vec<_> = exceptions.iter().map(|(name, _license)| *name).collect();
let runtime_ids = if is_runtime { compute_runtime_crates(metadata) } else { HashSet::new() };

// Check if any package does not have a valid license.
for pkg in &metadata.packages {
Expand Down Expand Up @@ -295,9 +340,14 @@ fn check_exceptions(metadata: &Metadata, bad: &mut bool) {
/// `true` if a check failed.
///
/// Specifically, this checks that the dependencies are on the `PERMITTED_DEPENDENCIES`.
fn check_dependencies(metadata: &Metadata, bad: &mut bool) {
fn check_dependencies(
metadata: &Metadata,
permitted: &[&'static str],
restricted_dependency_crates: &[&'static str],
bad: &mut bool,
) {
// Check that the PERMITTED_DEPENDENCIES does not have unused entries.
for name in PERMITTED_DEPENDENCIES {
for name in permitted {
if !metadata.packages.iter().any(|p| p.name == *name) {
println!(
"could not find allowed package `{}`\n\
Expand All @@ -308,12 +358,12 @@ fn check_dependencies(metadata: &Metadata, bad: &mut bool) {
}
}
// Get the list in a convenient form.
let permitted_dependencies: HashSet<_> = PERMITTED_DEPENDENCIES.iter().cloned().collect();
let permitted_dependencies: HashSet<_> = permitted.iter().cloned().collect();

// Check dependencies.
let mut visited = BTreeSet::new();
let mut unapproved = BTreeSet::new();
for &krate in RESTRICTED_DEPENDENCY_CRATES.iter() {
for &krate in restricted_dependency_crates.iter() {
let pkg = pkg_from_name(metadata, krate);
let mut bad =
check_crate_dependencies(&permitted_dependencies, metadata, &mut visited, pkg);
Expand Down
19 changes: 4 additions & 15 deletions src/tools/tidy/src/edition.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,6 @@

use std::path::Path;

fn filter_dirs(path: &Path) -> bool {
// FIXME: just use super::filter_dirs after the submodules are updated.
if super::filter_dirs(path) {
return true;
}
let skip = [
"src/doc/book/second-edition",
"src/doc/book/2018-edition",
"src/doc/book/ci/stable-check",
"src/doc/reference/stable-check",
];
skip.iter().any(|p| path.ends_with(p))
}

fn is_edition_2018(mut line: &str) -> bool {
line = line.trim();
line == "edition = \"2018\"" || line == "edition = \'2018\'"
Expand All @@ -24,13 +10,16 @@ fn is_edition_2018(mut line: &str) -> bool {
pub fn check(path: &Path, bad: &mut bool) {
super::walk(
path,
&mut |path| filter_dirs(path) || path.ends_with("src/test"),
&mut |path| super::filter_dirs(path) || path.ends_with("src/test"),
&mut |entry, contents| {
let file = entry.path();
let filename = file.file_name().unwrap();
if filename != "Cargo.toml" {
return;
}
if file.ends_with("library/Cargo.toml") {
return;
}
let has_edition = contents.lines().any(is_edition_2018);
if !has_edition {
tidy_error!(
Expand Down

0 comments on commit 30488fb

Please sign in to comment.