Files
mcp-nextcloud/tests/unit/test_management_apps_endpoint.py
T
Chris CoutinhoandClaude Opus 4.7 a0e484d95b fix(webhooks): use app-password basic auth for NC API calls
The webhook API endpoints in api/webhooks.py forwarded the inbound MCP
OAuth bearer token directly to Nextcloud as the Authorization header.
Per ADR-022 / docs/login-flow-v2.md the data leg from MCP server to
Nextcloud must use HTTP Basic Auth with the user's stored Login Flow v2
app password — bearer-forwarding requires upstream user_oidc patches that
were never merged and is incompatible with admin endpoints gated by
@PasswordConfirmationRequired (e.g. webhook_listeners/api/v1/webhooks,
which 401s).

PR #760 papered over the symptom for /api/v1/apps by switching to the
permissive /cloud/capabilities endpoint, but the same architectural
mistake remained on list_webhooks / create_webhook / delete_webhook,
which still 500'd on the astrolabe admin UI's preset page.

Changes:
- New helper api/_auth.py:get_basic_auth_for_user(user_id) reads the
  user's app password from encrypted storage and returns
  (username, app_password). Mirrors context.py:_get_client_from_login_flow
  but is callable from Starlette routes (no MCP Context required).
- All four endpoints in api/webhooks.py now use httpx.BasicAuth instead
  of forwarding the OAuth bearer; ProvisioningRequiredError is mapped to
  HTTP 412 so callers can render a "complete provisioning" CTA rather
  than receiving an opaque 500.
- Outbound NC requests now identify the user by the username recorded at
  Login Flow v2 provisioning time (which may differ from the IdP-issued
  user_id) — flowed into WebhooksClient and used for logging.

Tests:
- tests/unit/test_management_apps_endpoint.py: assertions updated to
  verify outbound NC request uses BasicAuth and carries no Authorization
  header. Replaced "missing-Authorization → 500" test with a
  ProvisioningRequiredError → 412 case.
- tests/unit/test_webhooks_api_auth.py (new): cross-endpoint coverage
  for list_webhooks, create_webhook, delete_webhook and the new helper —
  including 412 symmetry for all four endpoints.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-03 23:50:59 +02:00

186 lines
6.6 KiB
Python

