mirror of
https://github.com/dnlbauer/cordra-mcp.git
synced 2026-09-11 06:05:29 +00:00
94340e2bb1
Implement MCP tool to search Cordra repository using Lucene/Solr syntax. Enables AI assistants to discover and filter digital objects by content, type, and other metadata fields. Features: - Lucene/Solr compatible query syntax support - Optional type filtering (e.g., Person, Document) - Configurable result limits with sensible defaults - Comprehensive error handling and validation - JSON formatted results with proper indentation Technical changes: - Enhanced CordraClient.find() with type and limit parameters - Added search_objects MCP tool with detailed annotations - Removed unused tools module in favor of decorator approach - Added 12 comprehensive unit tests covering all scenarios
312 lines
10 KiB
Python
312 lines
10 KiB
Python
"""Unit tests for the Cordra client."""
|
|
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
|
|
from cordra_mcp.client import (
|
|
CordraClient,
|
|
CordraClientError,
|
|
CordraNotFoundError,
|
|
DigitalObject,
|
|
)
|
|
from cordra_mcp.config import CordraConfig
|
|
|
|
|
|
@pytest.fixture
|
|
def config():
|
|
"""Create a test configuration."""
|
|
return CordraConfig(
|
|
base_url="https://test.example.com",
|
|
username="testuser",
|
|
password="testpass",
|
|
verify_ssl=False,
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def client(config):
|
|
"""Create a test client."""
|
|
return CordraClient(config)
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_cordra_object():
|
|
"""Create a mock CordraObject response (dictionary)."""
|
|
return {
|
|
"type": "TestType",
|
|
"content": {"title": "Test Object", "description": "A test object"},
|
|
"metadata": {"created": "2023-01-01", "modified": "2023-01-02"},
|
|
"acl": {"read": ["public"], "write": ["admin"]},
|
|
"payloads": [
|
|
{
|
|
"name": "file1.txt",
|
|
"filename": "file1.txt",
|
|
"size": 1024,
|
|
"mediaType": "text/plain",
|
|
},
|
|
{
|
|
"name": "file2.pdf",
|
|
"filename": "file2.pdf",
|
|
"size": 2048,
|
|
"mediaType": "application/pdf",
|
|
},
|
|
],
|
|
}
|
|
|
|
|
|
class TestDigitalObject:
|
|
"""Test the DigitalObject model."""
|
|
|
|
def test_digital_object_creation(self):
|
|
"""Test creating a DigitalObject."""
|
|
obj = DigitalObject(
|
|
id="test/123",
|
|
type="TestType",
|
|
content={"title": "Test"},
|
|
metadata={"created": "2023-01-01"},
|
|
acl={"read": ["public"]},
|
|
payloads=[
|
|
{
|
|
"name": "file1.txt",
|
|
"mediaType": "text/plain",
|
|
"size": 1024,
|
|
"filename": "file1.txt",
|
|
}
|
|
],
|
|
)
|
|
|
|
assert obj.id == "test/123"
|
|
assert obj.type == "TestType"
|
|
assert obj.content == {"title": "Test"}
|
|
assert obj.metadata == {"created": "2023-01-01"}
|
|
assert obj.acl == {"read": ["public"]}
|
|
assert obj.payloads and len(obj.payloads) == 1
|
|
payload = obj.payloads[0]
|
|
assert payload["name"] == "file1.txt"
|
|
assert payload["mediaType"] == "text/plain"
|
|
assert payload["size"] == 1024
|
|
assert payload["filename"] == "file1.txt"
|
|
|
|
def test_digital_object_optional_fields(self):
|
|
"""Test DigitalObject with only required fields."""
|
|
obj = DigitalObject(id="test/123", type="TestType", content={"title": "Test"})
|
|
|
|
assert obj.id == "test/123"
|
|
assert obj.type == "TestType"
|
|
assert obj.content == {"title": "Test"}
|
|
assert obj.metadata is None
|
|
assert obj.acl is None
|
|
assert obj.payloads is None
|
|
|
|
|
|
class TestCordraClient:
|
|
"""Test the CordraClient class."""
|
|
|
|
def test_client_initialization(self, config):
|
|
"""Test client initialization."""
|
|
client = CordraClient(config)
|
|
assert client.config == config
|
|
|
|
@patch("cordra_mcp.client.requests.Session.get")
|
|
async def test_get_object_success(self, mock_get, client, mock_cordra_object):
|
|
"""Test successful object retrieval."""
|
|
mock_response = mock_get.return_value
|
|
mock_response.status_code = 200
|
|
mock_response.json.return_value = mock_cordra_object
|
|
mock_response.raise_for_status.return_value = None
|
|
|
|
result = await client.get_object("test/123")
|
|
|
|
assert isinstance(result, DigitalObject)
|
|
assert result.id == "test/123"
|
|
assert result.type == "TestType"
|
|
assert result.content == {
|
|
"title": "Test Object",
|
|
"description": "A test object",
|
|
}
|
|
assert result.metadata == {"created": "2023-01-01", "modified": "2023-01-02"}
|
|
assert result.acl == {"read": ["public"], "write": ["admin"]}
|
|
assert result.payloads and len(result.payloads) == 2
|
|
|
|
mock_get.assert_called_once_with(
|
|
"https://test.example.com/objects/test/123",
|
|
params={"full": "true"},
|
|
timeout=30,
|
|
)
|
|
|
|
@patch("cordra_mcp.client.requests.Session.get")
|
|
async def test_get_object_not_found(self, mock_get, client):
|
|
"""Test object not found exception."""
|
|
mock_response = mock_get.return_value
|
|
mock_response.status_code = 404
|
|
mock_response.ok = False
|
|
|
|
with pytest.raises(CordraNotFoundError) as exc_info:
|
|
await client.get_object("test/nonexistent")
|
|
|
|
assert "Resource not found" in str(exc_info.value)
|
|
|
|
@patch("cordra_mcp.client.requests.Session.get")
|
|
async def test_get_object_general_error(self, mock_get, client):
|
|
"""Test general error handling."""
|
|
from requests import RequestException
|
|
|
|
mock_get.side_effect = RequestException("Connection failed")
|
|
|
|
with pytest.raises(CordraClientError) as exc_info:
|
|
await client.get_object("test/123")
|
|
|
|
assert "Failed to retrieve object test/123" in str(exc_info.value)
|
|
|
|
@patch("cordra_mcp.client.requests.Session.get")
|
|
async def test_find_success(self, mock_get, client):
|
|
"""Test successful find operation."""
|
|
mock_response_data = {
|
|
"results": [
|
|
{"name": "User", "identifier": "test/user-schema"},
|
|
{"name": "Project", "identifier": "test/project-schema"},
|
|
{"name": "Document", "identifier": "test/doc-schema"},
|
|
],
|
|
"size": 3,
|
|
}
|
|
mock_response = mock_get.return_value
|
|
mock_response.status_code = 200
|
|
mock_response.json.return_value = mock_response_data
|
|
mock_response.raise_for_status.return_value = None
|
|
|
|
result = await client.find("type:Schema")
|
|
|
|
assert len(result) == 3
|
|
assert result[0]["name"] == "User"
|
|
assert result[1]["name"] == "Project"
|
|
assert result[2]["name"] == "Document"
|
|
|
|
mock_get.assert_called_once_with(
|
|
"https://test.example.com/search",
|
|
params={"query": "type:Schema"},
|
|
timeout=30,
|
|
)
|
|
|
|
@patch("cordra_mcp.client.requests.Session.get")
|
|
async def test_find_empty_results(self, mock_get, client):
|
|
"""Test find with empty results."""
|
|
mock_response_data = {"results": [], "size": 0}
|
|
mock_response = mock_get.return_value
|
|
mock_response.status_code = 200
|
|
mock_response.json.return_value = mock_response_data
|
|
mock_response.raise_for_status.return_value = None
|
|
|
|
result = await client.find("type:NonExistent")
|
|
|
|
assert result == []
|
|
mock_get.assert_called_once_with(
|
|
"https://test.example.com/search",
|
|
params={"query": "type:NonExistent"},
|
|
timeout=30,
|
|
)
|
|
|
|
@patch("cordra_mcp.client.requests.Session.get")
|
|
async def test_find_no_results_key(self, mock_get, client):
|
|
"""Test find with response missing results key."""
|
|
mock_response_data = {"size": 0} # No results key
|
|
mock_response = mock_get.return_value
|
|
mock_response.status_code = 200
|
|
mock_response.json.return_value = mock_response_data
|
|
mock_response.raise_for_status.return_value = None
|
|
|
|
result = await client.find("type:Schema")
|
|
|
|
assert result == []
|
|
|
|
@patch("cordra_mcp.client.requests.Session.get")
|
|
async def test_find_error(self, mock_get, client):
|
|
"""Test find error handling."""
|
|
from requests import RequestException
|
|
|
|
mock_get.side_effect = RequestException("Search failed")
|
|
|
|
with pytest.raises(CordraClientError) as exc_info:
|
|
await client.find("invalid:query")
|
|
|
|
assert "Failed to search with query 'invalid:query'" in str(exc_info.value)
|
|
assert "Search failed" in str(exc_info.value)
|
|
|
|
@patch("cordra_mcp.client.requests.Session.get")
|
|
async def test_find_with_type_filter(self, mock_get, client):
|
|
"""Test find operation with type filter constructs correct query."""
|
|
mock_response = mock_get.return_value
|
|
mock_response.status_code = 200
|
|
mock_response.json.return_value = {"results": []}
|
|
mock_response.ok = True
|
|
|
|
await client.find("name:John", object_type="Person")
|
|
|
|
mock_get.assert_called_once_with(
|
|
"https://test.example.com/search",
|
|
params={"query": "type:Person AND (name:John)"},
|
|
timeout=30,
|
|
)
|
|
|
|
@patch("cordra_mcp.client.requests.Session.get")
|
|
async def test_find_with_limit(self, mock_get, client):
|
|
"""Test find operation with limit adds pageSize parameter."""
|
|
mock_response = mock_get.return_value
|
|
mock_response.status_code = 200
|
|
mock_response.json.return_value = {"results": []}
|
|
mock_response.ok = True
|
|
|
|
await client.find("type:Test", limit=50)
|
|
|
|
mock_get.assert_called_once_with(
|
|
"https://test.example.com/search",
|
|
params={"query": "type:Test", "pageSize": "50"},
|
|
timeout=30,
|
|
)
|
|
|
|
@patch("cordra_mcp.client.requests.Session.get")
|
|
async def test_find_with_type_and_limit(self, mock_get, client):
|
|
"""Test find operation with both type filter and limit."""
|
|
mock_response = mock_get.return_value
|
|
mock_response.status_code = 200
|
|
mock_response.json.return_value = {"results": []}
|
|
mock_response.ok = True
|
|
|
|
await client.find("title:Report", object_type="Document", limit=25)
|
|
|
|
mock_get.assert_called_once_with(
|
|
"https://test.example.com/search",
|
|
params={"query": "type:Document AND (title:Report)", "pageSize": "25"},
|
|
timeout=30,
|
|
)
|
|
|
|
@patch("cordra_mcp.client.requests.Session.get")
|
|
async def test_find_no_optional_params(self, mock_get, client):
|
|
"""Test find operation with no optional parameters."""
|
|
mock_response = mock_get.return_value
|
|
mock_response.status_code = 200
|
|
mock_response.json.return_value = {"results": []}
|
|
mock_response.ok = True
|
|
|
|
await client.find("content:test")
|
|
|
|
mock_get.assert_called_once_with(
|
|
"https://test.example.com/search",
|
|
params={"query": "content:test"},
|
|
timeout=30,
|
|
)
|
|
|
|
|
|
class TestCordraConfig:
|
|
"""Test the CordraConfig class."""
|
|
|
|
def test_default_config(self):
|
|
"""Test default configuration values."""
|
|
config = CordraConfig()
|
|
assert config.base_url == "https://localhost:8443"
|
|
assert config.username is None
|
|
assert config.password is None
|
|
assert config.max_search_results == 1000
|
|
assert config.verify_ssl is True
|
|
assert config.timeout == 30
|