a3s-code-core 5.2.7

A3S Code Core - Embeddable AI agent library with tool execution
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
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
use super::*;
use crate::workspace::{
    CommandOutput, CommandRequest, WorkspaceCommandRunner, WorkspaceDirEntry, WorkspaceError,
    WorkspaceFileSystem, WorkspaceFileType, WorkspacePath, WorkspaceRef, WorkspaceResult,
    WorkspaceServices, WorkspaceWriteOutcome,
};
use async_trait::async_trait;
use std::sync::RwLock;

#[test]
fn test_redacted_tool_log_summary_omits_values() {
    let args = serde_json::json!({
        "command": "export AWS_SECRET_ACCESS_KEY=AKIAIOSFODNN7EXAMPLE && deploy",
        "timeout": 30
    });
    let summary = redacted_tool_log_summary("bash", &args);
    // Field names and size are logged...
    assert!(summary.contains("bash"));
    assert!(summary.contains("command"));
    assert!(summary.contains("timeout"));
    assert!(summary.contains("bytes"));
    // ...but never the values (the secret must not appear).
    assert!(!summary.contains("AKIAIOSFODNN7EXAMPLE"));
    assert!(!summary.contains("deploy"));
}

#[test]
fn test_redacted_tool_log_summary_handles_non_object_args() {
    let summary = redacted_tool_log_summary("noop", &serde_json::json!("raw string"));
    assert!(summary.contains("noop"));
    assert!(summary.contains("arg_keys=[]"));
    assert!(!summary.contains("raw string"));
}

struct LargeArtifactTool;

#[async_trait]
impl Tool for LargeArtifactTool {
    fn name(&self) -> &str {
        "large_artifact"
    }

    fn description(&self) -> &str {
        "Produces large output for artifact API tests"
    }

    fn parameters(&self) -> serde_json::Value {
        serde_json::json!({
            "type": "object",
            "additionalProperties": false,
            "properties": {},
            "required": []
        })
    }

    async fn execute(&self, args: &serde_json::Value, _ctx: &ToolContext) -> Result<ToolOutput> {
        let suffix = args
            .get("suffix")
            .and_then(|value| value.as_str())
            .unwrap_or_default();
        Ok(ToolOutput::success(format!(
            "{}{}",
            "z".repeat(MAX_OUTPUT_SIZE + 1),
            suffix
        )))
    }
}

struct EchoTool;

#[async_trait]
impl Tool for EchoTool {
    fn name(&self) -> &str {
        "echo"
    }

    fn description(&self) -> &str {
        "Echoes the message argument"
    }

    fn parameters(&self) -> serde_json::Value {
        serde_json::json!({
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "message": { "type": "string" }
            },
            "required": ["message"]
        })
    }

    async fn execute(&self, args: &serde_json::Value, _ctx: &ToolContext) -> Result<ToolOutput> {
        Ok(ToolOutput::success(
            args["message"].as_str().unwrap_or_default(),
        ))
    }
}

#[derive(Default)]
struct MemoryWorkspaceFs {
    files: RwLock<HashMap<String, String>>,
}

impl MemoryWorkspaceFs {
    fn insert(&self, path: &str, content: &str) {
        self.files
            .write()
            .unwrap()
            .insert(path.to_string(), content.to_string());
    }

    fn get(&self, path: &str) -> Option<String> {
        self.files.read().unwrap().get(path).cloned()
    }
}

#[async_trait]
impl WorkspaceFileSystem for MemoryWorkspaceFs {
    async fn read_text(&self, path: &WorkspacePath) -> WorkspaceResult<String> {
        self.files
            .read()
            .unwrap()
            .get(path.as_str())
            .cloned()
            .ok_or_else(|| WorkspaceError::NotFound {
                path: path.as_str().to_string(),
            })
    }

    async fn write_text(
        &self,
        path: &WorkspacePath,
        content: &str,
    ) -> WorkspaceResult<WorkspaceWriteOutcome> {
        self.insert(path.as_str(), content);
        Ok(WorkspaceWriteOutcome {
            bytes: content.len(),
            lines: content.lines().count(),
        })
    }

