core/tests/components/renault/test_config_flow.py

"""Test the Renault config flow."""

from unittest.mock import AsyncMock, PropertyMock, patch

import aiohttp
import pytest
from renault_api.gigya.exceptions import InvalidCredentialsException
from renault_api.kamereon import schemas
from renault_api.renault_account import RenaultAccount
from renault_api.renault_session import RenaultSession

from homeassistant import config_entries
from homeassistant.components.renault.const import DOMAIN, RenaultConfigurationKeys
from homeassistant.core import HomeAssistant
from homeassistant.data_entry_flow import FlowResultType
from homeassistant.helpers import aiohttp_client

from .const import MOCK_LOGIN_TOKEN

from tests.common import MockConfigEntry, async_load_fixture, get_schema_suggested_value

pytestmark = pytest.mark.usefixtures("mock_setup_entry")


def _mock_login(session: RenaultSession, login_id: str, password: str) -> None:
    """Restore a login token like a successful Gigya login would."""
    session.set_login_token(MOCK_LOGIN_TOKEN)


@pytest.mark.parametrize(
    ("exception", "error"),
    [
        (Exception(), "unknown"),
        (aiohttp.ClientConnectionError(), "cannot_connect"),
        (
            InvalidCredentialsException(403042, "invalid loginID or password"),
            "invalid_credentials",
        ),
    ],
)
async def test_config_flow_single_account(
    hass: HomeAssistant,
    mock_setup_entry: AsyncMock,
    exception: Exception,
    error: str,
) -> None:
    """Test we get the form."""
    result = await hass.config_entries.flow.async_init(
        DOMAIN, context={"source": config_entries.SOURCE_USER}
    )
    assert result["type"] is FlowResultType.FORM
    assert result["step_id"] == "user"
    assert not result["errors"]

    # Raise error
    with patch(
        "renault_api.renault_session.RenaultSession.login",
        side_effect=exception,
    ):
        result = await hass.config_entries.flow.async_configure(
            result["flow_id"],
            user_input={
                RenaultConfigurationKeys.LOCALE: "fr_FR",
                RenaultConfigurationKeys.USERNAME: "email@test.com",
                RenaultConfigurationKeys.PASSWORD: "test",
            },
        )

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

    data_schema = result["data_schema"].schema
    assert (
        get_schema_suggested_value(data_schema, RenaultConfigurationKeys.LOCALE)
        == "fr_FR"
    )
    assert (
        get_schema_suggested_value(data_schema, RenaultConfigurationKeys.USERNAME)
        == "email@test.com"
    )
    assert (
        get_schema_suggested_value(data_schema, RenaultConfigurationKeys.PASSWORD)
        == "test"
    )

    renault_account = AsyncMock()
    type(renault_account).account_id = PropertyMock(return_value="account_id_1")
    renault_account.get_vehicles.return_value = (
        schemas.KamereonVehiclesResponseSchema.loads(
            await async_load_fixture(hass, "vehicle_zoe_40.json", DOMAIN)
        )
    )

    # Account list single
    with (
        patch(
            "renault_api.renault_session.RenaultSession.login",
            autospec=True,
            side_effect=_mock_login,
        ),
        patch(
            "renault_api.renault_client.RenaultClient.get_api_accounts",
            return_value=[renault_account],
        ),
    ):
        result = await hass.config_entries.flow.async_configure(
            result["flow_id"],
            user_input={
                RenaultConfigurationKeys.LOCALE: "fr_FR",
                RenaultConfigurationKeys.USERNAME: "email@test.com",
                RenaultConfigurationKeys.PASSWORD: "test",
            },
        )

    assert result["type"] is FlowResultType.CREATE_ENTRY
    assert result["title"] == "account_id_1"
    assert result["data"][RenaultConfigurationKeys.USERNAME] == "email@test.com"
    assert result["data"][RenaultConfigurationKeys.PASSWORD] == "test"
    assert result["data"][RenaultConfigurationKeys.LOGIN_TOKEN] == MOCK_LOGIN_TOKEN
    assert (
        result["data"][RenaultConfigurationKeys.KAMEREON_ACCOUNT_ID] == "account_id_1"
    )
    assert result["data"][RenaultConfigurationKeys.LOCALE] == "fr_FR"
    assert result["context"]["unique_id"] == "account_id_1"

    assert len(mock_setup_entry.mock_calls) == 1


