Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

cargo: prevent dashes in lib.name #12783

Merged
merged 3 commits into from
Mar 16, 2024
Merged

cargo: prevent dashes in lib.name #12783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8bcc0fa
cargo/manifest: remember whether target names were inferred
dvdhrm Oct 13, 2023
8b2cc62
cargo/artifact: prepare compatibility env-vars
dvdhrm Oct 13, 2023
3ca04e2
cargo: prevent dashes in lib.name
dvdhrm Oct 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions src/cargo/core/compiler/artifact.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,39 @@ pub fn get_env(
let path = artifact_path.parent().expect("parent dir for artifacts");
env.insert(var, path.to_owned().into());

let var = format!(
let var_file = format!(
"CARGO_{}_FILE_{}_{}",
artifact_type_upper,
dep_name_upper,
unit_dep.unit.target.name()
);
env.insert(var, artifact_path.to_owned().into());

if unit_dep.unit.target.name() == dep_name.as_str() {
// In older releases, lib-targets defaulted to the name of the package. Newer releases
// use the same name as default, but with dashes replaced. Hence, if the name of the
// target was inferred by Cargo, we also set the env-var with the unconverted name for
// backwards compatibility.
let need_compat = unit_dep.unit.target.is_lib() && unit_dep.unit.target.name_inferred();
if need_compat {
let var_compat = format!(
"CARGO_{}_FILE_{}_{}",
artifact_type_upper,
dep_name_upper,
unit_dep.unit.pkg.name(),
);
if var_compat != var_file {
env.insert(var_compat, artifact_path.to_owned().into());
}
}

env.insert(var_file, artifact_path.to_owned().into());

// If the name of the target matches the name of the dependency, we strip the
// repetition and provide the simpler env-var as well.
// For backwards-compatibility of inferred names, we compare against the name of the
// package as well, since that used to be the default for library targets.
if unit_dep.unit.target.name() == dep_name.as_str()
|| (need_compat && unit_dep.unit.pkg.name() == dep_name.as_str())
{
let var = format!("CARGO_{}_FILE_{}", artifact_type_upper, dep_name_upper,);
env.insert(var, artifact_path.to_owned().into());
}
Expand Down
11 changes: 11 additions & 0 deletions src/cargo/core/manifest.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,8 @@ pub struct Target {
struct TargetInner {
kind: TargetKind,
name: String,
// Whether the name was inferred by Cargo, or explicitly given.
name_inferred: bool,
// Note that `bin_name` is used for the cargo-feature `different_binary_name`
bin_name: Option<String>,
// Note that the `src_path` here is excluded from the `Hash` implementation
Expand Down Expand Up @@ -366,6 +368,7 @@ compact_debug! {
[debug_the_fields(
kind
name
name_inferred
bin_name
src_path
required_features
Expand Down Expand Up @@ -657,6 +660,7 @@ impl Target {
inner: Arc::new(TargetInner {
kind: TargetKind::Bin,
name: String::new(),
name_inferred: false,
bin_name: None,
src_path,
required_features: None,
Expand Down Expand Up @@ -790,6 +794,9 @@ impl Target {
pub fn name(&self) -> &str {
&self.inner.name
}
pub fn name_inferred(&self) -> bool {
self.inner.name_inferred
}
pub fn crate_name(&self) -> String {
self.name().replace("-", "_")
}
Expand Down Expand Up @@ -964,6 +971,10 @@ impl Target {
Arc::make_mut(&mut self.inner).name = name.to_string();
self
}
pub fn set_name_inferred(&mut self, inferred: bool) -> &mut Target {
Arc::make_mut(&mut self.inner).name_inferred = inferred;
self
}
pub fn set_binary_name(&mut self, bin_name: Option<String>) -> &mut Target {
Arc::make_mut(&mut self.inner).bin_name = bin_name;
self
Expand Down
9 changes: 6 additions & 3 deletions src/cargo/util/toml/targets.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,18 +154,20 @@ fn clean_lib(
let lib = match toml_lib {
Some(lib) => {
if let Some(ref name) = lib.name {
// XXX: other code paths dodge this validation
if name.contains('-') {
anyhow::bail!("library target names cannot contain hyphens: {}", name)
}
}
Some(TomlTarget {
name: lib.name.clone().or_else(|| Some(package_name.to_owned())),
name: lib
.name
.clone()
.or_else(|| Some(package_name.replace("-", "_"))),
..lib.clone()
})
}
None => inferred.as_ref().map(|lib| TomlTarget {
name: Some(package_name.to_string()),
name: Some(package_name.replace("-", "_")),
path: Some(PathValue(lib.clone())),
..TomlTarget::new()
}),
Expand Down Expand Up @@ -247,6 +249,7 @@ fn clean_lib(

let mut target = Target::lib_target(&lib.name(), crate_types, path, edition);
configure(lib, &mut target)?;
target.set_name_inferred(toml_lib.map_or(true, |v| v.name.is_none()));
Ok(Some(target))
}

Expand Down
2 changes: 2 additions & 0 deletions tests/testsuite/artifact_dep.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -817,8 +817,10 @@ fn lib_with_selected_dashed_bin_artifact_and_lib_true() {
let _b = include_bytes!(env!("CARGO_BIN_FILE_BAR_BAZ_baz-suffix"));
let _b = include_bytes!(env!("CARGO_STATICLIB_FILE_BAR_BAZ"));
let _b = include_bytes!(env!("CARGO_STATICLIB_FILE_BAR_BAZ_bar-baz"));
let _b = include_bytes!(env!("CARGO_STATICLIB_FILE_BAR_BAZ_bar_baz"));
let _b = include_bytes!(env!("CARGO_CDYLIB_FILE_BAR_BAZ"));
let _b = include_bytes!(env!("CARGO_CDYLIB_FILE_BAR_BAZ_bar-baz"));
let _b = include_bytes!(env!("CARGO_CDYLIB_FILE_BAR_BAZ_bar_baz"));
weihanglo marked this conversation as resolved.
Show resolved Hide resolved
}
"#,
)
Expand Down
2 changes: 1 addition & 1 deletion tests/testsuite/collisions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,7 @@ fn collision_with_root() {
[DOWNLOADING] crates ...
[DOWNLOADED] foo-macro v1.0.0 [..]
warning: output filename collision.
The lib target `foo-macro` in package `foo-macro v1.0.0` has the same output filename as the lib target `foo-macro` in package `foo-macro v1.0.0 [..]`.
The lib target `foo_macro` in package `foo-macro v1.0.0` has the same output filename as the lib target `foo_macro` in package `foo-macro v1.0.0 [..]`.
Colliding filename is: [CWD]/target/doc/foo_macro/index.html
The targets should have unique names.
This is a known bug where multiple crates with the same name use
Expand Down
4 changes: 2 additions & 2 deletions tests/testsuite/doc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2089,7 +2089,7 @@ fn doc_test_in_workspace() {
)
.build();
p.cargo("test --doc -vv")
.with_stderr_contains("[DOCTEST] crate-a")
.with_stderr_contains("[DOCTEST] crate_a")
.with_stdout_contains(
"
running 1 test
Expand All @@ -2098,7 +2098,7 @@ test crate-a/src/lib.rs - (line 1) ... ok
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out[..]
",
)
.with_stderr_contains("[DOCTEST] crate-b")
.with_stderr_contains("[DOCTEST] crate_b")
.with_stdout_contains(
"
running 1 test
Expand Down
10 changes: 5 additions & 5 deletions tests/testsuite/metadata.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1616,7 +1616,7 @@ fn workspace_metadata_with_dependencies_and_resolve() {
"kind": [
"lib"
],
"name": "non-artifact",
"name": "non_artifact",
"src_path": "[..]/foo/non-artifact/src/lib.rs",
"test": true
}
Expand Down Expand Up @@ -3110,7 +3110,7 @@ fn filter_platform() {
"crate_types": [
"lib"
],
"name": "alt-dep",
"name": "alt_dep",
"src_path": "[..]/alt-dep-0.0.1/src/lib.rs",
"edition": "2015",
"test": true,
Expand Down Expand Up @@ -3154,7 +3154,7 @@ fn filter_platform() {
"crate_types": [
"lib"
],
"name": "cfg-dep",
"name": "cfg_dep",
"src_path": "[..]/cfg-dep-0.0.1/src/lib.rs",
"edition": "2015",
"test": true,
Expand Down Expand Up @@ -3198,7 +3198,7 @@ fn filter_platform() {
"crate_types": [
"lib"
],
"name": "host-dep",
"name": "host_dep",
"src_path": "[..]/host-dep-0.0.1/src/lib.rs",
"edition": "2015",
"test": true,
Expand Down Expand Up @@ -3242,7 +3242,7 @@ fn filter_platform() {
"crate_types": [
"lib"
],
"name": "normal-dep",
"name": "normal_dep",
"src_path": "[..]/normal-dep-0.0.1/src/lib.rs",
"edition": "2015",
"test": true,
Expand Down
16 changes: 8 additions & 8 deletions tests/testsuite/test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4671,9 +4671,9 @@ fn test_workspaces_cwd() {
.build();

p.cargo("test --workspace --all")
.with_stderr_contains("[DOCTEST] root-crate")
.with_stderr_contains("[DOCTEST] nested-crate")
.with_stderr_contains("[DOCTEST] deep-crate")
.with_stderr_contains("[DOCTEST] root_crate")
.with_stderr_contains("[DOCTEST] nested_crate")
.with_stderr_contains("[DOCTEST] deep_crate")
.with_stdout_contains("test test_unit_root_cwd ... ok")
.with_stdout_contains("test test_unit_nested_cwd ... ok")
.with_stdout_contains("test test_unit_deep_cwd ... ok")
Expand All @@ -4683,33 +4683,33 @@ fn test_workspaces_cwd() {
.run();

p.cargo("test -p root-crate --all")
.with_stderr_contains("[DOCTEST] root-crate")
.with_stderr_contains("[DOCTEST] root_crate")
.with_stdout_contains("test test_unit_root_cwd ... ok")
.with_stdout_contains("test test_integration_root_cwd ... ok")
.run();

p.cargo("test -p nested-crate --all")
.with_stderr_contains("[DOCTEST] nested-crate")
.with_stderr_contains("[DOCTEST] nested_crate")
.with_stdout_contains("test test_unit_nested_cwd ... ok")
.with_stdout_contains("test test_integration_nested_cwd ... ok")
.run();

p.cargo("test -p deep-crate --all")
.with_stderr_contains("[DOCTEST] deep-crate")
.with_stderr_contains("[DOCTEST] deep_crate")
.with_stdout_contains("test test_unit_deep_cwd ... ok")
.with_stdout_contains("test test_integration_deep_cwd ... ok")
.run();

p.cargo("test --all")
.cwd("nested-crate")
.with_stderr_contains("[DOCTEST] nested-crate")
.with_stderr_contains("[DOCTEST] nested_crate")
.with_stdout_contains("test test_unit_nested_cwd ... ok")
.with_stdout_contains("test test_integration_nested_cwd ... ok")
.run();

p.cargo("test --all")
.cwd("very/deeply/nested/deep-crate")
.with_stderr_contains("[DOCTEST] deep-crate")
.with_stderr_contains("[DOCTEST] deep_crate")
.with_stdout_contains("test test_unit_deep_cwd ... ok")
.with_stdout_contains("test test_integration_deep_cwd ... ok")
.run();
Expand Down