    async fn list_dir(&self, path: &WorkspacePath) -> WorkspaceResult<Vec<WorkspaceDirEntry>> {
        let prefix = if path.is_root() {
            String::new()
        } else {
            format!("{}/", path.as_str())
        };
        let files = self.files.read().unwrap();
        let mut entries = Vec::new();
        for name in files.keys() {
            if !name.starts_with(&prefix) {
                continue;
            }
            let remaining = &name[prefix.len()..];
            if remaining.is_empty() || remaining.contains('/') {
                continue;
            }
            entries.push(WorkspaceDirEntry {
                name: remaining.to_string(),
                kind: WorkspaceFileType::File,
                size: files
                    .get(name)
                    .map(|content| content.len() as u64)
                    .unwrap_or(0),
            });
        }
        Ok(entries)
    }
}

struct MockCommandRunner;

#[async_trait]
impl WorkspaceCommandRunner for MockCommandRunner {
    async fn exec(&self, request: CommandRequest) -> Result<CommandOutput> {
        Ok(CommandOutput {
            output: format!("remote: {}\n", request.command),
            exit_code: 0,
            timed_out: false,
        })
    }
}

#[tokio::test]
async fn test_tool_executor_creation() {
    let executor = ToolExecutor::new("/tmp".to_string());
    // Baseline tools on a raw ToolExecutor: 13
    assert_eq!(executor.registry.len(), 13);
}

#[tokio::test]
async fn test_unknown_tool() {
    let executor = ToolExecutor::new("/tmp".to_string());
    let result = executor
        .execute("unknown", &serde_json::json!({}))
        .await
        .unwrap();
    assert_eq!(result.exit_code, 1);
    assert!(result.output.contains("Unknown tool"));
}

#[tokio::test]
async fn test_builtin_tools_registered() {
    let executor = ToolExecutor::new("/tmp".to_string());
    let definitions = executor.definitions();

    assert!(definitions.iter().any(|t| t.name == "bash"));
    assert!(definitions.iter().any(|t| t.name == "read"));
    assert!(definitions.iter().any(|t| t.name == "write"));
    assert!(definitions.iter().any(|t| t.name == "edit"));
    assert!(definitions.iter().any(|t| t.name == "grep"));
    assert!(definitions.iter().any(|t| t.name == "glob"));
    assert!(definitions.iter().any(|t| t.name == "ls"));
    assert!(definitions.iter().any(|t| t.name == "patch"));
    assert!(definitions.iter().any(|t| t.name == "web_fetch"));
    assert!(definitions.iter().any(|t| t.name == "web_search"));
    assert!(definitions.iter().any(|t| t.name == "batch"));
}

#[tokio::test]
async fn test_builtin_file_tools_use_workspace_services() {
    let fs = Arc::new(MemoryWorkspaceFs::default());
    fs.insert("remote.txt", "first\nsecond\n");
    let services = WorkspaceServices::builder(
        WorkspaceRef::new("browser-workspace", "browser://workspace"),
        fs.clone(),
    )
    .build();
    let executor = ToolExecutor::new_with_workspace_services_and_artifact_limits(
        "/server/local-placeholder".to_string(),
        services,
        ArtifactStoreLimits::default(),
    );
    let definitions = executor.definitions();
    assert!(definitions.iter().any(|tool| tool.name == "read"));
    assert!(definitions.iter().any(|tool| tool.name == "write"));
    assert!(definitions.iter().any(|tool| tool.name == "ls"));
    assert!(!definitions.iter().any(|tool| tool.name == "bash"));
    assert!(!definitions.iter().any(|tool| tool.name == "grep"));
    assert!(definitions.iter().any(|tool| tool.name == "edit"));
    assert!(definitions.iter().any(|tool| tool.name == "patch"));

    let read = executor
        .execute("read", &serde_json::json!({"file_path": "remote.txt"}))
        .await
        .unwrap();
    assert_eq!(read.exit_code, 0);
    assert!(read.output.contains("first"));

    let write = executor
        .execute(
            "write",
            &serde_json::json!({"file_path": "created.txt", "content": "remote write\n"}),
        )
        .await
        .unwrap();
    assert_eq!(write.exit_code, 0);
    assert_eq!(fs.get("created.txt").unwrap(), "remote write\n");

    let ls = executor
        .execute("ls", &serde_json::json!({}))
        .await
        .unwrap();
    assert_eq!(ls.exit_code, 0);
    assert!(ls.output.contains("created.txt"));
    assert!(ls.output.contains("remote.txt"));
}

