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.

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

Infer multi-file binaries like src/bin/server/main.rs by convention #4214

Merged
merged 5 commits into from
Jun 30, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
39 changes: 38 additions & 1 deletion src/cargo/util/toml.rs
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ impl Layout {

try_add_file(&mut bins, root_path.join("src").join("main.rs"));
try_add_files(&mut bins, root_path.join("src").join("bin"));
try_add_mains_from_dirs(&mut bins, root_path.join("src").join("bin"));

try_add_files(&mut examples, root_path.join("examples"));

Expand All @@ -74,6 +75,26 @@ fn try_add_file(files: &mut Vec<PathBuf>, file: PathBuf) {
files.push(file);
}
}

// Add directories form src/bin which contain main.rs file
fn try_add_mains_from_dirs(files: &mut Vec<PathBuf>, root: PathBuf) {
if let Ok(new) = fs::read_dir(&root) {
let new: Vec<PathBuf> = new.filter_map(|i| i.ok())
// Filter only directories
.filter(|i| {
i.file_type().map(|f| f.is_dir()).unwrap_or(false)
// Convert DirEntry into PathBuf and append "main.rs"
}).map(|i| {
i.path().join("main.rs")
// Filter only directories where main.rs is present
}).filter(|f| {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like indentation is off here. I would format this as

    fn try_add_mains_from_dirs(files: &mut Vec<PathBuf>, root: PathBuf) {
        if let Ok(new) = fs::read_dir(&root) {
            let new: Vec<PathBuf> = new.filter_map(|i| i.ok())
                // Filter only directories
                .filter(|i| {
                    i.file_type().map(|f| f.is_dir()).unwrap_or(false)
                    // Convert DirEntry into PathBuf and append "main.rs"
                })
                .map(|i| {
                    i.path().join("main.rs")
                    // Filter only directories where main.rs is present
                })
                .filter(|f| {
                    f.as_path()
                        .exists()
                }).collect();
            files.extend(new);
        }
    }

f.as_path()
.exists()
}).collect();
files.extend(new);
}
}

fn try_add_files(files: &mut Vec<PathBuf>, root: PathBuf) {
if let Ok(new) = fs::read_dir(&root) {
files.extend(new.filter_map(|dir| {
Expand Down Expand Up @@ -505,7 +526,23 @@ fn inferred_bin_targets(name: &str, layout: &Layout) -> Vec<TomlTarget> {
*bin == layout.root.join("src").join("main.rs") {
Some(name.to_string())
} else {
bin.file_stem().and_then(|s| s.to_str()).map(|f| f.to_string())
// bin is either a source file or a directory with main.rs inside.
if bin.ends_with("main.rs") {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's change this to bin.ends_with("main.rs") && !bin.ends_with("src/bin/main.rs") so that we one if inside.

if let Some(parent) = bin.parent() {
// if the path ends with main.rs it is probably a directory, but it can also be
// a file directly inside src/bin
if parent.ends_with("src/bin") {
bin.file_stem().and_then(|s| s.to_str()).map(|f| f.to_string())
} else {
parent.file_stem().and_then(|s| s.to_str()).map(|f| f.to_string())
}
} else {
None
}
} else {
// regular case, just a file in the bin directory
bin.file_stem().and_then(|s| s.to_str()).map(|f| f.to_string())
}
};

name.map(|name| {
Expand Down
26 changes: 26 additions & 0 deletions tests/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3271,3 +3271,29 @@ fn no_bin_in_src_with_lib() {
execs().with_status(101)
.with_stderr_contains(r#"[ERROR] couldn't read "[..]main.rs"[..]"#));
}


#[test]
fn dirs_in_bin_dir_with_main_rs() {
let p = project("foo")
.file("Cargo.toml", r#"
[package]
name = "foo"
version = "0.1.0"
authors = []
"#)
.file("src/main.rs", "fn main() {}")
.file("src/bin/bar.rs", "fn main() {}")
.file("src/bin/bar2.rs", "fn main() {}")
.file("src/bin/main.rs", "fn main() {}")
.file("src/bin/bar3/main.rs", "fn main() {}")
.file("src/bin/bar4/main.rs", "fn main() {}");

assert_that(p.cargo_process("build"), execs().with_status(0));
assert_that(&p.bin("foo"), existing_file());
assert_that(&p.bin("bar"), existing_file());
assert_that(&p.bin("bar2"), existing_file());
assert_that(&p.bin("bar3"), existing_file());
assert_that(&p.bin("bar4"), existing_file());
assert_that(&p.bin("main"), existing_file());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, I don't think we should implicitly name binary main... Does it happen with stable Cargo as well? Looks like a bug to me!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm using stable cargo and it creates a binary called "main" when there is src/bin/main.rs

}