|
| 1 | +// Copyright 2016 The Rust Project Developers. See the COPYRIGHT |
| 2 | +// file at the top-level directory of this distribution and at |
| 3 | +// http://rust-lang.org/COPYRIGHT. |
| 4 | +// |
| 5 | +// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or |
| 6 | +// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license |
| 7 | +// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your |
| 8 | +// option. This file may not be copied, modified, or distributed |
| 9 | +// except according to those terms. |
| 10 | + |
| 11 | +//! Tidy check to ensure that `[dependencies]` and `extern crate` are in sync. |
| 12 | +//! |
| 13 | +//! This tidy check ensures that all crates listed in the `[dependencies]` |
| 14 | +//! section of a `Cargo.toml` are present in the corresponding `lib.rs` as |
| 15 | +//! `extern crate` declarations. This should help us keep the DAG correctly |
| 16 | +//! structured through various refactorings to prune out unnecessary edges. |
| 17 | +
|
| 18 | +use std::io::prelude::*; |
| 19 | +use std::fs::File; |
| 20 | +use std::path::Path; |
| 21 | + |
| 22 | +pub fn check(path: &Path, bad: &mut bool) { |
| 23 | + for entry in t!(path.read_dir()).map(|e| t!(e)) { |
| 24 | + // Look for `Cargo.toml` with a sibling `src/lib.rs` or `lib.rs` |
| 25 | + if entry.file_name().to_str() == Some("Cargo.toml") { |
| 26 | + if path.join("src/lib.rs").is_file() { |
| 27 | + verify(&entry.path(), &path.join("src/lib.rs"), bad) |
| 28 | + } |
| 29 | + if path.join("lib.rs").is_file() { |
| 30 | + verify(&entry.path(), &path.join("lib.rs"), bad) |
| 31 | + } |
| 32 | + } else if t!(entry.file_type()).is_dir() { |
| 33 | + check(&entry.path(), bad); |
| 34 | + } |
| 35 | + } |
| 36 | +} |
| 37 | + |
| 38 | +// Verify that the dependencies in Cargo.toml at `tomlfile` are sync'd with the |
| 39 | +// `extern crate` annotations in the lib.rs at `libfile`. |
| 40 | +fn verify(tomlfile: &Path, libfile: &Path, bad: &mut bool) { |
| 41 | + let mut toml = String::new(); |
| 42 | + let mut librs = String::new(); |
| 43 | + t!(t!(File::open(tomlfile)).read_to_string(&mut toml)); |
| 44 | + t!(t!(File::open(libfile)).read_to_string(&mut librs)); |
| 45 | + |
| 46 | + if toml.contains("name = \"bootstrap\"") { |
| 47 | + return |
| 48 | + } |
| 49 | + |
| 50 | + // "Poor man's TOML parser", just assume we use one syntax for now |
| 51 | + // |
| 52 | + // We just look for: |
| 53 | + // |
| 54 | + // [dependencies] |
| 55 | + // name = ... |
| 56 | + // name2 = ... |
| 57 | + // name3 = ... |
| 58 | + // |
| 59 | + // If we encounter a line starting with `[` then we assume it's the end of |
| 60 | + // the dependency section and bail out. |
| 61 | + let deps = match toml.find("[dependencies]") { |
| 62 | + Some(i) => &toml[i+1..], |
| 63 | + None => return, |
| 64 | + }; |
| 65 | + let mut lines = deps.lines().peekable(); |
| 66 | + while let Some(line) = lines.next() { |
| 67 | + if line.starts_with("[") { |
| 68 | + break |
| 69 | + } |
| 70 | + |
| 71 | + let mut parts = line.splitn(2, '='); |
| 72 | + let krate = parts.next().unwrap().trim(); |
| 73 | + if parts.next().is_none() { |
| 74 | + continue |
| 75 | + } |
| 76 | + |
| 77 | + // Don't worry about depending on core/std but not saying `extern crate |
| 78 | + // core/std`, that's intentional. |
| 79 | + if krate == "core" || krate == "std" { |
| 80 | + continue |
| 81 | + } |
| 82 | + |
| 83 | + // This is intentional, this dependency just makes the crate available |
| 84 | + // for others later on. |
| 85 | + if krate == "alloc_jemalloc" && toml.contains("name = \"std\"") { |
| 86 | + continue |
| 87 | + } |
| 88 | + |
| 89 | + if !librs.contains(&format!("extern crate {}", krate)) { |
| 90 | + println!("{} doesn't have `extern crate {}`, but Cargo.toml \ |
| 91 | + depends on it", libfile.display(), krate); |
| 92 | + *bad = true; |
| 93 | + } |
| 94 | + } |
| 95 | +} |
0 commit comments