Files
hermes-agent/tests/gateway/test_discord_document_handling.py
Teknium b1756084a3 feat: add .zip document support and auto-mount cache dirs into remote backends (#4846)
- Add .zip to SUPPORTED_DOCUMENT_TYPES so gateway platforms (Telegram,
  Slack, Discord) cache uploaded zip files instead of rejecting them.
- Add get_cache_directory_mounts() and iter_cache_files() to
  credential_files.py for host-side cache directory passthrough
  (documents, images, audio, screenshots).
- Docker: bind-mount cache dirs read-only alongside credentials/skills.
  Changes are live (bind mount semantics).
- Modal: mount cache files at sandbox creation + resync before each
  command via _sync_files() with mtime+size change detection.
- Handles backward-compat with legacy dir names (document_cache,
  image_cache, audio_cache, browser_screenshots) via get_hermes_dir().
- Container paths always use the new cache/<subdir> layout regardless
  of host layout.

This replaces the need for a dedicated extract_archive tool (PR #4819)
— the agent can now use standard terminal commands (unzip, tar) on
uploaded files inside remote containers.

Closes: related to PR #4819 by kshitijk4poor
2026-04-03 13:16:26 -07:00

351 lines
13 KiB
Python

"""Tests for Discord incoming document/file attachment handling.
Covers the document branch in DiscordAdapter._handle_message() —
the `else` clause of the attachment content-type loop that was added
to download, cache, and optionally inject text from non-image/audio files.
"""
import os
import sys
from datetime import datetime, timezone
from types import SimpleNamespace
from unittest.mock import AsyncMock, MagicMock, patch
import pytest
from gateway.config import PlatformConfig
from gateway.platforms.base import MessageType
# ---------------------------------------------------------------------------
# Discord mock setup (copied from test_discord_free_response.py)
# ---------------------------------------------------------------------------
def _ensure_discord_mock():
"""Install a mock discord module when discord.py isn't available."""
if "discord" in sys.modules and hasattr(sys.modules["discord"], "__file__"):
return
discord_mod = MagicMock()
discord_mod.Intents.default.return_value = MagicMock()
discord_mod.Client = MagicMock
discord_mod.File = MagicMock
discord_mod.DMChannel = type("DMChannel", (), {})
discord_mod.Thread = type("Thread", (), {})
discord_mod.ForumChannel = type("ForumChannel", (), {})
discord_mod.ui = SimpleNamespace(View=object, button=lambda *a, **k: (lambda fn: fn), Button=object)
discord_mod.ButtonStyle = SimpleNamespace(success=1, primary=2, secondary=2, danger=3, green=1, grey=2, blurple=2, red=3)
discord_mod.Color = SimpleNamespace(orange=lambda: 1, green=lambda: 2, blue=lambda: 3, red=lambda: 4, purple=lambda: 5)
discord_mod.Interaction = object
discord_mod.Embed = MagicMock
discord_mod.app_commands = SimpleNamespace(
describe=lambda **kwargs: (lambda fn: fn),
choices=lambda **kwargs: (lambda fn: fn),
Choice=lambda **kwargs: SimpleNamespace(**kwargs),
)
ext_mod = MagicMock()
commands_mod = MagicMock()
commands_mod.Bot = MagicMock
ext_mod.commands = commands_mod
sys.modules.setdefault("discord", discord_mod)
sys.modules.setdefault("discord.ext", ext_mod)
sys.modules.setdefault("discord.ext.commands", commands_mod)
_ensure_discord_mock()
import gateway.platforms.discord as discord_platform # noqa: E402
from gateway.platforms.discord import DiscordAdapter # noqa: E402
# ---------------------------------------------------------------------------
# Fake channel / thread types
# ---------------------------------------------------------------------------
class FakeDMChannel:
def __init__(self, channel_id: int = 1):
self.id = channel_id
self.name = "dm"
class FakeThread:
def __init__(self, channel_id: int = 10):
self.id = channel_id
self.name = "thread"
self.parent = None
self.parent_id = None
self.guild = SimpleNamespace(name="TestServer")
self.topic = None
# ---------------------------------------------------------------------------
# Fixtures
# ---------------------------------------------------------------------------
@pytest.fixture(autouse=True)
def _redirect_cache(tmp_path, monkeypatch):
"""Point document cache to tmp_path so tests never write to ~/.hermes."""
monkeypatch.setattr(
"gateway.platforms.base.DOCUMENT_CACHE_DIR", tmp_path / "doc_cache"
)
@pytest.fixture
def adapter(monkeypatch):
monkeypatch.setattr(discord_platform.discord, "DMChannel", FakeDMChannel, raising=False)
monkeypatch.setattr(discord_platform.discord, "Thread", FakeThread, raising=False)
config = PlatformConfig(enabled=True, token="fake-token")
a = DiscordAdapter(config)
a._client = SimpleNamespace(user=SimpleNamespace(id=999))
a.handle_message = AsyncMock()
return a
# ---------------------------------------------------------------------------
# Helpers
# ---------------------------------------------------------------------------
def make_attachment(
*,
filename: str,
content_type: str,
size: int = 1024,
url: str = "https://cdn.discordapp.com/attachments/fake/file",
) -> SimpleNamespace:
return SimpleNamespace(
filename=filename,
content_type=content_type,
size=size,
url=url,
)
def make_message(attachments: list, content: str = "") -> SimpleNamespace:
return SimpleNamespace(
id=123,
content=content,
attachments=attachments,
mentions=[],
reference=None,
created_at=datetime.now(timezone.utc),
channel=FakeDMChannel(),
author=SimpleNamespace(id=42, display_name="Tester", name="Tester"),
)
def _mock_aiohttp_download(raw_bytes: bytes):
"""Return a patch context manager that makes aiohttp return raw_bytes."""
resp = AsyncMock()
resp.status = 200
resp.read = AsyncMock(return_value=raw_bytes)
resp.__aenter__ = AsyncMock(return_value=resp)
resp.__aexit__ = AsyncMock(return_value=False)
session = AsyncMock()
session.get = MagicMock(return_value=resp)
session.__aenter__ = AsyncMock(return_value=session)
session.__aexit__ = AsyncMock(return_value=False)
return patch("aiohttp.ClientSession", return_value=session)
# ---------------------------------------------------------------------------
# Tests
# ---------------------------------------------------------------------------
class TestIncomingDocumentHandling:
@pytest.mark.asyncio
async def test_pdf_document_cached(self, adapter):
"""A PDF attachment should be downloaded, cached, typed as DOCUMENT."""
pdf_bytes = b"%PDF-1.4 fake content"
with _mock_aiohttp_download(pdf_bytes):
msg = make_message([make_attachment(filename="report.pdf", content_type="application/pdf")])
await adapter._handle_message(msg)
event = adapter.handle_message.call_args[0][0]
assert event.message_type == MessageType.DOCUMENT
assert len(event.media_urls) == 1
assert os.path.exists(event.media_urls[0])
assert event.media_types == ["application/pdf"]
assert "[Content of" not in (event.text or "")
@pytest.mark.asyncio
async def test_txt_content_injected(self, adapter):
""".txt file under 100KB should have its content injected into event.text."""
file_content = b"Hello from a text file"
with _mock_aiohttp_download(file_content):
msg = make_message(
attachments=[make_attachment(filename="notes.txt", content_type="text/plain")],
content="summarize this",
)
await adapter._handle_message(msg)
event = adapter.handle_message.call_args[0][0]
assert "[Content of notes.txt]:" in event.text
assert "Hello from a text file" in event.text
assert "summarize this" in event.text
# injection prepended before caption
assert event.text.index("[Content of") < event.text.index("summarize this")
@pytest.mark.asyncio
async def test_md_content_injected(self, adapter):
""".md file under 100KB should have its content injected."""
file_content = b"# Title\nSome markdown content"
with _mock_aiohttp_download(file_content):
msg = make_message(
attachments=[make_attachment(filename="readme.md", content_type="text/markdown")],
content="",
)
await adapter._handle_message(msg)
event = adapter.handle_message.call_args[0][0]
assert "[Content of readme.md]:" in event.text
assert "# Title" in event.text
@pytest.mark.asyncio
async def test_oversized_document_skipped(self, adapter):
"""A document over 20MB should be skipped — media_urls stays empty."""
msg = make_message([
make_attachment(
filename="huge.pdf",
content_type="application/pdf",
size=25 * 1024 * 1024,
)
])
await adapter._handle_message(msg)
event = adapter.handle_message.call_args[0][0]
assert event.media_urls == []
# handler must still be called
adapter.handle_message.assert_called_once()
@pytest.mark.asyncio
async def test_zip_document_cached(self, adapter):
"""A .zip file should be cached as a supported document."""
msg = make_message([
make_attachment(filename="archive.zip", content_type="application/zip")
])
with _mock_aiohttp_download(b"PK\x03\x04test"):
await adapter._handle_message(msg)
event = adapter.handle_message.call_args[0][0]
assert len(event.media_urls) == 1
assert event.media_types == ["application/zip"]
assert event.message_type == MessageType.DOCUMENT
@pytest.mark.asyncio
async def test_download_error_handled(self, adapter):
"""If the HTTP download raises, the handler should not crash."""
resp = AsyncMock()
resp.__aenter__ = AsyncMock(side_effect=RuntimeError("connection reset"))
resp.__aexit__ = AsyncMock(return_value=False)
session = AsyncMock()
session.get = MagicMock(return_value=resp)
session.__aenter__ = AsyncMock(return_value=session)
session.__aexit__ = AsyncMock(return_value=False)
with patch("aiohttp.ClientSession", return_value=session):
msg = make_message([
make_attachment(filename="report.pdf", content_type="application/pdf")
])
await adapter._handle_message(msg)
# Must still deliver an event
adapter.handle_message.assert_called_once()
event = adapter.handle_message.call_args[0][0]
assert event.media_urls == []
@pytest.mark.asyncio
async def test_large_txt_cached_not_injected(self, adapter):
""".txt over 100KB should be cached but NOT injected into event.text."""
large_content = b"x" * (200 * 1024)
with _mock_aiohttp_download(large_content):
msg = make_message(
attachments=[make_attachment(filename="big.txt", content_type="text/plain", size=len(large_content))],
content="",
)
await adapter._handle_message(msg)
event = adapter.handle_message.call_args[0][0]
assert len(event.media_urls) == 1
assert os.path.exists(event.media_urls[0])
assert "[Content of" not in (event.text or "")
@pytest.mark.asyncio
async def test_multiple_text_files_both_injected(self, adapter):
"""Two text file attachments should both be injected into event.text in order."""
content1 = b"First file content"
content2 = b"Second file content"
call_count = 0
responses = [content1, content2]
def make_session(_responses):
idx = 0
class FakeSession:
async def __aenter__(self):
return self
async def __aexit__(self, *_):
pass
def get(self, url, **kwargs):
nonlocal idx
data = _responses[idx % len(_responses)]
idx += 1
resp = AsyncMock()
resp.status = 200
resp.read = AsyncMock(return_value=data)
resp.__aenter__ = AsyncMock(return_value=resp)
resp.__aexit__ = AsyncMock(return_value=False)
return resp
return FakeSession()
with patch("aiohttp.ClientSession", return_value=make_session([content1, content2])):
msg = make_message(
attachments=[
make_attachment(filename="file1.txt", content_type="text/plain"),
make_attachment(filename="file2.txt", content_type="text/plain"),
],
content="",
)
await adapter._handle_message(msg)
event = adapter.handle_message.call_args[0][0]
assert "[Content of file1.txt]:" in event.text
assert "First file content" in event.text
assert "[Content of file2.txt]:" in event.text
assert "Second file content" in event.text
assert event.text.index("file1") < event.text.index("file2")
@pytest.mark.asyncio
async def test_image_attachment_unaffected(self, adapter):
"""Image attachments should still go through the image path, not the document path."""
with patch(
"gateway.platforms.discord.cache_image_from_url",
new_callable=AsyncMock,
return_value="/tmp/cached_image.png",
):
msg = make_message([
make_attachment(filename="photo.png", content_type="image/png")
])
await adapter._handle_message(msg)
event = adapter.handle_message.call_args[0][0]
assert event.message_type == MessageType.PHOTO
assert event.media_urls == ["/tmp/cached_image.png"]
assert event.media_types == ["image/png"]