richie 2.34.1.dev10__py2.py3-none-any.whl → 2.34.1.dev16__py2.py3-none-any.whl

richie/apps/core/tests/test_cache.py

@@ -0,0 +1,159 @@
+"""Test site cache plugin"""
+
+import datetime
+from unittest import mock
+
+from django.core.cache.backends.dummy import DummyCache
+from django.test import TestCase, override_settings
+
+from django_redis.cache import RedisCache
+
+from richie.apps.core.cache import RedisCacheWithFallback
+
+
+class RedisCacheWithFallbackTestCase(TestCase):
+    """
+    Test suite for the RedisCacheWithFallback
+
+    Credits:
+    - https://github.com/Kub-AT/django-cache-fallback
+    """
+
+    @override_settings(
+        CACHES={
+            "default": {
+                "BACKEND": "apps.core.cache.RedisCacheWithFallback",
+                "LOCATION": "mymaster/redis-sentinel:26379,redis-sentinel:26379/0",
+                "OPTIONS": {
+                    "CLIENT_CLASS": "richie.apps.core.cache.SentinelClient",
+                },
+            },
+            "memory_cache": {
+                "BACKEND": "django.core.cache.backends.dummy.DummyCache",
+            },
+        }
+    )
+    def test_client(self):
+        """Test class instance of caches"""
+        client = RedisCacheWithFallback(None, {})
+        self.assertIs(type(client), RedisCacheWithFallback)
+        self.assertIs(type(client.redis_cache), RedisCache)
+        self.assertIs(type(client.fallback_cache), DummyCache)
+
+    @mock.patch.object(RedisCacheWithFallback, "_call_fallback_cache")
+    @mock.patch.object(RedisCacheWithFallback, "_call_redis_cache")
+    def test_get_redis_cache(self, redis_cache_mock, fallback_cache_mock):
+        """Test that redis_cache is used by default."""
+        client = RedisCacheWithFallback(None, {})
+        client.get("irrelevent")
+
+        redis_cache_mock.assert_called_once()
+        fallback_cache_mock.assert_not_called()
+
+    @mock.patch("apps.core.cache.logger")
+    @mock.patch.object(RedisCacheWithFallback, "_call_fallback_cache")
+    @mock.patch.object(RedisCacheWithFallback, "_call_redis_cache")
+    def test_get_fallback_cache(
+        self, redis_cache_mock, fallback_cache_mock, logger_mock
+    ):
+        """
+        Test case when redis_cache raises an exception,
+        logger logs the exception then fallback_cache takes over
+        """
+        client = RedisCacheWithFallback(None, {})
+        client.get("irrelevent")
+
+        redis_cache_mock.assert_called_once()
+        fallback_cache_mock.assert_not_called()
+
+        redis_cache_mock.side_effect = Exception()
+        client.get("irrelevent")
+
+        logger_mock.warning.assert_called_with(
+            "[DEGRADED CACHE MODE] - Switch to fallback cache"
+        )
+        logger_mock.exception.assert_called_once()
+        fallback_cache_mock.assert_called_once()
+
+    @override_settings(
+        CACHES={
+            "default": {
+                "BACKEND": "apps.core.cache.RedisCacheWithFallback",
+                "LOCATION": "mymaster/redis-sentinel:26379,redis-sentinel:26379/0",
+                "OPTIONS": {
+                    "CLIENT_CLASS": "richie.apps.core.cache.SentinelClient",
+                },
+            },
+            "memory_cache": {
+                "BACKEND": "django.core.cache.backends.dummy.DummyCache",
+            },
+        }
+    )
+    @mock.patch.object(DummyCache, "delete")
+    @mock.patch.object(RedisCacheWithFallback, "_call_redis_cache")
+    def test_invalidate_fallback_cache(self, redis_cache_mock, delete_mock):
+        """
+        Test that fallback_cache is invalidated every 60 seconds
+        when Redis is up
+        """
+        now = datetime.datetime.now()
+
+        client = RedisCacheWithFallback(None, {})
+        client.get("round_0")
+        redis_cache_mock.reset_mock()
+        delete_mock.reset_mock()
+
+        # A second cache access should not delete the fallback cache again
+        client.get("round_1")
+        redis_cache_mock.assert_called_once()
+        delete_mock.assert_not_called()
+        redis_cache_mock.reset_mock()
+        delete_mock.reset_mock()
+
+        # Another call to Redis cache 120 seconds later
+        # should delete the fallback cache again
+        read_time = now + datetime.timedelta(seconds=120)
+        with mock.patch("base.utils.datetime") as mock_datetime:
+            mock_datetime.now.return_value = read_time
+            client.get("round_2")
+
+        redis_cache_mock.assert_called_once()
+        delete_mock.assert_called_once()
+        redis_cache_mock.reset_mock()
+        delete_mock.reset_mock()
+
+        # Another call to Redis cache 30 seconds later (<1 minute)
+        # should not delete the fallback cache again
+        read_time += datetime.timedelta(seconds=30)
+        with mock.patch("base.utils.datetime") as mock_datetime:
+            mock_datetime.now.return_value = read_time
+            client.get("round_3")
+
+        redis_cache_mock.assert_called_once()
+        delete_mock.assert_not_called()
+        redis_cache_mock.reset_mock()
+        delete_mock.reset_mock()
+
+        # Another call to Redis cache exactly 1 minute after
+        # the latest call should not delete the fallback cache again
+        read_time += datetime.timedelta(seconds=30)
+        with mock.patch("base.utils.datetime") as mock_datetime:
+            mock_datetime.now.return_value = read_time
+            client.get("round_4")
+
+        redis_cache_mock.assert_called_once()
+        delete_mock.assert_not_called()
+        redis_cache_mock.reset_mock()
+        delete_mock.reset_mock()
+
+        # Another call to Redis cache exactly 1 minute and 1 second after
+        # the latest call should delete the fallback cache again
+        read_time += datetime.timedelta(seconds=1)
+        with mock.patch("base.utils.datetime") as mock_datetime:
+            mock_datetime.now.return_value = read_time
+            client.get("round_5")
+
+        redis_cache_mock.assert_called_once()
+        delete_mock.assert_called_once()
+        redis_cache_mock.reset_mock()
+        delete_mock.reset_mock()

