Skip to content
This repository has been archived by the owner on Dec 29, 2021. It is now read-only.

WIP: Make cargo bin helpers work with empty env #54

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
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
3 changes: 3 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ categories = ["development-tools::testing"]
keywords = ["cli", "testing", "assert"]
build = "build.rs"

[[bin]]
name = "assert_fixture"

[dependencies]
colored = "1.5"
difference = "1.0"
Expand Down
41 changes: 31 additions & 10 deletions src/assert.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
use environment::Environment;
use error_chain::ChainedError;
use errors::*;
use output::{OutputAssertion, OutputKind};
use std::default;
Expand All @@ -7,6 +8,20 @@ use std::path::PathBuf;
use std::process::{Command, Stdio};
use std::vec::Vec;

fn find_cargo() -> String {
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We should should need to panic in this fn at all

let which_cargo = Command::new("which").arg("cargo")
Copy link
Collaborator

Choose a reason for hiding this comment

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

At this point, we should probably add a Windows CI

.output().expect("Cannot exectute `which` to find `cargo`.");

if !which_cargo.status.success() {
panic!("Could not find `cargo` command");
}

String::from_utf8(which_cargo.stdout)
.expect("Path to `cargo` is not UTF-8. This is currently unsupported by assert_cli.")
.trim()
.to_string()
}

/// Assertions for a specific command.
#[derive(Debug)]
pub struct Assert {
Expand All @@ -24,11 +39,13 @@ impl default::Default for Assert {
///
/// Defaults to asserting _successful_ execution.
fn default() -> Self {
let cargo_path = find_cargo();
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This fn can currently panic. We should deal with the result instead and maybe cache the error in the Assert struct so we can return it only when running execute or unwrap

Copy link
Collaborator

Choose a reason for hiding this comment

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

The main value of caching the result would be for when calling .execute() rather than .unwrap(), right?

Also, should the result of find_cargo be shoved off into a lazy_static!?

let args = vec!["run", "--quiet", "--"]
.into_iter()
.map(String::from);

Assert {
cmd: vec!["cargo", "run", "--"]
.into_iter()
.map(String::from)
.collect(),
cmd: vec![cargo_path].into_iter().chain(args).collect(),
env: Environment::inherit(),
current_dir: None,
expect_success: Some(true),
Expand All @@ -51,11 +68,13 @@ impl Assert {
///
/// Defaults to asserting _successful_ execution.
pub fn cargo_binary(name: &str) -> Self {
let cargo_path = find_cargo();
let args = vec!["run", "--quiet", "--bin", name, "--"]
.into_iter()
.map(String::from);

Assert {
cmd: vec!["cargo", "run", "--bin", name, "--"]
.into_iter()
.map(String::from)
.collect(),
cmd: vec![cargo_path].into_iter().chain(args).collect(),
..Self::default()
}
}
Expand Down Expand Up @@ -308,7 +327,9 @@ impl Assert {
None => command,
};

let mut spawned = command.spawn()?;
let mut spawned = command
.spawn()
.chain_err(|| ErrorKind::SpawnFailed(self.cmd.clone()))?;

if let Some(ref contents) = self.stdin_contents {
spawned
Expand Down Expand Up @@ -365,7 +386,7 @@ impl Assert {
/// ```
pub fn unwrap(self) {
if let Err(err) = self.execute() {
panic!("{}", err);
panic!("{}", err.display_chain());
}
}
}
Expand Down
31 changes: 31 additions & 0 deletions src/bin/assert_fixture.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#[macro_use]
extern crate error_chain;

use std::env;
use std::process;

error_chain! {
foreign_links {
Env(env::VarError);
ParseInt(std::num::ParseIntError);
}
}

fn run() -> Result<()> {
if let Ok(text) = env::var("stdout") {
println!("{}", text);
}
if let Ok(text) = env::var("stderr") {
eprintln!("{}", text);
}

let code = env::var("exit")
.ok()
.map(|v| v.parse::<i32>())
.map_or(Ok(None), |r| r.map(Some))
.chain_err(|| "Invalid exit code")?
.unwrap_or(0);
process::exit(code);
}

quick_main!(run);
8 changes: 8 additions & 0 deletions src/errors.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ error_chain! {
Fmt(::std::fmt::Error);
}
errors {
SpawnFailed(cmd: Vec<String>) {
description("Spawn failed")
display(
"{}: (command `{}` failed to run)",
ERROR_PREFIX,
cmd.join(" "),
)
}
StatusMismatch(cmd: Vec<String>, expected: bool, out: String, err: String) {
description("Wrong status")
display(
Expand Down
35 changes: 35 additions & 0 deletions tests/cargo.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
extern crate assert_cli;

#[test]
fn main_binary() {
assert_cli::Assert::main_binary()
.with_env(assert_cli::Environment::inherit().insert("stdout", "42"))
.stdout()
.is("42")
.stderr()
.is("")
.unwrap();
}

#[test]
fn cargo_binary() {
assert_cli::Assert::cargo_binary("assert_fixture")
.with_env(assert_cli::Environment::inherit().insert("stdout", "42"))
.stdout()
.is("42")
.stderr()
.is("")
.unwrap();
}


#[test]
fn works_with_empty_env() {
assert_cli::Assert::main_binary()
.with_env(assert_cli::Environment::empty())
.unwrap();

assert_cli::Assert::cargo_binary("assert_fixture")
.with_env(assert_cli::Environment::empty())
.unwrap();
}