trustgraph/tests/unit/test_gateway/test_endpoint_stream.py

"""
Tests for Gateway Stream Endpoint
"""

import pytest
from unittest.mock import MagicMock

from trustgraph.gateway.endpoint.stream_endpoint import StreamEndpoint


class TestStreamEndpoint:
    """Test cases for StreamEndpoint class"""

    def test_stream_endpoint_initialization_with_post(self):
        """Construction records the configured capability on the
        instance.  StreamEndpoint is used in production for the
        core-import / core-export / document-stream routes; a
        document-write capability is a realistic value for a POST
        stream (e.g. core-import)."""
        mock_auth = MagicMock()
        mock_dispatcher = MagicMock()

        endpoint = StreamEndpoint(
            endpoint_path="/api/stream",
            auth=mock_auth,
            dispatcher=mock_dispatcher,
            capability="documents:write",
            method="POST",
        )

        assert endpoint.path == "/api/stream"
        assert endpoint.auth == mock_auth
        assert endpoint.dispatcher == mock_dispatcher
        assert endpoint.capability == "documents:write"
        assert endpoint.method == "POST"

    def test_stream_endpoint_initialization_with_get(self):
        """GET stream — export-style endpoint, read capability."""
        mock_auth = MagicMock()
        mock_dispatcher = MagicMock()

        endpoint = StreamEndpoint(
            endpoint_path="/api/stream",
            auth=mock_auth,
            dispatcher=mock_dispatcher,
            capability="documents:read",
            method="GET",
        )

        assert endpoint.method == "GET"

    def test_stream_endpoint_initialization_default_method(self):
        """Test StreamEndpoint initialization with default POST method.
        The method default is cosmetic; the capability is not
        defaulted — it is always required."""
        mock_auth = MagicMock()
        mock_dispatcher = MagicMock()

        endpoint = StreamEndpoint(
            endpoint_path="/api/stream",
            auth=mock_auth,
            dispatcher=mock_dispatcher,
            capability="documents:write",
        )

        assert endpoint.method == "POST"  # Default value

    @pytest.mark.asyncio
    async def test_stream_endpoint_start_method(self):
        """Test StreamEndpoint start method (should be no-op)"""
        mock_auth = MagicMock()
        mock_dispatcher = MagicMock()

        endpoint = StreamEndpoint(
            "/api/stream", mock_auth, mock_dispatcher,
            capability="documents:write",
        )

        # start() should complete without error
        await endpoint.start()

    def test_add_routes_with_post_method(self):
        """Test add_routes method with POST method"""
        mock_auth = MagicMock()
        mock_dispatcher = MagicMock()
        mock_app = MagicMock()

        endpoint = StreamEndpoint(
            endpoint_path="/api/stream",
            auth=mock_auth,
            dispatcher=mock_dispatcher,
            capability="documents:write",
            method="POST",
        )

        endpoint.add_routes(mock_app)

        # Verify add_routes was called with POST route
        mock_app.add_routes.assert_called_once()
        call_args = mock_app.add_routes.call_args[0][0]
        assert len(call_args) == 1  # One route added

    def test_add_routes_with_get_method(self):
        """Test add_routes method with GET method"""
        mock_auth = MagicMock()
        mock_dispatcher = MagicMock()
        mock_app = MagicMock()

        endpoint = StreamEndpoint(
            endpoint_path="/api/stream",
            auth=mock_auth,
            dispatcher=mock_dispatcher,
            capability="documents:read",
            method="GET",
        )

        endpoint.add_routes(mock_app)

        # Verify add_routes was called with GET route
        mock_app.add_routes.assert_called_once()
        call_args = mock_app.add_routes.call_args[0][0]
        assert len(call_args) == 1  # One route added

    def test_add_routes_with_invalid_method_raises_error(self):
        """Test add_routes method with invalid method raises RuntimeError"""
        mock_auth = MagicMock()
        mock_dispatcher = MagicMock()
        mock_app = MagicMock()

        endpoint = StreamEndpoint(
            endpoint_path="/api/stream",
            auth=mock_auth,
            dispatcher=mock_dispatcher,
            capability="documents:write",
            method="INVALID",
        )

        with pytest.raises(RuntimeError, match="Bad method"):
            endpoint.add_routes(mock_app)