async def test_config_flow_no_account(
    hass: HomeAssistant, mock_setup_entry: AsyncMock
) -> None:
    """Test we get the form."""
    result = await hass.config_entries.flow.async_init(
        DOMAIN, context={"source": config_entries.SOURCE_USER}
    )
    assert result["type"] is FlowResultType.FORM
    assert result["errors"] == {}

    # Account list empty
    with (
        patch(
            "renault_api.renault_session.RenaultSession.login",
            autospec=True,
            side_effect=_mock_login,
        ),
        patch(
            "renault_api.renault_client.RenaultClient.get_api_accounts",
            return_value=[],
        ),
    ):
        result = await hass.config_entries.flow.async_configure(
            result["flow_id"],
            user_input={
                RenaultConfigurationKeys.LOCALE: "fr_FR",
                RenaultConfigurationKeys.USERNAME: "email@test.com",
                RenaultConfigurationKeys.PASSWORD: "test",
            },
        )

    assert result["type"] is FlowResultType.ABORT
    assert result["reason"] == "kamereon_no_account"

    assert len(mock_setup_entry.mock_calls) == 0


async def test_config_flow_multiple_accounts(
    hass: HomeAssistant, mock_setup_entry: AsyncMock
) -> None:
    """Test what happens if multiple Kamereon accounts are available."""
    result = await hass.config_entries.flow.async_init(
        DOMAIN, context={"source": config_entries.SOURCE_USER}
    )
    assert result["type"] is FlowResultType.FORM
    assert result["errors"] == {}

    renault_account_1 = RenaultAccount(
        "account_id_1",
        websession=aiohttp_client.async_get_clientsession(hass),
    )
    renault_account_2 = RenaultAccount(
        "account_id_2",
        websession=aiohttp_client.async_get_clientsession(hass),
    )
    renault_vehicles = schemas.KamereonVehiclesResponseSchema.loads(
        await async_load_fixture(hass, "renault/vehicle_zoe_40.json")
    )

    # Multiple accounts
    with (
        patch(
            "renault_api.renault_session.RenaultSession.login",
            autospec=True,
            side_effect=_mock_login,
        ),
        patch(
            "renault_api.renault_client.RenaultClient.get_api_accounts",
            return_value=[renault_account_1, renault_account_2],
        ),
        patch(
            "renault_api.renault_account.RenaultAccount.get_vehicles",
            return_value=renault_vehicles,
        ),
    ):
        result = await hass.config_entries.flow.async_configure(
            result["flow_id"],
            user_input={
                RenaultConfigurationKeys.LOCALE: "fr_FR",
                RenaultConfigurationKeys.USERNAME: "email@test.com",
                RenaultConfigurationKeys.PASSWORD: "test",
            },
        )

    assert result["type"] is FlowResultType.FORM
    assert result["step_id"] == "kamereon"

    # Account selected
    result = await hass.config_entries.flow.async_configure(
        result["flow_id"],
        user_input={RenaultConfigurationKeys.KAMEREON_ACCOUNT_ID: "account_id_2"},
    )
    assert result["type"] is FlowResultType.CREATE_ENTRY
    assert result["title"] == "account_id_2"
    assert result["data"][RenaultConfigurationKeys.USERNAME] == "email@test.com"
    assert result["data"][RenaultConfigurationKeys.PASSWORD] == "test"
    assert result["data"][RenaultConfigurationKeys.LOGIN_TOKEN] == MOCK_LOGIN_TOKEN
    assert (
        result["data"][RenaultConfigurationKeys.KAMEREON_ACCOUNT_ID] == "account_id_2"
    )
    assert result["data"][RenaultConfigurationKeys.LOCALE] == "fr_FR"
    assert result["context"]["unique_id"] == "account_id_2"

    assert len(mock_setup_entry.mock_calls) == 1