richie/apps/core/tests/test_settings.py

@@ -0,0 +1,52 @@
+"""Test cnfpt configuration."""
+
+from unittest import mock
+
+from django.conf import settings
+from django.test import TestCase, override_settings
+
+from rest_framework.response import Response
+from rest_framework.settings import DEFAULTS, api_settings
+
+from richie.apps.search.viewsets.courses import CoursesViewSet
+
+
+class ConfigurationTestCase(TestCase):
+    """Validate that our configuration works as expected."""
+
+    @mock.patch.object(CoursesViewSet, "list", spec=True, return_value=Response({}))
+    def test_configuration_restframework_htaccess(self, _mock_list):
+        """The search API endpoint should work behind an htaccess."""
+        # First, check that API calls were broken with the default DRF configuration
+        # What was happening is that DRF defines Basic Authentication as a fallback by default
+        # and our query has a basic auth header with the username and password of the htaccess
+        # defined in nginx. Django was trying to authenticate a user with these credentials,
+        # which of course failed.
+        with override_settings(
+            REST_FRAMEWORK={
+                **settings.REST_FRAMEWORK,
+                "DEFAULT_AUTHENTICATION_CLASSES": DEFAULTS[
+                    "DEFAULT_AUTHENTICATION_CLASSES"
+                ],
+            }
+        ):
+            authentication_classes = api_settings.DEFAULT_AUTHENTICATION_CLASSES
+
+        # The authentication classes are loaded before settings are overriden so we need
+        # to mock them on the APIView
+        with mock.patch(
+            "rest_framework.views.APIView.authentication_classes",
+            new_callable=mock.PropertyMock,
+            return_value=authentication_classes,
+        ):
+            response = self.client.get(
+                "/api/v1.0/courses/",
+                HTTP_AUTHORIZATION="Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+            )
+        self.assertEqual(response.status_code, 403)
+
+        # Check that the project configuration solves it
+        response = self.client.get(
+            "/api/v1.0/courses/", HTTP_AUTHORIZATION="Basic dXNlcm5hbWU6cGFzc3dvcmQ="
+        )
+        self.assertEqual(response.status_code, 200)

richie/apps/core/utils.py

@@ -0,0 +1,60 @@
+"""
+This module contains utility function and the `Throttle` decorator used across the Richie project.
+"""
+
+import collections.abc
+from datetime import datetime, timedelta
+from functools import wraps
+
+
+def merge_dict(base_dict, update_dict):
+    """Utility for deep dictionary updates.
+
+    >>> d1 = {'k1':{'k11':{'a': 0, 'b': 1}}}
+    >>> d2 = {'k1':{'k11':{'b': 10}, 'k12':{'a': 3}}}
+    >>> merge_dict(d1, d2)
+    {'k1': {'k11': {'a': 0, 'b': 10}, 'k12':{'a': 3}}}
+
+    """
+    for key, value in update_dict.items():
+        if isinstance(value, collections.abc.Mapping):
+            base_dict[key] = merge_dict(base_dict.get(key, {}), value)
+        else:
+            base_dict[key] = value
+    return base_dict
+
+
+class Throttle:
+    """
+    Throttle Decorator
+
+    Limit execution of a function to a defined interval
+    """
+
+    def __init__(self, interval):
+        """
+        Initialize throttle decorator
+        Define the throttle_interval with the provided interval (in seconds)
+        and set time_of_last_call to the earliest representable datetime
+        """
+        self.throttle_interval = timedelta(seconds=interval)
+        self.time_of_last_call = datetime.min
+
+    def __call__(self, callback):
+        """
+        Process `elapsed_since_last_call`,
+        if it is greater than `throttle_interval`, callback is executed.
+        """
+
+        @wraps(callback)
+        def wrapper(*args, **kwargs):
+            now = datetime.now()
+            elapsed_since_last_call = now - self.time_of_last_call
+
+            if elapsed_since_last_call < self.throttle_interval:
+                return None
+
+            self.time_of_last_call = now
+            return callback(*args, **kwargs)
+
+        return wrapper

richie/apps/courses/migrations/0037_alter_blogpostpluginmodel_cmsplugin_ptr_and_more.py

@@ -0,0 +1,230 @@
+# Generated by Django 4.2.19 on 2025-02-25 09:38
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+import richie.apps.core.fields.multiselect
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("cms", "0022_auto_20180620_1551"),
+        ("courses", "0036_courserun_certificate_offer_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="blogpostpluginmodel",
+            name="cmsplugin_ptr",
+            field=models.OneToOneField(
+                auto_created=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                parent_link=True,
+                primary_key=True,
+                related_name="%(app_label)s_%(class)s",
+                serialize=False,
+                to="cms.cmsplugin",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="categorypluginmodel",
+            name="cmsplugin_ptr",
+            field=models.OneToOneField(
+                auto_created=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                parent_link=True,
+                primary_key=True,
+                related_name="%(app_label)s_%(class)s",
+                serialize=False,
+                to="cms.cmsplugin",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="coursepluginmodel",
+            name="cmsplugin_ptr",
+            field=models.OneToOneField(
+                auto_created=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                parent_link=True,
+                primary_key=True,
+                related_name="%(app_label)s_%(class)s",
+                serialize=False,
+                to="cms.cmsplugin",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="courserun",
+            name="languages",
+            field=richie.apps.core.fields.multiselect.MultiSelectField(
+                choices=[
+                    ("af", "Afrikaans"),
+                    ("ar", "Arabic"),
+                    ("ar-dz", "Algerian Arabic"),
+                    ("ast", "Asturian"),
+                    ("az", "Azerbaijani"),
+                    ("bg", "Bulgarian"),
+                    ("be", "Belarusian"),
+                    ("bn", "Bengali"),
+                    ("br", "Breton"),
+                    ("bs", "Bosnian"),
+                    ("ca", "Catalan"),
+                    ("ckb", "Central Kurdish (Sorani)"),
+                    ("cs", "Czech"),
+                    ("cy", "Welsh"),
+                    ("da", "Danish"),
+                    ("de", "German"),
+                    ("dsb", "Lower Sorbian"),
+                    ("el", "Greek"),
+                    ("en", "English"),
+                    ("en-au", "Australian English"),
+                    ("en-gb", "British English"),
+                    ("eo", "Esperanto"),
+                    ("es", "Spanish"),
+                    ("es-ar", "Argentinian Spanish"),
+                    ("es-co", "Colombian Spanish"),
+                    ("es-mx", "Mexican Spanish"),
+                    ("es-ni", "Nicaraguan Spanish"),
+                    ("es-ve", "Venezuelan Spanish"),
+                    ("et", "Estonian"),
+                    ("eu", "Basque"),
+                    ("fa", "Persian"),
+                    ("fi", "Finnish"),
+                    ("fr", "French"),
+                    ("fy", "Frisian"),
+                    ("ga", "Irish"),
+                    ("gd", "Scottish Gaelic"),
+                    ("gl", "Galician"),
+                    ("he", "Hebrew"),
+                    ("hi", "Hindi"),
+                    ("hr", "Croatian"),
+                    ("hsb", "Upper Sorbian"),
+                    ("hu", "Hungarian"),
+                    ("hy", "Armenian"),
+                    ("ia", "Interlingua"),
+                    ("id", "Indonesian"),
+                    ("ig", "Igbo"),
+                    ("io", "Ido"),
+                    ("is", "Icelandic"),
+                    ("it", "Italian"),
+                    ("ja", "Japanese"),
+                    ("ka", "Georgian"),
+                    ("kab", "Kabyle"),
+                    ("kk", "Kazakh"),
+                    ("km", "Khmer"),
+                    ("kn", "Kannada"),
+                    ("ko", "Korean"),
+                    ("ky", "Kyrgyz"),
+                    ("lb", "Luxembourgish"),
+                    ("lt", "Lithuanian"),
+                    ("lv", "Latvian"),
+                    ("mk", "Macedonian"),
+                    ("ml", "Malayalam"),
+                    ("mn", "Mongolian"),
+                    ("mr", "Marathi"),
+                    ("ms", "Malay"),
+                    ("my", "Burmese"),
+                    ("nb", "Norwegian Bokmål"),
+                    ("ne", "Nepali"),
+                    ("nl", "Dutch"),
+                    ("nn", "Norwegian Nynorsk"),
+                    ("os", "Ossetic"),
+                    ("pa", "Punjabi"),
+                    ("pl", "Polish"),
+                    ("pt", "Portuguese"),
+                    ("pt-br", "Brazilian Portuguese"),
+                    ("ro", "Romanian"),
+                    ("ru", "Russian"),
+                    ("sk", "Slovak"),
+                    ("sl", "Slovenian"),
+                    ("sq", "Albanian"),
+                    ("sr", "Serbian"),
+                    ("sr-latn", "Serbian Latin"),
+                    ("sv", "Swedish"),
+                    ("sw", "Swahili"),
+                    ("ta", "Tamil"),
+                    ("te", "Telugu"),
+                    ("tg", "Tajik"),
+                    ("th", "Thai"),
+                    ("tk", "Turkmen"),
+                    ("tr", "Turkish"),
+                    ("tt", "Tatar"),
+                    ("udm", "Udmurt"),
+                    ("uk", "Ukrainian"),
+                    ("ur", "Urdu"),
+                    ("uz", "Uzbek"),
+                    ("vi", "Vietnamese"),
+                    ("zh-hans", "Simplified Chinese"),
+                    ("zh-hant", "Traditional Chinese"),
+                ],
+                help_text="The list of languages in which the course content is available.",
+                max_choices=50,
+                max_length=255,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="licencepluginmodel",
+            name="cmsplugin_ptr",
+            field=models.OneToOneField(
+                auto_created=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                parent_link=True,
+                primary_key=True,
+                related_name="%(app_label)s_%(class)s",
+                serialize=False,
+                to="cms.cmsplugin",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="organizationpluginmodel",
+            name="cmsplugin_ptr",
+            field=models.OneToOneField(
+                auto_created=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                parent_link=True,
+                primary_key=True,
+                related_name="%(app_label)s_%(class)s",
+                serialize=False,
+                to="cms.cmsplugin",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="organizationsbycategorypluginmodel",
+            name="cmsplugin_ptr",
+            field=models.OneToOneField(
+                auto_created=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                parent_link=True,
+                primary_key=True,
+                related_name="%(app_label)s_%(class)s",
+                serialize=False,
+                to="cms.cmsplugin",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="personpluginmodel",
+            name="cmsplugin_ptr",
+            field=models.OneToOneField(
+                auto_created=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                parent_link=True,
+                primary_key=True,
+                related_name="%(app_label)s_%(class)s",
+                serialize=False,
+                to="cms.cmsplugin",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="programpluginmodel",
+            name="cmsplugin_ptr",
+            field=models.OneToOneField(
+                auto_created=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                parent_link=True,
+                primary_key=True,
+                related_name="%(app_label)s_%(class)s",
+                serialize=False,
+                to="cms.cmsplugin",
+            ),
+        ),
+    ]

richie/apps/courses/migrations/0038_alter_mainmenuentry_menu_color.py

@@ -0,0 +1,25 @@
+# Generated by Django 4.2.19 on 2025-02-25 09:40
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("courses", "0037_alter_blogpostpluginmodel_cmsplugin_ptr_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="mainmenuentry",
+            name="menu_color",
+            field=models.CharField(
+                blank=True,
+                choices=[("", "None")],
+                default="",
+                help_text="A color used to display page entry in menu.",
+                max_length=50,
+                verbose_name="Color in menu",
+            ),
+        ),
+    ]

richie/apps/courses/models/menuentry.py

@@ -40,7 +40,7 @@ class MainMenuEntry(BasePageExtension):
     )
     menu_color = models.CharField(
         _("Color in menu"),
-        max_length=10,
+        max_length=50,
         default="",
         blank=True,
         choices=defaults.MENU_ENTRY_COLOR_CLASSES,

richie/plugins/glimpse/migrations/0004_alter_glimpse_cmsplugin_ptr_alter_glimpse_variant.py

@@ -0,0 +1,49 @@
+# Generated by Django 4.2.19 on 2025-02-19 16:43
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("cms", "0022_auto_20180620_1551"),
+        ("glimpse", "0003_auto_20201118_1153"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="glimpse",
+            name="cmsplugin_ptr",
+            field=models.OneToOneField(
+                auto_created=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                parent_link=True,
+                primary_key=True,
+                related_name="%(app_label)s_%(class)s",
+                serialize=False,
+                to="cms.cmsplugin",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="glimpse",
+            name="variant",
+            field=models.CharField(
+                blank=True,
+                choices=[
+                    (None, "Inherit"),
+                    ("badge", "Badge"),
+                    ("card_square", "Square card"),
+                    ("person", "Person"),
+                    ("quote", "Quote"),
+                    ("row_half", "Half row"),
+                    ("row_full", "Full row"),
+                ],
+                default=None,
+                help_text="Form factor variant",
+                max_length=50,
+                null=True,
+                verbose_name="Variant",
+            ),
+        ),
+    ]

richie/plugins/html_sitemap/migrations/0002_alter_htmlsitemappage_cmsplugin_ptr.py

@@ -0,0 +1,28 @@
+# Generated by Django 4.2.19 on 2025-02-25 09:35
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("cms", "0022_auto_20180620_1551"),
+        ("html_sitemap", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="htmlsitemappage",
+            name="cmsplugin_ptr",
+            field=models.OneToOneField(
+                auto_created=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                parent_link=True,
+                primary_key=True,
+                related_name="%(app_label)s_%(class)s",
+                serialize=False,
+                to="cms.cmsplugin",
+            ),
+        ),
+    ]

richie/plugins/large_banner/migrations/0004_alter_largebanner_cmsplugin_ptr.py

@@ -0,0 +1,28 @@
+# Generated by Django 4.2.19 on 2025-02-25 09:35
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("cms", "0022_auto_20180620_1551"),
+        ("large_banner", "0003_make_logo_optional"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="largebanner",
+            name="cmsplugin_ptr",
+            field=models.OneToOneField(
+                auto_created=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                parent_link=True,
+                primary_key=True,
+                related_name="%(app_label)s_%(class)s",
+                serialize=False,
+                to="cms.cmsplugin",
+            ),
+        ),
+    ]

richie/plugins/lti_consumer/migrations/0004_alter_lticonsumer_cmsplugin_ptr.py

@@ -0,0 +1,28 @@
+# Generated by Django 4.2.19 on 2025-02-25 09:35
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("cms", "0022_auto_20180620_1551"),
+        ("lti_consumer", "0003_auto_20221005_0931"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="lticonsumer",
+            name="cmsplugin_ptr",
+            field=models.OneToOneField(
+                auto_created=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                parent_link=True,
+                primary_key=True,
+                related_name="%(app_label)s_%(class)s",
+                serialize=False,
+                to="cms.cmsplugin",
+            ),
+        ),
+    ]