Feature proposal: Run examples as top level concept, with compilation profile

[azriel91]

Hiya, I really like assert_cli, thanks for making such a useful crate!

Since I'm a fan of "automatically test everything, so I know when I break things", I have automated tests for my examples, and control them through arguments or stdin. For example:

extern crate assert_cli;

#[test]
fn example_01_menu() {
    assert_cli::Assert::command(&["cargo", "run", "--example", "01_menu", "--"])
        .with_args(&["--timeout", "0"])
        .unwrap();
}

Now, because cargo run --example example_name always runs the example in the debug profile, to make sure I don't double compile when I'm testing my release profile build, I can do something like this:

extern crate assert_cli;

#[test]
fn example_01_menu() {
    assert_cli::Assert::command(&(example_command("01_menu")))
        .with_args(&["--timeout", "0"])
        .unwrap();
}

fn example_command(example_name: &'static str) -> Vec<&str> {
    let mut command = vec!["cargo", "run"];
    if !cfg!(debug_assertions) {
        command.push("--release");
    }
    command.extend(&["--example", example_name, "--"]);
    command
}

Since I would be replicating this functionality across a number of crates, I was wondering whether you'd like this to go in assert_cli (is it in line with what this crate is intended to cover), otherwise I can make an intermediate crate.

---

Edit: just noticed the conditional compilation for the profile is also mentioned in #86.

[epage]

In light of #86, do you see value in keeping this issue open?

[azriel91]

Yeap -- even after implementing #86, there's no quick way to run an example and insert the compilation profile. Assert::cargo_binary lets you pick another binary, but not an example.

[epage]

Oh, I missed the part about running examples.

[volks73]

I, too, would like to be able to quickly use an example for a command to test. I would like to suggest an Assert::example_binary constructor/method similar to Assert::cargo_binary, but accepts a name of an example defined in the Cargo.toml of the project.

[epage]

Fixed by #108

[epage]

I'm publishing 0.6.1 right now.