Error: src/examples/README.md/Cargo.toml: Not a directory

[parasyte]

When parsing workspace.members, the result of glob matching doesn't filter directories. It will gladly append Cargo.toml to file paths like README.md:

cargo-subcommand/src/manifest.rs

Lines 38 to 42 in de0458c

	for member in &workspace.members {
	for manifest_dir in glob::glob(workspace_root.join(member).to_str().unwrap())? {
	let manifest_dir = manifest_dir?;
	let manifest_path = manifest_dir.join("Cargo.toml");
	let manifest = Manifest::parse_from_toml(&manifest_path)?;

Assumes a manifest being parsed contains:

[workspace]
members = [
    "examples/*",
    "tests/*",
]

... and these directories contain a README.md or other files as direct children. An example repo in the wild where this is done:

• egui:
  • https://github.com/emilk/egui/blob/4e101d25cde5a396804ece4a916970e2390fb434/Cargo.toml#L17-L18
  • https://github.com/emilk/egui/blob/4e101d25cde5a396804ece4a916970e2390fb434/examples/README.md
  • https://github.com/emilk/egui/blob/4e101d25cde5a396804ece4a916970e2390fb434/tests/README.md

This kind of setup causes Subcommand::new() to return an error here:

cargo-subcommand/src/subcommand.rs

Lines 67 to 71 in de0458c

	utils::find_package_manifest_in_workspace(
	workspace_manifest,
	potential_manifest,
	package,
	)?

The glob result needs to be filtered to match directories. Checking manifest_dir.is_dir() is a good start, but symlinks also need to be followed.

[MarijnS95]

Looks like xbuild suffers the same issue too: rust-mobile/xbuild#183 / rust-mobile/xbuild#184

[MarijnS95]

A few weird observations:

• Cargo allows non-directories, i.e. a README.md, to be an explicit part of the members een if it is not part of a glob match);
• Cargo only errors out if the members (be it with or without globs) results in zero matches. Even if the only match is a file, it succeeds.
  For example, if your tests/* directory only contains a README.md but no crates, it's still okay with that...

but symlinks also need to be followed.

Sounds like we should canonicalize for this, unfortunately.

[parasyte]

FYI, I did the quick and dirty is_dir() hack in a private branch to unblock my work on Android builds in egui.

[MarijnS95]

@parasyte thanks, but notice that a PR has already been opened and linked above. Would you mind testing it out instead?

[parasyte]

I saw, and it looks good. I will test it when I get around to Android stuff again. Thanks!