improve doc + test

Signed-off-by: Freyskeyd <[email protected]>

Author: Freyskeyd

README.md

@@ -76,6 +76,8 @@ like this:
          if there are special characters, which the macro doesn't accept, e.g.
          `assert_cmd!(cat "foo.txt")`.
 
+Assert Cli use [Environment][Environment] underneath to deal with environment variables.
+
 More detailed information is available in the [documentation]. :-)
 
 ## License
@@ -95,3 +97,4 @@ license, shall be dual licensed as above, without any additional terms or
 conditions.
 
 [Documentation]: https://docs.rs/assert_cli
+[Environment]: https://github.com/Freyskeyd/environment

src/assert.rs

@@ -153,6 +153,13 @@ impl Assert {
     ///     .stdout().is("FOO=BAR")
     ///     .execute()
     ///     .unwrap();
+    ///
+    /// ::std::env::set_var("BAZ", "BAR");
+    ///
+    /// assert_cli::Assert::command(&["printenv"])
+    ///     .stdout().contains("BAZ=BAR")
+    ///     .execute()
+    ///     .unwrap();
     /// ```
     pub fn with_env<E: Into<Environment>>(mut self, env: E) -> Self {
         self.env = env.into();
@@ -495,14 +502,12 @@ mod test {
     fn in_place_mod2() {
         let x = Environment::inherit();
 
-        assert!(
-            command()
-                .with_env(&x.insert("key", "value").insert("key", "vv"))
-                .stdout()
-                .contains("key=vv")
-                .execute()
-                .is_ok()
-        );
+        command()
+            .with_env(&x.insert("key", "value").insert("key", "vv"))
+            .stdout()
+            .contains("key=vv")
+            .execute()
+            .unwrap();
         // Granted, `insert` moved `x`, so we can no longer reference it, even
         // though only a reference was passed to `with_env`
     }
@@ -517,15 +522,13 @@ mod test {
             vec![(OsString::from("key"), OsString::from("value"))]
         );
 
-        assert!(
-            command()
-                .with_env(y)
-                .stdout()
-                .not()
-                .contains("key=value")
-                .execute()
-                .is_ok()
-        );
+        command()
+            .with_env(y)
+            .stdout()
+            .not()
+            .contains("key=value")
+            .execute()
+            .unwrap();
     }
 
     #[test]
@@ -539,117 +542,95 @@ mod test {
     fn take_vec() {
         let v = vec![("bar".to_string(), "baz".to_string())];
 
-        assert!(
-            command()
-                .with_env(&vec![("bar", "baz")])
-                .stdout()
-                .contains("bar=baz")
-                .execute()
-                .is_ok()
-        );
+        command()
+            .with_env(&vec![("bar", "baz")])
+            .stdout()
+            .contains("bar=baz")
+            .execute()
+            .unwrap();
 
-        assert!(
-            command()
-                .with_env(&v)
-                .stdout()
-                .contains("bar=baz")
-                .execute()
-                .is_ok()
-        );
+        command()
+            .with_env(&v)
+            .stdout()
+            .contains("bar=baz")
+            .execute()
+            .unwrap();
 
-        assert!(
-            command()
-                .with_env(&vec![("bar", "baz")])
-                .stdout()
-                .isnt("")
-                .execute()
-                .is_ok()
-        );
+        command()
+            .with_env(&vec![("bar", "baz")])
+            .stdout()
+            .isnt("")
+            .execute()
+            .unwrap();
     }
 
     #[test]
     fn take_slice_of_strs() {
-        assert!(
-            command()
-                .with_env(&[("bar", "BAZ")])
-                .stdout()
-                .contains("bar=BAZ")
-                .execute()
-                .is_ok()
-        );
-
-        assert!(
-            command()
-                .with_env(&[("bar", "BAZ")][..])
-                .stdout()
-                .contains("bar=BAZ")
-                .execute()
-                .is_ok()
-        );
-
-        assert!(
-            command()
-                .with_env([("bar", "BAZ")].as_ref())
-                .stdout()
-                .contains("bar=BAZ")
-                .execute()
-                .is_ok()
-        );
+        command()
+            .with_env(&[("bar", "BAZ")])
+            .stdout()
+            .contains("bar=BAZ")
+            .execute()
+            .unwrap();
+
+        command()
+            .with_env(&[("bar", "BAZ")][..])
+            .stdout()
+            .contains("bar=BAZ")
+            .execute()
+            .unwrap();
+
+        command()
+            .with_env([("bar", "BAZ")].as_ref())
+            .stdout()
+            .contains("bar=BAZ")
+            .execute()
+            .unwrap();
     }
 
     #[test]
     fn take_slice_of_strings() {
         // same deal as above
 
-        assert!(
-            command()
-                .with_env(&[("bar".to_string(), "BAZ".to_string())])
-                .stdout()
-                .contains("bar=BAZ")
-                .execute()
-                .is_ok()
-        );
+        command()
+            .with_env(&[("bar".to_string(), "BAZ".to_string())])
+            .stdout()
+            .contains("bar=BAZ")
+            .execute()
+            .unwrap();
 
-        assert!(
-            command()
-                .with_env(&[("bar".to_string(), "BAZ".to_string())][..])
-                .stdout()
-                .contains("bar=BAZ")
-                .execute()
-                .is_ok()
-        );
+        command()
+            .with_env(&[("bar".to_string(), "BAZ".to_string())][..])
+            .stdout()
+            .contains("bar=BAZ")
+            .execute()
+            .unwrap();
     }
 
     #[test]
     fn take_slice() {
-        assert!(
-            command()
-                .with_env(&[("hey", "ho")])
-                .stdout()
-                .contains("hey=ho")
-                .execute()
-                .is_ok()
-        );
+        command()
+            .with_env(&[("hey", "ho")])
+            .stdout()
+            .contains("hey=ho")
+            .execute()
+            .unwrap();
 
-        assert!(
-            command()
-                .with_env(&[("hey", "ho".to_string())])
-                .stdout()
-                .contains("hey=ho")
-                .execute()
-                .is_ok()
-        );
+        command()
+            .with_env(&[("hey", "ho".to_string())])
+            .stdout()
+            .contains("hey=ho")
+            .execute()
+            .unwrap();
     }
 
     #[test]
     fn take_string_i32() {
-        assert!(
-            command()
-                .with_env(&[("bar", 3 as i32)])
-                .stdout()
-                .contains("bar=3")
-                .execute()
-                .is_ok()
-        );
+        command()
+            .with_env(&[("bar", 3 as i32)])
+            .stdout()
+            .contains("bar=3")
+            .execute()
+            .unwrap();
     }
 }

src/lib.rs

@@ -118,12 +118,11 @@
 #![deny(missing_docs)]
 
 extern crate difference;
+extern crate environment;
 #[macro_use]
 extern crate error_chain;
 extern crate serde_json;
 
-extern crate environment;
-
 mod errors;
 
 #[macro_use]
@@ -137,4 +136,7 @@ mod diff;
 mod assert;
 pub use assert::Assert;
 pub use assert::OutputAssertionBuilder;
+/// Environment is a re-export of the Environment crate
+///
+/// It allow you to define/override environment variables for one or more assertions.
 pub use environment::Environment;