Merge pull request #13 from killercup/refactor/everything

Assert CLI using a builder instead of complex macro

Author: killercup

.travis.yml

@@ -1,12 +1,17 @@
 sudo: false
 language: rust
+cache: cargo
 rust:
-- nightly
 - beta
 - stable
+- nightly
 matrix:
-  allow_failures:
-  - rust: nightly
+  include:
+  - rust: nightly-2017-03-15
+    env: CLIPPY=YESPLEASE
+    script: |
+        cargo install clippy --vers "0.0.120"
+        cargo clippy
 before_script:
 - |
   pip install 'travis-cargo<0.2' --user &&
@@ -15,22 +20,14 @@ script:
 - |
   travis-cargo build &&
   travis-cargo test &&
-  travis-cargo bench &&
-  travis-cargo --only stable doc
-addons:
-  apt:
-    packages:
-    - libcurl4-openssl-dev
-    - libelf-dev
-    - libdw-dev
-after_success:
-- travis-cargo --only stable doc-upload
-- rm tests/skeptic.rs # "skip" skeptic doctests for coverage
-- travis-cargo coveralls --no-sudo
+  travis-cargo bench
 notifications:
   email:
     on_success: never
+branches:
+  only:
+    - master
 env:
   global:
-  - TRAVIS_CARGO_NIGHTLY_FEATURE=dev
+  - TRAVIS_CARGO_NIGHTLY_FEATURE=""
   - secure: OUHDuY7h82pYkis1oJW/dO029Rp/HLGT7od5VQJ1eki0M+Oawj7L0tjQPGLKLjj6hA1Sh8XeeelQgrlwVQfkrvwgYLRfmEdbP8z2PclmbxvXmRFysM5R9dN15HYx9AlUsDiHF9otmkNzJPBghlLvvKbzjp7Mlr5cdBaFZ9psafJLOgIWTIpiuHvYhmKhaXG6bIpLw6pi9NWdUYcd5s/gy1n1v5a4oPH/JB9V3Zc8+tv/EPvRynzSRK1jghD7KtppQoRRt92OCQGZ2BYLoTVpkt/bPS50D558xbVoDPyNNgcPM86eSSNbgp8llASJMFVNWWBZYLmbQ5x/219G907YbKWDLbcwMJL0H/JFbtErLarDU5XiEFBELs0Zx2t0S96xOM+ZWxZvWBk3UuKTBaXIKc921JEU+uHHUsPp3zasiMZWN3Rv2ia68HZGvYtwAPG5PWJTeh7BAo6dLGNDISVE/uHhf64E+ZvH3ToEmadx/yimedE7IOBh7kvPTnr1X5RFWNEJYOVSWJ531LoE3WHO9/UKPRLx01fGHzJKXMyWcp2fQjwCsu9zwThk3N4kYQJfi5YNmJw1EiOERiQ0nRckaUC5sA5KE+ZJmEa4ztfe7RMTVceCNagVdsqH8IHWgM+ROKNNKYDjqKbGSiE0RVwUdITUFLeQDWzQYfzsWRQpFV0=

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "assert_cli"
-version = "0.3.0"
+version = "0.4.0"
 authors = ["Pascal Hertleif <killercup@gmail.com>"]
 repository = "https://github.com/killercup/assert_cli.git"
 homepage = "https://github.com/killercup/assert_cli"
@@ -10,14 +10,10 @@ documentation = "http://killercup.github.io/assert_cli/"
 description = "Test CLI Applications."
 build = "build.rs"
 
-[features]
-default = []
-dev = ["clippy"]
-
 [dependencies]
-ansi_term = "0.6.3"
-difference = "0.4.0"
-clippy = {version = "0.0.23", optional = true}
+colored = "1.4"
+difference = "1.0"
+error-chain = "0.10.0"
 
 [build-dependencies]
 skeptic = "0.5"

README.md

@@ -15,7 +15,7 @@ Just add it to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-assert_cli = "0.3"
+assert_cli = "0.4"
 ```
 
 ## Example
@@ -24,59 +24,56 @@ Here's a trivial example:
 
 ```rust
 extern crate assert_cli;
