Add config flow to Tankerkoenig (#68386)

2026-09-25 17:04:04 -04:00 · 2022-03-29 20:23:30 -07:00
parent f5a13fc51b
commit 2f7aeb64d2
13 changed files with 731 additions and 161 deletions
@@ -0,0 +1 @@
+"""Tests for Tankerkoenig component."""
@@ -0,0 +1,241 @@
+"""Tests for Tankerkoenig config flow."""
+from unittest.mock import patch
+
+from pytankerkoenig import customException
+
+from homeassistant.components.tankerkoenig.const import (
+    CONF_FUEL_TYPES,
+    CONF_STATIONS,
+    DOMAIN,
+)
+from homeassistant.config_entries import SOURCE_IMPORT, SOURCE_USER
+from homeassistant.const import (
+    CONF_API_KEY,
+    CONF_LATITUDE,
+    CONF_LOCATION,
+    CONF_LONGITUDE,
+    CONF_NAME,
+    CONF_RADIUS,
+    CONF_SHOW_ON_MAP,
+)
+from homeassistant.core import HomeAssistant
+from homeassistant.data_entry_flow import (
+    RESULT_TYPE_ABORT,
+    RESULT_TYPE_CREATE_ENTRY,
+    RESULT_TYPE_FORM,
+)
+
+from tests.common import MockConfigEntry
+
+MOCK_USER_DATA = {
+    CONF_NAME: "Home",
+    CONF_API_KEY: "269534f6-xxxx-xxxx-xxxx-yyyyzzzzxxxx",
+    CONF_FUEL_TYPES: ["e5"],
+    CONF_LOCATION: {CONF_LATITUDE: 51.0, CONF_LONGITUDE: 13.0},
+    CONF_RADIUS: 2.0,
+}
+
+MOCK_STATIONS_DATA = {
+    CONF_STATIONS: [
+        "3bcd61da-xxxx-xxxx-xxxx-19d5523a7ae8",
+        "36b4b812-xxxx-xxxx-xxxx-c51735325858",
+    ],
+}
+
+MOCK_IMPORT_DATA = {
+    CONF_API_KEY: "269534f6-xxxx-xxxx-xxxx-yyyyzzzzxxxx",
+    CONF_FUEL_TYPES: ["e5"],
+    CONF_LOCATION: {CONF_LATITUDE: 51.0, CONF_LONGITUDE: 13.0},
+    CONF_RADIUS: 2.0,
+    CONF_STATIONS: [
+        "3bcd61da-yyyy-yyyy-yyyy-19d5523a7ae8",
+        "36b4b812-yyyy-yyyy-yyyy-c51735325858",
+    ],
+    CONF_SHOW_ON_MAP: True,
+}
+
+MOCK_NEARVY_STATIONS_OK = {
+    "ok": True,
+    "stations": [
+        {
+            "id": "3bcd61da-xxxx-xxxx-xxxx-19d5523a7ae8",
+            "brand": "BrandA",
+            "place": "CityA",
+            "street": "Main",
+            "houseNumber": "1",
+            "dist": 1,
+        },
+        {
+            "id": "36b4b812-xxxx-xxxx-xxxx-c51735325858",
+            "brand": "BrandB",
+            "place": "CityB",
+            "street": "School",
+            "houseNumber": "2",
+            "dist": 2,
+        },
+    ],
+}
+
+
+async def test_user(hass: HomeAssistant):
+    """Test starting a flow by user."""
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": SOURCE_USER}
+    )
+    assert result["type"] == RESULT_TYPE_FORM
+    assert result["step_id"] == "user"
+
+    with patch(
+        "homeassistant.components.tankerkoenig.async_setup_entry"
+    ) as mock_setup_entry, patch(
+        "homeassistant.components.tankerkoenig.config_flow.getNearbyStations",
+        return_value=MOCK_NEARVY_STATIONS_OK,
+    ):
+        result = await hass.config_entries.flow.async_configure(
+            result["flow_id"], user_input=MOCK_USER_DATA
+        )
+        assert result["type"] == RESULT_TYPE_FORM
+        assert result["step_id"] == "select_station"
+
+        result = await hass.config_entries.flow.async_configure(
+            result["flow_id"], user_input=MOCK_STATIONS_DATA
+        )
+        assert result["type"] == RESULT_TYPE_CREATE_ENTRY
+        assert result["data"][CONF_NAME] == "Home"
+        assert result["data"][CONF_API_KEY] == "269534f6-xxxx-xxxx-xxxx-yyyyzzzzxxxx"
+        assert result["data"][CONF_FUEL_TYPES] == ["e5"]
+        assert result["data"][CONF_LOCATION] == {"latitude": 51.0, "longitude": 13.0}
+        assert result["data"][CONF_RADIUS] == 2.0
+        assert result["data"][CONF_STATIONS] == [
+            "3bcd61da-xxxx-xxxx-xxxx-19d5523a7ae8",
+            "36b4b812-xxxx-xxxx-xxxx-c51735325858",
+        ]
+        assert result["options"][CONF_SHOW_ON_MAP]
+
+        await hass.async_block_till_done()
+
+    assert mock_setup_entry.called
+
+
+async def test_user_already_configured(hass: HomeAssistant):
+    """Test starting a flow by user with an already configured region."""
+
+    mock_config = MockConfigEntry(
+        domain=DOMAIN,
+        data={**MOCK_USER_DATA, **MOCK_STATIONS_DATA},
+        unique_id=f"{MOCK_USER_DATA[CONF_LOCATION][CONF_LATITUDE]}_{MOCK_USER_DATA[CONF_LOCATION][CONF_LONGITUDE]}",
+    )
+    mock_config.add_to_hass(hass)
+
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": SOURCE_USER}
+    )
+    assert result["type"] == RESULT_TYPE_FORM
+    assert result["step_id"] == "user"
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"], user_input=MOCK_USER_DATA
+    )
+
+    assert result["type"] == RESULT_TYPE_ABORT
+
+
+async def test_exception_security(hass: HomeAssistant):
+    """Test starting a flow by user with invalid api key."""
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": SOURCE_USER}
+    )
+    assert result["type"] == RESULT_TYPE_FORM
+    assert result["step_id"] == "user"
+
+    with patch(
+        "homeassistant.components.tankerkoenig.config_flow.getNearbyStations",
+        side_effect=customException,
+    ):
+
+        result = await hass.config_entries.flow.async_configure(
+            result["flow_id"], user_input=MOCK_USER_DATA
+        )
+        assert result["type"] == RESULT_TYPE_FORM
+        assert result["step_id"] == "user"
+        assert result["errors"][CONF_API_KEY] == "invalid_auth"
+
+
+async def test_user_no_stations(hass: HomeAssistant):
+    """Test starting a flow by user which does not find any station."""
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": SOURCE_USER}
+    )
+    assert result["type"] == RESULT_TYPE_FORM
+    assert result["step_id"] == "user"
+
+    with patch(
+        "homeassistant.components.tankerkoenig.config_flow.getNearbyStations",
+        return_value={"ok": True, "stations": []},
+    ):
+        result = await hass.config_entries.flow.async_configure(
+            result["flow_id"], user_input=MOCK_USER_DATA
+        )
+        assert result["type"] == RESULT_TYPE_FORM
+        assert result["step_id"] == "user"
+        assert result["errors"][CONF_RADIUS] == "no_stations"
+
+
+async def test_import(hass: HomeAssistant):
+    """Test starting a flow by import."""
+    with patch(
+        "homeassistant.components.tankerkoenig.async_setup_entry"
+    ) as mock_setup_entry, patch(
+        "homeassistant.components.tankerkoenig.config_flow.getNearbyStations",
+        return_value=MOCK_NEARVY_STATIONS_OK,
+    ):
+        result = await hass.config_entries.flow.async_init(
+            DOMAIN, context={"source": SOURCE_IMPORT}, data=MOCK_IMPORT_DATA
+        )
+        assert result["type"] == RESULT_TYPE_CREATE_ENTRY
+        assert result["type"] == RESULT_TYPE_CREATE_ENTRY
+        assert result["data"][CONF_NAME] == "Home"
+        assert result["data"][CONF_API_KEY] == "269534f6-xxxx-xxxx-xxxx-yyyyzzzzxxxx"
+        assert result["data"][CONF_FUEL_TYPES] == ["e5"]
+        assert result["data"][CONF_LOCATION] == {"latitude": 51.0, "longitude": 13.0}
+        assert result["data"][CONF_RADIUS] == 2.0
+        assert result["data"][CONF_STATIONS] == [
+            "3bcd61da-xxxx-xxxx-xxxx-19d5523a7ae8",
+            "36b4b812-xxxx-xxxx-xxxx-c51735325858",
+            "3bcd61da-yyyy-yyyy-yyyy-19d5523a7ae8",
+            "36b4b812-yyyy-yyyy-yyyy-c51735325858",
+        ]
+        assert result["options"][CONF_SHOW_ON_MAP]
+
+        await hass.async_block_till_done()
+
+    assert mock_setup_entry.called
+
+
+async def test_options_flow(hass: HomeAssistant):
+    """Test options flow."""
+
+    mock_config = MockConfigEntry(
+        domain=DOMAIN,
+        data=MOCK_USER_DATA,
+        options={CONF_SHOW_ON_MAP: True},
+        unique_id=f"{DOMAIN}_{MOCK_USER_DATA[CONF_LOCATION][CONF_LATITUDE]}_{MOCK_USER_DATA[CONF_LOCATION][CONF_LONGITUDE]}",
+    )
+    mock_config.add_to_hass(hass)
+
+    with patch(
+        "homeassistant.components.tankerkoenig.async_setup_entry"
+    ) as mock_setup_entry:
+        await mock_config.async_setup(hass)
+        await hass.async_block_till_done()
+        assert mock_setup_entry.called
+
+    result = await hass.config_entries.options.async_init(mock_config.entry_id)
+    assert result["type"] == RESULT_TYPE_FORM
+    assert result["step_id"] == "init"
+    result = await hass.config_entries.options.async_configure(
+        result["flow_id"],
+        user_input={CONF_SHOW_ON_MAP: False},
+    )
+    assert result["type"] == RESULT_TYPE_CREATE_ENTRY
+    assert not mock_config.options[CONF_SHOW_ON_MAP]