Merge pull request #1094 from thunderstore-io/api-endpoint-for-package-source-data

Add endpoint for fetching package source (TS-2282)

Author: Roffenlund

django/thunderstore/api/cyberstorm/tests/test_package_source.py

@@ -0,0 +1,87 @@
+import pytest
+from rest_framework.test import APIClient
+
+from thunderstore.api.urls import cyberstorm_urls
+from thunderstore.repository.factories import PackageFactory, PackageVersionFactory
+from thunderstore.repository.models import Package
+
+HAS_CYBERSTORM_SOURCE = "packages.api.detail.source" in [
+    x.name for x in cyberstorm_urls
+]
+
+
+def get_package_source_endpoint_url(package: Package, version: str = "") -> str:
+    base_url = "/api/cyberstorm/package"
+
+    package_name = package.name
+    namespace_id = package.namespace.name
+    if not version:
+        version = package.version_number
+
+    return f"{base_url}/{namespace_id}/{package_name}/v/{version}/source/"
+
+
+@pytest.mark.django_db
+def test_package_source_endpoint(api_client: APIClient):
+    if not HAS_CYBERSTORM_SOURCE:
+        pytest.skip("Cyberstorm source endpoint is not enabled")
+
+    package = PackageFactory(is_active=True)
+    PackageVersionFactory(package=package)
+    url = get_package_source_endpoint_url(package)
+    response = api_client.get(url)
+    assert response.status_code == 200
+
+
+@pytest.mark.django_db
+def test_package_not_found(api_client: APIClient):
+    if not HAS_CYBERSTORM_SOURCE:
+        pytest.skip("Cyberstorm source endpoint is not enabled")
+
+    package = PackageFactory(is_active=False)
+    PackageVersionFactory(package=package)
+
+    url = get_package_source_endpoint_url(package)
+    response = api_client.get(url)
+
+    assert response.status_code == 404
+    assert response.json() == {"detail": "Package not found"}
+
+
+@pytest.mark.django_db
+def test_package_version_not_found(api_client: APIClient):
+    if not HAS_CYBERSTORM_SOURCE:
+        pytest.skip("Cyberstorm source endpoint is not enabled")
+
+    package = PackageFactory(is_active=True)
+    PackageVersionFactory(package=package)
+    version = package.available_versions.first()
+    version.version_number = "2.0.0"
+    version.save()
+
+    url = get_package_source_endpoint_url(package, version="1.0.0")
+    response = api_client.get(url)
+
+    assert response.status_code == 404
+    assert response.json() == {"detail": "Package version not found"}
+
+
+@pytest.mark.django_db
+def test_package_source_response_format(api_client: APIClient):
+    if not HAS_CYBERSTORM_SOURCE:
+        pytest.skip("Cyberstorm source endpoint is not enabled")
+
+    package = PackageFactory(is_active=True)
+    PackageVersionFactory(package=package)
+    url = get_package_source_endpoint_url(package)
+    response = api_client.get(url)
+
+    expected_result = {
+        "is_visible": True,
+        "namespace": package.namespace.name,
+        "package_name": package.name,
+        "version_number": package.version_number,
+        "decompilations": [],
+    }
+
+    assert response.json() == expected_result

django/thunderstore/api/urls.py

@@ -36,6 +36,7 @@
     UpdateTeamAPIView,
     UpdateTeamMemberAPIView,
 )
+from thunderstore.plugins.registry import plugin_registry
 
 cyberstorm_urls = [
     path(
@@ -219,3 +220,5 @@
         name="cyberstorm.team.member.update",
     ),
 ]
+
+cyberstorm_urls += plugin_registry.get_cyberstorm_api_urls()

django/thunderstore/core/tests/test_inheritance.py

@@ -3,6 +3,46 @@
 
 
 def test_get_effective_bool_choice_depth_first():
