ucapi-framework 1.4.0b8__tar.gz → 1.4.0b11__tar.gz

{ucapi_framework-1.4.0b8 → ucapi_framework-1.4.0b11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ucapi-framework
-Version: 1.4.0b8
+Version: 1.4.0b11
 Summary: ucapi framework that provides core functionality for building integrations.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown

{ucapi_framework-1.4.0b8 → ucapi_framework-1.4.0b11}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ucapi-framework"
-version = "1.4.0b8"
+version = "1.4.0b11"
 description = "ucapi framework that provides core functionality for building integrations."
 readme = "README.md"
 requires-python = ">=3.11"

{ucapi_framework-1.4.0b8 → ucapi_framework-1.4.0b11}/tests/test_setup.py

@@ -1951,6 +1951,54 @@ class TestMigrationMethods:
         )
         assert migration_field is None
 
+        # But migration_possible should NOT be present either
+        # because ConcreteSetupFlow doesn't override get_migration_data
+        migration_possible = next(
+            (s for s in result.settings if s["id"] == "migration_possible"), None
+        )
+        assert migration_possible is None
+
+    @pytest.mark.asyncio
+    async def test_migration_possible_when_get_migration_data_overridden(
+        self, config_manager, mock_driver
+    ):
+        """Test that migration_possible field appears when get_migration_data is overridden."""
+
+        class FlowWithMigrationSupport(ConcreteSetupFlow):
+            """Flow that has migration support."""
+
+            async def get_migration_data(self, previous_version, current_version):
+                return {
+                    "previous_driver_id": "old_driver",
+                    "new_driver_id": "new_driver",
+                    "entity_mappings": [],
+                }
+
+        setup_flow = FlowWithMigrationSupport(config_manager, driver=mock_driver)
+
+        # Simulate initial setup WITHOUT previous_version
+        msg = DriverSetupRequest(reconfigure=False, setup_data={})
+
+        result = await setup_flow.handle_driver_setup(msg)
+
+        # Should get restore prompt screen
+        assert isinstance(result, RequestUserInput)
+
+        # migration_required should NOT be present (no previous_version)
+        migration_field = next(
+            (s for s in result.settings if s["id"] == "migration_required"), None
+        )
+        assert migration_field is None
+
+        # But migration_possible SHOULD be present
+        migration_possible = next(
+            (s for s in result.settings if s["id"] == "migration_possible"), None
+        )
+        assert migration_possible is not None
+        assert (
+            "migration" in migration_possible["field"]["label"]["value"]["en"].lower()
+        )
+
     @pytest.mark.asyncio
     async def test_is_migration_required_default_returns_false(self, config_manager):
         """Test that default implementation of is_migration_required returns False."""
@@ -2125,6 +2173,7 @@ class TestMigrationMethods:
                 remote_url="http://localhost",
                 driver_id="mydriver",
                 pin="1234",
+                api_key=None,
             )
 
             # Should return success

{ucapi_framework-1.4.0b8 → ucapi_framework-1.4.0b11}/ucapi_framework/setup.py

@@ -714,6 +714,20 @@ class BaseSetupFlow(ABC, Generic[ConfigT]):
             self._pending_device_config = None
             return SetupError(error_type=IntegrationSetupError.OTHER)
 
+    def _has_migration_support(self) -> bool:
+        """
+        Check if this setup flow has migration support by detecting if
+        get_migration_data has been overridden from the base implementation.
+
+        :return: True if get_migration_data is overridden, False otherwise
+        """
+        # Get the method from this instance's class
+        this_method = self.__class__.get_migration_data
+        # Get the method from BaseSetupFlow
+        base_method = BaseSetupFlow.get_migration_data
+        # They're different if the subclass overrode it
+        return this_method is not base_method
+
     async def _build_restore_prompt_screen(self) -> RequestUserInput:
         """
         Build the restore prompt screen for initial setup.
@@ -745,6 +759,23 @@ class BaseSetupFlow(ABC, Generic[ConfigT]):
                     "field": {"label": {"value": self._previous_version or ""}},
                 }
             )
+        # If we can't determine migration requirement (no previous_version provided),
+        # check if get_migration_data is overridden to indicate migration support
+        elif self._migration_required is None and self._has_migration_support():
+            settings.append(
+                {
+                    "id": "migration_possible",
+                    "label": {"en": ""},
+                    "field": {
+                        "label": {
+                            "value": {
+                                "en": "This integration supports migration. "
+                                "If upgrading, consult documentation for migration requirements."
+                            }
+                        }
+                    },
+                }
+            )
 
         settings.append(
             {
@@ -1124,8 +1155,9 @@ class BaseSetupFlow(ABC, Generic[ConfigT]):
         """
         Handle migration execution request.
 
-        Expects previous_version, remote_url, and pin. If driver_id is configured,
-        current_version will be automatically fetched from the Remote.
+        Expects previous_version, remote_url, and either pin or api_key.
+        If driver_id is configured, current_version will be automatically
+        fetched from the Remote.
         Calls get_migration_data() to get entity mappings, then calls
         migrate_entities_on_remote() to perform the migration on the Remote.
 
@@ -1136,6 +1168,7 @@ class BaseSetupFlow(ABC, Generic[ConfigT]):
         current_version = msg.input_values.get("current_version", "").strip()
         remote_url = msg.input_values.get("remote_url", "http://localhost").strip()
         pin = msg.input_values.get("pin", "").strip()
+        api_key = msg.input_values.get("api_key", "").strip()
 
         # Ensure remote_url has protocol prefix
         if remote_url and not remote_url.startswith(("http://", "https://")):
@@ -1144,11 +1177,14 @@ class BaseSetupFlow(ABC, Generic[ConfigT]):
 
         # If driver has driver_id set and current_version is not provided, fetch it from Remote
         driver_id = self.driver.driver_id if self.driver else None
-        if driver_id and not current_version and remote_url and pin:
+        if driver_id and not current_version and remote_url and (pin or api_key):
             _LOG.info("Fetching current version from Remote for driver %s", driver_id)
 
             fetched_version = await get_driver_version(
-                remote_url=remote_url, driver_id=driver_id, pin=pin
+                remote_url=remote_url,
+                driver_id=driver_id,
+                pin=pin or None,
+                api_key=api_key or None,
             )
 
             if fetched_version:
@@ -1163,8 +1199,8 @@ class BaseSetupFlow(ABC, Generic[ConfigT]):
             missing_fields.append("Current Version")
         if not remote_url:
             missing_fields.append("Remote URL")
-        if not pin:
-            missing_fields.append("Remote PIN")
+        if not pin and not api_key:
+            missing_fields.append("Remote PIN or API Key")
 
         if missing_fields:
             _LOG.warning(
@@ -1243,7 +1279,8 @@ class BaseSetupFlow(ABC, Generic[ConfigT]):
             success = await migrate_entities_on_remote(
                 remote_url=remote_url,
                 migration_data=migration_data,
-                pin=pin,
+                pin=pin or None,
+                api_key=api_key or None,
             )
 
             if not success:

{ucapi_framework-1.4.0b8 → ucapi_framework-1.4.0b11}/ucapi_framework.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ucapi-framework
-Version: 1.4.0b8
+Version: 1.4.0b11
 Summary: ucapi framework that provides core functionality for building integrations.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown