swink-agent 0.8.0

Core scaffolding for running LLM-powered agentic loops
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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
#![cfg(feature = "builtin-tools")]

use serde_json::json;
use tokio_util::sync::CancellationToken;

use swink_agent::ContentBlock;
use swink_agent::{AgentTool, BashTool, ReadFileTool, WriteFileTool};

// Cross-platform `sleep N seconds` command string for BashTool tests.
fn sleep_command(seconds: u32) -> String {
    if cfg!(windows) {
        // `ping -n K 127.0.0.1` waits ~(K-1) seconds. Add 1 for the target duration.
        format!("ping -n {} 127.0.0.1 > NUL", seconds + 1)
    } else {
        format!("sleep {seconds}")
    }
}

// ═══════════════════════════════════════════════════════════════════════════
// BashTool
// ═══════════════════════════════════════════════════════════════════════════

#[test]
fn bash_tool_metadata() {
    let tool = BashTool::new();
    assert_eq!(tool.name(), "bash");
    assert_eq!(tool.label(), "Bash");
    assert!(!tool.description().is_empty());

    let schema = tool.parameters_schema();
    let required = schema["required"]
        .as_array()
        .expect("required should be an array");
    assert!(
        required
            .iter()
            .filter_map(|v| v.as_str())
            .any(|x| x == "command"),
        "schema must require 'command'"
    );
}

