ralph-agent-loop 0.4.0

A Rust CLI for managing AI agent loops with a structured JSON task queue
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
//! App command regression tests.
//!
//! Purpose:
//! - Verify `crate::commands::app` planning and launch behavior stays stable.
//!
//! Responsibilities:
//! - Exercise launch-target planning, URL handoff construction, encoding, and workspace resolution.
//! - Cover CLI path propagation and launcher failure reporting.
//!
//! Scope:
//! - Unit tests for app-command helpers only.
//!
//! Usage:
//! - Compiled via `cargo test` when the app command module is exercised.
//!
//! Invariants/assumptions:
//! - Tests avoid real app launches by inspecting planned command specs.
//! - URL planning must remain deterministic across environments.

use std::ffi::{OsStr, OsString};
use std::path::PathBuf;

use crate::cli::app::AppOpenArgs;

use super::launch_plan::{
    env_assignment_for_path, installed_app_candidates_for_home, plan_open_command,
    plan_open_command_with_installed_path,
};
use super::model::{DEFAULT_APP_NAME, GUI_CLI_BIN_ENV, OpenCommandSpec};
use super::runtime::execute_launch_command;
use super::url_plan::{
    percent_encode, percent_encode_path, plan_url_command_with_installed_path,
    resolve_workspace_path,
};

#[test]
fn plan_open_command_non_macos_errors() {
    let args = AppOpenArgs {
        bundle_id: None,
        path: None,
        workspace: None,
    };

    let err = plan_open_command(false, &args, None).expect_err("expected error");
    assert!(
        err.to_string().to_lowercase().contains("macos-only"),
        "unexpected error: {err:#}"
    );
}

#[test]
fn installed_app_candidates_prioritize_system_then_home() {
    let home = PathBuf::from("/Users/tester");
    let candidates = installed_app_candidates_for_home(Some(home.clone()));

    assert_eq!(
        candidates,
        vec![
            PathBuf::from("/Applications").join(DEFAULT_APP_NAME),
            home.join("Applications").join(DEFAULT_APP_NAME),
        ]
    );
}

#[test]
fn plan_open_command_bundle_id_override_uses_open_b_when_no_installed_app() -> anyhow::Result<()> {
    let args = AppOpenArgs {
        bundle_id: Some("com.example.override".to_string()),
        path: None,
        workspace: None,
    };

    let spec = plan_open_command(true, &args, None)?;
    assert_eq!(spec.program, OsString::from("open"));
    assert_eq!(
        spec.args,
        vec![
            OsStr::new("-b").to_os_string(),
            OsStr::new("com.example.override").to_os_string()
        ]
    );
    Ok(())
}

#[test]
fn plan_open_command_path_uses_open_a() -> anyhow::Result<()> {
    let temp = tempfile::tempdir()?;
    let app_dir = temp.path().join("Ralph.app");
    std::fs::create_dir_all(&app_dir)?;

    let args = AppOpenArgs {
        bundle_id: None,
        path: Some(app_dir.clone()),
        workspace: None,
    };

    let spec = plan_open_command(true, &args, None)?;
    assert_eq!(spec.program, OsString::from("open"));
    assert_eq!(
        spec.args,
        vec![
            OsStr::new("-a").to_os_string(),
            app_dir.as_os_str().to_os_string()
        ]
    );
    Ok(())
}

#[test]
fn plan_open_command_default_prefers_injected_installed_app_path() -> anyhow::Result<()> {
    let app_dir =
        crate::testsupport::path::portable_abs_path("test/Applications").join(DEFAULT_APP_NAME);
    let args = AppOpenArgs {
        bundle_id: None,
        path: None,
        workspace: None,
    };

    let spec = plan_open_command_with_installed_path(true, &args, None, Some(app_dir.clone()))?;

    assert_eq!(spec.program, OsString::from("open"));
    assert_eq!(
        spec.args,
        vec![
            OsStr::new("-a").to_os_string(),
            app_dir.as_os_str().to_os_string()
        ]
    );
    Ok(())
}

#[test]
fn plan_open_command_path_missing_errors() {
    let args = AppOpenArgs {
        bundle_id: None,
        path: Some(PathBuf::from("/definitely/not/a/real/path/Ralph.app")),
        workspace: None,
    };

    let err = plan_open_command(true, &args, None).expect_err("expected error");
    assert!(
        err.to_string().to_lowercase().contains("does not exist"),
        "unexpected error: {err:#}"
    );
}