#[tokio::test]
async fn test_bash_uses_workspace_command_runner() {
    let fs = Arc::new(MemoryWorkspaceFs::default());
    let fs_backend: Arc<dyn WorkspaceFileSystem> = fs;
    let services = WorkspaceServices::builder(
        WorkspaceRef::new("remote-workspace", "remote://workspace"),
        fs_backend,
    )
    .command_runner(Arc::new(MockCommandRunner))
    .build();
    let executor = ToolExecutor::new_with_workspace_services_and_artifact_limits(
        "/server/local-placeholder".to_string(),
        services,
        ArtifactStoreLimits::default(),
    );
    assert!(executor
        .definitions()
        .iter()
        .any(|tool| tool.name == "bash"));

    let result = executor
        .execute("bash", &serde_json::json!({"command": "pwd"}))
        .await
        .unwrap();

    assert_eq!(result.exit_code, 0);
    assert_eq!(result.output, "remote: pwd\n");
}

#[tokio::test]
async fn test_command_env_is_available_on_default_context() {
    let temp = tempfile::tempdir().unwrap();
    let mut env = HashMap::new();
    env.insert(
        "A3S_COMMAND_ENV_TEST".to_string(),
        "registry-env".to_string(),
    );

    let executor = ToolExecutor::new(temp.path().to_string_lossy().to_string());
    executor.registry().set_command_env(Arc::new(env));
    let context = executor.registry().context();
    assert_eq!(
        context
            .command_env
            .as_ref()
            .and_then(|env| env.get("A3S_COMMAND_ENV_TEST"))
            .map(String::as_str),
        Some("registry-env")
    );

    #[cfg(windows)]
    let command = "Write-Output $env:A3S_COMMAND_ENV_TEST";
    #[cfg(not(windows))]
    let command = "printf '%s' \"$A3S_COMMAND_ENV_TEST\"";

    let result = executor
        .execute("bash", &serde_json::json!({ "command": command }))
        .await
        .unwrap();

    assert_eq!(result.exit_code, 0, "{}", result.output);
    assert!(result.output.contains("registry-env"));
}

#[tokio::test]
async fn test_execute_applies_workspace_boundary_for_default_context() {
    let workspace = tempfile::tempdir().unwrap();
    let outside = tempfile::tempdir().unwrap();
    std::fs::write(outside.path().join("secret.txt"), "secret").unwrap();

    let executor = ToolExecutor::new(workspace.path().to_string_lossy().to_string());
    let result = executor
        .execute(
            "grep",
            &serde_json::json!({
                "pattern": "secret",
                "path": outside.path().to_string_lossy()
            }),
        )
        .await
        .unwrap();

    assert_eq!(result.exit_code, 1);
    assert!(result.output.contains("Workspace boundary"));
    assert!(result.output.contains("escapes workspace"));
}

#[test]
fn test_tool_result_success() {
    let result = ToolResult::success("test_tool", "output text".to_string());
    assert_eq!(result.name, "test_tool");
    assert_eq!(result.output, "output text");
    assert_eq!(result.exit_code, 0);
    assert!(result.metadata.is_none());
}

#[test]
fn test_tool_result_error() {
    let result = ToolResult::error("test_tool", "error message".to_string());
    assert_eq!(result.name, "test_tool");
    assert_eq!(result.output, "error message");
    assert_eq!(result.exit_code, 1);
    assert!(result.metadata.is_none());
}

#[test]
fn test_tool_result_from_tool_output_success() {
    let output = ToolOutput {
        content: "success content".to_string(),
        success: true,
        metadata: None,
        images: Vec::new(),
        error_kind: None,
    };
    let result: ToolResult = output.into();
    assert_eq!(result.output, "success content");
    assert_eq!(result.exit_code, 0);
    assert!(result.metadata.is_none());
}

