refactor(extensions): add Pydantic validation for extension configuration (#36767)

tests/unit_tests/extensions/test_types.py

@@ -0,0 +1,258 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+"""Tests for extension configuration and manifest Pydantic models."""
+
+import pytest
+from pydantic import ValidationError
+from superset_core.extensions.types import (
+    ContributionConfig,
+    ExtensionConfig,
+    ExtensionConfigBackend,
+    ExtensionConfigFrontend,
+    Manifest,
+    ManifestBackend,
+    ModuleFederationConfig,
+)
+
+# =============================================================================
+# ExtensionConfig (extension.json) tests
+# =============================================================================
+
+
+def test_extension_config_minimal():
+    """Test ExtensionConfig with minimal required fields."""
+    config = ExtensionConfig.model_validate(
+        {
+            "id": "my-extension",
+            "name": "My Extension",
+        }
+    )
+    assert config.id == "my-extension"
+    assert config.name == "My Extension"
+    assert config.version == "0.0.0"
+    assert config.dependencies == []
+    assert config.permissions == []
+    assert config.frontend is None
+    assert config.backend is None
+
+
+def test_extension_config_full():
+    """Test ExtensionConfig with all fields populated."""
+    config = ExtensionConfig.model_validate(
+        {
+            "id": "query_insights",
+            "name": "Query Insights",
+            "version": "1.0.0",
+            "license": "Apache-2.0",
+            "description": "A query insights extension",
+            "dependencies": ["other-extension"],
+            "permissions": ["can_read", "can_view"],
+            "frontend": {
+                "contributions": {
+                    "views": {
+                        "sqllab.panels": [
+                            {"id": "query_insights.main", "name": "Query Insights"}
+                        ]
+                    }
+                },
+                "moduleFederation": {"exposes": ["./index"]},
+            },
+            "backend": {
+                "entryPoints": ["query_insights.entrypoint"],
+                "files": ["backend/src/query_insights/**/*.py"],
+            },
+        }
+    )
+    assert config.id == "query_insights"
+    assert config.name == "Query Insights"
+    assert config.version == "1.0.0"
+    assert config.license == "Apache-2.0"
+    assert config.description == "A query insights extension"
+    assert config.dependencies == ["other-extension"]
+    assert config.permissions == ["can_read", "can_view"]
+    assert config.frontend is not None
+    assert config.frontend.moduleFederation.exposes == ["./index"]
+    assert config.backend is not None
+    assert config.backend.entryPoints == ["query_insights.entrypoint"]
+    assert config.backend.files == ["backend/src/query_insights/**/*.py"]
+
+
+def test_extension_config_missing_id():
+    """Test ExtensionConfig raises error when id is missing."""
+    with pytest.raises(ValidationError) as exc_info:
+        ExtensionConfig.model_validate({"name": "My Extension"})
+    assert "id" in str(exc_info.value)
+
+
+def test_extension_config_missing_name():
+    """Test ExtensionConfig raises error when name is missing."""
+    with pytest.raises(ValidationError) as exc_info:
+        ExtensionConfig.model_validate({"id": "my-extension"})
+    assert "name" in str(exc_info.value)
+
+
+def test_extension_config_empty_id():
+    """Test ExtensionConfig raises error when id is empty."""
+    with pytest.raises(ValidationError) as exc_info:
+        ExtensionConfig.model_validate({"id": "", "name": "My Extension"})
+    assert "id" in str(exc_info.value)
+
+
+def test_extension_config_invalid_version():
+    """Test ExtensionConfig raises error for invalid version format."""
+    with pytest.raises(ValidationError) as exc_info:
+        ExtensionConfig.model_validate(
+            {"id": "my-extension", "name": "My Extension", "version": "invalid"}
+        )
+    assert "version" in str(exc_info.value)
+
+
+def test_extension_config_valid_versions():
+    """Test ExtensionConfig accepts valid semantic versions (major.minor.patch only)."""
+    for version in ["1.0.0", "0.1.0", "10.20.30"]:
+        config = ExtensionConfig.model_validate(
+            {"id": "my-extension", "name": "My Extension", "version": version}
+        )
+        assert config.version == version
+
+
+def test_extension_config_prerelease_version_rejected():
+    """Test ExtensionConfig rejects prerelease versions."""
+    with pytest.raises(ValidationError) as exc_info:
+        ExtensionConfig.model_validate(
+            {"id": "my-extension", "name": "My Extension", "version": "1.0.0-beta"}
+        )
+    assert "version" in str(exc_info.value)
+
+
+# =============================================================================
+# Manifest (manifest.json) tests
+# =============================================================================
+
+
+def test_manifest_minimal():
+    """Test Manifest with minimal required fields."""
+    manifest = Manifest.model_validate(
+        {
+            "id": "my-extension",
+            "name": "My Extension",
+        }
+    )
+    assert manifest.id == "my-extension"
+    assert manifest.name == "My Extension"
+    assert manifest.frontend is None
+    assert manifest.backend is None
+
+
+def test_manifest_with_frontend():
+    """Test Manifest with frontend section requires remoteEntry."""
+    manifest = Manifest.model_validate(
+        {
+            "id": "my-extension",
+            "name": "My Extension",
+            "frontend": {
+                "remoteEntry": "remoteEntry.abc123.js",
+                "contributions": {},
+                "moduleFederation": {"exposes": ["./index"]},
+            },
+        }
+    )
+    assert manifest.frontend is not None
+    assert manifest.frontend.remoteEntry == "remoteEntry.abc123.js"
+    assert manifest.frontend.moduleFederation.exposes == ["./index"]
+
+
+def test_manifest_frontend_missing_remote_entry():
+    """Test Manifest raises error when frontend is missing remoteEntry."""
+    with pytest.raises(ValidationError) as exc_info:
+        Manifest.model_validate(
+            {
+                "id": "my-extension",
+                "name": "My Extension",
+                "frontend": {"contributions": {}, "moduleFederation": {}},
+            }
+        )
+    assert "remoteEntry" in str(exc_info.value)
+
+
+def test_manifest_with_backend():
+    """Test Manifest with backend section."""
+    manifest = Manifest.model_validate(
+        {
+            "id": "my-extension",
+            "name": "My Extension",
+            "backend": {"entryPoints": ["my_extension.entrypoint"]},
+        }
+    )
+    assert manifest.backend is not None
+    assert manifest.backend.entryPoints == ["my_extension.entrypoint"]
+
+
+def test_manifest_backend_no_files_field():
+    """Test ManifestBackend does not have files field (only in ExtensionConfig)."""
+    manifest = Manifest.model_validate(
+        {
+            "id": "my-extension",
+            "name": "My Extension",
+            "backend": {"entryPoints": ["my_extension.entrypoint"]},
+        }
+    )
+    # ManifestBackend should not have a 'files' field
+    assert not hasattr(manifest.backend, "files")
+
+
+# =============================================================================
+# Shared component tests
+# =============================================================================
+
+
+def test_module_federation_config_defaults():
+    """Test ModuleFederationConfig has correct defaults."""
+    config = ModuleFederationConfig.model_validate({})
+    assert config.exposes == []
+    assert config.filename == "remoteEntry.js"
+    assert config.shared == {}
+    assert config.remotes == {}
+
+
+def test_contribution_config_defaults():
+    """Test ContributionConfig has correct defaults."""
+    config = ContributionConfig.model_validate({})
+    assert config.commands == []
+    assert config.views == {}
+    assert config.menus == {}
+
+
+def test_extension_config_frontend_defaults():
+    """Test ExtensionConfigFrontend has correct defaults."""
+    frontend = ExtensionConfigFrontend.model_validate({})
+    assert frontend.contributions.commands == []
+    assert frontend.moduleFederation.exposes == []
+
+
+def test_extension_config_backend_defaults():
+    """Test ExtensionConfigBackend has correct defaults."""
+    backend = ExtensionConfigBackend.model_validate({})
+    assert backend.entryPoints == []
+    assert backend.files == []
+
+
+def test_manifest_backend_defaults():
+    """Test ManifestBackend has correct defaults."""
+    backend = ManifestBackend.model_validate({})
+    assert backend.entryPoints == []