#[test]
fn plan_url_command_encodes_workspace() -> anyhow::Result<()> {
    let workspace = PathBuf::from("/Users/test/my project");
    let spec = plan_url_command_with_installed_path(
        &workspace,
        &AppOpenArgs {
            bundle_id: None,
            path: None,
            workspace: None,
        },
        None,
        Some(PathBuf::from("/Applications").join(DEFAULT_APP_NAME)),
    )?;

    assert_eq!(spec.program, OsString::from("open"));
    assert_eq!(spec.args.len(), 3);
    assert_eq!(spec.args[0], OsString::from("-a"));

    let url = spec.args[2].to_str().unwrap();
    assert!(url.starts_with("ralph://open?workspace="));
    assert!(
        url.contains("my%20project"),
        "space should be percent-encoded"
    );
    Ok(())
}

#[test]
fn plan_url_command_handles_special_chars() -> anyhow::Result<()> {
    let workspace = PathBuf::from("/path/with&special=chars");
    let spec = plan_url_command_with_installed_path(
        &workspace,
        &AppOpenArgs {
            bundle_id: None,
            path: None,
            workspace: None,
        },
        None,
        Some(PathBuf::from("/Applications").join(DEFAULT_APP_NAME)),
    )?;

    let url = spec.args.last().unwrap().to_str().unwrap();
    assert!(url.contains("%26"), "& should be encoded as %26");
    assert!(url.contains("%3D"), "= should be encoded as %3D");
    Ok(())
}

#[test]
fn percent_encode_preserves_unreserved_chars() {
    let input = b"abc-_.~/123";
    let encoded = percent_encode(input);
    assert_eq!(encoded, "abc-_.~/123");
}

#[test]
fn percent_encode_encodes_reserved_chars() {
    let input = b"hello world";
    let encoded = percent_encode(input);
    assert_eq!(encoded, "hello%20world");
}

#[test]
fn percent_encode_encodes_unicode() {
    let input = "test/文件".as_bytes();
    let encoded = percent_encode(input);
    assert!(encoded.starts_with("test/"));
    assert!(encoded.len() > "test/文件".len());
}

#[test]
fn percent_encode_path_handles_spaces() {
    let path = PathBuf::from("/Users/test/my project");
    let encoded = percent_encode_path(&path);
    assert!(encoded.contains("%20"), "spaces should be encoded as %20");
    assert!(
        !encoded.contains(' '),
        "result should not contain literal spaces"
    );
}

#[test]
fn percent_encode_path_preserves_path_structure() {
    let path = PathBuf::from("/path/to/directory");
    let encoded = percent_encode_path(&path);
    assert!(encoded.starts_with("/path/to/"));
    assert!(encoded.contains('/'));
}

#[test]
fn plan_open_command_includes_cli_env_when_provided() -> anyhow::Result<()> {
    let args = AppOpenArgs {
        bundle_id: None,
        path: None,
        workspace: None,
    };
    let cli = crate::testsupport::path::portable_abs_path("ralph-bin");

    let spec = plan_open_command(true, &args, Some(&cli))?;
    assert_eq!(spec.program, OsString::from("open"));
    assert!(spec.args.len() >= 4);
    assert_eq!(spec.args[0], OsString::from("--env"));
    assert_eq!(spec.args[1], env_assignment_for_path(&cli));
    assert!(
        spec.args[2] == "-a" || spec.args[2] == "-b",
        "unexpected launch args: {:?}",
        spec.args
    );
    Ok(())
}

#[test]
fn plan_url_command_never_includes_cli_param() -> anyhow::Result<()> {
    let workspace = PathBuf::from("/Users/test/workspace");
    let spec = plan_url_command_with_installed_path(
        &workspace,
        &AppOpenArgs {
            bundle_id: None,
            path: None,
            workspace: None,
        },
        None,
        Some(PathBuf::from("/Applications").join(DEFAULT_APP_NAME)),
    )?;

    let url = spec.args.last().unwrap().to_string_lossy();
    assert!(url.starts_with("ralph://open?workspace="));
    assert!(!url.contains("&cli="));
    Ok(())
}

