tests/ui.rs

   1 /// Snapshot tests for Ouch's output.
   2 ///
   3 /// See CONTRIBUTING.md for a brief guide on how to use [`insta`] for these tests.
   4 /// [`insta`]: https://docs.rs/insta
   5
   6 #[macro_use]
   7 mod utils;
   8
   9 use std::{io, path::Path, process::Output};
  10
  11 #[cfg(not(windows))]
  12 use insta::assert_display_snapshot as ui;
  13
  14 // Don't run these on Windows
  15 #[cfg(windows)]
  16 use self::ignore as ui;
  17 use crate::utils::run_in;
  18
  19 fn testdir() -> io::Result<(tempfile::TempDir, &'static Path)> {
  20     let dir = tempfile::tempdir()?;
  21     let path = dir.path().to_path_buf().into_boxed_path();
  22     Ok((dir, Box::leak(path)))
  23 }
  24
  25 fn run_ouch(argv: &str, dir: &Path) -> String {
  26     let output = utils::cargo_bin()
  27         .args(argv.split_whitespace().skip(1))
  28         .current_dir(dir)
  29         .output()
  30         .unwrap_or_else(|err| {
  31             panic!(
  32                 "Failed to run command\n\
  33                  argv: {argv}\n\
  34                  path: {dir:?}\n\
  35                  err: {err}"
  36             )
  37         });
  38
  39     redact_paths(&output_to_string(output), dir)
  40 }
  41
  42 // remove random tempdir paths from snapshots to make them deterministic
  43 fn redact_paths(text: &str, path: &Path) -> String {
  44     let redacted = "<FOLDER>";
  45
  46     let path = path.display();
  47     let path = if cfg!(target_os = "macos") {
  48         format!(r"/private{path}")
  49     } else {
  50         path.to_string()
  51     };
  52
  53     text.replace(path.as_str(), redacted)
  54 }
  55
  56 fn output_to_string(output: Output) -> String {
  57     String::from_utf8(output.stdout).unwrap() + std::str::from_utf8(&output.stderr).unwrap()
  58 }
  59
  60 #[test]
  61 fn ui_test_err_compress_missing_extension() {
  62     let (_dropper, dir) = testdir().unwrap();
  63
  64     // prepare
  65     #[cfg(not(windows))]
  66     run_in(dir, "touch", "input").unwrap();
  67
  68     #[cfg(windows)]
  69     run_in(dir, "cmd", "/C copy nul input").unwrap();
  70
  71     ui!(run_ouch("ouch compress input output", dir));
  72 }
  73
  74 #[test]
  75 fn ui_test_err_decompress_missing_extension() {
  76     let (_dropper, dir) = testdir().unwrap();
  77
  78     #[cfg(not(windows))]
  79     run_in(dir, "touch", "a b.unknown").unwrap();
  80
  81     #[cfg(windows)]
  82     run_in(dir, "cmd", "/C copy nul a").unwrap();
  83
  84     #[cfg(windows)]
  85     run_in(dir, "cmd", "/C copy nul b.unknown").unwrap();
  86
  87
  88     ui!(run_ouch("ouch decompress a", dir));
  89     ui!(run_ouch("ouch decompress a b.unknown", dir));
  90     ui!(run_ouch("ouch decompress b.unknown", dir));
  91 }
  92
  93 #[test]
  94 fn ui_test_err_missing_files() {
  95     let (_dropper, dir) = testdir().unwrap();
  96
  97     ui!(run_ouch("ouch compress a b", dir));
  98     ui!(run_ouch("ouch decompress a b", dir));
  99     ui!(run_ouch("ouch list a b", dir));
 100 }
 101
 102 #[test]
 103 fn ui_test_ok_compress() {
 104     let (_dropper, dir) = testdir().unwrap();
 105
 106     // prepare
 107     #[cfg(not(windows))]
 108     run_in(dir, "touch", "input").unwrap();
 109
 110     #[cfg(windows)]
 111     run_in(dir, "cmd", "/C copy nul input").unwrap();
 112
 113     ui!(run_ouch("ouch compress input output.zip", dir));
 114     ui!(run_ouch("ouch compress input output.gz", dir));
 115 }
 116
 117 #[test]
 118 fn ui_test_ok_decompress() {
 119     let (_dropper, dir) = testdir().unwrap();
 120
 121     // prepare
 122     #[cfg(not(windows))]
 123     run_in(dir, "touch", "input").unwrap();
 124     run_ouch("ouch compress input output.zst", dir);
 125
 126     ui!(run_ouch("ouch decompress output.zst", dir));
 127 }
 128
 129 #[test]
 130 fn ui_test_usage_help_flag() {
 131     ui!(output_to_string(ouch!("--help")));
 132     ui!(output_to_string(ouch!("-h")));
 133 }
 134
 135 #[allow(unused)]
 136 #[macro_export]
 137 macro_rules! ignore {
 138     ($expr:expr) => {{
 139         $expr
 140     }};
 141 }