#[test]
fn test_tool_result_from_tool_output_failure() {
    let output = ToolOutput {
        content: "failure content".to_string(),
        success: false,
        metadata: Some(serde_json::json!({"error": "test"})),
        images: Vec::new(),
        error_kind: None,
    };
    let result: ToolResult = output.into();
    assert_eq!(result.output, "failure content");
    assert_eq!(result.exit_code, 1);
    assert_eq!(result.metadata, Some(serde_json::json!({"error": "test"})));
}

#[test]
fn test_tool_result_metadata_propagation() {
    let output = ToolOutput::success("content")
        .with_metadata(serde_json::json!({"_load_skill": true, "skill_name": "test"}));
    let result: ToolResult = output.into();
    assert_eq!(result.exit_code, 0);
    let meta = result.metadata.unwrap();
    assert_eq!(meta["_load_skill"], true);
    assert_eq!(meta["skill_name"], "test");
}

#[test]
fn test_tool_executor_workspace() {
    let executor = ToolExecutor::new("/test/workspace".to_string());
    assert_eq!(executor.workspace().to_str().unwrap(), "/test/workspace");
}

#[test]
fn test_tool_executor_registry() {
    let executor = ToolExecutor::new("/tmp".to_string());
    let registry = executor.registry();
    // Baseline tools on a raw ToolExecutor: 13
    assert_eq!(registry.len(), 13);
}

#[tokio::test]
async fn test_tool_executor_get_artifact() {
    let executor = ToolExecutor::new("/tmp".to_string());
    executor.register_dynamic_tool(Arc::new(LargeArtifactTool));

    let result = executor
        .execute("large_artifact", &serde_json::json!({}))
        .await
        .unwrap();

    let artifact_uri = result.metadata.as_ref().unwrap()["artifact"]["artifact_uri"]
        .as_str()
        .unwrap();
    let artifact = executor.get_artifact(artifact_uri).expect("artifact");
    assert_eq!(artifact.tool_name, "large_artifact");
    assert_eq!(artifact.content.len(), MAX_OUTPUT_SIZE + 1);
    assert!(executor.artifact_store().get(artifact_uri).is_some());
}

#[tokio::test]
async fn test_tool_executor_respects_artifact_limits() {
    let executor = ToolExecutor::new_with_artifact_limits(
        "/tmp".to_string(),
        ArtifactStoreLimits {
            max_artifacts: 1,
            max_bytes: usize::MAX,
        },
    );
    executor.register_dynamic_tool(Arc::new(LargeArtifactTool));

    let first = executor
        .execute("large_artifact", &serde_json::json!({}))
        .await
        .unwrap();
    let first_uri = first.metadata.as_ref().unwrap()["artifact"]["artifact_uri"]
        .as_str()
        .unwrap()
        .to_string();

    executor
        .execute("large_artifact", &serde_json::json!({ "suffix": "again" }))
        .await
        .unwrap();

    assert_eq!(executor.artifact_store().limits().max_artifacts, 1);
    assert_eq!(executor.artifact_store().len(), 1);
    assert!(executor.get_artifact(&first_uri).is_none());
}

#[tokio::test]
async fn test_tool_executor_register_program_catalog_keeps_script_only_program_tool() {
    let executor = ToolExecutor::new("/tmp".to_string());
    let trace_sink = crate::trace::InMemoryTraceSink::default();
    executor.set_trace_sink(Arc::new(trace_sink.clone()));
    executor.register_dynamic_tool(Arc::new(EchoTool));
    let mut catalog = crate::program::ProgramCatalog::new();
    catalog.register(
        crate::program::ProgramTemplate::new("custom_echo", "Run a custom echo program")
            .with_parameter(crate::program::ProgramParameter::required(
                "message",
                "Message to echo",
            ))
            .with_step(
                crate::program::ProgramStepTemplate::new(
                    "echo",
                    serde_json::json!({ "message": "{{message}}" }),
                )
                .with_label("echo_message"),
            ),
    );
    executor.register_program_catalog(catalog);

    let result = executor
        .execute(
            "program",
            &serde_json::json!({
                "name": "custom_echo",
                "inputs": {
                    "message": "hello from catalog"
                }
            }),
        )
        .await
        .unwrap();

    assert_eq!(result.exit_code, 1);
    assert!(result.output.contains("type parameter is required"));

    let events = trace_sink.events();
    assert!(events.iter().any(|event| {
        event.kind == crate::trace::TraceEventKind::ToolExecution && event.name == "program"
    }));
    assert!(!events.iter().any(|event| {
        event.kind == crate::trace::TraceEventKind::ToolExecution && event.name == "echo"
    }));
}