+
 fn main() {
-  assert_cli::assert_cli_output("echo", &["42"], "42").unwrap();
+    assert_cli::Assert::command(&["echo", "42"]).prints("42").unwrap();
 }
 ```
 
 Or if you'd rather use the macro:
 
-```rust,ignore
+```rust
 #[macro_use] extern crate assert_cli;
-fn main() {
-  assert_cli!("echo", &["42"] => Success, "42").unwrap();
-  assert_cli!("black-box", &["--special"] => Error 42, "error no 42\n").unwrap()
-}
-```
-
-And here is one that will fail:
 
-```rust,should_panic
-extern crate assert_cli;
 fn main() {
-  assert_cli::assert_cli_output("echo", &["42"], "1337").unwrap();
+    assert_cmd!(echo 42).succeeds().and().prints("42").unwrap();
 }
 ```
 
-this will show a nice, colorful diff in your terminal, like this:
-
-```diff
--1337
-+42
-```
-
-If you'd prefer to not check the output:
+And here is one that will fail (which also shows `execute` which returns a
+`Result` and can be used instead of `unwrap`):
 
 ```rust
 #[macro_use] extern crate assert_cli;
+
 fn main() {
-  assert_cli::assert_cli("echo", &["42"]).unwrap();
-  assert_cli!("echo", &["42"] => Success).unwrap();
+    let test = assert_cmd!(grep amet Cargo.toml)
+        .fails_with(1)
+        .execute();
+    assert!(test.is_err());
 }
 ```
 
-All exported functions and the macro return a `Result` containing the
-`Output` of the process, allowing you to do further custom assertions:
+If you want to check for the program's output, you can use `print` or
+`print_exactly`:
 
-```rust
+```rust,should_panic="Assert CLI failure"
 #[macro_use] extern crate assert_cli;
