gitr 0.5.1

Async typed git CLI wrapper for agents and automation.
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
122
123
124
125
126
127
128
129
130
131
132
133
134

use crate::command::CommandOutput;
use crate::error::GitError;
use std::collections::HashMap;

/// A hermetic git runner for tests that replays scripted responses.
///
/// Only available when the `test-utils` feature is enabled or when running tests.
///
/// Register expected commands with [`ScriptedRunner::script`], then use the
/// runner in place of `GitCommand` in tests.
///
/// # Example
///
/// ```
/// use gitr::{CommandOutput, ScriptedRunner};
/// use gitr::Error as GitError;
///
/// let mut runner = ScriptedRunner::new();
/// runner.script("status --porcelain", Ok(CommandOutput {
///     stdout: " M file.txt".to_string(),
///     stderr: String::new(),
///     exit_code: 0,
/// }));
///
/// // In an async context:
/// // let out = runner.run(&["status", "--porcelain"]).await.unwrap();
/// ```
#[derive(Debug, Clone, Default)]
pub struct ScriptedRunner {
    scripts: HashMap<String, Result<CommandOutput, GitError>>,
}

impl ScriptedRunner {
    /// Create a new empty scripted runner.
    pub fn new() -> Self {
        Self::default()
    }

    /// Register a scripted response for a command.
    pub fn script(&mut self, command: impl Into<String>, result: Result<CommandOutput, GitError>) {
        self.scripts.insert(command.into(), result);
    }

    /// Run a command by looking up the scripted response.
    ///
    /// # Errors
    ///
    /// Returns `GitError::Io("unscripted command: ...")` if the command was not
    /// registered.
    #[allow(clippy::unused_async)]
    pub async fn run(&self, args: &[&str]) -> Result<CommandOutput, GitError> {
        let key = args.join(" ");
        self.lookup(&key)
    }

    /// Run with environment variables (same as `run`; env is ignored for lookup).
    #[allow(clippy::unused_async)]
    pub async fn run_with_env(
        &self,
        args: &[&str],
        _extra_env: &[(&str, &str)],
    ) -> Result<CommandOutput, GitError> {
        let key = args.join(" ");
        self.lookup(&key)
    }

    fn lookup(&self, key: &str) -> Result<CommandOutput, GitError> {
        match self.scripts.get(key) {
            Some(result) => result.clone(),
            None => Err(GitError::Io(format!("unscripted command: {key}"))),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    async fn test_scripted_runner_ok() {
        let mut runner = ScriptedRunner::new();
        runner.script(
            "status --porcelain",
            Ok(CommandOutput {
                stdout: " M file.txt".to_string(),
                stderr: String::new(),
                exit_code: 0,
            }),
        );
        let out = runner.run(&["status", "--porcelain"]).await.unwrap();
        assert_eq!(out.stdout, " M file.txt");
    }

    #[tokio::test]
    async fn test_scripted_runner_err() {
        let mut runner = ScriptedRunner::new();
        runner.script(
            "push origin main",
            Err(GitError::CommandFailed {
                command: "push origin main".to_string(),
                exit_code: 1,
                stderr: "no remote".to_string(),
                stdout: String::new(),
            }),
        );
        let err = runner.run(&["push", "origin", "main"]).await.unwrap_err();
        assert!(matches!(err, GitError::CommandFailed { .. }));
    }

    #[tokio::test]
    async fn test_scripted_runner_unscripted() {
        let runner = ScriptedRunner::new();
        let err = runner.run(&["fetch", "origin"]).await.unwrap_err();
        assert!(matches!(err, GitError::Io(ref s) if s.contains("unscripted")));
    }

    #[tokio::test]
    async fn test_scripted_runner_run_with_env() {
        let mut runner = ScriptedRunner::new();
        runner.script(
            "status --porcelain",
            Ok(CommandOutput {
                stdout: " M file.txt".to_string(),
                stderr: String::new(),
                exit_code: 0,
            }),
        );
        let out = runner
            .run_with_env(&["status", "--porcelain"], &[("FOO", "bar")])
            .await
            .unwrap();
        assert_eq!(out.stdout, " M file.txt");
    }
}