@pytest.mark.usefixtures("config_entry")
async def test_config_flow_duplicate(
    hass: HomeAssistant, mock_setup_entry: AsyncMock
) -> None:
    """Test abort if unique_id configured."""
    assert len(hass.config_entries.async_entries(DOMAIN)) == 1

    result = await hass.config_entries.flow.async_init(
        DOMAIN, context={"source": config_entries.SOURCE_USER}
    )
    assert result["type"] is FlowResultType.FORM
    assert result["errors"] == {}

    renault_account = RenaultAccount(
        "account_id_1",
        websession=aiohttp_client.async_get_clientsession(hass),
    )
    renault_vehicles = schemas.KamereonVehiclesResponseSchema.loads(
        await async_load_fixture(hass, "renault/vehicle_zoe_50.json")
    )
    with (
        patch(
            "renault_api.renault_session.RenaultSession.login",
            autospec=True,
            side_effect=_mock_login,
        ),
        patch(
            "renault_api.renault_client.RenaultClient.get_api_accounts",
            return_value=[renault_account],
        ),
        patch(
            "renault_api.renault_account.RenaultAccount.get_vehicles",
            return_value=renault_vehicles,
        ),
    ):
        result = await hass.config_entries.flow.async_configure(
            result["flow_id"],
            user_input={
                RenaultConfigurationKeys.LOCALE: "fr_FR",
                RenaultConfigurationKeys.USERNAME: "email@test.com",
                RenaultConfigurationKeys.PASSWORD: "test",
            },
        )

    assert result["type"] is FlowResultType.ABORT
    assert result["reason"] == "already_configured"
    await hass.async_block_till_done()

    assert len(mock_setup_entry.mock_calls) == 0


async def test_reauth(hass: HomeAssistant, config_entry: MockConfigEntry) -> None:
    """Test the start of the config flow."""
    assert len(hass.config_entries.async_entries(DOMAIN)) == 1

    result = await config_entry.start_reauth_flow(hass)

    assert result["type"] is FlowResultType.FORM
    assert result["description_placeholders"] == {
        "name": "Mock Title",
        RenaultConfigurationKeys.USERNAME: "email@test.com",
    }
    assert result["errors"] == {}

    # Failed credentials
    with patch(
        "renault_api.renault_session.RenaultSession.login",
        side_effect=InvalidCredentialsException(403042, "invalid loginID or password"),
    ):
        result2 = await hass.config_entries.flow.async_configure(
            result["flow_id"],
            user_input={RenaultConfigurationKeys.PASSWORD: "any"},
        )

    assert result2["type"] is FlowResultType.FORM
    assert result2["description_placeholders"] == {
        "name": "Mock Title",
        RenaultConfigurationKeys.USERNAME: "email@test.com",
    }
    assert result2["errors"] == {"base": "invalid_credentials"}

    # Valid credentials
    with patch(
        "renault_api.renault_session.RenaultSession.login",
        autospec=True,
        side_effect=_mock_login,
    ):
        result3 = await hass.config_entries.flow.async_configure(
            result["flow_id"],
            user_input={RenaultConfigurationKeys.PASSWORD: "any"},
        )

    assert result3["type"] is FlowResultType.ABORT
    assert result3["reason"] == "reauth_successful"

    assert config_entry.data[RenaultConfigurationKeys.USERNAME] == "email@test.com"
    assert config_entry.data[RenaultConfigurationKeys.PASSWORD] == "any"
    assert config_entry.data[RenaultConfigurationKeys.LOGIN_TOKEN] == MOCK_LOGIN_TOKEN


