Store access token in entry for Fyta (#116260)

* save access_token and expiration date in ConfigEntry

* add MINOR_VERSION and async_migrate_entry

* shorten reading of expiration from config entry

* add additional consts and test for config entry migration

* Update homeassistant/components/fyta/coordinator.py

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* Update homeassistant/components/fyta/__init__.py

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* omit check for datetime data type

* Update homeassistant/components/fyta/__init__.py

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* Update homeassistant/components/fyta/coordinator.py

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

---------

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

tests/components/fyta/conftest.py

@@ -5,6 +5,11 @@ from unittest.mock import AsyncMock, patch
 
 import pytest
 
+from homeassistant.components.fyta.const import CONF_EXPIRATION
+from homeassistant.const import CONF_ACCESS_TOKEN
+
+from .test_config_flow import ACCESS_TOKEN, EXPIRATION
+
 
 @pytest.fixture
 def mock_fyta():
@@ -15,7 +20,26 @@ def mock_fyta():
         "homeassistant.components.fyta.config_flow.FytaConnector",
         return_value=mock_fyta_api,
     ) as mock_fyta_api:
-        mock_fyta_api.return_value.login.return_value = {}
+        mock_fyta_api.return_value.login.return_value = {
+            CONF_ACCESS_TOKEN: ACCESS_TOKEN,
+            CONF_EXPIRATION: EXPIRATION,
+        }
+        yield mock_fyta_api
+
+
+@pytest.fixture
+def mock_fyta_init():
+    """Build a fixture for the Fyta API that connects successfully and returns one device."""
+
+    mock_fyta_api = AsyncMock()
+    with patch(
+        "homeassistant.components.fyta.FytaConnector",
+        return_value=mock_fyta_api,
+    ) as mock_fyta_api:
+        mock_fyta_api.return_value.login.return_value = {
+            CONF_ACCESS_TOKEN: ACCESS_TOKEN,
+            CONF_EXPIRATION: EXPIRATION,
+        }
         yield mock_fyta_api
 
 

tests/components/fyta/test_config_flow.py

@@ -1,5 +1,6 @@
 """Test the fyta config flow."""
 
