feat: Add bits needed to make a django app plugin.

This adds the plugin entry points as well as relevant settings and
updates the testing setup to load the plugin using the plugin system so
that we're testing that things load correctly.

Author: feanil

backend/sample_plugin/apps.py

@@ -3,11 +3,69 @@
 """
 
 from django.apps import AppConfig
+from edx_django_utils.plugins.constants import PluginSettings, PluginSignals, PluginURLs
 
 
 class SamplePluginConfig(AppConfig):
+    # pylint: disable=line-too-long
     """
     Configuration for the sample_plugin Django application.
-    """
-    default_auto_field = 'django.db.models.BigAutoField'
-    name = 'sample_plugin'
+
+    See https://github.com/openedx/edx-django-utils/blob/master/edx_django_utils/plugins/docs/how_tos/how_to_create_a_plugin_app.rst#manual-setup
+    for more details and examples.
+    """  # noqa:
+
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "sample_plugin"
+    plugin_app = {
+        "url_config": {
+            "lms.djangoapp": {
+                PluginURLs.NAMESPACE: "sample_plugin",
+                PluginURLs.REGEX: r"^sample-plugin/",
+                PluginURLs.RELATIVE_PATH: "urls",
+            },
+            "cms.djangoapp": {
+                PluginURLs.NAMESPACE: "sample_plugin",
+                PluginURLs.REGEX: r"^sample-plugin/",
+                PluginURLs.RELATIVE_PATH: "urls",
+            },
+        },
+        PluginSettings.CONFIG: {
+            "lms.djangoapp": {
+                "common": {
+                    PluginURLs.RELATIVE_PATH: "settings.common",
+                },
+                "test": {
+                    PluginURLs.RELATIVE_PATH: "settings.test",
+                },
+                "production": {
+                    PluginURLs.RELATIVE_PATH: "settings.production",
+                },
+            },
+            "cms.djangoapp": {
+                "common": {
+                    PluginURLs.RELATIVE_PATH: "settings.common",
+                },
+                "test": {
+                    PluginURLs.RELATIVE_PATH: "settings.test",
+                },
+                "production": {
+                    PluginURLs.RELATIVE_PATH: "settings.production",
+                },
+            },
+        },
+        PluginSignals.CONFIG: {
+            "lms.djangoapp": {
+                PluginURLs.RELATIVE_PATH: "signals",
+                PluginSignals.RECEIVERS: [
+                    # Signals handlers can be registered here
+                ],
+            },
+            "cms.djangoapp": {
+                PluginURLs.RELATIVE_PATH: "signals",
+                PluginSignals.RECEIVERS: [
+                    # Signals handlers can be registered here
+                ],
+            },
+        },
+    }

backend/sample_plugin/settings/common.py

@@ -0,0 +1,14 @@
+"""
+Common settings for the sample_plugin application.
+"""
+
+
+def plugin_settings(settings):
+    """
+    Add plugin settings to main settings object.
+
+    Args:
+        settings (dict): Django settings object
+    """
+    pass
+    # settings.FOO = 'bar'

backend/sample_plugin/settings/production.py

@@ -0,0 +1,15 @@
+"""
+Production settings for the sample_plugin application.
+"""
+from sample_plugin.settings.common import plugin_settings as common_settings
+
+
+def plugin_settings(settings):
+    """
+    Set up production-specific settings.
+
+    Args:
+        settings (dict): Django settings object
+    """
+    # Apply common settings
+    common_settings(settings)

backend/sample_plugin/settings/test.py

@@ -0,0 +1,16 @@
+"""
+Test settings for the sample_plugin application.
+"""
+from sample_plugin.settings.common import plugin_settings as common_settings
+
+
+def plugin_settings(settings):
+    """
+    Set up test-specific settings.
+
+    Args:
+        settings (dict): Django settings object
+    """
+
+    # Apply common settings
+    common_settings(settings)

backend/sample_plugin/signals.py

@@ -0,0 +1,15 @@
+"""
+Signal handlers for the sample_plugin application.
+"""
+
+# Signal handlers can be defined here if needed
+# For example:
+# from django.dispatch import receiver
+# from openedx.core.djangoapps.user_api.accounts.signals import USER_RETIRE_LMS_CRITICAL
+#
+# @receiver(USER_RETIRE_LMS_CRITICAL)
+# def _handle_user_retirement(sender, **kwargs):
+#     """
+#     Handle user retirement actions for this app.
+#     """
+#     pass

backend/setup.py

@@ -157,4 +157,12 @@ def is_requirement(line):
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.12',
     ],
+    entry_points={
+        'lms.djangoapp': [
+            'sample_plugin = sample_plugin.apps:SamplePluginConfig',
+        ],
+        'cms.djangoapp': [
+            'sample_plugin = sample_plugin.apps:SamplePluginConfig',
+        ],
+    },
 )

backend/test_settings.py

@@ -7,6 +7,9 @@
 
 from os.path import abspath, dirname, join
 
