soushi 0.1.1

Soushi (草紙) — Rhai scripting engine: shared engine setup, builtins, and script loading
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

//! Integration tests for the script loader against fixture scripts.

use std::path::Path;

use soushi::ScriptEngine;

/// Path to the checked-in fixture scripts.
fn fixtures_dir() -> &'static Path {
    Path::new(concat!(env!("CARGO_MANIFEST_DIR"), "/tests/fixtures"))
}

#[test]
fn load_fixtures_discovers_only_rhai_files() {
    let mut engine = ScriptEngine::new();
    engine.register_all_builtins();

    let names = engine.load_scripts_dir(fixtures_dir()).unwrap();

    assert_eq!(names.len(), 3, "expected 3 .rhai fixtures, got: {names:?}");
    assert!(!names.contains(&"not_a_script".to_string()));
}

#[test]
fn load_fixtures_returns_sorted_stems() {
    let mut engine = ScriptEngine::new();
    engine.register_all_builtins();

    let names = engine.load_scripts_dir(fixtures_dir()).unwrap();

    assert_eq!(names, vec!["01_math", "02_strings", "03_functions"]);
}

#[test]
fn eval_math_fixture() {
    let engine = ScriptEngine::new();
    let result = engine
        .eval_file(fixtures_dir().join("01_math.rhai"))
        .unwrap();
    assert_eq!(result.as_int().unwrap(), 30);
}

#[test]
fn eval_string_fixture_requires_builtins() {
    let engine = ScriptEngine::new();
    let result = engine.eval_file(fixtures_dir().join("02_strings.rhai"));
    assert!(result.is_err(), "should fail without string builtins");
}

#[test]
fn eval_string_fixture_with_builtins() {
    let mut engine = ScriptEngine::new();
    engine.register_builtin_string();

    let result = engine
        .eval_file(fixtures_dir().join("02_strings.rhai"))
        .unwrap();
    assert_eq!(result.into_string().unwrap(), "HI");
}

#[test]
fn eval_function_fixture() {
    let engine = ScriptEngine::new();
    let result = engine
        .eval_file(fixtures_dir().join("03_functions.rhai"))
        .unwrap();
    assert_eq!(result.as_int().unwrap(), 23);
}

#[test]
fn register_all_builtins_enables_all_families() {
    let mut engine = ScriptEngine::new();
    engine.register_all_builtins();

    let _ = engine.eval(r#"log_info("test")"#).unwrap();

    let upper = engine.eval(r#"str_upper("hello")"#).unwrap();
    assert_eq!(upper.into_string().unwrap(), "HELLO");

    let exists = engine
        .eval(r#"env_exists("SOUSHI_UNLIKELY_VAR_ABCDEF")"#)
        .unwrap();
    assert!(!exists.as_bool().unwrap());
}

#[test]
fn load_scripts_dir_with_builtins_succeeds() {
    let mut engine = ScriptEngine::new();
    engine.register_all_builtins();

    let names = engine.load_scripts_dir(fixtures_dir()).unwrap();
    assert_eq!(names.len(), 3);
}

#[test]
fn compile_and_reuse_fixture_script() {
    let engine = ScriptEngine::new();
    let source = std::fs::read_to_string(fixtures_dir().join("01_math.rhai")).unwrap();
    let ast = engine.compile(&source).unwrap();

    let r1 = engine.eval_ast(&ast).unwrap();
    let r2 = engine.eval_ast(&ast).unwrap();
    assert_eq!(r1.as_int().unwrap(), 30);
    assert_eq!(r2.as_int().unwrap(), 30);
}

#[test]
fn eval_file_nonexistent_produces_io_error() {
    let engine = ScriptEngine::new();
    let err = engine
        .eval_file(Path::new("/tmp/soushi_no_such_file.rhai"))
        .unwrap_err();
    assert!(
        matches!(err, soushi::SoushiError::ScriptFileNotFound(_)),
        "expected ScriptFileNotFound, got: {err:?}"
    );
}

#[test]
fn load_scripts_dir_nonexistent_produces_io_error() {
    let mut engine = ScriptEngine::new();
    let err = engine
        .load_scripts_dir(Path::new("/tmp/soushi_no_such_dir"))
        .unwrap_err();
    assert!(
        matches!(err, soushi::SoushiError::ScriptDirNotFound(_)),
        "expected ScriptDirNotFound, got: {err:?}"
    );
}