#[tokio::test]
async fn bash_echo_success() {
    let tool = BashTool::new();
    let token = CancellationToken::new();
    let result = tool
        .execute(
            "tc_1",
            json!({"command": "echo hello"}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("Exit code: 0"),
        "expected exit code 0, got: {text}"
    );
    assert!(
        text.contains("hello"),
        "expected 'hello' in output, got: {text}"
    );
}

// Regression for #202: BashTool used to hardcode `sh -c`, which does not exist
// on Windows. This test spawns a command via the platform shell — on Windows
// that means `cmd /C`, on Unix `sh -c`. Failure here indicates the dispatch
// regressed.
#[tokio::test]
async fn bash_uses_platform_shell() {
    let tool = BashTool::new();
    let token = CancellationToken::new();
    let result = tool
        .execute(
            "tc_platform",
            json!({"command": "echo platform-ok"}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    assert!(
        !result.is_error,
        "spawning platform shell must succeed, got: {:?}",
        result.content
    );
    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("Exit code: 0") && text.contains("platform-ok"),
        "expected successful platform-shell dispatch, got: {text}"
    );
}

#[tokio::test]
async fn bash_exit_code_nonzero() {
    let tool = BashTool::new();
    let token = CancellationToken::new();
    let result = tool
        .execute(
            "tc_2",
            json!({"command": "exit 42"}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("Exit code: 42"),
        "expected exit code 42, got: {text}"
    );
}

#[tokio::test]
async fn bash_stderr_captured() {
    let tool = BashTool::new();
    let token = CancellationToken::new();
    let result = tool
        .execute(
            "tc_3",
            json!({"command": "echo err >&2"}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("Stderr:"),
        "expected Stderr section, got: {text}"
    );
    assert!(
        text.contains("err"),
        "expected 'err' in stderr, got: {text}"
    );
}

#[tokio::test]
async fn bash_invalid_params() {
    let tool = BashTool::new();
    let token = CancellationToken::new();
    let result = tool
        .execute(
            "tc_4",
            json!({}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("invalid parameters") || text.contains("error"),
        "expected error for missing command, got: {text}"
    );
}

#[tokio::test]
async fn bash_cancellation() {
    let tool = BashTool::new();
    let token = CancellationToken::new();
    token.cancel();
    let result = tool
        .execute(
            "tc_5",
            json!({"command": "echo should not run"}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("cancelled"),
        "expected cancelled, got: {text}"
    );
}

#[tokio::test]
async fn bash_timeout() {
    let tool = BashTool::new();
    let token = CancellationToken::new();
    let result = tool
        .execute(
            "tc_6",
            json!({"command": sleep_command(30), "timeout_ms": 100}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("timed out"),
        "expected timeout error, got: {text}"
    );
}

// Unix-only: uses `cat` and `>&2` which are not available in `cmd /C`.
#[cfg(unix)]
#[tokio::test]
async fn bash_output_truncation() {
    let tool = BashTool::new();
    let token = CancellationToken::new();
    // Generate output larger than MAX_OUTPUT_BYTES (100 * 1024 = 102400).
    // Split output across stdout (55KB) and stderr (55KB), each within the OS
    // pipe buffer limit, but combined (110KB) exceeding MAX_OUTPUT_BYTES.
    // This avoids a deadlock where the child blocks on a full pipe buffer
    // before exiting (stdout/stderr are read after child.wait()).
    let dir = tempfile::tempdir().expect("failed to create temp dir");
    let stdout_file = dir.path().join("stdout.txt");
    let stderr_file = dir.path().join("stderr.txt");
    std::fs::write(&stdout_file, "A".repeat(55_000)).expect("write stdout file");
    std::fs::write(&stderr_file, "B".repeat(55_000)).expect("write stderr file");
    let cmd = format!(
        "cat {} && cat {} >&2",
        stdout_file.display(),
        stderr_file.display()
    );
    let result = tool
        .execute(
            "tc_7",
            json!({"command": cmd}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("[truncated]"),
        "expected truncation marker, got length: {}",
        text.len()
    );
}

// Uses Unix-only utilities (`head`, `tr`, `/dev/zero`); skipped on Windows
// where the platform shell is `cmd /C` and cannot interpret them.
#[cfg(unix)]
#[tokio::test]
async fn bash_large_stdout_does_not_deadlock() {
    let tool = BashTool::new();
    let token = CancellationToken::new();
    let result = tokio::time::timeout(
        std::time::Duration::from_secs(5),
        tool.execute(
            "tc_8",
            json!({"command": "head -c 200000 /dev/zero | tr '\\000' A"}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        ),
    )
    .await
    .expect("bash tool should not deadlock on large stdout");

    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("Exit code: 0"),
        "expected success, got: {text}"
    );
}

// Unix-only: uses `head`, `tr`, `/dev/zero`, `&`, and `wait`.
#[cfg(unix)]
#[tokio::test]
async fn bash_large_stdout_and_stderr_do_not_deadlock() {
    let tool = BashTool::new();
    let token = CancellationToken::new();
    let result = tokio::time::timeout(
        std::time::Duration::from_secs(5),
        tool.execute(
            "tc_9",
            json!({"command": "(head -c 150000 /dev/zero | tr '\\000' A) & (head -c 150000 /dev/zero | tr '\\000' B >&2) & wait"}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        ),
    )
    .await
    .expect("bash tool should not deadlock on large stdout/stderr");

    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("Exit code: 0"),
        "expected success, got: {text}"
    );
    assert!(
        text.contains("Stdout:"),
        "expected stdout in result, got: {text}"
    );
    assert!(
        text.contains("Stderr:"),
        "expected stderr in result, got: {text}"
    );
}

// Unix-only: `yes` is not available on Windows `cmd`.
#[cfg(unix)]
#[tokio::test]
async fn bash_noisy_timeout_does_not_deadlock() {
    let tool = BashTool::new();
    let token = CancellationToken::new();
    let result = tokio::time::timeout(
        std::time::Duration::from_secs(5),
        tool.execute(
            "tc_10",
            json!({"command": "yes X", "timeout_ms": 100}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        ),
    )
    .await
    .expect("bash tool timeout should not deadlock under active output");

    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("timed out"),
        "expected timeout error, got: {text}"
    );
}

// ═══════════════════════════════════════════════════════════════════════════
// ReadFileTool
// ═══════════════════════════════════════════════════════════════════════════

#[test]
fn read_file_metadata() {
    let tool = ReadFileTool::new();
    assert_eq!(tool.name(), "read_file");
    assert_eq!(tool.label(), "Read File");
    assert!(!tool.description().is_empty());
}

#[tokio::test]
async fn read_file_success() {
    let tool = ReadFileTool::new();
    let token = CancellationToken::new();

    let dir = tempfile::tempdir().expect("failed to create temp dir");
    let file_path = dir.path().join("hello.txt");
    std::fs::write(&file_path, "hello world").expect("failed to write temp file");

    let result = tool
        .execute(
            "tc_1",
            json!({"path": file_path.to_str().unwrap()}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    let text = ContentBlock::extract_text(&result.content);
    assert_eq!(text, "hello world");
}

#[tokio::test]
async fn read_file_not_found() {
    let tool = ReadFileTool::new();
    let token = CancellationToken::new();
    let result = tool
        .execute(
            "tc_2",
            json!({"path": "/tmp/nonexistent_swink_agent_test_file_xyz"}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("failed to read file"),
        "expected read error, got: {text}"
    );
}

#[tokio::test]
async fn read_file_invalid_params() {
    let tool = ReadFileTool::new();
    let token = CancellationToken::new();
    let result = tool
        .execute(
            "tc_3",
            json!({}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("invalid parameters"),
        "expected invalid parameters error, got: {text}"
    );
}

#[tokio::test]
async fn read_file_cancellation() {
    let tool = ReadFileTool::new();
    let token = CancellationToken::new();
    token.cancel();
    let result = tool
        .execute(
            "tc_4",
            json!({"path": "/tmp/anything"}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("cancelled"),
        "expected cancelled, got: {text}"
    );
}

#[tokio::test]
async fn read_file_truncation() {
    let tool = ReadFileTool::new();
    let token = CancellationToken::new();

    let dir = tempfile::tempdir().expect("failed to create temp dir");
    let file_path = dir.path().join("big.txt");
    // Write a file larger than MAX_OUTPUT_BYTES (100 * 1024 = 102400).
    let big_content = "A".repeat(110_000);
    std::fs::write(&file_path, &big_content).expect("failed to write big file");

    let result = tool
        .execute(
            "tc_5",
            json!({"path": file_path.to_str().unwrap()}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("[truncated]"),
        "expected truncation marker, got length: {}",
        text.len()
    );
    // Verify the output is smaller than the input.
    assert!(
        text.len() < big_content.len(),
        "truncated output should be smaller than original"
    );
}

// ═══════════════════════════════════════════════════════════════════════════
// WriteFileTool
// ═══════════════════════════════════════════════════════════════════════════

#[test]
fn write_file_metadata() {
    let tool = WriteFileTool::new();
    assert_eq!(tool.name(), "write_file");
    assert_eq!(tool.label(), "Write File");
    assert!(!tool.description().is_empty());
}

#[tokio::test]
async fn write_file_success() {
    let tool = WriteFileTool::new();
    let token = CancellationToken::new();

    let dir = tempfile::tempdir().expect("failed to create temp dir");
    let file_path = dir.path().join("output.txt");

    let result = tool
        .execute(
            "tc_1",
            json!({"path": file_path.to_str().unwrap(), "content": "written by test"}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("Successfully wrote"),
        "expected success message, got: {text}"
    );

    let on_disk = std::fs::read_to_string(&file_path).expect("failed to read written file");
    assert_eq!(on_disk, "written by test");
}

#[tokio::test]
async fn write_file_creates_dirs() {
    let tool = WriteFileTool::new();
    let token = CancellationToken::new();

    let dir = tempfile::tempdir().expect("failed to create temp dir");
    let nested_path = dir.path().join("a").join("b").join("c").join("deep.txt");

    let result = tool
        .execute(
            "tc_2",
            json!({"path": nested_path.to_str().unwrap(), "content": "deep content"}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("Successfully wrote"),
        "expected success message, got: {text}"
    );

    let on_disk = std::fs::read_to_string(&nested_path).expect("failed to read nested file");
    assert_eq!(on_disk, "deep content");
}

#[tokio::test]
async fn write_file_invalid_params() {
    let tool = WriteFileTool::new();
    let token = CancellationToken::new();
    let result = tool
        .execute(
            "tc_3",
            json!({}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("invalid parameters"),
        "expected invalid parameters error, got: {text}"
    );
}

#[tokio::test]
async fn write_file_cancellation() {
    let tool = WriteFileTool::new();
    let token = CancellationToken::new();
    token.cancel();
    let result = tool
        .execute(
            "tc_4",
            json!({"path": "/tmp/anything", "content": "nope"}),
            token,
            None,
            std::sync::Arc::new(std::sync::RwLock::new(swink_agent::SessionState::new())),
            None,
        )
        .await;
    let text = ContentBlock::extract_text(&result.content);
    assert!(
        text.contains("cancelled"),
        "expected cancelled, got: {text}"
    );
}