+    assert (
+        get_effective_bool_choice_depth_first(
+            OptionalBoolChoice.NONE,
+            OptionalBoolChoice.NO,
+            OptionalBoolChoice.YES,
+        )
+        == OptionalBoolChoice.YES
+    )
+    assert (
+        get_effective_bool_choice_depth_first(
+            OptionalBoolChoice.NONE,
+            OptionalBoolChoice.YES,
+            OptionalBoolChoice.NO,
+        )
+        == OptionalBoolChoice.NO
+    )
+    assert (
+        get_effective_bool_choice_depth_first(
+            OptionalBoolChoice.YES,
+            OptionalBoolChoice.NONE,
+            OptionalBoolChoice.NO,
+        )
+        == OptionalBoolChoice.NO
+    )
+    assert (
+        get_effective_bool_choice_depth_first(
+            OptionalBoolChoice.YES,
+            OptionalBoolChoice.NO,
+            OptionalBoolChoice.NONE,
+        )
+        == OptionalBoolChoice.NO
+    )
+    assert (
+        get_effective_bool_choice_depth_first(
+            OptionalBoolChoice.YES,
+            OptionalBoolChoice.NONE,
+            OptionalBoolChoice.NONE,
+        )
+        == OptionalBoolChoice.YES
+    )
     assert (
         get_effective_bool_choice_depth_first(
             OptionalBoolChoice.NONE,

django/thunderstore/plugins/base.py

@@ -30,6 +30,10 @@ def get_legacy_package_urls(cls) -> List[URLPattern]:
     def get_new_package_urls(cls) -> List[URLPattern]:
         return []
 
+    @classmethod
+    def get_cyberstorm_api_urls(cls) -> List[URLPattern]:
+        return []
+
     @classmethod
     def get_package_tabs(
         cls,

django/thunderstore/plugins/registry.py

@@ -44,6 +44,11 @@ def get_legacy_package_urls(self) -> List[URLPattern]:
     def get_new_package_urls(self) -> List[URLPattern]:
         return list(itertools.chain(*(x.get_new_package_urls() for x in self.plugins)))
 
+    def get_cyberstorm_api_urls(self) -> List[URLPattern]:
+        return list(
+            itertools.chain(*(x.get_cyberstorm_api_urls() for x in self.plugins))
+        )
+
     def get_package_tabs(
         self, user: "UserType", listing: "PackageListing"
     ) -> Dict[str, "PartialTab"]:

django/thunderstore/plugins/tests/__init__.py

@@ -0,0 +1,45 @@
+from django.urls import URLPattern
+
+from thunderstore.plugins.base import BasePlugin
+from thunderstore.plugins.registry import PluginRegistry, plugin_registry
+
+
+def test_plugin_registry_return_types():
+    assert isinstance(plugin_registry, PluginRegistry)
+    assert isinstance(plugin_registry.plugins, set)
+
+    assert isinstance(plugin_registry.get_django_settings({}), dict)
+    assert isinstance(plugin_registry.get_installed_apps([]), list)
+    assert isinstance(plugin_registry.get_settings_urls(), list)
+    assert isinstance(plugin_registry.get_legacy_package_urls(), list)
+    assert isinstance(plugin_registry.get_new_package_urls(), list)
+    assert isinstance(plugin_registry.get_cyberstorm_api_urls(), list)
+    assert isinstance(plugin_registry.get_settings_links(), list)
+
+
+def test_base_plugin_return_types():
+    base_plugin = BasePlugin()
+    assert isinstance(base_plugin.get_django_settings({}), dict)
+    assert isinstance(base_plugin.get_settings_urls(), list)
+    assert isinstance(base_plugin.get_legacy_package_urls(), list)
+    assert isinstance(base_plugin.get_new_package_urls(), list)
+    assert isinstance(base_plugin.get_cyberstorm_api_urls(), list)
+    assert isinstance(base_plugin.get_settings_links(), list)
+
+
+def test_plugin_registry_get_new_package_urls():
+    urls = plugin_registry.get_new_package_urls()
+    if plugin_registry.plugins:
+        for url in urls:
+            assert isinstance(url, URLPattern)
+    else:
+        assert urls == []
+
+
+def test_plugin_registry_get_cyberstorm_api_urls():
+    urls = plugin_registry.get_cyberstorm_api_urls()
+    if plugin_registry.plugins:
+        for url in urls:
+            assert isinstance(url, URLPattern)
+    else:
+        assert urls == []