mirror of
https://github.com/rust-lang/cargo
synced 2024-10-14 03:32:39 +00:00
08fdd86d84
In rust-lang/cargo#12115, we explored how we can let stable projects experiment with `[lints]` to provide feedback. What we settled on is switching from the `cargo-features` manifest key to the `-Z` flag as `cargo-features` always requires nightly while `-Z` only requires it when being passed in. This means a project can have a `[lints]` table and have CI / contributors run `cargo +nightly check -Zlints` when they care about warnings.
640 lines
13 KiB
Rust
640 lines
13 KiB
Rust
//! Tests for `[lints]`
|
|
|
|
use cargo_test_support::project;
|
|
use cargo_test_support::registry::Package;
|
|
|
|
#[cargo_test]
|
|
fn package_requires_option() {
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
authors = []
|
|
|
|
[lints.rust]
|
|
unsafe_code = "forbid"
|
|
"#,
|
|
)
|
|
.file("src/lib.rs", "")
|
|
.build();
|
|
|
|
foo.cargo("check")
|
|
.with_stderr(
|
|
"\
|
|
warning: unused manifest key `lints` (may be supported in a future version)
|
|
|
|
this Cargo does not support nightly features, but if you
|
|
switch to nightly channel you can pass
|
|
`-Zlints` to enable this feature.
|
|
[CHECKING] [..]
|
|
[FINISHED] [..]
|
|
",
|
|
)
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn workspace_requires_option() {
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
authors = []
|
|
|
|
[workspace.lints.rust]
|
|
unsafe_code = "forbid"
|
|
"#,
|
|
)
|
|
.file("src/lib.rs", "")
|
|
.build();
|
|
|
|
foo.cargo("check")
|
|
.with_stderr(
|
|
"\
|
|
warning: [CWD]/Cargo.toml: unused manifest key `lints` (may be supported in a future version)
|
|
|
|
this Cargo does not support nightly features, but if you
|
|
switch to nightly channel you can pass
|
|
`-Zlints` to enable this feature.
|
|
[CHECKING] [..]
|
|
[FINISHED] [..]
|
|
",
|
|
)
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn dependency_warning_ignored() {
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
authors = []
|
|
|
|
[dependencies]
|
|
bar.path = "../bar"
|
|
"#,
|
|
)
|
|
.file("src/lib.rs", "")
|
|
.build();
|
|
|
|
let _bar = project()
|
|
.at("bar")
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
[package]
|
|
name = "bar"
|
|
version = "0.0.1"
|
|
authors = []
|
|
|
|
[lints.rust]
|
|
unsafe_code = "forbid"
|
|
"#,
|
|
)
|
|
.file("src/lib.rs", "")
|
|
.build();
|
|
|
|
foo.cargo("check")
|
|
.with_stderr(
|
|
"\
|
|
[CHECKING] [..]
|
|
[CHECKING] [..]
|
|
[FINISHED] [..]
|
|
",
|
|
)
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn malformed_on_stable() {
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
lints = 20
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
authors = []
|
|
|
|
"#,
|
|
)
|
|
.file("src/lib.rs", "")
|
|
.build();
|
|
|
|
foo.cargo("check")
|
|
.with_stderr(
|
|
"\
|
|
warning: unused manifest key `lints` (may be supported in a future version)
|
|
|
|
this Cargo does not support nightly features, but if you
|
|
switch to nightly channel you can pass
|
|
`-Zlints` to enable this feature.
|
|
[CHECKING] [..]
|
|
[FINISHED] [..]
|
|
",
|
|
)
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn malformed_on_nightly() {
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
lints = 20
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
authors = []
|
|
|
|
"#,
|
|
)
|
|
.file("src/lib.rs", "")
|
|
.build();
|
|
|
|
foo.cargo("check -Zlints")
|
|
.masquerade_as_nightly_cargo(&["lints"])
|
|
.with_status(101)
|
|
.with_stderr(
|
|
"\
|
|
error: failed to parse manifest[..]
|
|
|
|
Caused by:
|
|
invalid type: integer `20`, expected a map
|
|
",
|
|
)
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn fail_on_invalid_tool() {
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
authors = []
|
|
|
|
[workspace.lints.super-awesome-linter]
|
|
unsafe_code = "forbid"
|
|
"#,
|
|
)
|
|
.file("src/lib.rs", "")
|
|
.build();
|
|
|
|
foo.cargo("check -Zlints")
|
|
.masquerade_as_nightly_cargo(&["lints"])
|
|
.with_status(101)
|
|
.with_stderr(
|
|
"\
|
|
[..]
|
|
|
|
Caused by:
|
|
unsupported `super-awesome-linter` in `[lints]`, must be one of rust, clippy, rustdoc
|
|
",
|
|
)
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn fail_on_tool_injection() {
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
authors = []
|
|
|
|
[workspace.lints.rust]
|
|
"clippy::cyclomatic_complexity" = "warn"
|
|
"#,
|
|
)
|
|
.file("src/lib.rs", "")
|
|
.build();
|
|
|
|
foo.cargo("check -Zlints")
|
|
.masquerade_as_nightly_cargo(&["lints"])
|
|
.with_status(101)
|
|
.with_stderr(
|
|
"\
|
|
[..]
|
|
|
|
Caused by:
|
|
`lints.rust.clippy::cyclomatic_complexity` is not valid lint name; try `lints.clippy.cyclomatic_complexity`
|
|
",
|
|
)
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn fail_on_redundant_tool() {
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
authors = []
|
|
|
|
[workspace.lints.rust]
|
|
"rust::unsafe_code" = "forbid"
|
|
"#,
|
|
)
|
|
.file("src/lib.rs", "")
|
|
.build();
|
|
|
|
foo.cargo("check -Zlints")
|
|
.masquerade_as_nightly_cargo(&["lints"])
|
|
.with_status(101)
|
|
.with_stderr(
|
|
"\
|
|
[..]
|
|
|
|
Caused by:
|
|
`lints.rust.rust::unsafe_code` is not valid lint name; try `lints.rust.unsafe_code`
|
|
",
|
|
)
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn fail_on_conflicting_tool() {
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
authors = []
|
|
|
|
[workspace.lints.rust]
|
|
"super-awesome-tool::unsafe_code" = "forbid"
|
|
"#,
|
|
)
|
|
.file("src/lib.rs", "")
|
|
.build();
|
|
|
|
foo.cargo("check -Zlints")
|
|
.masquerade_as_nightly_cargo(&["lints"])
|
|
.with_status(101)
|
|
.with_stderr(
|
|
"\
|
|
[..]
|
|
|
|
Caused by:
|
|
`lints.rust.super-awesome-tool::unsafe_code` is not a valid lint name
|
|
",
|
|
)
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn package_lint_deny() {
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
authors = []
|
|
|
|
[lints.rust]
|
|
"unsafe_code" = "deny"
|
|
"#,
|
|
)
|
|
.file(
|
|
"src/lib.rs",
|
|
"
|
|
pub fn foo(num: i32) -> u32 {
|
|
unsafe { std::mem::transmute(num) }
|
|
}
|
|
",
|
|
)
|
|
.build();
|
|
|
|
foo.cargo("check -Zlints")
|
|
.masquerade_as_nightly_cargo(&["lints"])
|
|
.with_status(101)
|
|
.with_stderr_contains(
|
|
"\
|
|
error: usage of an `unsafe` block
|
|
",
|
|
)
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn workspace_lint_deny() {
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
authors = []
|
|
|
|
[lints]
|
|
workspace = true
|
|
|
|
[workspace.lints.rust]
|
|
"unsafe_code" = "deny"
|
|
"#,
|
|
)
|
|
.file(
|
|
"src/lib.rs",
|
|
"
|
|
pub fn foo(num: i32) -> u32 {
|
|
unsafe { std::mem::transmute(num) }
|
|
}
|
|
",
|
|
)
|
|
.build();
|
|
|
|
foo.cargo("check -Zlints")
|
|
.masquerade_as_nightly_cargo(&["lints"])
|
|
.with_status(101)
|
|
.with_stderr_contains(
|
|
"\
|
|
error: usage of an `unsafe` block
|
|
",
|
|
)
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn attribute_has_precedence() {
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
authors = []
|
|
|
|
[lints.rust]
|
|
"unsafe_code" = "deny"
|
|
"#,
|
|
)
|
|
.file(
|
|
"src/lib.rs",
|
|
"
|
|
#![allow(unsafe_code)]
|
|
|
|
pub fn foo(num: i32) -> u32 {
|
|
unsafe { std::mem::transmute(num) }
|
|
}
|
|
",
|
|
)
|
|
.build();
|
|
|
|
foo.cargo("check -Zlints")
|
|
.arg("-v") // Show order of rustflags on failure
|
|
.masquerade_as_nightly_cargo(&["lints"])
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn rustflags_has_precedence() {
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
authors = []
|
|
|
|
[lints.rust]
|
|
"unsafe_code" = "deny"
|
|
"#,
|
|
)
|
|
.file(
|
|
"src/lib.rs",
|
|
"
|
|
pub fn foo(num: i32) -> u32 {
|
|
unsafe { std::mem::transmute(num) }
|
|
}
|
|
",
|
|
)
|
|
.build();
|
|
|
|
foo.cargo("check -Zlints")
|
|
.arg("-v") // Show order of rustflags on failure
|
|
.env("RUSTFLAGS", "-Aunsafe_code")
|
|
.masquerade_as_nightly_cargo(&["lints"])
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn profile_rustflags_has_precedence() {
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
cargo-features = ["profile-rustflags"]
|
|
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
|
|
[lints.rust]
|
|
"unsafe_code" = "deny"
|
|
|
|
[profile.dev]
|
|
rustflags = ["-A", "unsafe_code"]
|
|
"#,
|
|
)
|
|
.file(
|
|
"src/lib.rs",
|
|
"
|
|
pub fn foo(num: i32) -> u32 {
|
|
unsafe { std::mem::transmute(num) }
|
|
}
|
|
",
|
|
)
|
|
.build();
|
|
|
|
foo.cargo("check -Zlints")
|
|
.arg("-v") // Show order of rustflags on failure
|
|
.masquerade_as_nightly_cargo(&["lints", "profile-rustflags"])
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn build_rustflags_has_precedence() {
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
|
|
[lints.rust]
|
|
"unsafe_code" = "deny"
|
|
"#,
|
|
)
|
|
.file(
|
|
".cargo/config.toml",
|
|
r#"
|
|
[build]
|
|
rustflags = ["-A", "unsafe_code"]
|
|
"#,
|
|
)
|
|
.file(
|
|
"src/lib.rs",
|
|
"
|
|
pub fn foo(num: i32) -> u32 {
|
|
unsafe { std::mem::transmute(num) }
|
|
}
|
|
",
|
|
)
|
|
.build();
|
|
|
|
foo.cargo("check -Zlints")
|
|
.arg("-v") // Show order of rustflags on failure
|
|
.masquerade_as_nightly_cargo(&["lints"])
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn without_priority() {
|
|
Package::new("reg-dep", "1.0.0").publish();
|
|
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
edition = "2018"
|
|
authors = []
|
|
|
|
[dependencies]
|
|
reg-dep = "1.0.0"
|
|
|
|
[lints.rust]
|
|
"rust-2018-idioms" = "deny"
|
|
"unused-extern-crates" = "allow"
|
|
"#,
|
|
)
|
|
.file(
|
|
"src/lib.rs",
|
|
"
|
|
extern crate reg_dep;
|
|
|
|
pub fn foo() -> u32 {
|
|
2
|
|
}
|
|
",
|
|
)
|
|
.build();
|
|
|
|
foo.cargo("check -Zlints")
|
|
.masquerade_as_nightly_cargo(&["lints"])
|
|
.with_status(101)
|
|
.with_stderr_contains(
|
|
"\
|
|
error: unused extern crate
|
|
",
|
|
)
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn with_priority() {
|
|
Package::new("reg-dep", "1.0.0").publish();
|
|
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
edition = "2018"
|
|
authors = []
|
|
|
|
[dependencies]
|
|
reg-dep = "1.0.0"
|
|
|
|
[lints.rust]
|
|
"rust-2018-idioms" = { level = "deny", priority = -1 }
|
|
"unused-extern-crates" = "allow"
|
|
"#,
|
|
)
|
|
.file(
|
|
"src/lib.rs",
|
|
"
|
|
extern crate reg_dep;
|
|
|
|
pub fn foo() -> u32 {
|
|
2
|
|
}
|
|
",
|
|
)
|
|
.build();
|
|
|
|
foo.cargo("check -Zlints")
|
|
.masquerade_as_nightly_cargo(&["lints"])
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn rustdoc_lint() {
|
|
let foo = project()
|
|
.file(
|
|
"Cargo.toml",
|
|
r#"
|
|
[package]
|
|
name = "foo"
|
|
version = "0.0.1"
|
|
authors = []
|
|
|
|
[lints.rustdoc]
|
|
broken_intra_doc_links = "deny"
|
|
"#,
|
|
)
|
|
.file(
|
|
"src/lib.rs",
|
|
"
|
|
/// [`bar`] doesn't exist
|
|
pub fn foo() -> u32 {
|
|
}
|
|
",
|
|
)
|
|
.build();
|
|
|
|
foo.cargo("doc -Zlints")
|
|
.masquerade_as_nightly_cargo(&["lints"])
|
|
.with_status(101)
|
|
.with_stderr_contains(
|
|
"\
|
|
error: unresolved link to `bar`
|
|
",
|
|
)
|
|
.run();
|
|
}
|