openrunner-rs 1.0.1

A Rust library for running OpenScript
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
//! Core execution functions for running OpenScript code.

use crate::error::{Error, Result};
use crate::types::{ExecResult, IoOptions, ScriptOptions, SpawnResult};
use std::io::Write;
use std::path::PathBuf;
use std::process::Stdio;
use std::time::Instant;
use tempfile::NamedTempFile;
use tokio::process::{Child, Command};
use tokio::time::timeout;

/// Run an OpenScript from a string and wait for completion.
///
/// This function creates a temporary file with the script content and executes it
/// using the OpenScript interpreter, waiting for completion and capturing the output.
///
/// # Arguments
///
/// * `script` - The OpenScript code to execute
/// * `options` - Configuration options for script execution
///
/// # Returns
///
/// Returns an `ExecResult` containing the exit code, stdout, stderr, and execution duration.
///
/// # Examples
///
/// ```rust
/// use openrunner_rs::{run, ScriptOptions};
/// use std::time::Duration;
///
/// # #[tokio::main]
/// # async fn main() -> openrunner_rs::Result<()> {
/// let options = ScriptOptions::new()
///     .openscript_path("/bin/sh")
///     .timeout(Duration::from_secs(30));
/// let result = run("echo 'Hello, World!'", options).await?;
/// println!("Output: {}", result.stdout);
/// # Ok(())
/// # }
/// ```
pub async fn run(script: &str, options: ScriptOptions) -> Result<ExecResult> {
    let start_time = Instant::now();
    
    // Validate script is not empty
    if script.trim().is_empty() {
        return Err(Error::command_failed("Script content cannot be empty"));
    }

    // Create temporary file for the script
    let mut temp_file = NamedTempFile::new()
        .map_err(Error::script_write_error)?;
    
    temp_file.write_all(script.as_bytes())
        .map_err(Error::script_write_error)?;
    
    temp_file.flush()
        .map_err(Error::script_write_error)?;

    let script_path = temp_file.path().to_path_buf();
    
    // Validate working directory if specified
    if let Some(ref wd) = options.working_directory {
        if !wd.exists() {
            return Err(Error::invalid_working_directory(
                wd.to_string_lossy(),
                std::io::Error::new(std::io::ErrorKind::NotFound, "Directory does not exist")
            ));
        }
        if !wd.is_dir() {
            return Err(Error::invalid_working_directory(
                wd.to_string_lossy(),
                std::io::Error::new(std::io::ErrorKind::InvalidInput, "Path is not a directory")
            ));
        }
    }

    let timeout_duration = options.timeout;
    let child = spawn_command(&script_path, &options)
        .await?;

    // Handle timeout if specified
    let output = if let Some(timeout_duration) = timeout_duration {
        match timeout(timeout_duration, child.wait_with_output()).await {
            Ok(result) => result.map_err(Error::process_wait_error)?,
            Err(_) => {
                // Note: child is consumed by wait_with_output(), so we can't kill it here
                // The timeout mechanism in tokio will handle process cleanup
                return Ok(ExecResult {
                    exit_code: -1,
                    stdout: String::new(),
                    stderr: format!("Process timed out after {:?}", timeout_duration),
                    duration: start_time.elapsed(),
                    timed_out: true,
                });
            }
        }
    } else {
        child.wait_with_output().await
            .map_err(Error::process_wait_error)?
    };

    let duration = start_time.elapsed();
    let exit_code = output.status.code().unwrap_or(-1);
    
    let stdout = String::from_utf8_lossy(&output.stdout).to_string();
    let stderr = String::from_utf8_lossy(&output.stderr).to_string();

    Ok(ExecResult {
        exit_code,
        stdout,
        stderr,
        duration,
        timed_out: false,
    })
}

