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

Add support for Cargo workspace dependencies inheritance #1123

Merged
merged 2 commits into from
Sep 25, 2022
Merged

Add support for Cargo workspace dependencies inheritance #1123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
915baa2
Add support for Cargo workspace dependencies inheritance
messense Sep 23, 2022
3b64452
Resolve crates.io workspace dependencies
messense Sep 24, 2022
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
7 changes: 7 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ native-tls-crate = { package = "native-tls", version = "0.2.8", optional = true
[dev-dependencies]
indoc = "1.0.3"
pretty_assertions = "1.3.0"
rustversion = "1.0.9"

[features]
default = ["log", "upload", "rustls", "human-panic"]
Expand Down
1 change: 1 addition & 0 deletions Changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
* Fix `Cargo.toml` in new project template in [#1109](https://github.com/PyO3/maturin/pull/1109)
* Fix `maturin develop` on Windows when using Python installed from msys2 in [#1112](https://github.com/PyO3/maturin/pull/1112)
* Fix duplicated `Cargo.toml` of local dependencies in sdist in [#1114](https://github.com/PyO3/maturin/pull/1114)
* Add support for Cargo workspace dependencies inheritance in [#1123](https://github.com/PyO3/maturin/pull/1123)

## [0.13.3] - 2022-09-15

Expand Down
119 changes: 97 additions & 22 deletions src/source_distribution.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,19 @@ const LOCAL_DEPENDENCIES_FOLDER: &str = "local_dependencies";
/// This method is rather frail, but unfortunately I don't know a better solution.
fn rewrite_cargo_toml(
manifest_path: impl AsRef<Path>,
workspace_manifest: &toml_edit::Document,
known_path_deps: &HashMap<String, PathBuf>,
local_deps_folder: String,
root_crate: bool,
) -> Result<String> {
let manifest_path = manifest_path.as_ref();
let text = fs::read_to_string(&manifest_path).context(format!(
"Can't read Cargo.toml at {}",
manifest_path.as_ref().display(),
manifest_path.display(),
))?;
let mut data = text.parse::<toml_edit::Document>().context(format!(
"Failed to parse Cargo.toml at {}",
manifest_path.as_ref().display()
manifest_path.display()
))?;
let mut rewritten = false;
// ˇˇˇˇˇˇˇˇˇˇˇˇ dep_category
Expand All @@ -39,28 +41,84 @@ fn rewrite_cargo_toml(
// ^^^^^^^^^^^^^ dep_name
for dep_category in &["dependencies", "dev-dependencies", "build-dependencies"] {
if let Some(table) = data.get_mut(*dep_category).and_then(|x| x.as_table_mut()) {
let workspace_deps = workspace_manifest
.get("workspace")
.and_then(|x| x.get(dep_category))
.and_then(|x| x.as_table());
let dep_names: Vec<_> = table.iter().map(|(key, _)| key.to_string()).collect();
for dep_name in dep_names {
// There should either be no value for path, or it should be a string
if table.get(&dep_name).and_then(|x| x.get("path")).is_none() {
continue;
}
if !table[&dep_name]["path"].is_str() {
bail!(
"In {}, {} {} has a path value that is not a string",
manifest_path.as_ref().display(),
dep_category,
dep_name
)
}
if !known_path_deps.contains_key(&dep_name) {
bail!(
"cargo metadata does not know about the path for {}.{} present in {}, \
which should never happen ಠ_ಠ",
dep_category,
dep_name,
manifest_path.as_ref().display()
);
let workspace_inherit = table
.get(&dep_name)
.and_then(|x| x.get("workspace"))
.and_then(|x| x.as_bool())
.unwrap_or_default();

if !workspace_inherit {
// There should either be no value for path, or it should be a string
if table.get(&dep_name).and_then(|x| x.get("path")).is_none() {
continue;
}
if !table[&dep_name]["path"].is_str() {
bail!(
"In {}, {} {} has a path value that is not a string",
manifest_path.display(),
dep_category,
dep_name
)
}
if !known_path_deps.contains_key(&dep_name) {
bail!(
"cargo metadata does not know about the path for {}.{} present in {}, \
which should never happen ಠ_ಠ",
dep_category,
dep_name,
manifest_path.display()
);
}
} else {
// If a workspace inherited dependency isn't a path dep,
// we need to replace `workspace = true` with its full requirement spec.
if !known_path_deps.contains_key(&dep_name) {
if let Some(workspace_dep) = workspace_deps.and_then(|x| x.get(&dep_name)) {
let mut workspace_dep = workspace_dep.clone();
// Merge optional and features from the current Cargo.toml
if table[&dep_name].get("optional").is_some() {
workspace_dep["optional"] = table[&dep_name]["optional"].clone();
}
if let Some(features) =
table[&dep_name].get("features").and_then(|x| x.as_array())
{
let existing_features = workspace_dep
.as_table_like_mut()
.unwrap()
.entry("features")
.or_insert_with(|| {
toml_edit::Item::Value(toml_edit::Array::new().into())
})
.as_array_mut()
.with_context(|| {
format!(
"In {}, {} {} has a features value that is not an array",
manifest_path.display(),
dep_category,
dep_name
)
})?;
existing_features.extend(features);
}
table[&dep_name] = workspace_dep;
rewritten = true;
} else {
bail!(
"In {}, {} {} is marked as `workspace = true`, but it is found neither in \
the workspace manifest nor in the known path dependencies",
manifest_path.display(),
dep_category,
dep_name
)
}
continue;
}
}
// This is the location of the targeted crate in the source distribution
table[&dep_name]["path"] = if root_crate {
Expand All @@ -69,6 +127,13 @@ fn rewrite_cargo_toml(
// Cargo.toml contains relative paths, and we're already in LOCAL_DEPENDENCIES_FOLDER
toml_edit::value(format!("../{}", dep_name))
};
if workspace_inherit {
// Remove workspace inheritance now that we converted it into a path dependency
table[&dep_name]
.as_table_like_mut()
.unwrap()
.remove("workspace");
}
rewritten = true;
}
}
Expand Down Expand Up @@ -124,6 +189,7 @@ fn add_crate_to_source_distribution(
writer: &mut SDistWriter,
pyproject_toml_path: impl AsRef<Path>,
manifest_path: impl AsRef<Path>,
workspace_manifest: &toml_edit::Document,
prefix: impl AsRef<Path>,
known_path_deps: &HashMap<String, PathBuf>,
root_crate: bool,
Expand Down Expand Up @@ -218,6 +284,7 @@ fn add_crate_to_source_distribution(
};
let rewritten_cargo_toml = rewrite_cargo_toml(
&manifest_path,
workspace_manifest,
known_path_deps,
local_deps_folder,
root_crate,
Expand Down Expand Up @@ -284,6 +351,12 @@ pub fn source_distribution(
let metadata21 = &build_context.metadata21;
let manifest_path = &build_context.manifest_path;
let pyproject_toml_path = fs::canonicalize(&build_context.pyproject_toml_path)?;
let workspace_manifest_path = build_context
.cargo_metadata
.workspace_root
.join("Cargo.toml");
let workspace_manifest: toml_edit::Document =
fs::read_to_string(&workspace_manifest_path)?.parse()?;

let known_path_deps = find_path_deps(&build_context.cargo_metadata)?;

Expand All @@ -300,6 +373,7 @@ pub fn source_distribution(
&mut writer,
&pyproject_toml_path,
&path_dep,
&workspace_manifest,
&root_dir.join(LOCAL_DEPENDENCIES_FOLDER).join(name),
&known_path_deps,
false,
Expand All @@ -316,6 +390,7 @@ pub fn source_distribution(
&mut writer,
&pyproject_toml_path,
&manifest_path,
&workspace_manifest,
&root_dir,
&known_path_deps,
true,
Expand Down
Loading