"""
Unit tests for the Management API /api/v1/apps endpoint.
The handler hits ``/ocs/v2.php/cloud/capabilities`` (not the legacy admin-only
``/ocs/v1.php/cloud/apps`` which was ``@PasswordConfirmationRequired``) and
authenticates via the user's stored Login Flow v2 app password using HTTP
Basic Auth. The OAuth bearer is **never** forwarded to Nextcloud (see
``docs/login-flow-v2.md`` and ADR-022).
"""
from unittest.mock import AsyncMock, MagicMock
import httpx
import pytest
from starlette.applications import Starlette
from starlette.routing import Route
from starlette.testclient import TestClient
from nextcloud_mcp_server.api.webhooks import get_installed_apps
from nextcloud_mcp_server.auth.scope_authorization import ProvisioningRequiredError
pytestmark = pytest.mark.unit
def _build_test_app() -> Starlette:
app = Starlette(routes=[Route("/api/v1/apps", get_installed_apps, methods=["GET"])])
app.state.oauth_context = {"config": {"nextcloud_host": "http://nc.test"}}
return app
def _patch_token_validation(mocker, user_id: str = "admin") -> None:
mocker.patch(
"nextcloud_mcp_server.api.webhooks.validate_token_and_get_user",
new=AsyncMock(return_value=(user_id, {"sub": user_id})),
)
def _patch_basic_auth(
mocker, username: str = "admin", app_password: str = "stored-app-pwd"
) -> AsyncMock:
"""Patch get_basic_auth_for_user to return canned credentials."""
return mocker.patch(
"nextcloud_mcp_server.api.webhooks.get_basic_auth_for_user",
new=AsyncMock(return_value=(username, app_password)),
)
def _patch_outbound_client(mocker, response: MagicMock) -> MagicMock:
"""Patch the outbound httpx client; return the factory MagicMock so tests
can introspect the kwargs (esp. ``auth=``) it was called with."""
mock_get = AsyncMock(return_value=response)
mock_client = AsyncMock()
mock_client.get = mock_get
mock_client.__aenter__ = AsyncMock(return_value=mock_client)
# Must return False (or None) so async-with does NOT suppress exceptions
# raised inside the block — default AsyncMock() resolves to a truthy
# MagicMock and would silently swallow ValueError.
mock_client.__aexit__ = AsyncMock(return_value=False)
mock_factory = MagicMock(return_value=mock_client)
mocker.patch(
"nextcloud_mcp_server.api.webhooks.nextcloud_httpx_client", mock_factory
)
mock_factory.attach_mock(mock_get, "get")
return mock_factory
def _capabilities_response(capabilities: dict[str, dict]) -> MagicMock:
response = MagicMock()
response.status_code = 200
response.json.return_value = {"ocs": {"data": {"capabilities": capabilities}}}
return response
async def test_returns_sorted_capability_keys(mocker):
"""Happy path: handler hits OCS v2 capabilities and returns sorted app keys."""
_patch_token_validation(mocker)
_patch_basic_auth(mocker)
response = _capabilities_response(
{
"notes": {"api_version": "1.4"},
"files": {"bigfilechunking": True},
"core": {"webdav-root": "remote.php/webdav"},
"tables": {"foo": "bar"},
}
)
factory = _patch_outbound_client(mocker, response)
app = _build_test_app()
client = TestClient(app)
http_response = client.get(
"/api/v1/apps", headers={"Authorization": "Bearer test-token"}
)
assert http_response.status_code == 200
assert http_response.json() == {"apps": ["core", "files", "notes", "tables"]}
# Outbound URL is OCS v2 capabilities, NOT v1 cloud/apps.
factory.get.assert_awaited_once()
called_path = factory.get.call_args.args[0]
assert called_path == "/ocs/v2.php/cloud/capabilities"
# Outbound auth is BasicAuth (NOT Bearer) — the OAuth token must not be
# forwarded to Nextcloud per ADR-022 / docs/login-flow-v2.md.
factory_kwargs = factory.call_args.kwargs
assert "headers" not in factory_kwargs or "Authorization" not in (
factory_kwargs.get("headers") or {}
)
assert isinstance(factory_kwargs["auth"], httpx.BasicAuth)
async def test_empty_capabilities_returns_empty_list(mocker):
"""Empty capabilities map → empty apps list, not an error."""
_patch_token_validation(mocker)
_patch_basic_auth(mocker)
response = _capabilities_response({})
_patch_outbound_client(mocker, response)
app = _build_test_app()
client = TestClient(app)
http_response = client.get(
"/api/v1/apps", headers={"Authorization": "Bearer test-token"}
)
assert http_response.status_code == 200
assert http_response.json() == {"apps": []}
async def test_ocs_error_returns_500_with_sanitized_message(mocker):
"""Non-200 from Nextcloud OCS surfaces as a generic 500 to the caller."""
_patch_token_validation(mocker)
_patch_basic_auth(mocker)
error_response = MagicMock()
error_response.status_code = 503
_patch_outbound_client(mocker, error_response)
app = _build_test_app()
client = TestClient(app)
http_response = client.get(
"/api/v1/apps", headers={"Authorization": "Bearer test-token"}
)
assert http_response.status_code == 500
body = http_response.json()
assert body["error"] == "Internal error"
# _sanitize_error_for_client returns a generic message; specific status
# code must NOT leak to the client
assert "503" not in body["message"]
async def test_missing_nextcloud_host_returns_500(mocker):
"""Misconfigured oauth_context (no nextcloud_host) surfaces as 500."""
_patch_token_validation(mocker)
_patch_basic_auth(mocker)
response = _capabilities_response({})
_patch_outbound_client(mocker, response)
app = Starlette(routes=[Route("/api/v1/apps", get_installed_apps, methods=["GET"])])
app.state.oauth_context = {"config": {}} # no nextcloud_host
client = TestClient(app)
http_response = client.get(
"/api/v1/apps", headers={"Authorization": "Bearer test-token"}
)
assert http_response.status_code == 500
async def test_unprovisioned_user_returns_412(mocker):
"""Users without a stored app password get HTTP 412 so the client can
surface a 'complete Login Flow v2' UX rather than a generic 500."""
_patch_token_validation(mocker)
mocker.patch(
"nextcloud_mcp_server.api.webhooks.get_basic_auth_for_user",
new=AsyncMock(side_effect=ProvisioningRequiredError("not provisioned")),
)
app = _build_test_app()
client = TestClient(app)
http_response = client.get(
"/api/v1/apps", headers={"Authorization": "Bearer test-token"}
)
assert http_response.status_code == 412
assert http_response.json()["error"] == "Provisioning required"