/// Run an OpenScript file and wait for completion.
///
/// This function executes a script file using the OpenScript interpreter,
/// waiting for completion and capturing the output.
///
/// # Arguments
///
/// * `path` - Path to the script file to execute
/// * `options` - Configuration options for script execution
///
/// # Returns
///
/// Returns an `ExecResult` containing the exit code, stdout, stderr, and execution duration.
///
/// # Examples
///
/// ```rust
/// use openrunner_rs::{run_file, ScriptOptions};
/// use std::path::PathBuf;
/// use std::io::Write;
///
/// # #[tokio::main]
/// # async fn main() -> openrunner_rs::Result<()> {
/// # let mut temp_file = tempfile::NamedTempFile::new().unwrap();
/// # writeln!(temp_file, "echo 'Hello from file!'").unwrap();
/// # let script_path = temp_file.path().to_path_buf();
/// let options = ScriptOptions::new().openscript_path("/bin/sh");
/// let result = run_file(&script_path, options).await?;
/// println!("Exit code: {}", result.exit_code);
/// # Ok(())
/// # }
/// ```
pub async fn run_file(path: &PathBuf, options: ScriptOptions) -> Result<ExecResult> {
    // Validate the script file exists and is readable
    if !path.exists() {
        return Err(Error::script_read_error(
            path.to_string_lossy(),
            std::io::Error::new(std::io::ErrorKind::NotFound, "Script file does not exist")
        ));
    }
    
    if !path.is_file() {
        return Err(Error::invalid_script_path(
            path.to_string_lossy(),
            "Path is not a file"
        ));
    }

    // Check if file is readable
    match std::fs::metadata(path) {
        Ok(metadata) => {
            if metadata.len() == 0 {
                return Err(Error::invalid_script_path(
                    path.to_string_lossy(),
                    "Script file is empty"
                ));
            }
        }
        Err(e) => {
            return Err(Error::script_read_error(path.to_string_lossy(), e));
        }
    }

    let start_time = Instant::now();
    let timeout_duration = options.timeout;
    let child = spawn_command(path, &options).await?;

    // Handle timeout if specified
    let output = if let Some(timeout_duration) = timeout_duration {
        match timeout(timeout_duration, child.wait_with_output()).await {
            Ok(result) => result.map_err(Error::process_wait_error)?,
            Err(_) => {
                // Note: child is consumed by wait_with_output(), so we can't kill it here
                // The timeout mechanism in tokio will handle process cleanup
                return Ok(ExecResult {
                    exit_code: -1,
                    stdout: String::new(),
                    stderr: format!("Process timed out after {:?}", timeout_duration),
                    duration: start_time.elapsed(),
                    timed_out: true,
                });
            }
        }
    } else {
        child.wait_with_output().await
            .map_err(Error::process_wait_error)?
    };

    let duration = start_time.elapsed();
    let exit_code = output.status.code().unwrap_or(-1);
    
    let stdout = String::from_utf8_lossy(&output.stdout).to_string();
    let stderr = String::from_utf8_lossy(&output.stderr).to_string();

    Ok(ExecResult {
        exit_code,
        stdout,
        stderr,
        duration,
        timed_out: false,
    })
}

/// Spawn an OpenScript process from a string without waiting for completion.
///
/// This function creates a temporary file with the script content and spawns
/// the OpenScript process, returning a `Child` handle for further interaction.
///
/// The returned `SpawnResult` contains the `Child` and a handle to the temporary
/// file, ensuring it is not deleted until the `SpawnResult` is dropped.
///
/// # Arguments
///
/// * `script` - The OpenScript code to execute
/// * `options` - Configuration options for script execution
///
/// # Returns
///
/// Returns a `SpawnResult` that can be used to interact with the running process.
///
/// # Examples
///
/// ```rust
/// use openrunner_rs::{spawn, ScriptOptions};
///
/// # #[tokio::main]
/// # async fn main() -> openrunner_rs::Result<()> {
/// let options = ScriptOptions::new().openscript_path("/bin/sh");
/// let spawn_result = spawn("echo 'Background task'", options).await?;
/// let output = spawn_result.child.wait_with_output().await?;
/// println!("Output: {}", String::from_utf8_lossy(&output.stdout));
/// # Ok(())
/// # }
/// ```
pub async fn spawn(script: &str, options: ScriptOptions) -> Result<SpawnResult> {
    // Validate script is not empty
    if script.trim().is_empty() {
        return Err(Error::command_failed("Script content cannot be empty"));
    }

    // Create temporary file for the script
    let mut temp_file = NamedTempFile::new()
        .map_err(Error::script_write_error)?;
    
    temp_file.write_all(script.as_bytes())
        .map_err(Error::script_write_error)?;
    
    temp_file.flush()
        .map_err(Error::script_write_error)?;

    let script_path = temp_file.path().to_path_buf();
    let child = spawn_command(&script_path, &options).await?;

    Ok(SpawnResult {
        child,
        _temp_file: Some(temp_file),
    })
}

/// Spawn an OpenScript process from a file without waiting for completion.
///
/// This function spawns a script file using the OpenScript interpreter and returns
/// a `Child` handle for further interaction.
///
/// # Arguments
///
/// * `path` - Path to the script file to execute
/// * `options` - Configuration options for script execution
///
/// # Returns
///
/// Returns a `Child` process handle.
pub async fn spawn_file(path: &PathBuf, options: ScriptOptions) -> Result<Child> {
    // Validate the script file exists and is readable
    if !path.exists() {
        return Err(Error::script_read_error(
            path.to_string_lossy(),
            std::io::Error::new(std::io::ErrorKind::NotFound, "Script file does not exist")
        ));
    }
    
    if !path.is_file() {
        return Err(Error::invalid_script_path(
            path.to_string_lossy(),
            "Path is not a file"
        ));
    }

    spawn_command(path, &options).await
}

