Portainer switch terminology to API token (home-assistant#152958)

Co-authored-by: Norbert Rittel <[email protected]>

Author: 2 people

homeassistant/components/portainer/__init__.py

@@ -5,7 +5,14 @@
 from pyportainer import Portainer
 
 from homeassistant.config_entries import ConfigEntry
-from homeassistant.const import CONF_API_KEY, CONF_HOST, CONF_VERIFY_SSL, Platform
+from homeassistant.const import (
+    CONF_API_KEY,
+    CONF_API_TOKEN,
+    CONF_HOST,
+    CONF_URL,
+    CONF_VERIFY_SSL,
+    Platform,
+)
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.aiohttp_client import async_create_clientsession
 
@@ -20,8 +27,8 @@ async def async_setup_entry(hass: HomeAssistant, entry: PortainerConfigEntry) ->
     """Set up Portainer from a config entry."""
 
     client = Portainer(
-        api_url=entry.data[CONF_HOST],
-        api_key=entry.data[CONF_API_KEY],
+        api_url=entry.data[CONF_URL],
+        api_key=entry.data[CONF_API_TOKEN],
         session=async_create_clientsession(
             hass=hass, verify_ssl=entry.data[CONF_VERIFY_SSL]
         ),
@@ -39,3 +46,15 @@ async def async_setup_entry(hass: HomeAssistant, entry: PortainerConfigEntry) ->
 async def async_unload_entry(hass: HomeAssistant, entry: PortainerConfigEntry) -> bool:
     """Unload a config entry."""
     return await hass.config_entries.async_unload_platforms(entry, _PLATFORMS)
+
+
+async def async_migrate_entry(hass: HomeAssistant, entry: PortainerConfigEntry) -> bool:
+    """Migrate old entry."""
+
+    if entry.version < 2:
+        data = dict(entry.data)
+        data[CONF_URL] = data.pop(CONF_HOST)
+        data[CONF_API_TOKEN] = data.pop(CONF_API_KEY)
+        hass.config_entries.async_update_entry(entry=entry, data=data, version=2)
+
+    return True

homeassistant/components/portainer/config_flow.py

@@ -14,7 +14,7 @@
 import voluptuous as vol
 
 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
-from homeassistant.const import CONF_API_KEY, CONF_HOST, CONF_VERIFY_SSL
+from homeassistant.const import CONF_API_TOKEN, CONF_URL, CONF_VERIFY_SSL
 from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import HomeAssistantError
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
@@ -24,8 +24,8 @@
 _LOGGER = logging.getLogger(__name__)
 STEP_USER_DATA_SCHEMA = vol.Schema(
     {
-        vol.Required(CONF_HOST): str,
-        vol.Required(CONF_API_KEY): str,
+        vol.Required(CONF_URL): str,
+        vol.Required(CONF_API_TOKEN): str,
         vol.Optional(CONF_VERIFY_SSL, default=True): bool,
     }
 )
@@ -35,9 +35,11 @@ async def _validate_input(hass: HomeAssistant, data: dict[str, Any]) -> None:
     """Validate the user input allows us to connect."""
 
     client = Portainer(
-        api_url=data[CONF_HOST],
-        api_key=data[CONF_API_KEY],
-        session=async_get_clientsession(hass=hass, verify_ssl=data[CONF_VERIFY_SSL]),
+        api_url=data[CONF_URL],
+        api_key=data[CONF_API_TOKEN],
+        session=async_get_clientsession(
+            hass=hass, verify_ssl=data.get(CONF_VERIFY_SSL, True)
+        ),
     )
     try:
         await client.get_endpoints()
@@ -48,19 +50,21 @@ async def _validate_input(hass: HomeAssistant, data: dict[str, Any]) -> None:
     except PortainerTimeoutError as err:
         raise PortainerTimeout from err
 
-    _LOGGER.debug("Connected to Portainer API: %s", data[CONF_HOST])
+    _LOGGER.debug("Connected to Portainer API: %s", data[CONF_URL])
 
 
 class PortainerConfigFlow(ConfigFlow, domain=DOMAIN):
     """Handle a config flow for Portainer."""
 
+    VERSION = 2
+
     async def async_step_user(
         self, user_input: dict[str, Any] | None = None
     ) -> ConfigFlowResult:
         """Handle the initial step."""
         errors: dict[str, str] = {}
         if user_input is not None:
-            self._async_abort_entries_match({CONF_HOST: user_input[CONF_HOST]})
+            self._async_abort_entries_match({CONF_URL: user_input[CONF_URL]})
             try:
                 await _validate_input(self.hass, user_input)
             except CannotConnect:
@@ -73,10 +77,10 @@ async def async_step_user(
                 _LOGGER.exception("Unexpected exception")
                 errors["base"] = "unknown"
             else:
-                await self.async_set_unique_id(user_input[CONF_API_KEY])
+                await self.async_set_unique_id(user_input[CONF_API_TOKEN])
                 self._abort_if_unique_id_configured()
                 return self.async_create_entry(
-                    title=user_input[CONF_HOST], data=user_input
+                    title=user_input[CONF_URL], data=user_input
                 )
 
         return self.async_show_form(

homeassistant/components/portainer/coordinator.py

@@ -16,7 +16,7 @@
 from pyportainer.models.portainer import Endpoint
 
 from homeassistant.config_entries import ConfigEntry
-from homeassistant.const import CONF_HOST
+from homeassistant.const import CONF_URL
 from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import ConfigEntryError, ConfigEntryNotReady
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
@@ -87,7 +87,7 @@ async def _async_setup(self) -> None:
     async def _async_update_data(self) -> dict[int, PortainerCoordinatorData]:
         """Fetch data from Portainer API."""
         _LOGGER.debug(
-            "Fetching data from Portainer API: %s", self.config_entry.data[CONF_HOST]
+            "Fetching data from Portainer API: %s", self.config_entry.data[CONF_URL]
         )
 
         try:

homeassistant/components/portainer/strings.json

@@ -3,16 +3,16 @@
     "step": {
       "user": {
         "data": {
-          "host": "[%key:common::config_flow::data::host%]",
-          "api_key": "[%key:common::config_flow::data::api_key%]",
+          "url": "[%key:common::config_flow::data::url%]",
+          "api_token": "[%key:common::config_flow::data::api_token%]",
           "verify_ssl": "[%key:common::config_flow::data::verify_ssl%]"
         },
         "data_description": {
-          "host": "The host/URL, including the port, of your Portainer instance",
-          "api_key": "The API key for authenticating with Portainer",
+          "url": "The URL, including the port, of your Portainer instance",
+          "api_token": "The API access token for authenticating with Portainer",
           "verify_ssl": "Whether to verify SSL certificates. Disable only if you have a self-signed certificate"
         },
-        "description": "You can create an API key in the Portainer UI. Go to **My account > API keys** and select **Add API key**"
+        "description": "You can create an access token in the Portainer UI. Go to **My account > Access tokens** and select **Add access token**"
       }
     },
     "error": {

tests/components/portainer/conftest.py

@@ -8,13 +8,13 @@
 import pytest
 
 from homeassistant.components.portainer.const import DOMAIN
-from homeassistant.const import CONF_API_KEY, CONF_HOST, CONF_VERIFY_SSL
+from homeassistant.const import CONF_API_TOKEN, CONF_URL, CONF_VERIFY_SSL
 
 from tests.common import MockConfigEntry, load_json_array_fixture
 
 MOCK_TEST_CONFIG = {
-    CONF_HOST: "https://127.0.0.1:9000/",
-    CONF_API_KEY: "test_api_key",
+    CONF_URL: "https://127.0.0.1:9000/",
+    CONF_API_TOKEN: "test_api_token",
     CONF_VERIFY_SSL: True,
 }
 
@@ -61,4 +61,5 @@ def mock_config_entry() -> MockConfigEntry:
         title="Portainer test",
         data=MOCK_TEST_CONFIG,
         entry_id="portainer_test_entry_123",
+        version=2,
     )

tests/components/portainer/test_config_flow.py

@@ -11,7 +11,7 @@
 
 from homeassistant.components.portainer.const import DOMAIN
 from homeassistant.config_entries import SOURCE_USER
-from homeassistant.const import CONF_API_KEY, CONF_HOST
+from homeassistant.const import CONF_API_TOKEN, CONF_URL, CONF_VERIFY_SSL
 from homeassistant.core import HomeAssistant
 from homeassistant.data_entry_flow import FlowResultType
 
@@ -20,8 +20,9 @@
 from tests.common import MockConfigEntry
 
 MOCK_USER_SETUP = {
-    CONF_HOST: "https://127.0.0.1:9000/",
-    CONF_API_KEY: "test_api_key",
+    CONF_URL: "https://127.0.0.1:9000/",
+    CONF_API_TOKEN: "test_api_token",
+    CONF_VERIFY_SSL: True,
 }
 
 

tests/components/portainer/test_init.py

@@ -9,7 +9,9 @@
 )
 import pytest
 
+from homeassistant.components.portainer.const import DOMAIN
 from homeassistant.config_entries import ConfigEntryState
+from homeassistant.const import CONF_API_KEY, CONF_API_TOKEN, CONF_HOST, CONF_URL
 from homeassistant.core import HomeAssistant
 
 from . import setup_integration
@@ -36,3 +38,25 @@ async def test_setup_exceptions(
     mock_portainer_client.get_endpoints.side_effect = exception
     await setup_integration(hass, mock_config_entry)
     assert mock_config_entry.state == expected_state
+
+
+async def test_v1_migration(hass: HomeAssistant) -> None:
+    """Test migration from v1 to v2 config entry."""
+    entry = MockConfigEntry(
+        domain=DOMAIN,
+        data={
+            CONF_HOST: "http://test_host",
+            CONF_API_KEY: "test_key",
+        },
+        unique_id="1",
+        version=1,
+    )
+    entry.add_to_hass(hass)
+    await hass.config_entries.async_setup(entry.entry_id)
+    await hass.async_block_till_done()
+
+    assert entry.version == 2
+    assert CONF_HOST not in entry.data
+    assert CONF_API_KEY not in entry.data
+    assert entry.data[CONF_URL] == "http://test_host"
+    assert entry.data[CONF_API_TOKEN] == "test_key"