ralph-workflow 0.7.18

PROMPT-driven multi-agent orchestrator for git repos
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
use super::common::TestFixture;
use crate::files::llm_output_extraction::file_based_extraction::paths as xml_paths;
use crate::reducer::boundary::MainEffectHandler;
use crate::reducer::event::{ErrorEvent, PipelineEvent, WorkspaceIoErrorKind};
use crate::reducer::state::{PipelineState, ReviewValidatedOutcome};
use crate::reducer::ui_event::{UIEvent, XmlOutputContext, XmlOutputType};
use crate::workspace::MemoryWorkspace;
use crate::workspace::Workspace;
use std::io;
use std::path::{Path, PathBuf};

#[derive(Debug, Clone)]
struct ReadFailingWorkspace {
    inner: MemoryWorkspace,
    forbidden_read_path: PathBuf,
    kind: io::ErrorKind,
}

impl ReadFailingWorkspace {
    fn new(inner: MemoryWorkspace, forbidden_read_path: PathBuf, kind: io::ErrorKind) -> Self {
        Self {
            inner,
            forbidden_read_path,
            kind,
        }
    }
}

impl Workspace for ReadFailingWorkspace {
    fn root(&self) -> &Path {
        self.inner.root()
    }

    fn read(&self, relative: &Path) -> io::Result<String> {
        if relative == self.forbidden_read_path.as_path() {
            return Err(io::Error::new(self.kind, "read forbidden (test)"));
        }
        self.inner.read(relative)
    }

    fn read_bytes(&self, relative: &Path) -> io::Result<Vec<u8>> {
        self.inner.read_bytes(relative)
    }

    fn write(&self, relative: &Path, content: &str) -> io::Result<()> {
        self.inner.write(relative, content)
    }

    fn write_bytes(&self, relative: &Path, content: &[u8]) -> io::Result<()> {
        self.inner.write_bytes(relative, content)
    }

    fn append_bytes(&self, relative: &Path, content: &[u8]) -> io::Result<()> {
        self.inner.append_bytes(relative, content)
    }

    fn exists(&self, relative: &Path) -> bool {
        self.inner.exists(relative)
    }

    fn is_file(&self, relative: &Path) -> bool {
        self.inner.is_file(relative)
    }

    fn is_dir(&self, relative: &Path) -> bool {
        self.inner.is_dir(relative)
    }

    fn remove(&self, relative: &Path) -> io::Result<()> {
        self.inner.remove(relative)
    }

    fn remove_if_exists(&self, relative: &Path) -> io::Result<()> {
        self.inner.remove_if_exists(relative)
    }

    fn remove_dir_all(&self, relative: &Path) -> io::Result<()> {
        self.inner.remove_dir_all(relative)
    }

    fn remove_dir_all_if_exists(&self, relative: &Path) -> io::Result<()> {
        self.inner.remove_dir_all_if_exists(relative)
    }

    fn create_dir_all(&self, relative: &Path) -> io::Result<()> {
        self.inner.create_dir_all(relative)
    }

    fn read_dir(&self, relative: &Path) -> io::Result<Vec<crate::workspace::DirEntry>> {
        self.inner.read_dir(relative)
    }

    fn rename(&self, from: &Path, to: &Path) -> io::Result<()> {
        self.inner.rename(from, to)
    }

    fn write_atomic(&self, relative: &Path, content: &str) -> io::Result<()> {
        self.inner.write_atomic(relative, content)
    }

    fn set_readonly(&self, relative: &Path) -> io::Result<()> {
        self.inner.set_readonly(relative)
    }

    fn set_writable(&self, relative: &Path) -> io::Result<()> {
        self.inner.set_writable(relative)
    }
}

#[test]
fn test_validate_review_issues_xml_emits_event_with_xml_output() {
    let issues_xml =
        "<ralph-issues><ralph-no-issues-found>ok</ralph-no-issues-found></ralph-issues>";
    let workspace = MemoryWorkspace::new_test().with_file(xml_paths::ISSUES_XML, issues_xml);
    let mut fixture = TestFixture::with_workspace(workspace);
    let ctx = fixture.ctx();

    let handler = MainEffectHandler::new(PipelineState::initial(0, 1));
    let result = handler.validate_review_issues_xml(&ctx, 0);

    assert!(matches!(
        result.event,
        PipelineEvent::Review(crate::reducer::event::ReviewEvent::IssuesXmlValidated {
            pass: 0,
            clean_no_issues: true,
            issues,
            no_issues_found,
            ..
        }) if issues.is_empty() && no_issues_found.as_deref() == Some("ok")
    ));

    assert!(result.ui_events.iter().any(|event| matches!(
        event,
        UIEvent::XmlOutput {
            xml_type: XmlOutputType::ReviewIssues,
            content,
            context: Some(XmlOutputContext {
                pass: Some(0),
                ..
            }),
        } if content == issues_xml
    )));
}

#[test]
fn test_validate_fix_result_xml_emits_ui_output() {
    let fix_xml =
        "<ralph-fix-result><ralph-status>all_issues_addressed</ralph-status></ralph-fix-result>";
    let workspace = MemoryWorkspace::new_test().with_file(xml_paths::FIX_RESULT_XML, fix_xml);
    let mut fixture = TestFixture::with_workspace(workspace);
    let ctx = fixture.ctx();

    let handler = MainEffectHandler::new(PipelineState::initial(0, 1));
    let result = handler.validate_fix_result_xml(&ctx, 0);

    assert!(matches!(
        result.event,
        PipelineEvent::Review(crate::reducer::event::ReviewEvent::FixResultXmlValidated {
            pass: 0,
            ..
        })
    ));

    assert!(result.ui_events.iter().any(|event| matches!(
        event,
        UIEvent::XmlOutput {
            xml_type: XmlOutputType::FixResult,
            content,
            context: Some(XmlOutputContext {
                pass: Some(0),
                ..
            }),
        } if content == fix_xml
    )));
}

#[test]
fn test_write_issues_markdown_renders_from_validated_issues() {
    let mut fixture = TestFixture::new();
    let ctx = fixture.ctx();

    let mut handler = MainEffectHandler::new(PipelineState::initial(0, 1));
    handler.state.review_validated_outcome = Some(ReviewValidatedOutcome {
        pass: 0,
        issues_found: false,
        clean_no_issues: true,
        issues: Vec::new().into_boxed_slice(),
        no_issues_found: Some("No issues found.".to_string()),
    });

    let result = handler
        .write_issues_markdown(&ctx, 0)
        .expect("write_issues_markdown should succeed");

    assert!(matches!(
        result.event,
        PipelineEvent::Review(crate::reducer::event::ReviewEvent::IssuesMarkdownWritten {
            pass: 0
        })
    ));

    let content = fixture
        .workspace
        .read(Path::new(".agent/ISSUES.md"))
        .expect("ISSUES.md should be written");
    assert_eq!(content, "# Issues\n\nNo issues found.\n");
}

#[test]
fn test_write_issues_markdown_includes_skills_mcp_from_xml() {
    let issues_xml = r#"<ralph-issues>
<ralph-issue>src/main.rs:42 - Variable unused
<skills-mcp>
<skill reason="Start with failing test">test-driven-development</skill>
<mcp reason="Use for library research">context7</mcp>
</skills-mcp>
</ralph-issue>
</ralph-issues>"#;

    let workspace = MemoryWorkspace::new_test().with_file(xml_paths::ISSUES_XML, issues_xml);
    let mut fixture = TestFixture::with_workspace(workspace);
    let ctx = fixture.ctx();

    let mut handler = MainEffectHandler::new(PipelineState::initial(0, 1));
    handler.state.review_validated_outcome = Some(ReviewValidatedOutcome {
        pass: 0,
        issues_found: true,
        clean_no_issues: false,
        issues: vec!["src/main.rs:42 - Variable unused".to_string()].into_boxed_slice(),
        no_issues_found: None,
    });

    let result = handler
        .write_issues_markdown(&ctx, 0)
        .expect("write_issues_markdown should succeed");

    assert!(matches!(
        result.event,
        PipelineEvent::Review(crate::reducer::event::ReviewEvent::IssuesMarkdownWritten {
            pass: 0
        })
    ));

    let content = fixture
        .workspace
        .read(Path::new(".agent/ISSUES.md"))
        .expect("ISSUES.md should be written");

    assert!(
        content.contains("Variable unused"),
        "Should show issue text"
    );
    assert!(
        content.contains("test-driven-development"),
        "Should show skill name"
    );
    assert!(content.contains("context7"), "Should show mcp name");
    assert!(
        content.contains("Start with failing test"),
        "Should show skill reason"
    );
}

#[test]
fn test_extract_review_issue_snippets_includes_snippets_for_locations() {
    let issues_xml = "<ralph-issues><ralph-issue>[high] src/lib.rs:2 - adjust logic</ralph-issue></ralph-issues>";
    let workspace = MemoryWorkspace::new_test()
        .with_file(xml_paths::ISSUES_XML, issues_xml)
        .with_file("src/lib.rs", "fn main() {\n    let x = 1;\n}\n");
    let mut fixture = TestFixture::with_workspace(workspace);
    let ctx = fixture.ctx();

    let mut handler = MainEffectHandler::new(PipelineState::initial(0, 1));
    handler.state.review_validated_outcome = Some(ReviewValidatedOutcome {
        pass: 0,
        issues_found: true,
        clean_no_issues: false,
        issues: vec!["[high] src/lib.rs:2 - adjust logic".to_string()].into_boxed_slice(),
        no_issues_found: None,
    });
    let result = handler
        .extract_review_issue_snippets(&ctx, 0)
        .expect("extract_review_issue_snippets should succeed");

    assert!(matches!(
        result.event,
        PipelineEvent::Review(crate::reducer::event::ReviewEvent::IssueSnippetsExtracted {
            pass: 0
        })
    ));

    let snippets = result.ui_events.iter().find_map(|event| {
        if let UIEvent::XmlOutput { context, .. } = event {
            context.as_ref().map(|ctx| ctx.snippets.clone())
        } else {
            None
        }
    });

    let snippets = snippets.expect("expected XmlOutput context with snippets");
    assert_eq!(snippets.len(), 1);
    assert_eq!(snippets[0].file, "src/lib.rs");
    assert_eq!(snippets[0].line_start, 2);
    assert_eq!(snippets[0].line_end, 2);
    assert!(snippets[0].content.contains("2 |"));
    assert!(snippets[0].content.contains("let x = 1;"));
}

#[test]
fn test_extract_review_issue_snippets_includes_snippets_for_windows_paths() {
    let issues_xml =
        "<ralph-issues><ralph-issue>[high] C:\\repo\\src\\lib.rs:2 - adjust logic</ralph-issue></ralph-issues>";
    let workspace = MemoryWorkspace::new_test()
        .with_file("src/lib.rs", "fn main() {\n    let y = 2;\n}\n")
        .with_file(xml_paths::ISSUES_XML, issues_xml);
    let mut fixture = TestFixture::with_workspace(workspace);
    let ctx = fixture.ctx();

    let mut handler = MainEffectHandler::new(PipelineState::initial(0, 1));
    handler.state.review_validated_outcome = Some(ReviewValidatedOutcome {
        pass: 0,
        issues_found: true,
        clean_no_issues: false,
        issues: vec!["[high] C:\\repo\\src\\lib.rs:2 - adjust logic".to_string()]
            .into_boxed_slice(),
        no_issues_found: None,
    });
    let result = handler
        .extract_review_issue_snippets(&ctx, 0)
        .expect("extract_review_issue_snippets should succeed");

    assert!(matches!(
        result.event,
        PipelineEvent::Review(crate::reducer::event::ReviewEvent::IssueSnippetsExtracted {
            pass: 0
        })
    ));

    let snippets = result.ui_events.iter().find_map(|event| {
        if let UIEvent::XmlOutput { context, .. } = event {
            context.as_ref().map(|ctx| ctx.snippets.clone())
        } else {
            None
        }
    });

    let snippets = snippets.expect("expected XmlOutput context with snippets");
    assert_eq!(snippets.len(), 1);
    assert!(snippets[0].content.contains("2 |"));
    assert!(snippets[0].content.contains("let y = 2;"));
}

#[test]
fn test_extract_review_issue_snippets_surfaces_non_not_found_issues_xml_read_errors() {
    let inner =
        MemoryWorkspace::new_test().with_file("src/lib.rs", "fn main() {\n    let x = 1;\n}\n");
    let workspace = ReadFailingWorkspace::new(
        inner.clone(),
        PathBuf::from(xml_paths::ISSUES_XML),
        io::ErrorKind::PermissionDenied,
    );

    let mut fixture = TestFixture::with_workspace(inner);
    let ctx = fixture.ctx_with_workspace(&workspace);

    let mut handler = MainEffectHandler::new(PipelineState::initial(0, 1));
    handler.state.review_validated_outcome = Some(ReviewValidatedOutcome {
        pass: 0,
        issues_found: true,
        clean_no_issues: false,
        issues: vec!["[high] src/lib.rs:2 - adjust logic".to_string()].into_boxed_slice(),
        no_issues_found: None,
    });

    let err = handler.extract_review_issue_snippets(&ctx, 0).expect_err(
        "extract_review_issue_snippets should surface non-NotFound issues.xml read failures",
    );

    let error_event = err
        .downcast_ref::<ErrorEvent>()
        .expect("error should preserve ErrorEvent for event-loop recovery");
    assert!(
        matches!(
            error_event,
            ErrorEvent::WorkspaceReadFailed {
                path,
                kind: WorkspaceIoErrorKind::PermissionDenied
            } if path == xml_paths::ISSUES_XML
        ),
        "expected WorkspaceReadFailed for issues.xml read, got: {error_event:?}"
    );
}

#[test]
fn test_write_issues_markdown_returns_error_when_missing_validated_outcome() {
    let mut fixture = TestFixture::new();
    let ctx = fixture.ctx();

    let handler = MainEffectHandler::new(PipelineState::initial(0, 1));
    let err = handler
        .write_issues_markdown(&ctx, 0)
        .expect_err("write_issues_markdown should return error when validated outcome is missing");

    assert!(
        err.to_string().contains("validated review outcome"),
        "Expected error about missing validated review outcome, got: {err}"
    );
}