async fn spawn_command(path: &PathBuf, options: &ScriptOptions) -> Result<Child> {
    let openscript_path = options
        .openscript_path
        .as_ref()
        .cloned()
        .unwrap_or_else(|| PathBuf::from("openscript"));

    // Validate openscript executable exists if it's an absolute path
    if openscript_path.is_absolute() && !openscript_path.exists() {
        return Err(Error::OpenScriptNotFound);
    }

    let mut cmd = Command::new(&openscript_path);

    cmd.arg(path);
    cmd.args(&options.args);

    // Validate and set working directory
    if let Some(ref cwd) = options.working_directory {
        if !cwd.exists() {
            return Err(Error::invalid_working_directory(
                cwd.to_string_lossy(),
                std::io::Error::new(std::io::ErrorKind::NotFound, "Directory does not exist")
            ));
        }
        cmd.current_dir(cwd);
    }

    if options.clear_env {
        cmd.env_clear();
    }
    
    // Validate environment variables
    for (key, value) in &options.env_vars {
        if key.contains('\0') || value.contains('\0') {
            return Err(Error::invalid_environment_variable(
                key, 
                "Environment variable contains null bytes"
            ));
        }
        cmd.env(key, value);
    }

    cmd.stdin(convert_io(options.stdin));
    cmd.stdout(convert_io(options.stdout));
    cmd.stderr(convert_io(options.stderr));

    let child = cmd.spawn().map_err(|e| {
        match e.kind() {
            std::io::ErrorKind::NotFound => Error::OpenScriptNotFound,
            std::io::ErrorKind::PermissionDenied => Error::PermissionDenied,
            _ => Error::process_spawn_error(e),
        }
    })?;

    Ok(child)
}

fn convert_io(io_option: IoOptions) -> Stdio {
    match io_option {
        IoOptions::Inherit => Stdio::inherit(),
        IoOptions::Pipe => Stdio::piped(),
        IoOptions::Null => Stdio::null(),
    }
}

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

    #[tokio::test]
    async fn test_run_success() {
        let options = ScriptOptions::new().openscript_path("/bin/sh");
        let result = run("echo 'test'", options).await.unwrap();
        assert_eq!(result.exit_code, 0);
        assert!(result.stdout.contains("test"));
    }

    #[tokio::test]
    async fn test_run_empty_script() {
        let options = ScriptOptions::new().openscript_path("/bin/sh");
        let result = run("", options).await;
        assert!(result.is_err());
        assert!(matches!(result.unwrap_err(), Error::CommandFailed { .. }));
    }

    #[tokio::test]
    async fn test_run_with_timeout() {
        let options = ScriptOptions::new()
            .openscript_path("/bin/sh")
            .timeout(Duration::from_millis(100));
        let result = run("sleep 1", options).await.unwrap();
        assert!(result.timed_out);
    }

    #[tokio::test]
    async fn test_spawn_and_wait() -> crate::Result<()> {
        let options = ScriptOptions::new().openscript_path("/bin/sh");
        let spawn_result = spawn("echo 'spawned'", options).await?;
        let output = spawn_result.child.wait_with_output().await?;
        let stdout = String::from_utf8_lossy(&output.stdout);
        assert!(stdout.contains("spawned"));
        Ok(())
    }

    #[tokio::test]
    async fn test_invalid_working_directory() {
        let options = ScriptOptions::new()
            .openscript_path("/bin/sh")
            .working_directory("/nonexistent/directory");
        let result = run("echo 'test'", options).await;
        assert!(result.is_err());
        assert!(matches!(result.unwrap_err(), Error::InvalidWorkingDirectory { .. }));
    }

    #[tokio::test]
    async fn test_invalid_script_file() {
        let options = ScriptOptions::new().openscript_path("/bin/sh");
        let non_existent_path = PathBuf::from("/nonexistent/script.sh");
        let result = run_file(&non_existent_path, options).await;
        assert!(result.is_err());
        assert!(matches!(result.unwrap_err(), Error::ScriptReadError { .. }));
    }

    #[tokio::test]
    async fn test_error_retryability() {
        let timeout_error = Error::timeout(Duration::from_secs(5));
        assert!(timeout_error.is_retryable());

        let not_found_error = Error::OpenScriptNotFound;
        assert!(!not_found_error.is_retryable());
    }

    #[tokio::test]
    async fn test_user_friendly_messages() {
        let error = Error::OpenScriptNotFound;
        let message = error.user_message();
        assert!(message.contains("install OpenScript"));
    }
}