Skip to content

Commit bc903cd

Browse files
borsbors
committed
Auto merge of #9216 - smoelius:master, r=flip1995
Add `ui_cargo_toml_metadata` test This PR adds a test to check the metadata of packages in the `ui_cargo` directory. A recent change to Cargo causes it to warn when it finds multiple packages with the same name in a git dependency (the issue is described [here](rust-lang/cargo#10752)). Many (if not all) Dylint libraries depend upon `clippy_utils`. As a result of the change, one now sees the following when building a Dylint library: ``` warning: skipping duplicate package `fail` found at `/home/smoelius/.cargo/git/checkouts/rust-clippy-4b72815e96774b3d/0cb0f76/tests/ui-cargo/module_style/pass_mod` warning: skipping duplicate package `fail` found at `/home/smoelius/.cargo/git/checkouts/rust-clippy-4b72815e96774b3d/0cb0f76/tests/ui-cargo/module_style/fail_no_mod` warning: skipping duplicate package `cargo_common_metadata` found at `/home/smoelius/.cargo/git/checkouts/rust-clippy-4b72815e96774b3d/0cb0f76/tests/ui-cargo/cargo_common_metadata/fail_publish_true` warning: skipping duplicate package `fail-cargo` found at `/home/smoelius/.cargo/git/checkouts/rust-clippy-4b72815e96774b3d/0cb0f76/tests/ui-cargo/cargo_rust_version/pass_cargo` warning: skipping duplicate package `fail-clippy` found at `/home/smoelius/.cargo/git/checkouts/rust-clippy-4b72815e96774b3d/0cb0f76/tests/ui-cargo/cargo_rust_version/fail_clippy` warning: skipping duplicate package `fail-both-same` found at `/home/smoelius/.cargo/git/checkouts/rust-clippy-4b72815e96774b3d/0cb0f76/tests/ui-cargo/cargo_rust_version/fail_both_same` warning: skipping duplicate package `fail-file-attr` found at `/home/smoelius/.cargo/git/checkouts/rust-clippy-4b72815e96774b3d/0cb0f76/tests/ui-cargo/cargo_rust_version/fail_file_attr` ``` There appear to be two contributing factors: - Some packages in `ui_cargo` could have a `publish = false` added to them. - Some packages in `ui_cargo` seem to be inconsistently named. The new test checks that each package in the `ui_cargo` directory has a name matching one of its parent directories, and `publish = false` in its metadata (with a few exceptions). Note that the packages in `cargo_common_metadata` require special care because `publish` is the subject of some of the `cargo_common_metadata` tests. Also note that this PR adds `walkdir` as a dev dependency to the `clippy` package. However, it was already a dependency of `clippy_dev` and `lintcheck`. So hopefully this is acceptable. Our continued thanks for making `clippy_utils` available, BTW. :) r? `@flip1995` changelog: none
2 parents d017e2d + 5b3300d commit bc903cd

File tree

28 files changed

+90
-34
lines changed

28 files changed

+90
-34
lines changed

‎Cargo.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ compiletest_rs = { version = "0.8", features = ["tmp"] }
3232
tester = "0.9"
3333
regex = "1.5"
3434
toml = "0.5"
35+
walkdir = "2.3"
3536
# This is used by the `collect-metadata` alias.
3637
filetime = "0.2"
3738

‎tests/compile-test.rs‎

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ fn rustfix_coverage_known_exceptions_accuracy() {
433433
let rs_path = Path::new("tests/ui").join(filename);
434434
assert!(
435435
rs_path.exists(),
436-
"`{}` does not exists",
436+
"`{}` does not exist",
437437
rs_path.strip_prefix(env!("CARGO_MANIFEST_DIR")).unwrap().display()
438438
);
439439
let fixed_path = rs_path.with_extension("fixed");
@@ -445,6 +445,45 @@ fn rustfix_coverage_known_exceptions_accuracy() {
445445
}
446446
}
447447

448+
#[test]
449+
fn ui_cargo_toml_metadata() {
450+
let ui_cargo_path = Path::new("tests/ui-cargo");
451+
let cargo_common_metadata_path = ui_cargo_path.join("cargo_common_metadata");
452+
let publish_exceptions =
453+
["fail_publish", "fail_publish_true", "pass_publish_empty"].map(|path| cargo_common_metadata_path.join(path));
454+
455+
for entry in walkdir::WalkDir::new(ui_cargo_path) {
456+
let entry = entry.unwrap();
457+
let path = entry.path();
458+
if path.file_name() != Some(OsStr::new("Cargo.toml")) {
459+
continue;
460+
}
461+
462+
let toml = fs::read_to_string(path).unwrap().parse::<toml::Value>().unwrap();
463+
464+
let package = toml.as_table().unwrap().get("package").unwrap().as_table().unwrap();
465+
466+
let name = package.get("name").unwrap().as_str().unwrap().replace('-', "_");
467+
assert!(
468+
path.parent()
469+
.unwrap()
470+
.components()
471+
.map(|component| component.as_os_str().to_string_lossy().replace('-', "_"))
472+
.any(|s| *s == name)
473+
|| path.starts_with(&cargo_common_metadata_path),
474+
"{:?} has incorrect package name",
475+
path
476+
);
477+
478+
let publish = package.get("publish").and_then(toml::Value::as_bool).unwrap_or(true);
479+
assert!(
480+
!publish || publish_exceptions.contains(&path.parent().unwrap().to_path_buf()),
481+
"{:?} lacks `publish = false`",
482+
path
483+
);
484+
}
485+
}
486+
448487
/// Restores an env var on drop
449488
#[must_use]
450489
struct VarGuard {

‎tests/ui-cargo/cargo_common_metadata/fail/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[package]
2-
name = "cargo_common_metadata"
2+
name = "cargo_common_metadata_fail"
33
version = "0.1.0"
44
publish = false
55

‎tests/ui-cargo/cargo_common_metadata/fail/src/main.stderr‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
error: package `cargo_common_metadata` is missing `package.description` metadata
1+
error: package `cargo_common_metadata_fail` is missing `package.description` metadata
22
|
33
= note: `-D clippy::cargo-common-metadata` implied by `-D warnings`
44

5-
error: package `cargo_common_metadata` is missing `either package.license or package.license_file` metadata
5+
error: package `cargo_common_metadata_fail` is missing `either package.license or package.license_file` metadata
66

7-
error: package `cargo_common_metadata` is missing `package.repository` metadata
7+
error: package `cargo_common_metadata_fail` is missing `package.repository` metadata
88

9-
error: package `cargo_common_metadata` is missing `package.readme` metadata
9+
error: package `cargo_common_metadata_fail` is missing `package.readme` metadata
1010

11-
error: package `cargo_common_metadata` is missing `package.keywords` metadata
11+
error: package `cargo_common_metadata_fail` is missing `package.keywords` metadata
1212

13-
error: package `cargo_common_metadata` is missing `package.categories` metadata
13+
error: package `cargo_common_metadata_fail` is missing `package.categories` metadata
1414

1515
error: aborting due to 6 previous errors
1616

‎tests/ui-cargo/cargo_common_metadata/fail_publish/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[package]
2-
name = "cargo_common_metadata"
2+
name = "cargo_common_metadata_fail_publish"
33
version = "0.1.0"
44
publish = ["some-registry-name"]
55

‎tests/ui-cargo/cargo_common_metadata/fail_publish/src/main.stderr‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
error: package `cargo_common_metadata` is missing `package.description` metadata
1+
error: package `cargo_common_metadata_fail_publish` is missing `package.description` metadata
22
|
33
= note: `-D clippy::cargo-common-metadata` implied by `-D warnings`
44

5-
error: package `cargo_common_metadata` is missing `either package.license or package.license_file` metadata
5+
error: package `cargo_common_metadata_fail_publish` is missing `either package.license or package.license_file` metadata
66

7-
error: package `cargo_common_metadata` is missing `package.repository` metadata
7+
error: package `cargo_common_metadata_fail_publish` is missing `package.repository` metadata
88

9-
error: package `cargo_common_metadata` is missing `package.readme` metadata
9+
error: package `cargo_common_metadata_fail_publish` is missing `package.readme` metadata
1010

11-
error: package `cargo_common_metadata` is missing `package.keywords` metadata
11+
error: package `cargo_common_metadata_fail_publish` is missing `package.keywords` metadata
1212

13-
error: package `cargo_common_metadata` is missing `package.categories` metadata
13+
error: package `cargo_common_metadata_fail_publish` is missing `package.categories` metadata
1414

1515
error: aborting due to 6 previous errors
1616

‎tests/ui-cargo/cargo_common_metadata/fail_publish_true/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[package]
2-
name = "cargo_common_metadata"
2+
name = "cargo_common_metadata_fail_publish_true"
33
version = "0.1.0"
44
publish = true
55

‎tests/ui-cargo/cargo_common_metadata/fail_publish_true/src/main.stderr‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
error: package `cargo_common_metadata` is missing `package.description` metadata
1+
error: package `cargo_common_metadata_fail_publish_true` is missing `package.description` metadata
22
|
33
= note: `-D clippy::cargo-common-metadata` implied by `-D warnings`
44

5-
error: package `cargo_common_metadata` is missing `either package.license or package.license_file` metadata
5+
error: package `cargo_common_metadata_fail_publish_true` is missing `either package.license or package.license_file` metadata
66

7-
error: package `cargo_common_metadata` is missing `package.repository` metadata
7+
error: package `cargo_common_metadata_fail_publish_true` is missing `package.repository` metadata
88

9-
error: package `cargo_common_metadata` is missing `package.readme` metadata
9+
error: package `cargo_common_metadata_fail_publish_true` is missing `package.readme` metadata
1010

11-
error: package `cargo_common_metadata` is missing `package.keywords` metadata
11+
error: package `cargo_common_metadata_fail_publish_true` is missing `package.keywords` metadata
1212

13-
error: package `cargo_common_metadata` is missing `package.categories` metadata
13+
error: package `cargo_common_metadata_fail_publish_true` is missing `package.categories` metadata
1414

1515
error: aborting due to 6 previous errors
1616

‎tests/ui-cargo/cargo_common_metadata/pass/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[package]
2-
name = "cargo_common_metadata"
2+
name = "cargo_common_metadata_pass"
33
version = "0.1.0"
44
publish = false
55
description = "A test package for the cargo_common_metadata lint"

‎tests/ui-cargo/cargo_common_metadata/pass_publish_empty/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[package]
2-
name = "cargo_common_metadata"
2+
name = "cargo_common_metadata_pass_publish_empty"
33
version = "0.1.0"
44
publish = []
55

0 commit comments

Comments
 (0)