"""Tests for the helpers and validation tools"""
from unittest.mock import AsyncMock, MagicMock, patch
import pytest
from aiohttp.test_utils import make_mocked_request
from aiohttp import web
from custom_components.auth_oidc.tools.helpers import (
STATE_COOKIE_NAME,
error_response,
get_state_id,
get_url,
get_valid_state_id,
get_view,
html_response,
template_response,
)
from custom_components.auth_oidc.tools.validation import (
validate_client_id,
sanitize_client_secret,
validate_discovery_url,
validate_url,
)
@pytest.mark.asyncio
async def test_get_url():
"""Test the get_url helper."""
with pytest.raises(RuntimeError) as excinfo:
get_url("https://example.com", "/test")
assert str(excinfo.value) == "No current request in context"
# Mock homeassistant.components.http.current_request.get() to test the force HTTP flag
with patch("homeassistant.components.http.current_request") as mock_current_request:
fake_request = make_mocked_request("GET", "http://example.com")
mock_current_request.get.return_value = fake_request
result = get_url("/test", True)
assert result == "https://example.com/test"
@pytest.mark.asyncio
async def test_get_view():
"""Test the get_view helper."""
data = await get_view("welcome")
assert data.startswith("")
@pytest.mark.asyncio
async def test_get_state_id():
"""State cookie helper should return cookie value when present."""
request = make_mocked_request(
"GET", "/", headers={"Cookie": f"{STATE_COOKIE_NAME}=abc"}
)
assert get_state_id(request) == "abc"
request_without_cookie = make_mocked_request("GET", "/")
assert get_state_id(request_without_cookie) is None
@pytest.mark.asyncio
async def test_get_valid_state_id():
"""Valid-state helper should return only existing and valid cookie states."""
provider = MagicMock()
provider.async_is_state_valid = AsyncMock(return_value=True)
request = make_mocked_request(
"GET", "/", headers={"Cookie": f"{STATE_COOKIE_NAME}=state-1"}
)
state_id = await get_valid_state_id(request, provider)
assert state_id == "state-1"
provider.async_is_state_valid.assert_awaited_once_with("state-1")
@pytest.mark.asyncio
async def test_get_valid_state_id_invalid_or_missing_cookie():
"""Valid-state helper should reject missing and invalid states."""
provider = MagicMock()
provider.async_is_state_valid = AsyncMock(return_value=False)
request = make_mocked_request(
"GET", "/", headers={"Cookie": f"{STATE_COOKIE_NAME}=state-2"}
)
assert await get_valid_state_id(request, provider) is None
provider.async_is_state_valid.assert_awaited_once_with("state-2")
request_without_cookie = make_mocked_request("GET", "/")
provider.async_is_state_valid.reset_mock()
assert await get_valid_state_id(request_without_cookie, provider) is None
provider.async_is_state_valid.assert_not_called()
@pytest.mark.asyncio
async def test_html_response_and_template_helpers():
"""Response helpers should preserve status and render HTML views."""
response = html_response("ok
", status=418)
assert isinstance(response, web.Response)
assert response.status == 418
assert response.content_type == "text/html"
assert response.text == "ok
"
with patch(
"custom_components.auth_oidc.tools.helpers.get_view",
new=AsyncMock(return_value="rendered
"),
) as mocked_get_view:
rendered = await template_response("welcome", {"name": "OIDC"})
assert rendered.status == 200
assert rendered.text == "rendered
"
mocked_get_view.assert_awaited_once_with("welcome", {"name": "OIDC"})
@pytest.mark.asyncio
async def test_error_response():
"""Error response helper should render the shared error template with status."""
with patch(
"custom_components.auth_oidc.tools.helpers.get_view",
new=AsyncMock(return_value="error
"),
) as mocked_get_view:
rendered = await error_response("boom", status=500)
assert rendered.status == 500
assert rendered.text == "error
"
mocked_get_view.assert_awaited_once_with("error", {"error": "boom"})
@pytest.mark.asyncio
async def test_validate_url():
"""Test the validate_url helper."""
assert not validate_url("ftp://example.com")
assert validate_url("http://example.com")
assert validate_url("https://example.com")
assert not validate_url("example.com")
assert not validate_url(42)
assert not validate_url([])
@pytest.mark.asyncio
async def test_validate_discovery_url():
"""Test the validate_discovery_url helper."""
assert not validate_discovery_url("ftp://example.com")
assert not validate_discovery_url("http://example.com")
assert not validate_discovery_url("https://example.com")
assert not validate_discovery_url("example.com")
assert not validate_discovery_url(
"https://example.com/.well-known/openid_configuration"
)
assert validate_discovery_url(
"https://example.com/.well-known/openid-configuration"
)
assert not validate_discovery_url(2)
assert not validate_discovery_url([])
@pytest.mark.asyncio
async def test_client_secret():
"""Test the sanitize_client_secret helper."""
assert sanitize_client_secret("test ") == "test"
assert sanitize_client_secret("test2") == "test2"
@pytest.mark.asyncio
async def test_client_id():
"""Test the validate_client_id helper."""
assert not validate_client_id(" ")
assert validate_client_id("test4")
assert validate_client_id("test4 ")