test: Move client integration tests to mocked unit tests

This commit is contained in:
Chris Coutinho
2025-10-24 05:50:25 +02:00
parent d452684535
commit 2f1bd1bbe9
7 changed files with 1792 additions and 1289 deletions
+219 -224
View File
@@ -1,260 +1,255 @@
import logging
import uuid # Keep uuid if needed for generating unique data within tests
import anyio
import httpx
import pytest
from httpx import HTTPStatusError
from nextcloud_mcp_server.client import NextcloudClient
# Note: nc_client fixture is now session-scoped in conftest.py
from nextcloud_mcp_server.client.notes import NotesClient
from tests.client.conftest import create_mock_error_response, create_mock_note_response
logger = logging.getLogger(__name__)
# Mark all tests in this module as integration tests
pytestmark = pytest.mark.integration
# Mark all tests in this module as unit tests
pytestmark = pytest.mark.unit
async def test_notes_api_create_and_read(
nc_client: NextcloudClient, temporary_note: dict
):
"""
Tests creating a note via the API (using fixture) and then reading it back.
"""
created_note_data = temporary_note # Get data from fixture
note_id = created_note_data["id"]
logger.info(f"Reading note created by fixture, ID: {note_id}")
read_note = await nc_client.notes.get_note(note_id=note_id)
assert read_note["id"] == note_id
assert read_note["title"] == created_note_data["title"]
assert read_note["content"] == created_note_data["content"]
assert read_note["category"] == created_note_data["category"]
logger.info(f"Successfully read and verified note ID: {note_id}")
async def test_notes_api_update(nc_client: NextcloudClient, temporary_note: dict):
"""
Tests updating a note created by the fixture.
"""
created_note_data = temporary_note
note_id = created_note_data["id"]
original_etag = created_note_data["etag"]
original_category = created_note_data["category"]
update_title = f"Updated Title {uuid.uuid4().hex[:8]}"
update_content = f"Updated Content {uuid.uuid4().hex[:8]}"
logger.info(f"Attempting to update note ID: {note_id} with etag: {original_etag}")
updated_note = await nc_client.notes.update(
note_id=note_id,
etag=original_etag,
title=update_title,
content=update_content,
# category=original_category # Explicitly pass category if required by update
async def test_notes_api_get_note(mocker):
"""Test that get_note correctly parses the API response."""
# Create mock response
mock_response = create_mock_note_response(
note_id=123,
title="Test Note",
content="Test content",
category="Test",
etag="abc123",
)
logger.info(f"Note updated: {updated_note}")
assert updated_note["id"] == note_id
assert updated_note["title"] == update_title
assert updated_note["content"] == update_content
assert (
updated_note["category"] == original_category
) # Verify category didn't change
assert "etag" in updated_note
assert updated_note["etag"] != original_etag # Etag must change
# Optional: Verify update by reading again
await anyio.sleep(1) # Allow potential propagation delay
read_updated_note = await nc_client.notes.get_note(note_id=note_id)
assert read_updated_note["title"] == update_title
assert read_updated_note["content"] == update_content
logger.info(f"Successfully updated and verified note ID: {note_id}")
async def test_notes_api_update_conflict(
nc_client: NextcloudClient, temporary_note: dict
):
"""
Tests that attempting to update with an old etag fails with 412.
"""
created_note_data = temporary_note
note_id = created_note_data["id"]
original_etag = created_note_data["etag"]
# Perform a first update to change the etag
first_update_title = f"First Update {uuid.uuid4().hex[:8]}"
logger.info(f"Performing first update on note ID: {note_id} to change etag.")
first_updated_note = await nc_client.notes.update(
note_id=note_id,
etag=original_etag,
title=first_update_title,
content="First update content",
# category=created_note_data["category"] # Pass category if required
# Mock the _make_request method
mock_client = mocker.AsyncMock(spec=httpx.AsyncClient)
mock_make_request = mocker.patch.object(
NotesClient, "_make_request", return_value=mock_response
)
new_etag = first_updated_note["etag"]
assert new_etag != original_etag
logger.info(f"Note ID: {note_id} updated, new etag: {new_etag}")
await anyio.sleep(1)
# Now attempt update with the *original* etag
logger.info(
f"Attempting second update on note ID: {note_id} with OLD etag: {original_etag}"
# Create client and test
client = NotesClient(mock_client, "testuser")
note = await client.get_note(note_id=123)
# Verify the response was parsed correctly
assert note["id"] == 123
assert note["title"] == "Test Note"
assert note["content"] == "Test content"
assert note["category"] == "Test"
assert note["etag"] == "abc123"
# Verify the correct API endpoint was called
mock_make_request.assert_called_once_with("GET", "/apps/notes/api/v1/notes/123")
async def test_notes_api_create_note(mocker):
"""Test that create_note correctly parses the API response."""
mock_response = create_mock_note_response(
note_id=456,
title="New Note",
content="New content",
category="Category",
etag="def456",
)
with pytest.raises(HTTPStatusError) as excinfo:
await nc_client.notes.update(
note_id=note_id,
etag=original_etag, # Use the stale etag
title="This update should fail due to conflict",
# category=created_note_data["category"] # Pass category if required
mock_client = mocker.AsyncMock(spec=httpx.AsyncClient)
mock_make_request = mocker.patch.object(
NotesClient, "_make_request", return_value=mock_response
)
client = NotesClient(mock_client, "testuser")
note = await client.create_note(
title="New Note", content="New content", category="Category"
)
assert note["id"] == 456
assert note["title"] == "New Note"
assert note["content"] == "New content"
assert note["category"] == "Category"
# Verify the correct API call was made
mock_make_request.assert_called_once_with(
"POST",
"/apps/notes/api/v1/notes",
json={"title": "New Note", "content": "New content", "category": "Category"},
)
async def test_notes_api_update(mocker):
"""Test that update correctly parses the API response and handles etag."""
# Mock the update response (no category passed, so no GET call happens)
update_response = create_mock_note_response(
note_id=123,
title="Updated Title",
content="Updated content",
category="Test",
etag="new_etag",
)
mock_client = mocker.AsyncMock(spec=httpx.AsyncClient)
# Mock _make_request to return the update response
mock_make_request = mocker.patch.object(NotesClient, "_make_request")
mock_make_request.return_value = update_response
client = NotesClient(mock_client, "testuser")
updated_note = await client.update(
note_id=123,
etag="abc123",
title="Updated Title",
content="Updated content",
)
assert updated_note["id"] == 123
assert updated_note["title"] == "Updated Title"
assert updated_note["content"] == "Updated content"
assert updated_note["etag"] == "new_etag"
# Verify the PUT request was made with the correct etag header (only 1 call since no category)
assert mock_make_request.call_count == 1
put_call = mock_make_request.call_args_list[0]
assert put_call[0] == ("PUT", "/apps/notes/api/v1/notes/123")
assert put_call[1]["headers"]["If-Match"] == '"abc123"'
async def test_notes_api_update_conflict(mocker):
"""Test that update raises HTTPStatusError on 412 conflict."""
# Mock the 412 error response
error_response = create_mock_error_response(412, "Precondition Failed")
mock_client = mocker.AsyncMock(spec=httpx.AsyncClient)
mock_make_request = mocker.patch.object(NotesClient, "_make_request")
mock_make_request.side_effect = httpx.HTTPStatusError(
"412 Precondition Failed",
request=httpx.Request("PUT", "http://test.local"),
response=error_response,
)
client = NotesClient(mock_client, "testuser")
with pytest.raises(httpx.HTTPStatusError) as excinfo:
await client.update(
note_id=123,
etag="old_etag",
title="This should fail",
)
assert excinfo.value.response.status_code == 412 # Precondition Failed
logger.info("Update with old etag correctly failed with 412 Precondition Failed.")
assert excinfo.value.response.status_code == 412
async def test_notes_api_delete_nonexistent(nc_client: NextcloudClient):
"""
Tests deleting a note that doesn't exist fails with 404.
"""
non_existent_id = 999999999 # Use an ID highly unlikely to exist
logger.info(f"\nAttempting to delete non-existent note ID: {non_existent_id}")
with pytest.raises(HTTPStatusError) as excinfo:
await nc_client.notes.delete_note(note_id=non_existent_id)
async def test_notes_api_delete_note(mocker):
"""Test that delete_note makes the correct API call."""
# Mock get_note response (to fetch category for cleanup)
get_response = create_mock_note_response(note_id=123, category="Test")
# Mock delete response
delete_response = create_mock_note_response(note_id=123)
mock_client = mocker.AsyncMock(spec=httpx.AsyncClient)
mock_make_request = mocker.patch.object(NotesClient, "_make_request")
mock_make_request.side_effect = [get_response, delete_response]
client = NotesClient(mock_client, "testuser")
await client.delete_note(note_id=123)
# Verify DELETE was called
assert any(call[0][0] == "DELETE" for call in mock_make_request.call_args_list)
async def test_notes_api_delete_nonexistent(mocker):
"""Test that deleting a non-existent note raises 404."""
# Mock 404 error when fetching note details
error_response = create_mock_error_response(404, "Not Found")
mock_client = mocker.AsyncMock(spec=httpx.AsyncClient)
mock_make_request = mocker.patch.object(NotesClient, "_make_request")
mock_make_request.side_effect = httpx.HTTPStatusError(
"404 Not Found",
request=httpx.Request("GET", "http://test.local"),
response=error_response,
)
client = NotesClient(mock_client, "testuser")
with pytest.raises(httpx.HTTPStatusError) as excinfo:
await client.delete_note(note_id=999999999)
assert excinfo.value.response.status_code == 404
logger.info(
f"Deleting non-existent note ID: {non_existent_id} correctly failed with 404."
async def test_notes_api_append_content(mocker):
"""Test that append_content correctly appends to existing content."""
# Mock get_note response (to fetch current content)
get_response = create_mock_note_response(
note_id=123,
content="Original content",
etag="old_etag",
)
async def test_notes_api_append_content_to_existing_note(
nc_client: NextcloudClient, temporary_note: dict
):
"""
Tests appending content to an existing note using the new append functionality.
"""
created_note_data = temporary_note
note_id = created_note_data["id"]
original_content = created_note_data["content"]
append_text = f"Appended content {uuid.uuid4().hex[:8]}"
logger.info(f"Appending content to note ID: {note_id}")
updated_note = await nc_client.notes.append_content(
note_id=note_id, content=append_text
# Mock update response with appended content
update_response = create_mock_note_response(
note_id=123,
content="Original content\n---\nAppended content",
etag="new_etag",
)
logger.info(f"Note after append: {updated_note}")
# Verify the note was updated
assert updated_note["id"] == note_id
assert "etag" in updated_note
assert updated_note["etag"] != created_note_data["etag"] # Etag must change
mock_client = mocker.AsyncMock(spec=httpx.AsyncClient)
mock_make_request = mocker.patch.object(NotesClient, "_make_request")
# First call: GET (from get_note), second call: PUT (from update)
mock_make_request.side_effect = [get_response, update_response]
# Verify content has the separator and appended text
expected_content = original_content + "\n---\n" + append_text
assert updated_note["content"] == expected_content
client = NotesClient(mock_client, "testuser")
updated_note = await client.append_content(note_id=123, content="Appended content")
# Verify by reading the note again
await anyio.sleep(1) # Allow potential propagation delay
read_note = await nc_client.notes.get_note(note_id=note_id)
assert read_note["content"] == expected_content
logger.info(f"Successfully appended content to note ID: {note_id}")
assert updated_note["content"] == "Original content\n---\nAppended content"
assert updated_note["etag"] == "new_etag"
async def test_notes_api_append_content_to_empty_note(nc_client: NextcloudClient):
"""
Tests appending content to an empty note (no separator should be added).
"""
# Create an empty note
test_title = f"Empty Note {uuid.uuid4().hex[:8]}"
test_category = "Test"
logger.info("Creating empty note for append test")
empty_note = await nc_client.notes.create_note(
title=test_title,
async def test_notes_api_append_content_to_empty_note(mocker):
"""Test that appending to empty note doesn't add separator."""
# Mock get_note response with empty content
get_response = create_mock_note_response(
note_id=123,
content="",
category=test_category, # Empty content
)
note_id = empty_note["id"]
try:
append_text = f"First content {uuid.uuid4().hex[:8]}"
logger.info(f"Appending content to empty note ID: {note_id}")
updated_note = await nc_client.notes.append_content(
note_id=note_id, content=append_text
)
# For empty notes, content should just be the appended text (no separator)
assert updated_note["content"] == append_text
# Verify by reading the note again
await anyio.sleep(1)
read_note = await nc_client.notes.get_note(note_id=note_id)
assert read_note["content"] == append_text
logger.info(f"Successfully appended content to empty note ID: {note_id}")
finally:
# Clean up the test note
try:
await nc_client.notes.delete_note(note_id=note_id)
logger.info(f"Cleaned up test note ID: {note_id}")
except Exception as e:
logger.warning(f"Failed to clean up test note ID: {note_id}: {e}")
async def test_notes_api_append_content_multiple_times(
nc_client: NextcloudClient, temporary_note: dict
):
"""
Tests appending content multiple times to verify separator behavior.
"""
created_note_data = temporary_note
note_id = created_note_data["id"]
original_content = created_note_data["content"]
first_append = f"First append {uuid.uuid4().hex[:8]}"
second_append = f"Second append {uuid.uuid4().hex[:8]}"
logger.info(f"Performing multiple appends to note ID: {note_id}")
# First append
updated_note = await nc_client.notes.append_content(
note_id=note_id, content=first_append
etag="old_etag",
)
expected_content_after_first = original_content + "\n---\n" + first_append
assert updated_note["content"] == expected_content_after_first
# Second append
updated_note = await nc_client.notes.append_content(
note_id=note_id, content=second_append
# Mock update response with just the appended text (no separator)
update_response = create_mock_note_response(
note_id=123,
content="First content",
etag="new_etag",
)
expected_content_after_second = (
expected_content_after_first + "\n---\n" + second_append
mock_client = mocker.AsyncMock(spec=httpx.AsyncClient)
mock_make_request = mocker.patch.object(NotesClient, "_make_request")
# First call: GET (from get_note), second call: PUT (from update)
mock_make_request.side_effect = [get_response, update_response]
client = NotesClient(mock_client, "testuser")
updated_note = await client.append_content(note_id=123, content="First content")
# For empty notes, no separator should be added
assert updated_note["content"] == "First content"
async def test_notes_api_append_content_nonexistent_note(mocker):
"""Test that appending to a non-existent note raises 404."""
error_response = create_mock_error_response(404, "Not Found")
mock_client = mocker.AsyncMock(spec=httpx.AsyncClient)
mock_make_request = mocker.patch.object(NotesClient, "_make_request")
mock_make_request.side_effect = httpx.HTTPStatusError(
"404 Not Found",
request=httpx.Request("GET", "http://test.local"),
response=error_response,
)
assert updated_note["content"] == expected_content_after_second
# Verify by reading the note again
await anyio.sleep(1)
read_note = await nc_client.notes.get_note(note_id=note_id)
assert read_note["content"] == expected_content_after_second
logger.info(f"Successfully performed multiple appends to note ID: {note_id}")
client = NotesClient(mock_client, "testuser")
with pytest.raises(httpx.HTTPStatusError) as excinfo:
await client.append_content(note_id=999999999, content="This should fail")
async def test_notes_api_append_content_nonexistent_note(nc_client: NextcloudClient):
"""
Tests that appending to a non-existent note fails with 404.
"""
non_existent_id = 999999999
logger.info(f"Attempting to append to non-existent note ID: {non_existent_id}")
with pytest.raises(HTTPStatusError) as excinfo:
await nc_client.notes.append_content(
note_id=non_existent_id, content="This should fail"
)
assert excinfo.value.response.status_code == 404
logger.info(
f"Appending to non-existent note ID: {non_existent_id} correctly failed with 404."
)