#[test]
fn test_max_output_size_constant() {
    assert_eq!(MAX_OUTPUT_SIZE, 100 * 1024);
}

#[test]
fn test_max_read_lines_constant() {
    assert_eq!(MAX_READ_LINES, 2000);
}

#[test]
fn test_max_line_length_constant() {
    assert_eq!(MAX_LINE_LENGTH, 2000);
}

#[test]
fn test_truncate_tool_output_with_artifact_reference() {
    let output = "x".repeat(MAX_OUTPUT_SIZE + 1);
    let truncated = truncate_tool_output_with_artifact("test/tool", &output);

    let artifact = truncated.artifact.expect("artifact");
    assert!(truncated.content.contains("Full output artifact:"));
    assert_eq!(artifact.original_bytes, MAX_OUTPUT_SIZE + 1);
    assert_eq!(artifact.shown_bytes, MAX_OUTPUT_SIZE);
    assert!(artifact.artifact_id.starts_with("tool-output:test_tool:"));
    assert!(artifact
        .artifact_uri
        .starts_with("a3s://tool-output/test_tool/"));
}

#[test]
fn test_tool_result_clone() {
    let result = ToolResult::success("test", "output".to_string());
    let cloned = result.clone();
    assert_eq!(result.name, cloned.name);
    assert_eq!(result.output, cloned.output);
    assert_eq!(result.exit_code, cloned.exit_code);
    assert_eq!(result.metadata, cloned.metadata);
}

#[test]
fn test_tool_result_debug() {
    let result = ToolResult::success("test", "output".to_string());
    let debug_str = format!("{:?}", result);
    assert!(debug_str.contains("test"));
    assert!(debug_str.contains("output"));
}

#[tokio::test]
async fn test_execute_attaches_diff_metadata() {
    use tempfile::TempDir;
    let dir = TempDir::new().unwrap();
    let file = dir.path().join("hello.txt");
    std::fs::write(&file, "before content\n").unwrap();

    let executor = ToolExecutor::new(dir.path().to_str().unwrap().to_string());
    let args = serde_json::json!({
        "file_path": "hello.txt",
        "content": "after content\n"
    });
    let result = executor.execute("write", &args).await.unwrap();

    let meta = result.metadata.expect("metadata should be present");
    assert_eq!(meta["before"], "before content\n");
    assert_eq!(meta["after"], "after content\n");
    assert_eq!(meta["file_path"], "hello.txt");
}

#[tokio::test]
async fn test_execute_with_context_attaches_diff_metadata() {
    use tempfile::TempDir;
    let dir = TempDir::new().unwrap();
    let canonical_dir = dir.path().canonicalize().unwrap();
    let file = canonical_dir.join("ctx.txt");
    std::fs::write(&file, "original\n").unwrap();

    let executor = ToolExecutor::new(canonical_dir.to_str().unwrap().to_string());
    let ctx = ToolContext::new(canonical_dir.clone());
    let args = serde_json::json!({
        "file_path": "ctx.txt",
        "content": "updated\n"
    });
    let result = executor
        .execute_with_context("write", &args, &ctx)
        .await
        .unwrap();
    assert_eq!(result.exit_code, 0, "write tool failed: {}", result.output);

    let meta = result.metadata.expect("metadata should be present");
    assert_eq!(meta["before"], "original\n");
    assert_eq!(meta["after"], "updated\n");
    assert_eq!(meta["file_path"], "ctx.txt");
}