arcade-mcp/toolkits/google/tests/test_docs.py
Eric Gustin ab889f9f1d
Lint all toolkits (#183)
# PR Description
* Adds/updates the following files to all toolkits:
    - `.pre-commit-config.yaml`
    - `.ruff.toml`
    - `LICENSE`
    - `Makefile`
    - `pyproject.toml`
* Lint all toolkits such that they pass `make check` and `make test` (a
total doozy). This includes adding some unit tests and evals.
* Github workflow for testing toolkits before merge into main (courtesy
of @sdreyer)
* Added a QOL improvement for tool developers for when they need to get
the context's auth token.
* Minor updates to `arcade new` template.
2024-12-20 09:49:45 -08:00

164 lines
5.9 KiB
Python

from unittest.mock import AsyncMock, patch
import pytest
from arcade.sdk.errors import ToolExecutionError
from googleapiclient.errors import HttpError
from arcade_google.tools.docs import (
create_blank_document,
create_document_from_text,
get_document_by_id,
insert_text_at_end_of_document,
)
from arcade_google.tools.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_service():
with patch("arcade_google.tools.docs." + 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_service):
# Mock the service.documents().get().execute() method
mock_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_service):
# Simulate HttpError
mock_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_service):
# Mock get_document_by_id to return a document with endIndex
with patch(
"arcade_google.tools.docs.get_document_by_id",
return_value={"body": {"content": [{"endIndex": 1, "paragraph": {}}]}},
):
# Mock the service.documents().batchUpdate().execute() method
mock_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
@pytest.mark.asyncio
async def test_insert_text_at_end_of_document_http_error(mock_context, mock_service):
with patch(
"arcade_google.tools.docs.get_document_by_id",
return_value={"body": {"content": [{"endIndex": 1, "paragraph": {}}]}},
):
# Simulate HttpError during batchUpdate
mock_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_service):
# Mock the service.documents().create().execute() method
mock_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_service):
# Simulate HttpError during create
mock_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_service):
with patch(
"arcade_google.tools.docs." + 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_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_service):
with patch(
"arcade_google.tools.docs." + 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_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!")