Files
tkmind_go/crates/goose/tests/todo_tools_test.rs
T
tlongwell-block 566b9dc577 To-Do Tools (#3902)
Co-authored-by: David Katz <dkatz@squareup.com>
2025-08-11 15:57:17 -04:00

529 lines
15 KiB
Rust

use goose::agents::todo_tools::{TODO_READ_TOOL_NAME, TODO_WRITE_TOOL_NAME};
use goose::agents::Agent;
use mcp_core::tool::ToolCall;
use serde_json::json;
use serial_test::serial;
use std::sync::Arc;
#[tokio::test]
async fn test_todo_tools_in_agent_list() {
let agent = Agent::new();
let tools = agent.list_tools(None).await;
// Check that todo tools are present
let todo_read = tools.iter().find(|t| t.name == TODO_READ_TOOL_NAME);
let todo_write = tools.iter().find(|t| t.name == TODO_WRITE_TOOL_NAME);
assert!(
todo_read.is_some(),
"Todo read tool should be in agent's tool list"
);
assert!(
todo_write.is_some(),
"Todo write tool should be in agent's tool list"
);
}
#[tokio::test]
#[serial]
async fn test_todo_write_and_read() {
// Ensure we have a clean environment for this test
std::env::remove_var("GOOSE_TODO_MAX_CHARS");
let agent = Agent::new();
// Write to the todo list
let write_call = ToolCall {
name: TODO_WRITE_TOOL_NAME.to_string(),
arguments: json!({
"content": "1. Buy milk\n2. Walk the dog\n3. Review code"
}),
};
let (_, write_result) = agent
.dispatch_tool_call(write_call, "test-write-1".to_string(), None)
.await;
assert!(write_result.is_ok(), "Write should succeed");
// Read from the todo list
let read_call = ToolCall {
name: TODO_READ_TOOL_NAME.to_string(),
arguments: json!({}),
};
let (_, read_result) = agent
.dispatch_tool_call(read_call, "test-read-1".to_string(), None)
.await;
assert!(read_result.is_ok(), "Read should succeed");
// Verify the content matches what we wrote
if let Ok(result) = read_result {
let content_future = result.result;
let content_result = content_future.await;
if let Ok(contents) = content_result {
assert!(!contents.is_empty(), "Should have content");
let text = contents[0].as_text().map(|t| t.text.as_str()).unwrap_or("");
assert_eq!(text, "1. Buy milk\n2. Walk the dog\n3. Review code");
} else {
panic!("Failed to get content from read result");
}
}
}
#[tokio::test]
async fn test_todo_empty_initially() {
let agent = Agent::new();
// Read from empty todo list
let read_call = ToolCall {
name: TODO_READ_TOOL_NAME.to_string(),
arguments: json!({}),
};
let (_, read_result) = agent
.dispatch_tool_call(read_call, "test-read-empty".to_string(), None)
.await;
assert!(read_result.is_ok(), "Read should succeed even when empty");
if let Ok(result) = read_result {
let content_future = result.result;
let content_result = content_future.await;
if let Ok(contents) = content_result {
assert!(!contents.is_empty(), "Should have content");
let text = contents[0].as_text().map(|t| t.text.as_str()).unwrap_or("");
assert_eq!(text, "", "Empty todo list should return empty string");
}
}
}
#[tokio::test]
#[serial]
async fn test_todo_overwrite() {
// Ensure no limit is set for this test
std::env::remove_var("GOOSE_TODO_MAX_CHARS");
let agent = Agent::new();
// Write initial content
let write_call1 = ToolCall {
name: TODO_WRITE_TOOL_NAME.to_string(),
arguments: json!({
"content": "Initial todo list"
}),
};
let (_, write_result1) = agent
.dispatch_tool_call(write_call1, "test-write-1".to_string(), None)
.await;
assert!(write_result1.is_ok(), "First write should succeed");
// Overwrite with new content
let write_call2 = ToolCall {
name: TODO_WRITE_TOOL_NAME.to_string(),
arguments: json!({
"content": "Completely new todo list"
}),
};
let (_, write_result2) = agent
.dispatch_tool_call(write_call2, "test-write-2".to_string(), None)
.await;
assert!(write_result2.is_ok(), "Second write should succeed");
// Read and verify it was overwritten
let read_call = ToolCall {
name: TODO_READ_TOOL_NAME.to_string(),
arguments: json!({}),
};
let (_, read_result) = agent
.dispatch_tool_call(read_call, "test-read-2".to_string(), None)
.await;
if let Ok(result) = read_result {
let content_future = result.result;
let content_result = content_future.await;
if let Ok(contents) = content_result {
let text = contents[0].as_text().map(|t| t.text.as_str()).unwrap_or("");
assert_eq!(
text, "Completely new todo list",
"Content should be overwritten"
);
}
}
}
#[tokio::test]
async fn test_todo_concurrent_access() {
let agent = Arc::new(Agent::new());
// Spawn multiple concurrent writes
let mut handles = vec![];
for i in 0..10 {
let agent_clone = agent.clone();
let handle = tokio::spawn(async move {
let write_call = ToolCall {
name: TODO_WRITE_TOOL_NAME.to_string(),
arguments: json!({
"content": format!("Todo list {}", i)
}),
};
agent_clone
.dispatch_tool_call(write_call, format!("concurrent-{}", i), None)
.await
});
handles.push(handle);
}
// Wait for all writes to complete
for handle in handles {
let _ = handle.await.unwrap();
}
// Read the final state
let read_call = ToolCall {
name: TODO_READ_TOOL_NAME.to_string(),
arguments: json!({}),
};
let (_, read_result) = agent
.dispatch_tool_call(read_call, "final-read".to_string(), None)
.await;
if let Ok(result) = read_result {
let content_future = result.result;
let content_result = content_future.await;
if let Ok(contents) = content_result {
let text = contents[0].as_text().map(|t| t.text.as_str()).unwrap_or("");
// The last write wins - we just verify it's one of the valid values
assert!(
text.starts_with("Todo list "),
"Should have valid todo content"
);
}
}
}
#[tokio::test]
#[serial]
async fn test_todo_large_content() {
// Ensure we have a clean environment for this test
std::env::remove_var("GOOSE_TODO_MAX_CHARS");
let agent = Agent::new();
// Create a large todo list that exceeds the 50,000 character limit
let large_content = "X".repeat(100_000);
let write_call = ToolCall {
name: TODO_WRITE_TOOL_NAME.to_string(),
arguments: json!({
"content": large_content.clone()
}),
};
let (_, write_result) = agent
.dispatch_tool_call(write_call, "large-write".to_string(), None)
.await;
// Should fail because it exceeds the 50,000 character limit
if let Ok(result) = write_result {
let response = result.result.await;
assert!(
response.is_err(),
"Should fail with error for content exceeding limit"
);
if let Err(error) = response {
let error_str = error.to_string();
assert!(error_str.contains("Todo list too large"));
assert!(error_str.contains("100000 chars"));
assert!(error_str.contains("max: 50000"));
}
} else {
panic!("Expected Ok(ToolCallResult) with inner error, got Err");
}
// Test with content within the limit
let valid_content = "X".repeat(50_000);
let write_call = ToolCall {
name: TODO_WRITE_TOOL_NAME.to_string(),
arguments: json!({
"content": valid_content.clone()
}),
};
let (_, write_result) = agent
.dispatch_tool_call(write_call, "valid-write".to_string(), None)
.await;
assert!(write_result.is_ok(), "Should handle content within limit");
// Read it back
let read_call = ToolCall {
name: TODO_READ_TOOL_NAME.to_string(),
arguments: json!({}),
};
let (_, read_result) = agent
.dispatch_tool_call(read_call, "valid-read".to_string(), None)
.await;
if let Ok(result) = read_result {
let content_future = result.result;
let content_result = content_future.await;
if let Ok(contents) = content_result {
let text = contents[0].as_text().map(|t| t.text.as_str()).unwrap_or("");
assert_eq!(
text.len(),
valid_content.len(),
"Valid content should be preserved"
);
}
}
}
#[tokio::test]
#[serial]
async fn test_todo_unicode_content() {
// Ensure no limit is set for this test
std::env::remove_var("GOOSE_TODO_MAX_CHARS");
let agent = Agent::new();
let unicode_content = "📝 Todo List:\n✅ Task 1\n⭐ Task 2\n🔥 Urgent: Task 3\n日本語のタスク";
let write_call = ToolCall {
name: TODO_WRITE_TOOL_NAME.to_string(),
arguments: json!({
"content": unicode_content
}),
};
let (_, write_result) = agent
.dispatch_tool_call(write_call, "unicode-write".to_string(), None)
.await;
assert!(write_result.is_ok(), "Write should succeed");
let read_call = ToolCall {
name: TODO_READ_TOOL_NAME.to_string(),
arguments: json!({}),
};
let (_, read_result) = agent
.dispatch_tool_call(read_call, "unicode-read".to_string(), None)
.await;
if let Ok(result) = read_result {
let content_future = result.result;
let content_result = content_future.await;
if let Ok(contents) = content_result {
let text = contents[0].as_text().map(|t| t.text.as_str()).unwrap_or("");
assert_eq!(text, unicode_content, "Unicode content should be preserved");
}
}
}
#[tokio::test]
#[serial]
async fn test_todo_character_limit_enforcement() {
// Set a small limit for testing
std::env::set_var("GOOSE_TODO_MAX_CHARS", "100");
// Create agent AFTER setting the environment variable
let agent = Agent::new();
// Create content that exceeds the limit
let large_content = "x".repeat(101);
let write_call = ToolCall {
name: TODO_WRITE_TOOL_NAME.to_string(),
arguments: json!({
"content": large_content
}),
};
let (_, result) = agent
.dispatch_tool_call(write_call, "test-limit".to_string(), None)
.await;
// Should fail with error
assert!(result.is_ok(), "dispatch_tool_call should return Ok");
if let Ok(result) = result {
let response = result.result.await;
assert!(response.is_err(), "Should fail with error");
if let Err(error) = response {
let error_str = error.to_string();
assert!(
error_str.contains("Todo list too large"),
"Error should mention 'Todo list too large'"
);
assert!(
error_str.contains("101 chars"),
"Error should mention '101 chars'"
);
assert!(
error_str.contains("max: 100"),
"Error should mention 'max: 100'"
);
}
}
// Clean up
std::env::remove_var("GOOSE_TODO_MAX_CHARS");
}
#[tokio::test]
#[serial]
async fn test_todo_character_count_in_write_response() {
// Ensure no limit is set for this test
std::env::remove_var("GOOSE_TODO_MAX_CHARS");
let agent = Agent::new();
let content = "Test todo content";
let write_call = ToolCall {
name: TODO_WRITE_TOOL_NAME.to_string(),
arguments: json!({
"content": content
}),
};
let (_, result) = agent
.dispatch_tool_call(write_call, "test-count".to_string(), None)
.await;
assert!(result.is_ok());
if let Ok(tool_result) = result {
let response = tool_result.result.await.unwrap();
let text = response[0].as_text().unwrap().text.clone();
assert!(text.contains("Updated (17 chars)")); // "Test todo content" is 17 chars
}
}
#[tokio::test]
#[serial]
async fn test_todo_read_returns_clean_content() {
// Ensure no limit is set for this test
std::env::remove_var("GOOSE_TODO_MAX_CHARS");
let agent = Agent::new();
// Write some content
let content = "My todo list\n- Task 1\n- Task 2";
let write_call = ToolCall {
name: TODO_WRITE_TOOL_NAME.to_string(),
arguments: json!({
"content": content
}),
};
let (_, write_result) = agent
.dispatch_tool_call(write_call, "test-write".to_string(), None)
.await;
assert!(write_result.is_ok(), "Write should succeed");
// Read should return exact content, no metadata
let read_call = ToolCall {
name: TODO_READ_TOOL_NAME.to_string(),
arguments: json!({}),
};
let (_, result) = agent
.dispatch_tool_call(read_call, "test-read".to_string(), None)
.await;
assert!(result.is_ok());
if let Ok(tool_result) = result {
let response = tool_result.result.await.unwrap();
let text = response[0].as_text().unwrap().text.clone();
// Should be exactly the original content
assert_eq!(text, content);
// Should NOT contain any metadata
assert!(!text.contains("chars"));
assert!(!text.contains("<!--"));
}
}
#[tokio::test]
#[serial]
async fn test_todo_unlimited_with_zero_limit() {
std::env::set_var("GOOSE_TODO_MAX_CHARS", "0");
let agent = Agent::new();
// Should accept very large content when limit is 0
let huge_content = "x".repeat(100_000);
let write_call = ToolCall {
name: TODO_WRITE_TOOL_NAME.to_string(),
arguments: json!({
"content": huge_content
}),
};
let (_, result) = agent
.dispatch_tool_call(write_call, "test-unlimited".to_string(), None)
.await;
// Should succeed
assert!(result.is_ok());
std::env::remove_var("GOOSE_TODO_MAX_CHARS");
}
#[tokio::test]
#[serial]
async fn test_todo_unicode_character_counting() {
std::env::set_var("GOOSE_TODO_MAX_CHARS", "10");
// Create agent AFTER setting the environment variable
let agent = Agent::new();
// Test with emoji - each emoji is 1 character in .chars().count()
let content = "📝📝📝📝📝📝📝📝📝📝📝"; // 11 emoji = 11 chars
let write_call = ToolCall {
name: TODO_WRITE_TOOL_NAME.to_string(),
arguments: json!({
"content": content
}),
};
let (_, result) = agent
.dispatch_tool_call(write_call, "test-unicode".to_string(), None)
.await;
// Should fail as it's 11 chars
assert!(result.is_ok(), "dispatch_tool_call should return Ok");
if let Ok(result) = result {
let response = result.result.await;
assert!(
response.is_err(),
"Should fail with error - 11 chars exceeds limit of 10"
);
if let Err(error) = response {
let error_str = error.to_string();
assert!(
error_str.contains("Todo list too large"),
"Error should mention 'Todo list too large'"
);
assert!(
error_str.contains("11 chars"),
"Error should mention '11 chars'"
);
assert!(
error_str.contains("max: 10"),
"Error should mention 'max: 10'"
);
}
}
std::env::remove_var("GOOSE_TODO_MAX_CHARS");
}