# PR Description ## Split toolkits This PR splits the `Microsoft`, `Google`, and `Search` toolkits into multiple toolkits each. * `Microsoft` --> `OutlookCalendar`, `OutlookMail`. * `Google` -----> `GoogleCalendar`, `GoogleContacts`, `GoogleDocs`, `GoogleDrive`, `Gmail`, `GoogleSheets` * `Search` -----> `GoogleFinance`, `GoogleFlights`, `GoogleHotels`, `GoogleJobs`, `GoogleMaps`, `GoogleNews`, `GoogleSearch`, `GoogleShopping`, `Walmart`, `Youtube` > The original monolithic toolkits (`Microsoft`, `Google`, `Search`) are not removed in this PR. The plan is to keep those toolkits around while we > 1. Stop documenting the toolkits, > 2. Stop displaying the toolkits in the dashboard, and > 3. Help customers migrate over to the new split toolkits. ## Rename toolkits This PR renames the following toolkits * `Web` ------------> `Firecrawl` * `CodeSandbox` ---> `E2B` > The `Web` and `CodeSandbox` toolkits are not removed in this PR. The plan is to keep them around while we > 1. Stop documenting the toolkits, > 2. Stop displaying the toolkits in the dashboard, and > 3. Help customers migrate over to the new renamed toolkits. ## Rename tools Since toolkit names were changed, this called for some tools to be renamed as well. * `GoogleSearch.SearchGoogle` ----------------> `GoogleSearch.Search` * `GoogleShopping.SearchShoppingProducts` ---> `GoogleShopping.SearchProducts` * `Walmart.SearchWalmartProducts` ------------> `Walmart.SearchProducts` * `Walmart.GetWalmartProductDetails` ---------> `Walmart.GetProductDetails` * `Youtube.SearchYoutubeVideos` --------------> `Youtube.SearchForVideos` ## Google File Picker Improvements to the Google File Picker experience were also added in this PR. The following tools will ALWAYS provide llm_instructions in their response to "let the end-user know that they have the option to select more files via the file picker url if they want to": * `GoogleDocs.SearchDocuments` * `GoogleDocs.SearchAndRetrieveDocuments` * `GoogleDrive.GetFileTreeStructure` The following tools will only provide the file picker URL if a 404 or 403 from the Google API: * `GoogleDocs.InsertTextAtEndOfDocument` * `GoogleDocs.GetDocumentById` * `GoogleSheets.GetSpreadsheet` * `GoogleSheets.WriteToCell` Also, a standalone `GoogleDrive.GenerateGoogleFilePickerUrl` tool exists. ## Other * The `SearchDocuments` and `SearchAndRetrieveDocuments` tools used to be organized within the Drive portion of the Google toolkit, but I moved these into the new GoogleDocs toolkit because they are specific to Docs. # Progress - [x] `OutlookCalendar` - [x] `OutlookMail` - [x] `GoogleFinance` - [x] `GoogleFlights` - [x] `GoogleHotels` - [x] `GoogleJobs` - [x] `GoogleMaps` - [x] `GoogleNews` - [x] `GoogleSearch` - [x] `GoogleShopping` - [x] `Walmart` - [x] `Youtube` - [x] `GoogleCalendar` - [x] `GoogleContacts` - [x] `GoogleDocs` - [x] `GoogleDrive` - [x] `Gmail` - [x] `GoogleSheets` - [x] `Firecrawl` - [x] `E2B` - [x] File picker # Discussion * Repeated code is a consequence of splitting toolkits that use the same provider. I am open to any ideas that would allow multiple toolkits to reference common code. Comment your ideas in this PR.
179 lines
6.4 KiB
Python
179 lines
6.4 KiB
Python
from unittest.mock import AsyncMock, patch
|
|
|
|
import pytest
|
|
from arcade_tdk.errors import ToolExecutionError
|
|
from googleapiclient.errors import HttpError
|
|
|
|
from arcade_google_docs.tools import (
|
|
create_blank_document,
|
|
create_document_from_text,
|
|
get_document_by_id,
|
|
insert_text_at_end_of_document,
|
|
)
|
|
from arcade_google_docs.utils import build_docs_service
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_context():
|
|
context = AsyncMock()
|
|
context.authorization.token = "mock_token" # noqa: S105
|
|
return context
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_get_service():
|
|
with patch("arcade_google_docs.tools.get." + build_docs_service.__name__) as mock_build_service:
|
|
yield mock_build_service.return_value
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_update_service():
|
|
with patch(
|
|
"arcade_google_docs.tools.update." + build_docs_service.__name__
|
|
) as mock_build_service:
|
|
yield mock_build_service.return_value
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_create_service():
|
|
with patch(
|
|
"arcade_google_docs.tools.create." + build_docs_service.__name__
|
|
) as mock_build_service:
|
|
yield mock_build_service.return_value
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_get_document_by_id_success(mock_context, mock_get_service):
|
|
# Mock the service.documents().get().execute() method
|
|
mock_get_service.documents.return_value.get.return_value.execute.return_value = {
|
|
"body": {"content": [{"endIndex": 1, "paragraph": {}}]},
|
|
"documentId": "test_document_id",
|
|
"title": "Test Document",
|
|
}
|
|
|
|
result = await get_document_by_id(mock_context, "test_document_id")
|
|
|
|
assert result["documentId"] == "test_document_id"
|
|
assert result["title"] == "Test Document"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_get_document_by_id_http_error(mock_context, mock_get_service):
|
|
# Simulate HttpError
|
|
mock_get_service.documents.return_value.get.return_value.execute.side_effect = HttpError(
|
|
resp=AsyncMock(status=404), content=b'{"error": {"message": "Not Found"}}'
|
|
)
|
|
|
|
with pytest.raises(ToolExecutionError, match="Error in execution of GetDocumentById"):
|
|
await get_document_by_id(mock_context, "invalid_document_id")
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_insert_text_at_end_of_document_success(mock_context, mock_update_service):
|
|
# Mock get_document_by_id to return a document with endIndex
|
|
with patch(
|
|
"arcade_google_docs.tools.update.get_document_by_id",
|
|
return_value={"body": {"content": [{"endIndex": 1, "paragraph": {}}]}},
|
|
):
|
|
# Mock the service.documents().batchUpdate().execute() method
|
|
mock_update_service.documents.return_value.batchUpdate.return_value.execute.return_value = {
|
|
"documentId": "test_document_id",
|
|
"replies": [],
|
|
}
|
|
|
|
result = await insert_text_at_end_of_document(
|
|
mock_context, "test_document_id", "Sample text"
|
|
)
|
|
|
|
assert result["documentId"] == "test_document_id"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_insert_text_at_end_of_document_http_error(mock_context, mock_update_service):
|
|
with patch(
|
|
"arcade_google_docs.tools.update.get_document_by_id",
|
|
return_value={"body": {"content": [{"endIndex": 1, "paragraph": {}}]}},
|
|
):
|
|
# Simulate HttpError during batchUpdate
|
|
mock_update_service.documents.return_value.batchUpdate.return_value.execute.side_effect = (
|
|
HttpError(resp=AsyncMock(status=400), content=b'{"error": {"message": "Bad Request"}}')
|
|
)
|
|
|
|
with pytest.raises(
|
|
ToolExecutionError, match="Error in execution of InsertTextAtEndOfDocument"
|
|
):
|
|
await insert_text_at_end_of_document(mock_context, "test_document_id", "Sample text")
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_create_blank_document_success(mock_context, mock_create_service):
|
|
# Mock the service.documents().create().execute() method
|
|
mock_create_service.documents.return_value.create.return_value.execute.return_value = {
|
|
"documentId": "new_document_id",
|
|
"title": "New Document",
|
|
}
|
|
|
|
result = await create_blank_document(mock_context, "New Document")
|
|
|
|
assert result["documentId"] == "new_document_id"
|
|
assert result["title"] == "New Document"
|
|
assert "documentUrl" in result
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_create_blank_document_http_error(mock_context, mock_create_service):
|
|
# Simulate HttpError during create
|
|
mock_create_service.documents.return_value.create.return_value.execute.side_effect = HttpError(
|
|
resp=AsyncMock(status=403), content=b'{"error": {"message": "Forbidden"}}'
|
|
)
|
|
|
|
with pytest.raises(ToolExecutionError, match="Error in execution of CreateBlankDocument"):
|
|
await create_blank_document(mock_context, "New Document")
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_create_document_from_text_success(mock_context, mock_create_service):
|
|
with patch(
|
|
"arcade_google_docs.tools.create." + create_blank_document.__name__
|
|
) as mock_create_blank_document:
|
|
# Mock create_blank_document
|
|
mock_create_blank_document.return_value = {
|
|
"documentId": "new_document_id",
|
|
"title": "New Document",
|
|
}
|
|
|
|
# Mock the service.documents().batchUpdate().execute() method
|
|
mock_create_service.documents.return_value.batchUpdate.return_value.execute.return_value = {
|
|
"documentId": "new_document_id",
|
|
"replies": [],
|
|
}
|
|
|
|
result = await create_document_from_text(mock_context, "New Document", "Hello, World!")
|
|
|
|
assert result["documentId"] == "new_document_id"
|
|
assert result["title"] == "New Document"
|
|
assert "documentUrl" in result
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_create_document_from_text_http_error(mock_context, mock_create_service):
|
|
with patch(
|
|
"arcade_google_docs.tools.create." + create_blank_document.__name__
|
|
) as mock_create_blank_document:
|
|
# Mock create_blank_document
|
|
mock_create_blank_document.return_value = {
|
|
"documentId": "new_document_id",
|
|
"title": "New Document",
|
|
}
|
|
|
|
# Simulate HttpError during batchUpdate
|
|
mock_create_service.documents.return_value.batchUpdate.return_value.execute.side_effect = (
|
|
HttpError(
|
|
resp=AsyncMock(status=500), content=b'{"error": {"message": "Internal Error"}}'
|
|
)
|
|
)
|
|
|
|
with pytest.raises(
|
|
ToolExecutionError, match="Error in execution of CreateDocumentFromText"
|
|
):
|
|
await create_document_from_text(mock_context, "New Document", "Hello, World!")
|