ironflow_engine/executor/
shell.rs

1//! Shell step executor.
2
3use std::sync::Arc;
4use std::time::{Duration, Instant};
5
6use rust_decimal::Decimal;
7use serde_json::json;
8use tracing::info;
9
10use ironflow_core::operations::shell::Shell;
11use ironflow_core::provider::AgentProvider;
12
13use crate::config::ShellConfig;
14use crate::error::EngineError;
15
16use super::{StepExecutor, StepOutput};
17
18/// Executor for shell steps.
19///
20/// Runs a shell command and captures stdout, stderr, and exit code.
21pub struct ShellExecutor<'a> {
22    config: &'a ShellConfig,
23}
24
25impl<'a> ShellExecutor<'a> {
26    /// Create a new shell executor from a config reference.
27    pub fn new(config: &'a ShellConfig) -> Self {
28        Self { config }
29    }
30}
31
32impl StepExecutor for ShellExecutor<'_> {
33    async fn execute(&self, _provider: &Arc<dyn AgentProvider>) -> Result<StepOutput, EngineError> {
34        let start = Instant::now();
35
36        let mut shell = Shell::new(&self.config.command);
37        if let Some(secs) = self.config.timeout_secs {
38            shell = shell.timeout(Duration::from_secs(secs));
39        }
40        if let Some(ref dir) = self.config.dir {
41            shell = shell.dir(dir);
42        }
43        for (key, value) in &self.config.env {
44            shell = shell.env(key, value);
45        }
46        if self.config.clean_env {
47            shell = shell.clean_env();
48        }
49
50        let output = shell.run().await?;
51        let duration_ms = start.elapsed().as_millis() as u64;
52
53        info!(
54            step_kind = "shell",
55            command = %self.config.command,
56            exit_code = output.exit_code(),
57            duration_ms,
58            "shell step completed"
59        );
60
61        Ok(StepOutput {
62            output: json!({
63                "stdout": output.stdout(),
64                "stderr": output.stderr(),
65                "exit_code": output.exit_code(),
66            }),
67            duration_ms,
68            cost_usd: Decimal::ZERO,
69            input_tokens: None,
70            output_tokens: None,
71        })
72    }
73}
74
75#[cfg(test)]
76mod tests {
77    use super::*;
78    use ironflow_core::providers::claude::ClaudeCodeProvider;
79    use ironflow_core::providers::record_replay::RecordReplayProvider;
80
81    fn create_test_provider() -> Arc<dyn AgentProvider> {
82        let inner = ClaudeCodeProvider::new();
83        Arc::new(RecordReplayProvider::replay(
84            inner,
85            "/tmp/ironflow-fixtures",
86        ))
87    }
88
89    #[tokio::test]
90    async fn shell_simple_command() {
91        let config = ShellConfig::new("echo hello");
92        let executor = ShellExecutor::new(&config);
93        let provider = create_test_provider();
94
95        let result = executor.execute(&provider).await;
96        assert!(result.is_ok());
97        let output = result.unwrap();
98        assert_eq!(output.output["exit_code"].as_i64().unwrap(), 0);
99        assert!(output.output["stdout"].as_str().unwrap().contains("hello"));
100    }
101
102    #[tokio::test]
103    async fn shell_nonzero_exit_returns_error() {
104        let config = ShellConfig::new("exit 1");
105        let executor = ShellExecutor::new(&config);
106        let provider = create_test_provider();
107
108        let result = executor.execute(&provider).await;
109        assert!(result.is_err());
110    }
111
112    #[tokio::test]
113    async fn shell_env_variables() {
114        let config = ShellConfig::new("echo $MY_VAR").env("MY_VAR", "test_value");
115        let executor = ShellExecutor::new(&config);
116        let provider = create_test_provider();
117
118        let result = executor.execute(&provider).await;
119        assert!(result.is_ok());
120        let output = result.unwrap();
121        assert!(
122            output.output["stdout"]
123                .as_str()
124                .unwrap()
125                .contains("test_value")
126        );
127    }
128
129    #[tokio::test]
130    async fn shell_step_output_has_structure() {
131        let config = ShellConfig::new("echo test");
132        let executor = ShellExecutor::new(&config);
133        let provider = create_test_provider();
134
135        let output = executor.execute(&provider).await.unwrap();
136        assert!(output.output.get("stdout").is_some());
137        assert!(output.output.get("stderr").is_some());
138        assert!(output.output.get("exit_code").is_some());
139        assert_eq!(output.cost_usd, Decimal::ZERO);
140        // duration_ms can be 0 when the command completes in under 1ms (CI)
141        assert!(output.duration_ms < 5000);
142    }
143
144    #[tokio::test]
145    async fn shell_command_with_pipe() {
146        let config = ShellConfig::new("echo hello | grep hello");
147        let executor = ShellExecutor::new(&config);
148        let provider = create_test_provider();
149
150        let result = executor.execute(&provider).await;
151        assert!(result.is_ok());
152        let output = result.unwrap();
153        assert_eq!(output.output["exit_code"].as_i64().unwrap(), 0);
154        assert!(output.output["stdout"].as_str().unwrap().contains("hello"));
155    }
156}
ironflow_engine/executor/shell.rs

ironflow_engine/executor/
shell.rs
