Merge branch 'feature/image-viewer' into viewer-poc

* feature/image-viewer:
  Push to feature/image-viewer env
  Replace strtobool
  Formatting
  Replace strtobool
  Move to Python 3.12
  FIX:Fix test compatible with python 3.12 (#1500)
  Accept Python 3.12
  DF-853 Sort by changes (#1498)
  CHORE:update search, record details templates to accommodate specific bucket details (#1497)

# Conflicts:
#	poetry.lock

.github/workflows/platformsh-cd-develop.yml

@@ -6,6 +6,7 @@ on:
     branches:
       # - main
       - develop
+      - feature/image-viewer
     paths:
       # Host config
       - '.plaform/**'

.platform.app.yaml

@@ -7,15 +7,15 @@ name: app
 # in multiple versions. Check the Python documentation
 # (https://docs.platform.sh/languages/python.html#supported-versions)
 # to find the supported versions for the 'python' type.
-type: 'python:3.11'
+type: 'python:3.12'
 
 variables:
   env:
     DJANGO_SETTINGS_MODULE: 'config.settings.platform'
     # pip
     POETRY_VIRTUALENVS_IN_PROJECT: true
     POETRY_VIRTUALENVS_CREATE: true
-    POETRY_VERSION: 1.5.1
+    POETRY_VERSION: 1.6.1
 
 # The size of the persistent disk of the application (in MB).
 disk: 2048
@@ -35,7 +35,7 @@ hooks:
     curl -sS https://platform.sh/cli/installer | php
     
     # Download the latest version of pip
-    python3.11 -m pip install --upgrade pip
+    python3.12 -m pip install --upgrade pip
 
     # Install and configure Poetry
     # Set user to false to install Poetry globally

config/settings/base.py

@@ -11,14 +11,14 @@
 """
 import os
 
-from distutils.sysconfig import get_python_lib
-from distutils.util import strtobool
+from sysconfig import get_path
 
 import sentry_sdk
 
 from sentry_sdk.integrations.django import DjangoIntegration
 
 from ..versioning import get_git_sha
+from .util import strtobool
 
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 PROJECT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
@@ -110,7 +110,7 @@
         "DIRS": [
             os.path.join(BASE_DIR, "templates"),
             os.path.join(
-                get_python_lib(), "nationalarchives-frontend-django/templates"
+                get_path("platlib"), "nationalarchives-frontend-django/templates"
             ),
         ],
         "APP_DIRS": True,

config/settings/dev.py

@@ -1,9 +1,8 @@
 import logging
 import os
 
-from distutils.util import strtobool
-
 from .base import *  # noqa: F401
+from .util import strtobool
 
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = strtobool(os.getenv("DEBUG", "True"))  # noqa: F405

config/settings/util.py

@@ -0,0 +1,13 @@
+def strtobool(val):
+    """Convert a string representation of truth to true (1) or false (0).
+    True values are 'y', 'yes', 't', 'true', 'on', and '1'; false values
+    are 'n', 'no', 'f', 'false', 'off', and '0'.  Raises ValueError if
+    'val' is anything else.
+    """
+    val = val.lower()
+    if val in ("y", "yes", "t", "true", "on", "1"):
+        return 1
+    elif val in ("n", "no", "f", "false", "off", "0"):
+        return 0
+    else:
+        raise ValueError("invalid truth value %r" % (val,))

etna/ciim/tests/test_utils.py

@@ -114,7 +114,7 @@ def test_test(self):
 
         stripped_markup = format_description_markup(markup)
 
-        self.assertEquals(
+        self.assertEqual(
             '<span><a href="/catalogue/id/C11996672/">link text</a></span>',
             stripped_markup,
         )
@@ -124,7 +124,7 @@ def test_no_links(self):
 
         stripped_markup = format_description_markup(markup)
 
-        self.assertEquals("<span/>", stripped_markup)
+        self.assertEqual("<span/>", stripped_markup)
 
     def test_multiple_links(self):
         markup = (
@@ -136,7 +136,7 @@ def test_multiple_links(self):
 
         stripped_markup = format_description_markup(markup)
 
-        self.assertEquals(
+        self.assertEqual(
             (
                 "<span>"
                 '<a href="/catalogue/id/C11996672/">link text one</a>'
@@ -155,7 +155,7 @@ def test_external_link(self):
 
         stripped_markup = format_description_markup(markup)
 
-        self.assertEquals(
+        self.assertEqual(
             ("<span>" '<a href="http://example.com/">link text one</a>' "</span>"),
             stripped_markup,
         )
@@ -166,7 +166,7 @@ def test_invalid_link(self):
 
         stripped_markup = format_description_markup(markup)
 
-        self.assertEquals(
+        self.assertEqual(
             ("<span></span>"),
             stripped_markup,
         )
@@ -327,46 +327,46 @@ def test_none(self):
 
         index = convert_sort_key_to_index(sort)
 
-        self.assertEquals(index, 0)
+        self.assertEqual(index, 0)
 
     def test_empty_string(self):
         sort = None
 
         index = convert_sort_key_to_index(sort)
 
-        self.assertEquals(index, 0)
+        self.assertEqual(index, 0)
 
     def test_converts_sort_key_with_leading_zero(self):
         sort = "01"
 
         index = convert_sort_key_to_index(sort)
 
-        self.assertEquals(index, 0)
+        self.assertEqual(index, 0)
 
     def test_converts_sort_key_at_three_digit_boundary(self):
         sort = "31000"
 
         index = convert_sort_key_to_index(sort)
 
-        self.assertEquals(index, 999)
+        self.assertEqual(index, 999)
 
     def test_converts_sort_key_at_four_digit_boundary(self):
         sort = "31001"
 
         index = convert_sort_key_to_index(sort)
 
-        self.assertEquals(index, 1000)
+        self.assertEqual(index, 1000)
 
     def test_index_is_zero_for_invalid_sort_key(self):
         sort = "10000"
 
         index = convert_sort_key_to_index(sort)
 
-        self.assertEquals(index, 0)
+        self.assertEqual(index, 0)
 
     def test_index_is_zero_for_non_int_sort_key(self):
         sort = "NaN"
 
         index = convert_sort_key_to_index(sort)
 
-        self.assertEquals(index, 0)
+        self.assertEqual(index, 0)

etna/collections/tests/test_models.py

@@ -22,9 +22,7 @@ def setUp(self):
         root_page.add_child(instance=self.topic_explorer_index_page)
 
     def test_no_child_pages(self):
-        self.assertEquals(
-            self.topic_explorer_index_page.topic_explorer_pages.count(), 0
-        )
+        self.assertEqual(self.topic_explorer_index_page.topic_explorer_pages.count(), 0)
 
     def test_unpublish_page_excluded(self):
         unpublished_topic_page = TopicExplorerPage(
@@ -33,9 +31,7 @@ def test_unpublish_page_excluded(self):
         self.topic_explorer_index_page.add_child(instance=unpublished_topic_page)
         unpublished_topic_page.unpublish()
 
-        self.assertEquals(
-            self.topic_explorer_index_page.topic_explorer_pages.count(), 0
-        )
+        self.assertEqual(self.topic_explorer_index_page.topic_explorer_pages.count(), 0)
 
     @unittest.skip(
         "Disabled test due to all child pages on home being private during beta."
@@ -47,19 +43,15 @@ def test_private_page_excluded(self):
         self.topic_explorer_index_page.add_child(instance=private_topic_page)
         PageViewRestriction.objects.create(page=private_topic_page)
 
-        self.assertEquals(
-            self.topic_explorer_index_page.topic_explorer_pages.count(), 0
-        )
+        self.assertEqual(self.topic_explorer_index_page.topic_explorer_pages.count(), 0)
 
     def test_published_public_pages(self):
         topic_page = TopicExplorerPage(
             title="Topic Page", intro="test", teaser_text="test"
         )
         self.topic_explorer_index_page.add_child(instance=topic_page)
 
-        self.assertEquals(
-            self.topic_explorer_index_page.topic_explorer_pages.count(), 1
-        )
+        self.assertEqual(self.topic_explorer_index_page.topic_explorer_pages.count(), 1)
 
     def test_published_time_period_pages_excluded(self):
         topic_page = TimePeriodExplorerPage(
@@ -71,9 +63,7 @@ def test_published_time_period_pages_excluded(self):
         )
         self.topic_explorer_index_page.add_child(instance=topic_page)
 
-        self.assertEquals(
-            self.topic_explorer_index_page.topic_explorer_pages.count(), 0
-        )
+        self.assertEqual(self.topic_explorer_index_page.topic_explorer_pages.count(), 0)
 
 
 class TestTopicExplorerPage(TestCase):
@@ -158,7 +148,7 @@ def setUp(self):
         root_page.add_child(instance=self.time_period_explorer_index_page)
 
     def test_no_child_pages(self):
-        self.assertEquals(
+        self.assertEqual(
             self.time_period_explorer_index_page.time_period_explorer_pages.count(), 0
         )
 
@@ -173,7 +163,7 @@ def test_unpublish_page_excluded(self):
         self.time_period_explorer_index_page.add_child(instance=unpublished_topic_page)
         unpublished_topic_page.unpublish()
 
-        self.assertEquals(
+        self.assertEqual(
             self.time_period_explorer_index_page.time_period_explorer_pages.count(), 0
         )
 
@@ -191,7 +181,7 @@ def test_private_page_excluded(self):
         self.time_period_explorer_index_page.add_child(instance=private_topic_page)
         PageViewRestriction.objects.create(page=private_topic_page)
 
-        self.assertEquals(
+        self.assertEqual(
             self.time_period_explorer_index_page.time_period_explorer_pages.count(), 0
         )
 
@@ -205,7 +195,7 @@ def test_published_public_pages(self):
         )
         self.time_period_explorer_index_page.add_child(instance=topic_page)
 
-        self.assertEquals(
+        self.assertEqual(
             self.time_period_explorer_index_page.time_period_explorer_pages.count(), 1
         )
 
@@ -215,6 +205,6 @@ def test_topic_pages_excluded(self):
         )
         self.time_period_explorer_index_page.add_child(instance=topic_page)
 
-        self.assertEquals(
+        self.assertEqual(
             self.time_period_explorer_index_page.time_period_explorer_pages.count(), 0
         )

etna/core/tests/test_decorators.py

@@ -71,7 +71,7 @@ def test_allows_request_when_setting_value_is_true_and_authenticated(self):
         for url in CONDITIONALLY_PROTECTED_URLS:
             with self.subTest(f"URL: {url}"):
                 response = self.client.get(url)
-                self.assertEquals(response.status_code, 200)
+                self.assertEqual(response.status_code, 200)
 
     @responses.activate
     @override_settings(
@@ -83,4 +83,4 @@ def test_allows_unauthenticated_access_when_setting_value_is_false(self):
         for url in CONDITIONALLY_PROTECTED_URLS:
             with self.subTest(f"URL: {url}"):
                 response = self.client.get(url)
-                self.assertEquals(response.status_code, 200)
+                self.assertEqual(response.status_code, 200)

etna/core/tests/test_middleware.py

@@ -14,24 +14,24 @@ class TestMaintenanceMode(TestCase):
     @prevent_request_warnings
     def test_without_maintenance_mode_ends(self):
         response = self.client.get("/")
-        self.assertEquals(response.status_code, 503)
+        self.assertEqual(response.status_code, 503)
         self.assertNotIn("Retry-After", response.headers)
 
     @prevent_request_warnings
     @override_settings(MAINTENENCE_MODE_ENDS="2011-11-04T00:05:23+04:00")
     def test_maintenance_mode_ends_with_timezone_info(self):
         response = self.client.get("/")
-        self.assertEquals(response.status_code, 503)
-        self.assertEquals(
+        self.assertEqual(response.status_code, 503)
+        self.assertEqual(
             response.headers["Retry-After"], "Thu, 03 Nov 2011 20:05:23 GMT"
         )
 
     @prevent_request_warnings
     @override_settings(MAINTENENCE_MODE_ENDS="2011-11-04T00:05:23")
     def test_maintenance_mode_ends_without_timezone_info(self):
         response = self.client.get("/")
-        self.assertEquals(response.status_code, 503)
-        self.assertEquals(
+        self.assertEqual(response.status_code, 503)
+        self.assertEqual(
             response.headers["Retry-After"], "Fri, 04 Nov 2011 00:05:23 GMT"
         )
 
@@ -40,7 +40,7 @@ def test_maintenance_mode_ends_without_timezone_info(self):
     def test_maintenance_mode_bypassed_when_ip_in_allow_list(self, *args):
         response = self.client.get("/")
 
-        self.assertEquals(response.status_code, 200)
+        self.assertEqual(response.status_code, 200)
 
     @prevent_request_warnings
     @override_settings(MAINTENENCE_MODE_ALLOW_IPS=["123.4.5.6"])
@@ -49,7 +49,7 @@ def test_maintenance_mode_enforced_when_ip_not_in_allowed_list(
         self, mock_get_client_ip
     ):
         response = self.client.get("/")
-        self.assertEquals(response.status_code, 503)
+        self.assertEqual(response.status_code, 503)
 
 
 class TestInterpretCookiesMiddleware(SimpleTestCase):

etna/records/tests/test_blocks.py

@@ -234,4 +234,4 @@ def test_view_edit_page_with_client_api_exception(self):
             reverse("wagtailadmin_pages:edit", args=(self.article_page.id,))
         )
 
-        self.assertEquals(response.status_code, 200)
+        self.assertEqual(response.status_code, 200)

etna/records/tests/test_models.py

@@ -588,7 +588,7 @@ def test_thumbnail_url(self):
         images = Image.search.filter(rid="")
         image = images[0]
 
-        self.assertEquals(
+        self.assertEqual(
             image.thumbnail_url, "https://media.preview/path/to/thumbnail.jpeg"
         )
 
@@ -610,7 +610,7 @@ def test_thumbnail_url_fallback(self):
         image = images[0]
 
         # Fallback serves image through Wagtail instead of from Client API
-        self.assertEquals(image.thumbnail_url, "/records/image/path/to/image.jpeg")
+        self.assertEqual(image.thumbnail_url, "/records/image/path/to/image.jpeg")
 
 
 @override_settings(CLIENT_BASE_URL=f"{settings.CLIENT_BASE_URL}")

etna/records/tests/test_urls.py

@@ -141,7 +141,7 @@ def test_resolves_iaid(self):
     def test_iaid_with_non_standard_prefix(self):
         resolver = resolve("/catalogue/id/C123456/")
 
-        self.assertEquals(resolver.view_name, "details-page-machine-readable")
+        self.assertEqual(resolver.view_name, "details-page-machine-readable")
         self.assertEqual(resolver.kwargs["iaid"], "C123456")
 
     def test_resolves_uuid(self):