cargo/tests/testsuite/profile_trim_paths.rs

759 lines
21 KiB
Rust
Raw Normal View History

//! Tests for `-Ztrim-paths`.
use cargo_test_support::basic_manifest;
use cargo_test_support::git;
use cargo_test_support::paths;
use cargo_test_support::project;
use cargo_test_support::registry::Package;
#[cargo_test]
fn gated_manifest() {
let p = project()
.file(
"Cargo.toml",
r#"
[package]
name = "foo"
version = "0.0.1"
[profile.dev]
trim-paths = "macro"
"#,
)
.file("src/lib.rs", "")
.build();
p.cargo("check")
.masquerade_as_nightly_cargo(&["-Ztrim-paths"])
.with_status(101)
.with_stderr_contains(
"\
[ERROR] failed to parse manifest at `[CWD]/Cargo.toml`
Caused by:
feature `trim-paths` is required",
)
.run();
}
#[cargo_test]
fn gated_config_toml() {
let p = project()
.file(
".cargo/config.toml",
r#"
[profile.dev]
trim-paths = "macro"
"#,
)
.file("src/lib.rs", "")
.build();
p.cargo("check")
.masquerade_as_nightly_cargo(&["-Ztrim-paths"])
.with_status(101)
.with_stderr_contains(
"\
[ERROR] config profile `dev` is not valid (defined in `[CWD]/.cargo/config.toml`)
Caused by:
feature `trim-paths` is required",
)
.run();
}
#[cargo_test(nightly, reason = "-Zremap-path-scope is unstable")]
fn release_profile_default_to_object() {
let p = project()
.file(
"Cargo.toml",
r#"
[package]
name = "foo"
version = "0.0.1"
"#,
)
.file("src/lib.rs", "")
.build();
p.cargo("build --release --verbose -Ztrim-paths")
.masquerade_as_nightly_cargo(&["-Ztrim-paths"])
.with_stderr(
"\
[COMPILING] foo v0.0.1 ([CWD])
[RUNNING] `rustc [..]\
-Zremap-path-scope=object \
--remap-path-prefix=[CWD]=. \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]
[FINISHED] release [..]",
)
.run();
}
#[cargo_test(nightly, reason = "-Zremap-path-scope is unstable")]
fn one_option() {
let build = |option| {
let p = project()
.file(
"Cargo.toml",
&format!(
r#"
[package]
name = "foo"
version = "0.0.1"
[profile.dev]
trim-paths = "{option}"
"#
),
)
.file("src/lib.rs", "")
.build();
p.cargo("build -v -Ztrim-paths")
};
for option in ["macro", "diagnostics", "object", "all"] {
build(option)
.masquerade_as_nightly_cargo(&["-Ztrim-paths"])
.with_stderr(&format!(
"\
[COMPILING] foo v0.0.1 ([CWD])
[RUNNING] `rustc [..]\
-Zremap-path-scope={option} \
--remap-path-prefix=[CWD]=. \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]
[FINISHED] dev [..]",
))
.run();
}
build("none")
.masquerade_as_nightly_cargo(&["-Ztrim-paths"])
.with_stderr_does_not_contain("[..]-Zremap-path-scope=[..]")
.with_stderr_does_not_contain("[..]--remap-path-prefix=[..]")
.run();
}
#[cargo_test(nightly, reason = "-Zremap-path-scope is unstable")]
fn multiple_options() {
let p = project()
.file(
"Cargo.toml",
r#"
[package]
name = "foo"
version = "0.0.1"
[profile.dev]
trim-paths = ["diagnostics", "macro", "object"]
"#,
)
.file("src/lib.rs", "")
.build();
p.cargo("build --verbose -Ztrim-paths")
.masquerade_as_nightly_cargo(&["-Ztrim-paths"])
.with_stderr(
"\
[COMPILING] foo v0.0.1 ([CWD])
[RUNNING] `rustc [..]\
-Zremap-path-scope=diagnostics,macro,object \
--remap-path-prefix=[CWD]=. \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]
[FINISHED] dev [..]",
)
.run();
}
#[cargo_test(nightly, reason = "-Zremap-path-scope is unstable")]
fn profile_merge_works() {
let p = project()
.file(
"Cargo.toml",
r#"
[package]
name = "foo"
version = "0.0.1"
[profile.dev]
trim-paths = ["macro"]
[profile.custom]
inherits = "dev"
trim-paths = ["diagnostics"]
"#,
)
.file("src/lib.rs", "")
.build();
p.cargo("build -v -Ztrim-paths --profile custom")
.masquerade_as_nightly_cargo(&["-Ztrim-paths"])
.with_stderr(
"\
[COMPILING] foo v0.0.1 ([CWD])
[RUNNING] `rustc [..]\
-Zremap-path-scope=diagnostics \
--remap-path-prefix=[CWD]=. \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]
[FINISHED] custom [..]",
)
.run();
}
#[cargo_test(nightly, reason = "-Zremap-path-scope is unstable")]
fn registry_dependency() {
Package::new("bar", "0.0.1")
.file("Cargo.toml", &basic_manifest("bar", "0.0.1"))
.file("src/lib.rs", r#"pub fn f() { println!("{}", file!()); }"#)
.publish();
let p = project()
.file(
"Cargo.toml",
r#"
[package]
name = "foo"
version = "0.0.1"
[dependencies]
bar = "0.0.1"
[profile.dev]
trim-paths = "object"
"#,
)
.file("src/main.rs", "fn main() { bar::f(); }")
.build();
let registry_src = paths::home().join(".cargo/registry/src");
let registry_src = registry_src.display();
p.cargo("run --verbose -Ztrim-paths")
.masquerade_as_nightly_cargo(&["-Ztrim-paths"])
.with_stdout("-[..]/bar-0.0.1/src/lib.rs") // Omit the hash of Source URL
.with_stderr(&format!(
"\
[UPDATING] [..]
[DOWNLOADING] crates ...
[DOWNLOADED] bar v0.0.1 ([..])
[COMPILING] bar v0.0.1
[RUNNING] `rustc [..]\
-Zremap-path-scope=object \
--remap-path-prefix={registry_src}= \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]
[COMPILING] foo v0.0.1 ([CWD])
[RUNNING] `rustc [..]\
-Zremap-path-scope=object \
--remap-path-prefix=[CWD]=. \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]
[FINISHED] dev [..]
[RUNNING] `target/debug/foo[EXE]`"
))
.run();
}
#[cargo_test(nightly, reason = "-Zremap-path-scope is unstable")]
fn git_dependency() {
let git_project = git::new("bar", |project| {
project
.file("Cargo.toml", &basic_manifest("bar", "0.0.1"))
.file("src/lib.rs", r#"pub fn f() { println!("{}", file!()); }"#)
});
let url = git_project.url();
let p = project()
.file(
"Cargo.toml",
&format!(
r#"
[package]
name = "foo"
version = "0.0.1"
[dependencies]
bar = {{ git = "{url}" }}
[profile.dev]
trim-paths = "object"
"#
),
)
.file("src/main.rs", "fn main() { bar::f(); }")
.build();
let git_checkouts_src = paths::home().join(".cargo/git/checkouts");
let git_checkouts_src = git_checkouts_src.display();
p.cargo("run --verbose -Ztrim-paths")
.masquerade_as_nightly_cargo(&["-Ztrim-paths"])
.with_stdout("bar-[..]/[..]/src/lib.rs") // Omit the hash of Source URL and commit
.with_stderr(&format!(
"\
[UPDATING] git repository `{url}`
[COMPILING] bar v0.0.1 ({url}[..])
[RUNNING] `rustc [..]\
-Zremap-path-scope=object \
--remap-path-prefix={git_checkouts_src}= \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]
[COMPILING] foo v0.0.1 ([CWD])
[RUNNING] `rustc [..]\
-Zremap-path-scope=object \
--remap-path-prefix=[CWD]=. \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]
[FINISHED] dev [..]
[RUNNING] `target/debug/foo[EXE]`"
))
.run();
}
#[cargo_test(nightly, reason = "-Zremap-path-scope is unstable")]
fn path_dependency() {
let p = project()
.file(
"Cargo.toml",
r#"
[package]
name = "foo"
version = "0.0.1"
[dependencies]
bar = { path = "cocktail-bar" }
[profile.dev]
trim-paths = "object"
"#,
)
.file("src/main.rs", "fn main() { bar::f(); }")
.file("cocktail-bar/Cargo.toml", &basic_manifest("bar", "0.0.1"))
.file(
"cocktail-bar/src/lib.rs",
r#"pub fn f() { println!("{}", file!()); }"#,
)
.build();
p.cargo("run --verbose -Ztrim-paths")
.masquerade_as_nightly_cargo(&["-Ztrim-paths"])
.with_stdout("cocktail-bar/src/lib.rs")
.with_stderr(&format!(
"\
[COMPILING] bar v0.0.1 ([..]/cocktail-bar)
[RUNNING] `rustc [..]\
-Zremap-path-scope=object \
--remap-path-prefix=[CWD]=. \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]
[COMPILING] foo v0.0.1 ([CWD])
[RUNNING] `rustc [..]\
-Zremap-path-scope=object \
--remap-path-prefix=[CWD]=. \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]
[FINISHED] dev [..]
[RUNNING] `target/debug/foo[EXE]`"
))
.run();
}
#[cargo_test(nightly, reason = "-Zremap-path-scope is unstable")]
fn path_dependency_outside_workspace() {
let bar = project()
.at("bar")
.file("Cargo.toml", &basic_manifest("bar", "0.0.1"))
.file("src/lib.rs", r#"pub fn f() { println!("{}", file!()); }"#)
.build();
let bar_path = bar.url().to_file_path().unwrap();
let bar_path = bar_path.display();
let p = project()
.file(
"Cargo.toml",
r#"
[package]
name = "foo"
version = "0.0.1"
[dependencies]
bar = { path = "../bar" }
[profile.dev]
trim-paths = "object"
"#,
)
.file("src/main.rs", "fn main() { bar::f(); }")
.build();
p.cargo("run --verbose -Ztrim-paths")
.masquerade_as_nightly_cargo(&["-Ztrim-paths"])
.with_stdout("bar-0.0.1/src/lib.rs")
.with_stderr(&format!(
"\
[COMPILING] bar v0.0.1 ([..]/bar)
[RUNNING] `rustc [..]\
-Zremap-path-scope=object \
--remap-path-prefix={bar_path}=bar-0.0.1 \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]
[COMPILING] foo v0.0.1 ([CWD])
[RUNNING] `rustc [..]\
-Zremap-path-scope=object \
--remap-path-prefix=[CWD]=. \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]
[FINISHED] dev [..]
[RUNNING] `target/debug/foo[EXE]`"
))
.run();
}
#[cargo_test(nightly, reason = "-Zremap-path-scope is unstable")]
fn diagnostics_works() {
Package::new("bar", "0.0.1")
.file("Cargo.toml", &basic_manifest("bar", "0.0.1"))
.file("src/lib.rs", r#"pub fn f() { let unused = 0; }"#)
.publish();
let p = project()
.file(
"Cargo.toml",
r#"
[package]
name = "foo"
version = "0.0.1"
[dependencies]
bar = "0.0.1"
[profile.dev]
trim-paths = "diagnostics"
"#,
)
.file("src/lib.rs", "")
.build();
let registry_src = paths::home().join(".cargo/registry/src");
let registry_src = registry_src.display();
p.cargo("build -vv -Ztrim-paths")
.masquerade_as_nightly_cargo(&["-Ztrim-paths"])
.with_stderr_line_without(
&["[..]bar-0.0.1/src/lib.rs:1[..]"],
&[&format!("{registry_src}")],
)
.with_stderr_contains("[..]unused_variables[..]")
.with_stderr_contains(&format!(
"\
[RUNNING] [..]rustc [..]\
-Zremap-path-scope=diagnostics \
--remap-path-prefix={registry_src}= \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]",
))
.with_stderr_contains(
"\
[RUNNING] [..]rustc [..]\
-Zremap-path-scope=diagnostics \
--remap-path-prefix=[CWD]=. \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]",
)
.run();
}
#[cfg(target_os = "macos")]
mod object_works {
use super::*;
fn inspect_debuginfo(path: &std::path::Path) -> Vec<u8> {
std::process::Command::new("nm")
.arg("-pa")
.arg(path)
.output()
.expect("nm works")
.stdout
}
#[cargo_test(requires_nm, nightly, reason = "-Zremap-path-scope is unstable")]
fn with_split_debuginfo_off() {
object_works_helper("off", inspect_debuginfo);
}
#[cargo_test(requires_nm, nightly, reason = "-Zremap-path-scope is unstable")]
fn with_split_debuginfo_packed() {
object_works_helper("packed", inspect_debuginfo);
}
#[cargo_test(requires_nm, nightly, reason = "-Zremap-path-scope is unstable")]
fn with_split_debuginfo_unpacked() {
object_works_helper("unpacked", inspect_debuginfo);
}
}
#[cfg(target_os = "linux")]
mod object_works {
use super::*;
fn inspect_debuginfo(path: &std::path::Path) -> Vec<u8> {
std::process::Command::new("readelf")
.arg("--debug-dump=info")
.arg("--debug-dump=no-follow-links") // older version can't recognized but just a warning
.arg(path)
.output()
.expect("readelf works")
.stdout
}
#[cargo_test(requires_readelf, nightly, reason = "-Zremap-path-scope is unstable")]
fn with_split_debuginfo_off() {
object_works_helper("off", inspect_debuginfo);
}
#[cargo_test(requires_readelf, nightly, reason = "-Zremap-path-scope is unstable")]
fn with_split_debuginfo_packed() {
object_works_helper("packed", inspect_debuginfo);
}
#[cargo_test(requires_readelf, nightly, reason = "-Zremap-path-scope is unstable")]
fn with_split_debuginfo_unpacked() {
object_works_helper("unpacked", inspect_debuginfo);
}
}
#[cfg(unix)]
fn object_works_helper(split_debuginfo: &str, run: impl Fn(&std::path::Path) -> Vec<u8>) {
use std::os::unix::ffi::OsStrExt;
let registry_src = paths::home().join(".cargo/registry/src");
let registry_src_bytes = registry_src.as_os_str().as_bytes();
let registry_src = registry_src.display();
let rust_src = "/lib/rustc/src/rust".as_bytes();
Package::new("bar", "0.0.1")
.file("Cargo.toml", &basic_manifest("bar", "0.0.1"))
.file("src/lib.rs", r#"pub fn f() { println!("{}", file!()); }"#)
.publish();
let p = project()
.file(
"Cargo.toml",
&format!(
r#"
[package]
name = "foo"
version = "0.0.1"
[dependencies]
bar = "0.0.1"
[profile.dev]
split-debuginfo = "{split_debuginfo}"
"#
),
)
.file("src/main.rs", "fn main() { bar::f(); }")
.build();
let pkg_root = p.root();
let pkg_root = pkg_root.as_os_str().as_bytes();
p.cargo("build").run();
let bin_path = p.bin("foo");
assert!(bin_path.is_file());
let stdout = run(&bin_path);
// TODO: re-enable this check when rustc bootstrap disables remapping
// <https://github.com/rust-lang/cargo/pull/12625#discussion_r1371714791>
// assert!(memchr::memmem::find(&stdout, rust_src).is_some());
assert!(memchr::memmem::find(&stdout, registry_src_bytes).is_some());
assert!(memchr::memmem::find(&stdout, pkg_root).is_some());
p.cargo("clean").run();
p.cargo("build --verbose -Ztrim-paths")
.arg("--config")
.arg(r#"profile.dev.trim-paths="object""#)
.masquerade_as_nightly_cargo(&["-Ztrim-paths"])
.with_stderr(&format!(
"\
[COMPILING] bar v0.0.1
[RUNNING] `rustc [..]-C split-debuginfo={split_debuginfo} [..]\
-Zremap-path-scope=object \
--remap-path-prefix={registry_src}= \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]
[COMPILING] foo v0.0.1 ([CWD])
[RUNNING] `rustc [..]-C split-debuginfo={split_debuginfo} [..]\
-Zremap-path-scope=object \
--remap-path-prefix=[CWD]=. \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]
[FINISHED] dev [..]",
))
.run();
let bin_path = p.bin("foo");
assert!(bin_path.is_file());
let stdout = run(&bin_path);
assert!(memchr::memmem::find(&stdout, rust_src).is_none());
for line in stdout.split(|c| c == &b'\n') {
let registry = memchr::memmem::find(line, registry_src_bytes).is_none();
let local = memchr::memmem::find(line, pkg_root).is_none();
if registry && local {
continue;
}
#[cfg(target_os = "macos")]
{
// `OSO` symbols can't be trimmed at this moment.
// See <https://github.com/rust-lang/rust/issues/116948#issuecomment-1793617018>
if memchr::memmem::find(line, b" OSO ").is_some() {
continue;
}
// on macOS `SO` symbols are embedded in final binaries and should be trimmed.
// See rust-lang/rust#117652.
if memchr::memmem::find(line, b" SO ").is_some() {
continue;
}
}
#[cfg(target_os = "linux")]
{
// There is a bug in rustc `-Zremap-path-scope`.
// See rust-lang/rust/pull/118518
if memchr::memmem::find(line, b"DW_AT_comp_dir").is_some() {
continue;
}
if memchr::memmem::find(line, b"DW_AT_GNU_dwo_name").is_some() {
continue;
}
}
panic!(
"unexpected untrimmed symbol: {}",
String::from_utf8(line.into()).unwrap()
);
}
}
// TODO: might want to move to test/testsuite/build_script.rs once stabilized.
#[cargo_test(nightly, reason = "-Zremap-path-scope is unstable")]
fn custom_build_env_var_trim_paths() {
let p = project()
.file(
"Cargo.toml",
r#"
[package]
name = "foo"
version = "0.0.1"
"#,
)
.file("src/lib.rs", "")
.file("build.rs", "")
.build();
let test_cases = [
("[]", "none"),
("\"all\"", "all"),
("\"diagnostics\"", "diagnostics"),
("\"macro\"", "macro"),
("\"none\"", "none"),
("\"object\"", "object"),
("false", "none"),
("true", "all"),
(
r#"["diagnostics", "macro", "object"]"#,
"diagnostics,macro,object",
),
];
for (opts, expected) in test_cases {
p.change_file(
"Cargo.toml",
&format!(
r#"
[package]
name = "foo"
version = "0.0.1"
[profile.dev]
trim-paths = {opts}
"#
),
);
p.change_file(
"build.rs",
&format!(
r#"
fn main() {{
assert_eq!(
std::env::var("CARGO_TRIM_PATHS").unwrap().as_str(),
"{expected}",
);
}}
"#
),
);
p.cargo("build -Ztrim-paths")
.masquerade_as_nightly_cargo(&["-Ztrim-paths"])
.run();
}
}
#[cfg(unix)]
#[cargo_test(requires_lldb, nightly, reason = "-Zremap-path-scope is unstable")]
fn lldb_works_after_trimmed() {
use cargo_test_support::compare::match_contains;
let run_lldb = |path| {
std::process::Command::new("lldb")
.args(["-o", "breakpoint set --file src/main.rs --line 4"])
.args(["-o", "run"])
.args(["-o", "continue"])
.args(["-o", "exit"])
.arg("--no-use-colors")
.arg(path)
.output()
.expect("lldb works")
};
let p = project()
.file(
"Cargo.toml",
r#"
[package]
name = "foo"
version = "0.0.1"
[profile.dev]
trim-paths = "object"
"#,
)
.file(
"src/main.rs",
r#"
fn main() {
let msg = "Hello, Ferris!";
println!("{msg}");
}
"#,
)
.build();
p.cargo("build --verbose -Ztrim-paths")
.masquerade_as_nightly_cargo(&["-Ztrim-paths"])
.with_stderr_contains(
"\
[RUNNING] `rustc [..]\
-Zremap-path-scope=object \
--remap-path-prefix=[CWD]=. \
--remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]",
)
.run();
let bin_path = p.bin("foo");
assert!(bin_path.is_file());
let stdout = String::from_utf8(run_lldb(bin_path).stdout).unwrap();
match_contains("[..]stopped[..]", &stdout, None).unwrap();
match_contains("[..]stop reason = breakpoint[..]", &stdout, None).unwrap();
match_contains(
"\
(lldb) continue
Hello, Ferris!",
&stdout,
None,
)
.unwrap();
}