Skip to content

data grand lyon: use test fixture instead of manual patching #170294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
balloob merged 1 commit into from
May 11, 2026
Merged

data grand lyon: use test fixture instead of manual patching #170294

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 58 additions & 60 deletions tests/components/data_grand_lyon/test_config_flow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
"""Test the Data Grand Lyon config flow."""

from collections.abc import Generator
from unittest.mock import AsyncMock, patch

from aiohttp import ClientConnectionError, ClientResponseError
Expand All @@ -18,27 +19,38 @@

from tests.common import MockConfigEntry


@pytest.fixture
def mock_get_tcl_passages() -> Generator[AsyncMock]:
"""Mock get_tcl_passages in config flow validation."""
with patch(
"homeassistant.components.data_grand_lyon.config_flow.DataGrandLyonClient.get_tcl_passages",
return_value=[],
) as mock:
yield mock


# Main config flow tests


async def test_full_user_flow(hass: HomeAssistant, mock_setup_entry: AsyncMock) -> None:
async def test_full_user_flow(
hass: HomeAssistant,
mock_setup_entry: AsyncMock,
mock_get_tcl_passages: AsyncMock,
) -> None:
"""Test we get the form and can create an entry with credentials."""
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": config_entries.SOURCE_USER}
)
assert result["type"] is FlowResultType.FORM

with patch(
"homeassistant.components.data_grand_lyon.config_flow.DataGrandLyonClient.get_tcl_passages",
return_value=[],
):
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{
CONF_USERNAME: "test-username",
CONF_PASSWORD: "test-password",
},
)
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{
CONF_USERNAME: "test-username",
CONF_PASSWORD: "test-password",
},
)

assert result["type"] is FlowResultType.CREATE_ENTRY
assert result["title"] == "Data Grand Lyon"
Expand All @@ -60,41 +72,39 @@ async def test_full_user_flow(hass: HomeAssistant, mock_setup_entry: AsyncMock)
ids=["connection-error", "auth-401", "http-500", "unknown"],
)
async def test_form_error_recovers(
hass: HomeAssistant, side_effect: Exception, error: str
hass: HomeAssistant,
mock_get_tcl_passages: AsyncMock,
side_effect: Exception,
error: str,
) -> None:
"""Test we show an error on API failures and can recover."""
result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": config_entries.SOURCE_USER}
)

with patch(
"homeassistant.components.data_grand_lyon.config_flow.DataGrandLyonClient.get_tcl_passages",
side_effect=side_effect,
):
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_USERNAME: "user", CONF_PASSWORD: "pass"},
)
mock_get_tcl_passages.side_effect = side_effect
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_USERNAME: "user", CONF_PASSWORD: "pass"},
)

assert result["type"] is FlowResultType.FORM
assert result["errors"] == {"base": error}

# Recover
with patch(
"homeassistant.components.data_grand_lyon.config_flow.DataGrandLyonClient.get_tcl_passages",
return_value=[],
):
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_USERNAME: "user", CONF_PASSWORD: "pass"},
)
mock_get_tcl_passages.side_effect = None
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_USERNAME: "user", CONF_PASSWORD: "pass"},
)

assert result["type"] is FlowResultType.CREATE_ENTRY


async def test_reauth_flow(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_get_tcl_passages: AsyncMock,
) -> None:
"""Test the reauth flow updates credentials on success."""
mock_config_entry.add_to_hass(hass)
Expand All @@ -103,14 +113,10 @@ async def test_reauth_flow(
assert result["type"] is FlowResultType.FORM
assert result["step_id"] == "reauth_confirm"

with patch(
"homeassistant.components.data_grand_lyon.config_flow.DataGrandLyonClient.get_tcl_passages",
return_value=[],
):
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_USERNAME: "new-user", CONF_PASSWORD: "new-pass"},
)
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_USERNAME: "new-user", CONF_PASSWORD: "new-pass"},
)

assert result["type"] is FlowResultType.ABORT
assert result["reason"] == "reauth_successful"
Expand All @@ -133,6 +139,7 @@ async def test_reauth_flow(
async def test_reauth_flow_errors(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_get_tcl_passages: AsyncMock,
side_effect: Exception,
error: str,
) -> None:
Expand All @@ -141,27 +148,21 @@ async def test_reauth_flow_errors(

result = await mock_config_entry.start_reauth_flow(hass)

with patch(
"homeassistant.components.data_grand_lyon.config_flow.DataGrandLyonClient.get_tcl_passages",
side_effect=side_effect,
):
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_USERNAME: "new-user", CONF_PASSWORD: "new-pass"},
)
mock_get_tcl_passages.side_effect = side_effect
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_USERNAME: "new-user", CONF_PASSWORD: "new-pass"},
)

assert result["type"] is FlowResultType.FORM
assert result["step_id"] == "reauth_confirm"
assert result["errors"] == {"base": error}

with patch(
"homeassistant.components.data_grand_lyon.config_flow.DataGrandLyonClient.get_tcl_passages",
return_value=[],
):
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_USERNAME: "new-user", CONF_PASSWORD: "new-pass"},
)
mock_get_tcl_passages.side_effect = None
result = await hass.config_entries.flow.async_configure(
result["flow_id"],
{CONF_USERNAME: "new-user", CONF_PASSWORD: "new-pass"},
)

assert result["type"] is FlowResultType.ABORT
assert result["reason"] == "reauth_successful"
Expand All @@ -174,6 +175,7 @@ async def test_reauth_flow_errors(
async def test_form_already_configured(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_get_tcl_passages: AsyncMock,
) -> None:
"""Test we abort if already configured."""
mock_config_entry.add_to_hass(hass)
Expand All @@ -183,13 +185,9 @@ async def test_form_already_configured(
)
assert result["type"] is FlowResultType.FORM

with patch(
"homeassistant.components.data_grand_lyon.config_flow.DataGrandLyonClient.get_tcl_passages",
return_value=[],
):
result = await hass.config_entries.flow.async_configure(
result["flow_id"], {CONF_USERNAME: "user", CONF_PASSWORD: "pass"}
)
result = await hass.config_entries.flow.async_configure(
result["flow_id"], {CONF_USERNAME: "user", CONF_PASSWORD: "pass"}
)

assert result["type"] is FlowResultType.ABORT
assert result["reason"] == "already_configured"
Expand Down