async def test_reconfigure(
    hass: HomeAssistant,
    mock_setup_entry: AsyncMock,
    config_entry: MockConfigEntry,
) -> None:
    """Test reconfigure works."""
    result = await config_entry.start_reconfigure_flow(hass)
    assert result["type"] is FlowResultType.FORM
    assert result["step_id"] == "user"
    assert not result["errors"]

    data_schema = result["data_schema"].schema
    assert (
        get_schema_suggested_value(data_schema, RenaultConfigurationKeys.LOCALE)
        == "fr_FR"
    )
    assert (
        get_schema_suggested_value(data_schema, RenaultConfigurationKeys.USERNAME)
        == "email@test.com"
    )
    assert (
        get_schema_suggested_value(data_schema, RenaultConfigurationKeys.PASSWORD)
        == "test"
    )

    renault_account = AsyncMock()
    type(renault_account).account_id = PropertyMock(return_value="account_id_1")
    renault_account.get_vehicles.return_value = (
        schemas.KamereonVehiclesResponseSchema.loads(
            await async_load_fixture(hass, "vehicle_zoe_40.json", DOMAIN)
        )
    )

    # Account list single
    with (
        patch(
            "renault_api.renault_session.RenaultSession.login",
            autospec=True,
            side_effect=_mock_login,
        ),
        patch(
            "renault_api.renault_client.RenaultClient.get_api_accounts",
            return_value=[renault_account],
        ),
    ):
        result = await hass.config_entries.flow.async_configure(
            result["flow_id"],
            user_input={
                RenaultConfigurationKeys.LOCALE: "fr_FR",
                RenaultConfigurationKeys.USERNAME: "email2@test.com",
                RenaultConfigurationKeys.PASSWORD: "test2",
            },
        )

    assert result["type"] is FlowResultType.ABORT
    assert result["reason"] == "reconfigure_successful"

    assert config_entry.data[RenaultConfigurationKeys.USERNAME] == "email2@test.com"
    assert config_entry.data[RenaultConfigurationKeys.PASSWORD] == "test2"
    assert config_entry.data[RenaultConfigurationKeys.LOGIN_TOKEN] == MOCK_LOGIN_TOKEN
    assert (
        config_entry.data[RenaultConfigurationKeys.KAMEREON_ACCOUNT_ID]
        == "account_id_1"
    )
    assert config_entry.data[RenaultConfigurationKeys.LOCALE] == "fr_FR"

    assert len(mock_setup_entry.mock_calls) == 1


async def test_reconfigure_mismatch(
    hass: HomeAssistant,
    mock_setup_entry: AsyncMock,
    config_entry: MockConfigEntry,
) -> None:
    """Test reconfigure fails on account ID mismatch."""
    result = await config_entry.start_reconfigure_flow(hass)
    assert result["type"] is FlowResultType.FORM
    assert result["step_id"] == "user"
    assert not result["errors"]

    data_schema = result["data_schema"].schema
    assert (
        get_schema_suggested_value(data_schema, RenaultConfigurationKeys.LOCALE)
        == "fr_FR"
    )
    assert (
        get_schema_suggested_value(data_schema, RenaultConfigurationKeys.USERNAME)
        == "email@test.com"
    )
    assert (
        get_schema_suggested_value(data_schema, RenaultConfigurationKeys.PASSWORD)
        == "test"
    )

    renault_account = AsyncMock()
    type(renault_account).account_id = PropertyMock(return_value="account_id_other")
    renault_account.get_vehicles.return_value = (
        schemas.KamereonVehiclesResponseSchema.loads(
            await async_load_fixture(hass, "vehicle_zoe_40.json", DOMAIN)
        )
    )

    # Account list single
    with (
        patch(
            "renault_api.renault_session.RenaultSession.login",
            autospec=True,
            side_effect=_mock_login,
        ),
        patch(
            "renault_api.renault_client.RenaultClient.get_api_accounts",
            return_value=[renault_account],
        ),
    ):
        result = await hass.config_entries.flow.async_configure(
            result["flow_id"],
            user_input={
                RenaultConfigurationKeys.LOCALE: "fr_FR",
                RenaultConfigurationKeys.USERNAME: "email2@test.com",
                RenaultConfigurationKeys.PASSWORD: "test2",
            },
        )

    assert result["type"] is FlowResultType.ABORT
    assert result["reason"] == "unique_id_mismatch"

    # Unchanged values
    assert config_entry.data[RenaultConfigurationKeys.USERNAME] == "email@test.com"
    assert config_entry.data[RenaultConfigurationKeys.PASSWORD] == "test"
    assert config_entry.data[RenaultConfigurationKeys.LOGIN_TOKEN] == MOCK_LOGIN_TOKEN
    assert (
        config_entry.data[RenaultConfigurationKeys.KAMEREON_ACCOUNT_ID]
        == "account_id_1"
    )
    assert config_entry.data[RenaultConfigurationKeys.LOCALE] == "fr_FR"

    assert len(mock_setup_entry.mock_calls) == 0