aboutsummaryrefslogtreecommitdiffhomepage
path: root/crates/shirabe/tests/common/process_executor_mock.rs
blob: 698d8d26d5c406b33793997df2ec1faf1602def1 (plain)
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
//! ref: composer/tests/Composer/Test/Mock/ProcessExecutorMock.php

use shirabe::util::process_executor::{MockExpectation, MockHandler, ProcessExecutor};
use shirabe_php_shim::PhpMixed;
use std::cell::RefCell;
use std::rc::Rc;

// A command expectation as written in the PHP tests: either a bare command
// (`'git command'` / `['git', '--version']`) or the full
// `{cmd, return?, stdout?, stderr?}` associative form.
pub fn cmd(command: impl IntoMockCmd) -> MockExpectation {
    MockExpectation::from_cmd(command.into_mock_cmd())
}

pub fn cmd_full(
    command: impl IntoMockCmd,
    r#return: i64,
    stdout: impl Into<String>,
    stderr: impl Into<String>,
) -> MockExpectation {
    MockExpectation {
        cmd: command.into_mock_cmd(),
        r#return,
        stdout: stdout.into(),
        stderr: stderr.into(),
        callback: None,
    }
}

// Accepts the same command shapes the tests use: a string command or a list of
// string args. Comparison against the executed command is exact (PHP `===`), so
// the form here must match the form the code under test passes to `execute`.
pub trait IntoMockCmd {
    fn into_mock_cmd(self) -> PhpMixed;
}

impl IntoMockCmd for &str {
    fn into_mock_cmd(self) -> PhpMixed {
        PhpMixed::String(self.to_string())
    }
}

impl IntoMockCmd for String {
    fn into_mock_cmd(self) -> PhpMixed {
        PhpMixed::String(self)
    }
}

impl IntoMockCmd for Vec<&str> {
    fn into_mock_cmd(self) -> PhpMixed {
        PhpMixed::List(
            self.into_iter()
                .map(|s| PhpMixed::String(s.to_string()))
                .collect(),
        )
    }
}

impl IntoMockCmd for Vec<String> {
    fn into_mock_cmd(self) -> PhpMixed {
        PhpMixed::List(self.into_iter().map(PhpMixed::String).collect())
    }
}

impl<const N: usize> IntoMockCmd for [&str; N] {
    fn into_mock_cmd(self) -> PhpMixed {
        PhpMixed::List(
            self.iter()
                .map(|s| PhpMixed::String(s.to_string()))
                .collect(),
        )
    }
}

pub struct ProcessExecutorMockGuard(Rc<RefCell<ProcessExecutor>>);

impl Drop for ProcessExecutorMockGuard {
    fn drop(&mut self) {
        // Avoid aborting on a double panic when a test assertion is already unwinding.
        if std::thread::panicking() {
            return;
        }
        self.0.borrow().__assert_complete();
    }
}

// For testing only. Mirrors TestCase::getProcessExecutorMock: returns a shared
// ProcessExecutor handle configured with the given expectations, plus a guard
// that runs `__assert_complete` when it drops at the end of the test scope.
pub fn get_process_executor_mock(
    expectations: Vec<MockExpectation>,
    strict: bool,
    default_handler: MockHandler,
) -> (Rc<RefCell<ProcessExecutor>>, ProcessExecutorMockGuard) {
    let process = Rc::new(RefCell::new(ProcessExecutor::new(None)));
    process
        .borrow_mut()
        .__expects(expectations, strict, default_handler);
    (process.clone(), ProcessExecutorMockGuard(process))
}