SXDEDPCXZIC-425 / upgrade to CKAN 2.11

Author: alexmorev

ckanext/datavic_odp_theme/plugin.py

@@ -68,27 +68,28 @@ def before_dataset_index(self, pkg_dict: dict[str, Any]) -> dict[str, Any]:
 
     def _is_all_api_format(self, pkg_dict: dict[str, Any]) -> bool:
         """Check if the dataset contains a resource in a format recognized as an API.
-        This involves determining if the format of the resource is CSV and if this resource exists in the datastore
-        or matches a format inside a predefined list.
+        This involves determining if the format of the resource is CSV and if this
+        resource exists in the datastore or matches a format inside a predefined list.
         """
-        for resource in tk.get_action("package_show")({"ignore_auth": True},
-                                                           {"id": pkg_dict["id"]}).get(
-                "resources", []):
+        for resource in tk.get_action("package_show")(
+                {"ignore_auth": True},
+                {"id": pkg_dict["id"]}
+            ).get("resources", []):
             if resource["format"].upper() == "CSV" and resource["datastore_active"]:
                 return True
 
         if [
             res_format
             for res_format in pkg_dict["res_format"]
             if res_format
-               in [
-                   "WMS",
-                   "WFS",
-                   "API",
-                   "ARCGIS GEOSERVICES REST API",
-                   "ESRI REST",
-                   "GEOJSON",
-               ]
+                in [
+                    "WMS",
+                    "WFS",
+                    "API",
+                    "ARCGIS GEOSERVICES REST API",
+                    "ESRI REST",
+                    "GEOJSON",
+                ]
         ]:
             return True
         return False
@@ -105,26 +106,27 @@ def get_categories(self):
     # IAuthenticator
 
     def login(self) -> Optional[Response]:
-        session.regenerate_id() # type: ignore
+        session.modified = True
 
     def logout(self) -> Optional[Response]:
-        session.regenerate_id() # type: ignore
+        session.modified = True
+
 
 @tk.blanket.auth_functions(auth_functions)
 class DatavicODPThemeAuth(p.SingletonPlugin):
     """Register auth function inside separate extension.
 
     We are chaining auth functions from activity and overriding its templates
     at the same time. The former requires us to put our plugin after the
-    activty, while the latter will work only if we put our plugin before the
+    activity, while the latter will work only if we put our plugin before the
     activity. The only way to solve this puzzle is to split the logic between
     two sub-plugins.
 
     """
     pass
 
 
-class DatavicXLoaderPlugin(xloaderPlugin):
+class DatavicXLoaderPlugin(xloaderPlugin, p.SingletonPlugin):
     p.implements(p.IPackageController, inherit=True)
 
     # IPackageController

ckanext/datavic_odp_theme/tests/e2e/__init__.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from typing import Any
+
+import pytest
+
+
+@pytest.fixture()
+def browser_context_args(
+    browser_context_args: dict[str, Any], ckan_config: dict[str, Any]
+):
+    """Modify playwright's standard configuration of browser's context."""
+    browser_context_args["base_url"] = ckan_config["ckan.site_url"]
+    return browser_context_args

ckanext/datavic_odp_theme/tests/e2e/conftest.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+from typing import Any, Callable
+
+import pytest
+from playwright.sync_api import Page, expect
+
+import ckan.plugins.toolkit as tk
+
+
+@pytest.mark.playwright
+@pytest.mark.usefixtures("with_plugins", "clean_db", "clean_index")
+class TestDatasetSearch:
+    def test_public_dataset(
+        self, page: Page, package_factory: Callable[..., dict[str, Any]]
+    ):
+        dataset = package_factory(private=False)
+
+        page.goto(tk.h.url_for("dataset.search"))
+        expect(page.locator(".privacy-label ")).to_have_text(
+            "Open to the public"
+        )
+
+        page.get_by_role("link", name=dataset["title"]).click()
+
+        expect(page).to_have_url(
+            tk.h.url_for("dataset.read", id=dataset["name"])
+        )

ckanext/datavic_odp_theme/tests/e2e/test_front.py

@@ -1,2 +1,4 @@
 pytest-ckan
 pytest-factoryboy
+pytest-mock
+pytest-playwright

dev-requirements.txt

@@ -13,7 +13,7 @@ sections = "FUTURE,STDLIB,FIRSTPARTY,THIRDPARTY,CKAN,CKANEXT,SELF,LOCALFOLDER"
 profile = "black"
 
 [tool.pytest.ini_options]
-addopts = "--ckan-ini test.ini"
+addopts = "--ckan-ini test_config/test.ini -m 'not benchmark and not playwright'"
 filterwarnings = [
                "ignore::sqlalchemy.exc.SADeprecationWarning",
                "ignore::sqlalchemy.exc.SAWarning",

pyproject.toml

@@ -0,0 +1,2 @@
+[app:main]
+use = config:../../ckan/test-core.ini

test_config/default.ini

@@ -3,28 +3,27 @@ debug = false
 smtp_server = localhost
 error_email_from = paste@localhost
 
-[server:main]
-use = egg:Paste#http
-host = 0.0.0.0
-port = 5000
-
 [app:main]
-use = config:../ckan/test-core.ini
+use = config:default.ini
+
+ckan.site_url = http://127.0.0.1:5000
 
 ckan.plugins =
-             datavic_odp_theme
-             datavic_odp_schema
-             scheming_datasets
+            datavic_odp_theme
+            datavic_odp_schema
+            scheming_datasets
+            scheming_organizations
 
 ## ckanext-scheming settings
 scheming.dataset_schemas = ckanext.datavic_odp_schema:odp_dataset_schema.yaml
+scheming.organization_schemas = ckanext.datavic_odp_schema:organisation_schema.yaml
 scheming.presets = ckanext.scheming:presets.json
 scheming.dataset_fallback = false
 
 
 # Logging configuration
 [loggers]
-keys = root, ckan, sqlalchemy
+keys = root, ckan, sqlalchemy, environment
 
 [handlers]
 keys = console
@@ -46,6 +45,11 @@ handlers =
 qualname = sqlalchemy.engine
 level = WARN
 
+[logger_environment]
+handlers =
+qualname = ckan.config.environment
+level = ERROR
+
 [handler_console]
 class = StreamHandler
 args = (sys.stdout,)