+from datetime import UTC, datetime
 from unittest.mock import AsyncMock
 
 from fyta_cli.fyta_exceptions import (
@@ -10,8 +11,8 @@ from fyta_cli.fyta_exceptions import (
 import pytest
 
 from homeassistant import config_entries
-from homeassistant.components.fyta.const import DOMAIN
-from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
+from homeassistant.components.fyta.const import CONF_EXPIRATION, DOMAIN
+from homeassistant.const import CONF_ACCESS_TOKEN, CONF_PASSWORD, CONF_USERNAME
 from homeassistant.core import HomeAssistant
 from homeassistant.data_entry_flow import FlowResultType
 
@@ -19,10 +20,12 @@ from tests.common import MockConfigEntry
 
 USERNAME = "fyta_user"
 PASSWORD = "fyta_pass"
+ACCESS_TOKEN = "123xyz"
+EXPIRATION = datetime.fromisoformat("2024-12-31T10:00:00").astimezone(UTC)
 
 
 async def test_user_flow(
-    hass: HomeAssistant, mock_fyta: AsyncMock, mock_setup_entry
+    hass: HomeAssistant, mock_fyta: AsyncMock, mock_setup_entry: AsyncMock
 ) -> None:
     """Test we get the form."""
 
@@ -39,7 +42,12 @@ async def test_user_flow(
 
     assert result2["type"] is FlowResultType.CREATE_ENTRY
     assert result2["title"] == USERNAME
-    assert result2["data"] == {CONF_USERNAME: USERNAME, CONF_PASSWORD: PASSWORD}
+    assert result2["data"] == {
+        CONF_USERNAME: USERNAME,
+        CONF_PASSWORD: PASSWORD,
+        CONF_ACCESS_TOKEN: ACCESS_TOKEN,
+        CONF_EXPIRATION: "2024-12-31T10:00:00+00:00",
+    }
     assert len(mock_setup_entry.mock_calls) == 1
 
 
@@ -57,7 +65,7 @@ async def test_form_exceptions(
     exception: Exception,
     error: dict[str, str],
     mock_fyta: AsyncMock,
-    mock_setup_entry,
+    mock_setup_entry: AsyncMock,
 ) -> None:
     """Test we can handle Form exceptions."""
 
@@ -89,6 +97,8 @@ async def test_form_exceptions(
     assert result["title"] == USERNAME
     assert result["data"][CONF_USERNAME] == USERNAME
     assert result["data"][CONF_PASSWORD] == PASSWORD
+    assert result["data"][CONF_ACCESS_TOKEN] == ACCESS_TOKEN
+    assert result["data"][CONF_EXPIRATION] == "2024-12-31T10:00:00+00:00"
 
     assert len(mock_setup_entry.mock_calls) == 1
 
@@ -134,14 +144,19 @@ async def test_reauth(
     exception: Exception,
     error: dict[str, str],
     mock_fyta: AsyncMock,
-    mock_setup_entry,
+    mock_setup_entry: AsyncMock,
 ) -> None:
     """Test reauth-flow works."""
 
     entry = MockConfigEntry(
         domain=DOMAIN,
         title=USERNAME,
-        data={CONF_USERNAME: USERNAME, CONF_PASSWORD: PASSWORD},
+        data={
+            CONF_USERNAME: USERNAME,
+            CONF_PASSWORD: PASSWORD,
+            CONF_ACCESS_TOKEN: ACCESS_TOKEN,
+            CONF_EXPIRATION: "2024-06-30T10:00:00+00:00",
+        },
     )
     entry.add_to_hass(hass)
 
@@ -157,7 +172,8 @@ async def test_reauth(
 
     # tests with connection error
     result = await hass.config_entries.flow.async_configure(
-        result["flow_id"], {CONF_USERNAME: USERNAME, CONF_PASSWORD: PASSWORD}
+        result["flow_id"],
+        {CONF_USERNAME: USERNAME, CONF_PASSWORD: PASSWORD},
     )
     await hass.async_block_till_done()
 
@@ -178,5 +194,5 @@ async def test_reauth(
     assert result["reason"] == "reauth_successful"
     assert entry.data[CONF_USERNAME] == "other_username"
     assert entry.data[CONF_PASSWORD] == "other_password"
-
-    assert len(mock_setup_entry.mock_calls) == 1
+    assert entry.data[CONF_ACCESS_TOKEN] == ACCESS_TOKEN
+    assert entry.data[CONF_EXPIRATION] == "2024-12-31T10:00:00+00:00"

tests/components/fyta/test_init.py

@@ -0,0 +1,42 @@
+"""Test the initialization."""
+
+from unittest.mock import AsyncMock
+
+from homeassistant.components.fyta.const import CONF_EXPIRATION, DOMAIN
+from homeassistant.const import CONF_ACCESS_TOKEN, CONF_PASSWORD, CONF_USERNAME
+from homeassistant.core import HomeAssistant
+
+from .test_config_flow import ACCESS_TOKEN, PASSWORD, USERNAME
+
+from tests.common import MockConfigEntry
+
+
+async def test_migrate_config_entry(
+    hass: HomeAssistant,
+    mock_fyta_init: AsyncMock,
+) -> None:
+    """Test successful migration of entry data."""
+    entry = MockConfigEntry(
+        domain=DOMAIN,
+        title=USERNAME,
+        data={
+            CONF_USERNAME: USERNAME,
+            CONF_PASSWORD: PASSWORD,
+        },
+        version=1,
+        minor_version=1,
+    )
+    entry.add_to_hass(hass)
+
+    assert entry.version == 1
+    assert entry.minor_version == 1
+
+    await hass.config_entries.async_setup(entry.entry_id)
+    await hass.async_block_till_done()
+
+    assert entry.version == 1
+    assert entry.minor_version == 2
+    assert entry.data[CONF_USERNAME] == USERNAME
+    assert entry.data[CONF_PASSWORD] == PASSWORD
+    assert entry.data[CONF_ACCESS_TOKEN] == ACCESS_TOKEN
+    assert entry.data[CONF_EXPIRATION] == "2024-12-31T10:00:00+00:00"