#[test]
fn plan_url_command_prefers_installed_app_path_over_bundle_lookup() -> anyhow::Result<()> {
    let app_dir =
        crate::testsupport::path::portable_abs_path("test/Applications").join(DEFAULT_APP_NAME);
    let workspace = PathBuf::from("/Users/test/workspace");
    let spec = plan_url_command_with_installed_path(
        &workspace,
        &AppOpenArgs {
            bundle_id: None,
            path: None,
            workspace: None,
        },
        None,
        Some(app_dir.clone()),
    )?;

    assert_eq!(spec.program, OsString::from("open"));
    assert_eq!(spec.args[0], OsString::from("-a"));
    assert_eq!(spec.args[1], app_dir.as_os_str().to_os_string());
    assert!(
        spec.args[2]
            .to_string_lossy()
            .starts_with("ralph://open?workspace=")
    );
    Ok(())
}

#[test]
fn plan_url_command_bundle_id_uses_open_launcher() -> anyhow::Result<()> {
    let workspace = PathBuf::from("/Users/test/workspace");
    let spec = plan_url_command_with_installed_path(
        &workspace,
        &AppOpenArgs {
            bundle_id: Some("com.example.override".to_string()),
            path: None,
            workspace: None,
        },
        None,
        Some(PathBuf::from("/Applications").join(DEFAULT_APP_NAME)),
    )?;

    assert_eq!(spec.program, OsString::from("open"));
    assert_eq!(spec.args[0], OsString::from("-b"));
    assert_eq!(spec.args[1], OsString::from("com.example.override"));
    assert!(
        spec.args[2]
            .to_string_lossy()
            .starts_with("ralph://open?workspace=")
    );
    Ok(())
}

#[test]
fn plan_url_command_includes_cli_env_when_provided() -> anyhow::Result<()> {
    let workspace = PathBuf::from("/Users/test/workspace");
    let cli = crate::testsupport::path::portable_abs_path("ralph-bin");
    let spec = plan_url_command_with_installed_path(
        &workspace,
        &AppOpenArgs {
            bundle_id: Some("com.example.override".to_string()),
            path: None,
            workspace: None,
        },
        Some(&cli),
        Some(PathBuf::from("/Applications").join(DEFAULT_APP_NAME)),
    )?;

    assert_eq!(spec.program, OsString::from("open"));
    assert_eq!(spec.args[0], OsString::from("--env"));
    assert_eq!(spec.args[1], env_assignment_for_path(&cli));
    assert_eq!(spec.args[2], OsString::from("-b"));
    assert_eq!(spec.args[3], OsString::from("com.example.override"));
    assert!(
        spec.args[4]
            .to_string_lossy()
            .starts_with("ralph://open?workspace=")
    );
    Ok(())
}

#[test]
fn env_assignment_prefixes_variable_name() {
    let cli = crate::testsupport::path::portable_abs_path("ralph");
    let assignment = env_assignment_for_path(&cli);
    let text = assignment.to_string_lossy();
    assert!(text.starts_with(&format!("{GUI_CLI_BIN_ENV}=")));
    assert!(text.ends_with(&*cli.to_string_lossy()));
}

#[cfg(unix)]
#[test]
fn execute_launch_command_surfaces_launcher_failure() {
    let spec = OpenCommandSpec {
        program: OsString::from("/bin/sh"),
        args: vec![
            OsString::from("-c"),
            OsString::from("printf 'launch failed' >&2; exit 9"),
        ],
    };

    let err = execute_launch_command(&spec).expect_err("expected launcher failure");
    let text = format!("{err:#}");
    assert!(text.contains("spawn macOS app launch command"));
    assert!(text.contains("launch failed"));
}

#[test]
fn resolve_workspace_path_prefers_explicit_workspace() -> anyhow::Result<()> {
    let temp = tempfile::tempdir()?;
    let args = AppOpenArgs {
        bundle_id: None,
        path: None,
        workspace: Some(temp.path().to_path_buf()),
    };

    let resolved = resolve_workspace_path(&args)?;
    assert_eq!(resolved.as_deref(), Some(temp.path()));
    Ok(())
}

#[test]
fn resolve_workspace_path_errors_for_missing_workspace() {
    let args = AppOpenArgs {
        bundle_id: None,
        path: None,
        workspace: Some(PathBuf::from("/definitely/not/a/real/workspace")),
    };

    let err = resolve_workspace_path(&args).expect_err("expected error");
    assert!(
        err.to_string().contains("Workspace path does not exist"),
        "unexpected error: {err:#}"
    );
}