+
 fn main() {
-  let output = assert_cli!("echo", &["Number 42"] => Success).unwrap();
-  let stdout = std::str::from_utf8(&output.stdout).unwrap();
-  assert!(stdout.contains("42"));
+    assert_cmd!("wc" "README.md")
+        .prints_exactly("1337 README.md")
+        .unwrap();
 }
 ```
 
+this will show a nice, colorful diff in your terminal, like this:
+
+```diff
+-1337
++92
+```
+
 ## License
 
 Licensed under either of

src/cli_error.rs

@@ -1,27 +1,46 @@
-use std::fmt;
+extern crate colored;
+use self::colored::Colorize;
 
-use difference::Difference;
-use ansi_term::Colour::{Green, Red};
+use difference::{Difference, Changeset};
+use std::fmt::Write;
 
-pub fn render(changeset: &[Difference]) -> Result<String, fmt::Error> {
-    use std::fmt::Write;
+use errors::*;
 
+pub fn render(&Changeset { ref diffs, .. }: &Changeset) -> Result<String> {
     let mut t = String::new();
 
-    for change in changeset {
-        match *change {
+    for (i, diff) in diffs.iter().enumerate() {
+        match *diff {
             Difference::Same(ref x) => {
-                for line in x.lines() {
-                    try!(writeln!(t, " {}", line));
-                }
-            }
-            Difference::Add(ref x) => {
-                try!(write!(t, "{}", Green.paint("+")));
-                try!(writeln!(t, "{}", Green.paint(x)));
+                writeln!(t, " {}", x)?;
             }
             Difference::Rem(ref x) => {
-                try!(write!(t, "{}", Red.paint("-")));
-                try!(writeln!(t, "{}", Red.paint(x)));
+                writeln!(t, "{}", format!("-{}", x).red())?;
+            }
+            Difference::Add(ref x) => {
+                match diffs[i - 1] {
+                    Difference::Rem(ref y) => {
+                        write!(t, "{}", "+".green())?;
+                        let Changeset { diffs, .. } = Changeset::new(y, x, " ");
+                        for c in diffs {
+                            match c {
+                                Difference::Same(ref z) if !z.is_empty() => {
+                                    write!(t, "{}", z.green())?;
+                                    write!(t, " ")?;
+                                }
+                                Difference::Add(ref z) if !z.is_empty() => {
+                                    write!(t, "{}", z.green().reverse())?;
+                                    write!(t, " ")?;
+                                }
+                                _ => (),
+                            }
+                        }
+                        writeln!(t, "")?;
+                    }
+                    _ => {
+                        writeln!(t, "{}", format!("+{}", x).green().dimmed())?;
+                    }
+                };
             }
         }
     }
@@ -31,20 +50,19 @@ pub fn render(changeset: &[Difference]) -> Result<String, fmt::Error> {
 
 #[cfg(test)]
 mod tests {
-    use difference::diff;
     use super::*;
 
     #[test]
     fn basic_diff() {
-        let (_, diff) = diff("lol", "yay", "\n");
+        let diff = Changeset::new("lol", "yay", "\n");
+        println!("{}", render(&diff).unwrap());
         assert_eq!(render(&diff).unwrap(),
-                   "\u{1b}[31m-\u{1b}[0m\u{1b}[31mlol\u{1b}[0m\n\u{1b}[32m+\u{1b}[0m\u{1b}[32myay\
-                    \u{1b}[0m\n")
+                   " \n\u{1b}[31m-lol\u{1b}[0m\n\u{1b}[32m+\u{1b}[0m\u{1b}[7;32myay\u{1b}[0m \n")
     }
 
     #[test]
     fn multiline_diff() {
-        let (_, diff) = diff("Lorem ipsum dolor sit amet, consectetur adipisicing elit,
+        let diff = Changeset::new("Lorem ipsum dolor sit amet, consectetur adipisicing elit,
 sed do eiusmod tempor incididunt ut labore et dolore magna
 aliqua. Ut enim ad minim veniam, quis nostrud exercitation
 ullamco laboris nisi ut aliquip ex ea commodo consequat.",
@@ -53,6 +71,7 @@ sed do eiusmod tempor **incididunt** ut labore et dolore magna
 aliqua. Ut enim ad minim veniam, quis nostrud exercitation
 ullamco laboris nisi ut aliquip ex ea commodo consequat.",
                              "\n");
-        assert_eq!(render(&diff).unwrap(), " Lorem ipsum dolor sit amet, consectetur adipisicing elit,\n\u{1b}[31m-\u{1b}[0m\u{1b}[31msed do eiusmod tempor incididunt ut labore et dolore magna\u{1b}[0m\n\u{1b}[32m+\u{1b}[0m\u{1b}[32msed do eiusmod tempor **incididunt** ut labore et dolore magna\u{1b}[0m\n aliqua. Ut enim ad minim veniam, quis nostrud exercitation\n ullamco laboris nisi ut aliquip ex ea commodo consequat.\n");
+        println!("{}", render(&diff).unwrap());
+        assert_eq!(render(&diff).unwrap(), " Lorem ipsum dolor sit amet, consectetur adipisicing elit,\n\u{1b}[31m-sed do eiusmod tempor incididunt ut labore et dolore magna\u{1b}[0m\n\u{1b}[32m+\u{1b}[0m\u{1b}[32msed do eiusmod tempor\u{1b}[0m \u{1b}[7;32m**incididunt**\u{1b}[0m \u{1b}[32mut labore et dolore magna\u{1b}[0m \n aliqua. Ut enim ad minim veniam, quis nostrud exercitation\nullamco laboris nisi ut aliquip ex ea commodo consequat.\n");
     }
 }

src/diff.rs

@@ -0,0 +1,48 @@
+error_chain! {
+    foreign_links {
+        Io(::std::io::Error);
+        Fmt(::std::fmt::Error);
+    }
+    errors {
+        StatusMismatch(cmd: Vec<String>, expected: bool) {
+            description("Wrong status")
+            display(
+                "Command {:?} {got} but expected it to {expected}",
+                cmd.join(" "),
+                got = if *expected { "failed" } else { "succeed" },
+                expected = if *expected { "succeed" } else { "failed" },
+            )
+        }
+        ExitCodeMismatch(cmd: Vec<String>, expected: Option<i32>, got: Option<i32>) {
+            description("Wrong exit code")
+            display(
+                "Command {:?} exited with code {:?} but expected it to be {:?}",
+                cmd.join(" "), got, expected,
+            )
+        }
+        OutputMismatch(expected: String, got: String) {
+            description("Output was not as expected")
+            display(
+                "Expected output to contain\n{}\nbut could not find it in\n{}",
+                expected,
+                got,
+            )
+        }
+        ExactOutputMismatch(diff: String) {
+            description("Output was not as expected")
+            display("{}", diff)
+        }
+        ErrorOutputMismatch(expected: String, got: String) {
+            description("Stderr output was not as expected")
+            display(
+                "Expected stderr output to contain\n{}\nbut could not find it in\n{}",
+                expected,
+                got,
+            )
+        }
+        ExactErrorOutputMismatch(diff: String) {
+            description("Stderr output was not as expected")
+            display("{}", diff)
+        }
+    }
+}