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

Review/feedback #16

Merged
merged 10 commits into from
Mar 22, 2017
Merged

Review/feedback #16

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5681d0b
cargo.toml keywords
colin-kiegel Mar 21, 2017
ed19a66
README.md
colin-kiegel Mar 21, 2017
cc2d7be
documentation tweaks
colin-kiegel Mar 21, 2017
cdf0d1e
error formatting
colin-kiegel Mar 21, 2017
0ee479c
refactor output assertion
colin-kiegel Mar 21, 2017
fcd20f1
refactor output assertion II
colin-kiegel Mar 21, 2017
1f29f4f
allow matching without asserting the exit status
colin-kiegel Mar 21, 2017
f45db85
refactor `assert_cmd!` macro
colin-kiegel Mar 22, 2017
8a01125
expect success by default + cleanup
colin-kiegel Mar 22, 2017
e307b80
some doc changes
colin-kiegel Mar 22, 2017
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
66 changes: 44 additions & 22 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,14 @@ pub struct Assert {
cmd: Vec<String>,
expect_success: bool,
expect_exit_code: Option<i32>,
expect_output: Option<String>,
fuzzy_output: bool,
expect_error_output: Option<String>,
fuzzy_error_output: bool,
expect_stdout: Option<OutputAssertion>,
expect_stderr: Option<OutputAssertion>,
}

#[derive(Debug)]
struct OutputAssertion {
expect: String,
fuzzy: bool,
Copy link
Collaborator

Choose a reason for hiding this comment

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

I like the way you split out this struct, it's very neat.

Seeing how the code below with the matches on fuzziness etc. is pretty much duplicated, I'm wondering if maybe it can become a method on this type, like OutputAssertion::compare_with(String)? (It might also be a good idea to make this struct generic over a trait OutputType , but more on that in a comment below.)

At one point I was thinking about introducing an enum Precision { Exact, Fuzzy } instead of using a bool, but didn't go through with it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I suggest we start a separate discussion about future refactoring, e.g. in the ticket #20 you created, or yet another general architecture discussion ticket?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Hm, I think I'll just open a new PR where I try that design after this one gets merged. Issues that are not about bugs or features but contain a ton of quoted code are kinda hard to keep track of :)

}

impl std::default::Default for Assert {
Expand All @@ -107,10 +111,8 @@ impl std::default::Default for Assert {
.into_iter().map(String::from).collect(),
expect_success: true,
expect_exit_code: None,
expect_output: None,
fuzzy_output: false,
expect_error_output: None,
fuzzy_error_output: false,
expect_stdout: None,
expect_stderr: None,
}
}
}
Expand Down Expand Up @@ -253,8 +255,10 @@ impl Assert {
/// .unwrap();
/// ```
pub fn prints<O: Into<String>>(mut self, output: O) -> Self {
self.expect_output = Some(output.into());
self.fuzzy_output = true;
self.expect_stdout = Some(OutputAssertion {
expect: output.into(),
fuzzy: true,
});
self
}

Expand All @@ -270,8 +274,10 @@ impl Assert {
/// .unwrap();
/// ```
pub fn prints_exactly<O: Into<String>>(mut self, output: O) -> Self {
self.expect_output = Some(output.into());
self.fuzzy_output = false;
self.expect_stdout = Some(OutputAssertion {
expect: output.into(),
fuzzy: false,
});
self
}

Expand All @@ -288,8 +294,10 @@ impl Assert {
/// .unwrap();
/// ```
pub fn prints_error<O: Into<String>>(mut self, output: O) -> Self {
self.expect_error_output = Some(output.into());
self.fuzzy_error_output = true;
self.expect_stderr = Some(OutputAssertion {
expect: output.into(),
fuzzy: true,
});
self
}

Expand All @@ -306,8 +314,10 @@ impl Assert {
/// .unwrap();
/// ```
pub fn prints_error_exactly<O: Into<String>>(mut self, output: O) -> Self {
self.expect_error_output = Some(output.into());
self.fuzzy_error_output = false;
self.expect_stderr = Some(OutputAssertion {
expect: output.into(),
fuzzy: false,
});
self
}

Expand Down Expand Up @@ -348,15 +358,21 @@ impl Assert {
}

let stdout = String::from_utf8_lossy(&output.stdout);
match (self.expect_output, self.fuzzy_output) {
(Some(ref expected_output), true) if !stdout.contains(expected_output) => {
match self.expect_stdout {
Some(OutputAssertion {
expect: ref expected_output,
fuzzy: true,
}) if !stdout.contains(expected_output) => {
bail!(ErrorKind::OutputMismatch(
self.cmd.clone(),
expected_output.clone(),
stdout.into(),
));
},
(Some(ref expected_output), false) => {
Some(OutputAssertion {
expect: ref expected_output,
fuzzy: false,
}) => {
let differences = Changeset::new(expected_output.trim(), stdout.trim(), "\n");
if differences.distance > 0 {
let nice_diff = diff::render(&differences)?;
Expand All @@ -367,15 +383,21 @@ impl Assert {
}

let stderr = String::from_utf8_lossy(&output.stderr);
match (self.expect_error_output, self.fuzzy_error_output) {
(Some(ref expected_output), true) if !stderr.contains(expected_output) => {
match self.expect_stderr {
Some(OutputAssertion {
expect: ref expected_output,
fuzzy: true,
}) if !stderr.contains(expected_output) => {
bail!(ErrorKind::ErrorOutputMismatch(
self.cmd.clone(),
expected_output.clone(),
stderr.into(),
));
},
(Some(ref expected_output), false) => {
Some(OutputAssertion {
expect: ref expected_output,
fuzzy: false,
}) => {
let differences = Changeset::new(expected_output.trim(), stderr.trim(), "\n");
if differences.distance > 0 {
let nice_diff = diff::render(&differences)?;
Expand Down