Merge pull request #980 from nathanross/tests-boilerplate-reduction

tests: remove helper function boilerplate via macros

Author: knight42

tests/common/macros.rs

@@ -46,3 +46,21 @@ macro_rules! path_concat {
         pb.to_str().unwrap().to_owned()
     }};
 }
+
+#[macro_export]
+macro_rules! util_name {
+  () => ( module_path!().split("_").nth(1).expect("no test name") )
+}
+
+#[macro_export]
+macro_rules! new_ucmd {
+  () => ( TestScenario::new(util_name!()).ucmd() )
+}
+
+#[macro_export]
+macro_rules! at_and_ucmd {
+  () => ({
+    let ts = TestScenario::new(util_name!());
+    (ts.fixtures.clone(), ts.ucmd())
+  })
+}

tests/common/util.rs

@@ -181,6 +181,7 @@ pub fn get_root_path() -> &'static str {
 
 /// Object-oriented path struct that represents and operates on
 /// paths relative to the directory it was constructed for.
+#[derive(Clone)]
 pub struct AtPath {
     pub subdir: PathBuf,
 }

tests/test_base32.rs

@@ -8,15 +8,11 @@
 
 use common::util::*;
 
-static UTIL_NAME: &'static str = "base32";
-fn new_ucmd() -> UCommand {
-    TestScenario::new(UTIL_NAME).ucmd()
-}
 
 #[test]
 fn test_encode() {
     let input = "Hello, World!";
-    new_ucmd()
+    new_ucmd!()
         .pipe_in(input)
         .succeeds()
         .stdout_only("JBSWY3DPFQQFO33SNRSCC===\n");
@@ -26,7 +22,7 @@ fn test_encode() {
 fn test_decode() {
     for decode_param in vec!["-d", "--decode"] {
         let input = "JBSWY3DPFQQFO33SNRSCC===\n";
-        new_ucmd()
+        new_ucmd!()
             .arg(decode_param)
             .pipe_in(input)
             .succeeds()
@@ -37,7 +33,7 @@ fn test_decode() {
 #[test]
 fn test_garbage() {
     let input = "aGVsbG8sIHdvcmxkIQ==\0";
-    new_ucmd()
+    new_ucmd!()
         .arg("-d")
         .pipe_in(input)
         .fails()
@@ -48,7 +44,7 @@ fn test_garbage() {
 fn test_ignore_garbage() {
     for ignore_garbage_param in vec!["-i", "--ignore-garbage"] {
         let input = "JBSWY\x013DPFQ\x02QFO33SNRSCC===\n";
-        new_ucmd()
+        new_ucmd!()
             .arg("-d")
             .arg(ignore_garbage_param)
             .pipe_in(input)
@@ -61,7 +57,7 @@ fn test_ignore_garbage() {
 fn test_wrap() {
     for wrap_param in vec!["-w", "--wrap"] {
         let input = "The quick brown fox jumps over the lazy dog.";
-        new_ucmd()
+        new_ucmd!()
             .arg(wrap_param)
             .arg("20")
             .pipe_in(input)
@@ -73,7 +69,7 @@ fn test_wrap() {
 #[test]
 fn test_wrap_no_arg() {
     for wrap_param in vec!["-w", "--wrap"] {
-        new_ucmd()
+        new_ucmd!()
             .arg(wrap_param)
             .fails()
             .stderr_only(format!("base32: error: Argument to option '{}' missing.\n",
@@ -84,7 +80,7 @@ fn test_wrap_no_arg() {
 #[test]
 fn test_wrap_bad_arg() {
     for wrap_param in vec!["-w", "--wrap"] {
-        new_ucmd()
+        new_ucmd!()
             .arg(wrap_param).arg("b")
             .fails()
             .stderr_only("base32: error: invalid wrap size: ‘b’: invalid digit found in string\n");

tests/test_base64.rs

@@ -1,14 +1,10 @@
 use common::util::*;
 
-static UTIL_NAME: &'static str = "base64";
-fn new_ucmd() -> UCommand {
-    TestScenario::new(UTIL_NAME).ucmd()
-}
 
 #[test]
 fn test_encode() {
     let input = "hello, world!";
-    new_ucmd()
+    new_ucmd!()
         .pipe_in(input)
         .succeeds()
         .stdout_only("aGVsbG8sIHdvcmxkIQ==\n");
@@ -18,7 +14,7 @@ fn test_encode() {
 fn test_decode() {
     for decode_param in vec!["-d", "--decode"] {
         let input = "aGVsbG8sIHdvcmxkIQ==";
-        new_ucmd()
+        new_ucmd!()
             .arg(decode_param)
             .pipe_in(input)
             .succeeds()
@@ -29,7 +25,7 @@ fn test_decode() {
 #[test]
 fn test_garbage() {
     let input = "aGVsbG8sIHdvcmxkIQ==\0";
-    new_ucmd()
+    new_ucmd!()
         .arg("-d")
         .pipe_in(input)
         .fails()
@@ -40,7 +36,7 @@ fn test_garbage() {
 fn test_ignore_garbage() {
     for ignore_garbage_param in vec!["-i", "--ignore-garbage"] {
         let input = "aGVsbG8sIHdvcmxkIQ==\0";
-        new_ucmd()
+        new_ucmd!()
             .arg("-d")
             .arg(ignore_garbage_param)
             .pipe_in(input)
@@ -53,7 +49,7 @@ fn test_ignore_garbage() {
 fn test_wrap() {
     for wrap_param in vec!["-w", "--wrap"] {
         let input = "The quick brown fox jumps over the lazy dog.";
-        new_ucmd()
+        new_ucmd!()
             .arg(wrap_param)
             .arg("20")
             .pipe_in(input)
@@ -65,7 +61,7 @@ fn test_wrap() {
 #[test]
 fn test_wrap_no_arg() {
     for wrap_param in vec!["-w", "--wrap"] {
-        new_ucmd()
+        new_ucmd!()
             .arg(wrap_param)
             .fails()
             .stderr_only(format!("base64: error: Argument to option '{}' missing.\n",
@@ -76,7 +72,7 @@ fn test_wrap_no_arg() {
 #[test]
 fn test_wrap_bad_arg() {
     for wrap_param in vec!["-w", "--wrap"] {
-        new_ucmd()
+        new_ucmd!()
             .arg(wrap_param)
             .arg("b")
             .fails()

tests/test_basename.rs

@@ -1,38 +1,34 @@
 use common::util::*;
 
-static UTIL_NAME: &'static str = "basename";
-fn new_ucmd() -> UCommand {
-    TestScenario::new(UTIL_NAME).ucmd()
-}
 
 #[test]
 fn test_directory() {
-    new_ucmd().args(&["/root/alpha/beta/gamma/delta/epsilon/omega/"])
+    new_ucmd!().args(&["/root/alpha/beta/gamma/delta/epsilon/omega/"])
         .succeeds().stdout_only("omega");
 }
 
 #[test]
 fn test_file() {
-    new_ucmd().args(&["/etc/passwd"]).succeeds().stdout_only("passwd");
+    new_ucmd!().args(&["/etc/passwd"]).succeeds().stdout_only("passwd");
 }
 
 #[test]
 fn test_remove_suffix() {
-    new_ucmd().args(&["/usr/local/bin/reallylongexecutable.exe", ".exe"])
+    new_ucmd!().args(&["/usr/local/bin/reallylongexecutable.exe", ".exe"])
         .succeeds().stdout_only("reallylongexecutable");
 }
 
 #[test]
 fn test_dont_remove_suffix() {
-    new_ucmd().args(&["/foo/bar/baz", "baz"]).succeeds().stdout_only( "baz");
+    new_ucmd!().args(&["/foo/bar/baz", "baz"]).succeeds().stdout_only( "baz");
 }
 
 #[cfg_attr(not(feature="test_unimplemented"),ignore)]
 #[test]
 fn test_multiple_param() {
     for multiple_param in vec!["-a", "--multiple"] {
         let path = "/foo/bar/baz";
-        new_ucmd().args(&[multiple_param, path, path])
+        new_ucmd!().args(&[multiple_param, path, path])
             .succeeds().stdout_only("baz\nbaz");
     }
 }
@@ -42,7 +38,7 @@ fn test_multiple_param() {
 fn test_suffix_param() {
     for suffix_param in vec!["-s", "--suffix"] {
         let path = "/foo/bar/baz.exe";
-        new_ucmd()
+        new_ucmd!()
             .args(&[suffix_param, ".exe", path, path])
             .succeeds().stdout_only("baz\nbaz");
     }
@@ -53,14 +49,14 @@ fn test_suffix_param() {
 fn test_zero_param() {
     for zero_param in vec!["-z", "--zero"] {
         let path = "/foo/bar/baz";
-        new_ucmd().args(&[zero_param, "-a", path, path])
+        new_ucmd!().args(&[zero_param, "-a", path, path])
             .succeeds().stdout_only("baz\0baz\0");
     }
 }
 
 
 fn expect_error(input: Vec<&str>) {
-    assert!(new_ucmd().args(&input)
+    assert!(new_ucmd!().args(&input)
                 .fails().no_stdout().stderr.len() > 0);
 }
 

tests/test_cat.rs

@@ -1,13 +1,9 @@
 use common::util::*;
 
-static UTIL_NAME: &'static str = "cat";
-fn new_ucmd() -> UCommand {
-    TestScenario::new(UTIL_NAME).ucmd()
-}
 
 #[test]
 fn test_output_multi_files_print_all_chars() {
-    new_ucmd()
+    new_ucmd!()
         .args(&["alpha.txt", "256.txt", "-A", "-n"])
         .succeeds()
         .stdout_only("     1\tabcde$\n     2\tfghij$\n     3\tklmno$\n     4\tpqrst$\n     \
@@ -26,7 +22,7 @@ fn test_output_multi_files_print_all_chars() {
 #[test]
 fn test_stdin_show_nonprinting() {
     for same_param in vec!["-v", "--show-nonprinting"] {
-        new_ucmd()
+        new_ucmd!()
             .args(&vec![same_param])
             .pipe_in("\t\0\n")
             .succeeds()
@@ -37,7 +33,7 @@ fn test_stdin_show_nonprinting() {
 #[test]
 fn test_stdin_show_tabs() {
     for same_param in vec!["-T", "--show-tabs"] {
-        new_ucmd()
+        new_ucmd!()
             .args(&[same_param])
             .pipe_in("\t\0\n")
             .succeeds()
@@ -49,7 +45,7 @@ fn test_stdin_show_tabs() {
 #[test]
 fn test_stdin_show_ends() {
     for same_param in vec!["-E", "--show-ends"] {
-        new_ucmd()
+        new_ucmd!()
             .args(&[same_param,"-"])
             .pipe_in("\t\0\n")
             .succeeds()
@@ -60,7 +56,7 @@ fn test_stdin_show_ends() {
 #[test]
 fn test_stdin_show_all() {
     for same_param in vec!["-A", "--show-all"] {
-        new_ucmd()
+        new_ucmd!()
             .args(&[same_param])
             .pipe_in("\t\0\n")
             .succeeds()
@@ -70,7 +66,7 @@ fn test_stdin_show_all() {
 
 #[test]
 fn test_stdin_nonprinting_and_endofline() {
-    new_ucmd()
+    new_ucmd!()
         .args(&["-e"])
         .pipe_in("\t\0\n")
         .succeeds()
@@ -79,7 +75,7 @@ fn test_stdin_nonprinting_and_endofline() {
 
 #[test]
 fn test_stdin_nonprinting_and_tabs() {
-    new_ucmd()
+    new_ucmd!()
         .args(&["-t"])
         .pipe_in("\t\0\n")
         .succeeds()
@@ -89,7 +85,7 @@ fn test_stdin_nonprinting_and_tabs() {
 #[test]
 fn test_stdin_squeeze_blank() {
     for same_param in vec!["-s", "--squeeze-blank"] {
-        new_ucmd()
+        new_ucmd!()
             .arg(same_param)
             .pipe_in("\n\na\n\n\n\n\nb\n\n\n")
             .succeeds()
@@ -100,7 +96,7 @@ fn test_stdin_squeeze_blank() {
 #[test]
 fn test_stdin_number_non_blank() {
     for same_param in vec!["-b", "--number-nonblank"] {
-        new_ucmd()
+        new_ucmd!()
             .arg(same_param)
             .arg("-")
             .pipe_in("\na\nb\n\n\nc")
@@ -112,7 +108,7 @@ fn test_stdin_number_non_blank() {
 #[test]
 fn test_non_blank_overrides_number() {
     for same_param in vec!["-b", "--number-nonblank"] {
-        new_ucmd()
+        new_ucmd!()
             .args(&[same_param, "-"])
             .pipe_in("\na\nb\n\n\nc")
             .succeeds()
@@ -123,7 +119,7 @@ fn test_non_blank_overrides_number() {
 #[test]
 fn test_squeeze_blank_before_numbering() {
     for same_param in vec!["-s", "--squeeze-blank"] {
-        new_ucmd()
+        new_ucmd!()
             .args(&[same_param, "-n", "-"])
             .pipe_in("a\n\n\nb")
             .succeeds()