cli-assert 0.1.13-rc.1

Testing command-line applications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

use crate::utils::bytes_to_str;

type StatusPredicate = Box<dyn Fn(i32) -> bool>;

type StdPredicate = Box<dyn Fn(Vec<u8>) -> bool>;

#[derive(Default)]
pub struct Assertions {
  /// Flag indicating if the command is expected to complete successfully.
  success: Option<bool>,
  /// Flag indicating if the command is expected to fail.
  failure: Option<bool>,
  /// Expected status code.
  status: Option<i32>,
  /// Predicate for status code.
  status_predicate: Option<StatusPredicate>,
  /// Expected content of `stdout` after executing the command.
  stdout: Option<Vec<u8>>,
  /// Predicate for stdout.
  stdout_predicate: Option<StdPredicate>,
  /// Expected content of `stderr` after executing the command.
  stderr: Option<Vec<u8>>,
  /// Predicate for stderr.
  stderr_predicate: Option<StdPredicate>,
}

impl Assertions {
  pub fn success(&mut self) {
    self.success = Some(true);
    self.failure = None;
  }

  pub fn failure(&mut self) {
    self.failure = Some(true);
    self.success = None;
  }

  pub fn code(&mut self, code: i32) {
    self.status = Some(code);
  }

  pub fn code_fn(&mut self, predicate: impl Fn(i32) -> bool + 'static) {
    self.status_predicate = Some(Box::new(predicate));
  }

  pub fn stdout(&mut self, bytes: impl AsRef<[u8]>) {
    self.stdout = Some(bytes.as_ref().to_vec());
  }

  pub fn stdout_fn(&mut self, predicate: impl Fn(Vec<u8>) -> bool + 'static) {
    self.stdout_predicate = Some(Box::new(predicate));
  }

  pub fn stderr(&mut self, bytes: impl AsRef<[u8]>) {
    self.stderr = Some(bytes.as_ref().to_vec());
  }

  pub fn stderr_fn(&mut self, predicate: impl Fn(Vec<u8>) -> bool + 'static) {
    self.stderr_predicate = Some(Box::new(predicate));
  }

  /// Checks all assertions.
  pub fn assert(&self, command: &crate::Command) {
    if let Some(true) = self.success
      && !command.get_status().success()
    {
      panic!("expected success");
    }
    if let Some(true) = self.failure
      && command.get_status().success()
    {
      panic!("expected failure");
    }
    if let Some(expected) = self.status {
      let actual = command.get_status().code().expect("failed to retrieve status code");
      if actual != expected {
        println!("\nexpected status code: {}\n  actual status code: {}", expected, actual);
        panic!("unexpected status");
      }
    }
    if let Some(predicate) = &self.status_predicate {
      let actual = command.get_status().code().expect("failed to retrieve status code");
      if !predicate(actual) {
        println!("\nunexpected status code: {}", actual);
        panic!("unexpected status code");
      }
    }
    if let Some(expected) = &self.stdout {
      let actual = command.get_stdout_raw();
      if actual != expected {
        println!("\nexpected stdout: {:?}\n  actual stdout: {:?}", expected, actual);
        println!("\n\nexpected stdout: {}\n  actual stdout: {}", bytes_to_str(expected), bytes_to_str(actual));
        panic!("unexpected stdout");
      }
    }
    if let Some(predicate) = &self.stdout_predicate {
      let actual = command.get_stdout_raw();
      if !predicate(actual.into()) {
        println!("\nunexpected stdout: {:?}\n", actual);
        println!("\n\nunexpected stdout: {}\n", bytes_to_str(actual));
        panic!("unexpected stdout");
      }
    }
    if let Some(expected) = &self.stderr {
      let actual = command.get_stderr_raw();
      if actual != expected {
        println!("\nexpected stderr: {:?}\n  actual stderr: {:?}", expected, actual);
        println!("\n\nexpected stderr: {}\n  actual stderr: {}", bytes_to_str(expected), bytes_to_str(actual));
        panic!("unexpected stderr");
      }
    }
    if let Some(predicate) = &self.stderr_predicate {
      let actual = command.get_stderr_raw();
      if !predicate(actual.into()) {
        println!("\nunexpected stderr: {:?}\n", actual);
        println!("\n\nunexpected stderr: {}\n", bytes_to_str(actual));
        panic!("unexpected stderr");
      }
    }
  }
}