+from edx_django_utils.plugins.plugin_apps import get_plugin_apps
+from edx_django_utils.plugins.plugin_settings import add_plugins
+
 
 def root(*args):
     """
@@ -16,70 +19,103 @@ def root(*args):
 
 
 DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': 'default.db',
-        'USER': '',
-        'PASSWORD': '',
-        'HOST': '',
-        'PORT': '',
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": "default.db",
+        "USER": "",
+        "PASSWORD": "",
+        "HOST": "",
+        "PORT": "",
     }
 }
 
-INSTALLED_APPS = (
-    'django.contrib.admin',
-    'django.contrib.auth',
-    'django.contrib.contenttypes',
-    'django.contrib.messages',
-    'django.contrib.sessions',
-    'rest_framework',
-    'django_filters',
-    'sample_plugin',
-)
+# Plugin Settings
+ENABLE_PLUGINS = True
+# Define both contexts for reference, but we'll only use one for testing
+PLUGIN_CONTEXTS = ["lms.djangoapp", "cms.djangoapp"]
+# We only use the LMS context for testing as the plugin is configured similarly for both
+# Could use CMS context instead by changing the index to 1
+
+# Base INSTALLED_APPS before plugin discovery
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.messages",
+    "django.contrib.sessions",
+    "rest_framework",
+    "django_filters",
+    "edx_django_utils.plugins",
+    "django_extensions",
+]
+
+# Dynamically add plugin apps - only using the LMS context for simplicity
+plugin_apps = get_plugin_apps(PLUGIN_CONTEXTS[0])
+INSTALLED_APPS.extend(plugin_apps)
 
 LOCALE_PATHS = [
-    root('sample_plugin', 'conf', 'locale'),
+    root("sample_plugin", "conf", "locale"),
 ]
 
-ROOT_URLCONF = 'sample_plugin.urls'
+ROOT_URLCONF = "tests.urls"
 
-SECRET_KEY = 'insecure-secret-key'
+SECRET_KEY = "insecure-secret-key"
 
 MIDDLEWARE = (
-    'django.contrib.sessions.middleware.SessionMiddleware',
-    'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'django.contrib.messages.middleware.MessageMiddleware',
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
 )
 
-TEMPLATES = [{
-    'BACKEND': 'django.template.backends.django.DjangoTemplates',
-    'APP_DIRS': False,
-    'OPTIONS': {
-        'context_processors': [
-            'django.contrib.auth.context_processors.auth',  # this is required for admin
-            'django.template.context_processors.request',  # this is also required for admin navigation sidebar
-            'django.contrib.messages.context_processors.messages',  # this is required for admin
-        ],
-    },
-}]
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "APP_DIRS": False,
+        "OPTIONS": {
+            "context_processors": [
+                "django.contrib.auth.context_processors.auth",  # this is required for admin
+                "django.template.context_processors.request",  # this is also required for admin navigation sidebar
+                "django.contrib.messages.context_processors.messages",  # this is required for admin
+            ],
+        },
+    }
+]
 
 REST_FRAMEWORK = {
-    'DEFAULT_PERMISSION_CLASSES': [
-        'rest_framework.permissions.IsAuthenticated',
+    "DEFAULT_PERMISSION_CLASSES": [
+        "rest_framework.permissions.IsAuthenticated",
     ],
-    'DEFAULT_AUTHENTICATION_CLASSES': [
-        'rest_framework.authentication.SessionAuthentication',
+    "DEFAULT_AUTHENTICATION_CLASSES": [
+        "rest_framework.authentication.SessionAuthentication",
     ],
-    'DEFAULT_FILTER_BACKENDS': [
-        'django_filters.rest_framework.DjangoFilterBackend',
-        'rest_framework.filters.OrderingFilter',
+    "DEFAULT_FILTER_BACKENDS": [
+        "django_filters.rest_framework.DjangoFilterBackend",
+        "rest_framework.filters.OrderingFilter",
     ],
-    'DEFAULT_THROTTLE_CLASSES': [
-        'rest_framework.throttling.AnonRateThrottle',
-        'rest_framework.throttling.UserRateThrottle',
+    "DEFAULT_THROTTLE_CLASSES": [
+        "rest_framework.throttling.AnonRateThrottle",
+        "rest_framework.throttling.UserRateThrottle",
     ],
-    'DEFAULT_THROTTLE_RATES': {
-        'anon': '20/hour',
-        'user': '100/hour',
+    "DEFAULT_THROTTLE_RATES": {
+        "anon": "20/hour",
+        "user": "100/hour",
+    },
+}
+
+LOGGING = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",
+        },
+    },
+    "root": {
+        "handlers": ["console"],
+        "level": "DEBUG",
     },
 }
+# Apply plugin settings - must be done after base settings are defined
+# Only using the LMS context for simplicity
+# Third parameter is the settings_type which should match the keys in settings_config
+add_plugins(__name__, PLUGIN_CONTEXTS[0], "test")