refactor: remove organization model retrieval from settings

Author: BryanttV

.annotation_safe_list.yml

@@ -41,3 +41,7 @@ waffle.Switch:
   ".. no_pii:": "This model has no PII"
 casbin_adapter.CasbinRule:
   ".. no_pii:": "This model stores authorization policy rules and contains no PII"
+organizations.HistoricalOrganization:
+  ".. no_pii:": "Historical snapshot of organization metadata and contains no PII"
+organizations.HistoricalOrganizationCourse:
+  ".. no_pii:": "Historical relation between organizations and courses and contains no PII"

openedx_authz/api/data.py

@@ -11,16 +11,12 @@
 from opaque_keys import InvalidKeyError
 from opaque_keys.edx.keys import CourseKey
 from opaque_keys.edx.locator import LibraryLocatorV2
+from organizations.models import Organization
 
-from openedx_authz.models.scopes import (
-    get_content_library_model,
-    get_course_overview_model,
-    get_organization_model,
-)
+from openedx_authz.models.scopes import get_content_library_model, get_course_overview_model
 
 ContentLibrary = get_content_library_model()
 CourseOverview = get_course_overview_model()
-Organization = get_organization_model()
 
 __all__ = [
     "ActionData",

openedx_authz/models/scopes.py

@@ -50,27 +50,8 @@ def get_course_overview_model():
         return None
 
 
-def get_organization_model():
-    """Return the Organization model class specified by settings.
-
-    The setting `OPENEDX_AUTHZ_ORGANIZATION_MODEL` should be an
-    app_label.ModelName string (e.g. 'organizations.Organization').
-    """
-    ORGANIZATION_MODEL = getattr(
-        settings,
-        "OPENEDX_AUTHZ_ORGANIZATION_MODEL",
-        "organizations.Organization",
-    )
-    try:
-        app_label, model_name = ORGANIZATION_MODEL.split(".")
-        return apps.get_model(app_label, model_name, require_ready=False)
-    except LookupError:
-        return None
-
-
 ContentLibrary = get_content_library_model()
 CourseOverview = get_course_overview_model()
-Organization = get_organization_model()
 
 
 class ContentLibraryScope(Scope):

openedx_authz/settings/common.py

@@ -50,10 +50,6 @@ def plugin_settings(settings):
     if not hasattr(settings, "OPENEDX_AUTHZ_COURSE_OVERVIEW_MODEL"):
         settings.OPENEDX_AUTHZ_COURSE_OVERVIEW_MODEL = "course_overviews.CourseOverview"
 
-    # Set default Organization model for swappable dependency
-    if not hasattr(settings, "OPENEDX_AUTHZ_ORGANIZATION_MODEL"):
-        settings.OPENEDX_AUTHZ_ORGANIZATION_MODEL = "organizations.Organization"
-
     # Set default CASBIN_LOG_LEVEL if not already set.
     # This setting defines the logging level for the Casbin enforcer.
     if not hasattr(settings, "CASBIN_LOG_LEVEL"):

openedx_authz/settings/test.py

@@ -38,6 +38,7 @@ def plugin_settings(settings):  # pylint: disable=unused-argument
     "openedx_authz.engine.apps.CasbinAdapterConfig",
     "openedx_authz.apps.OpenedxAuthzConfig",
     "openedx_authz.tests.stubs.apps.StubsConfig",
+    "organizations",
 )
 
 MIDDLEWARE = [
@@ -77,4 +78,3 @@ def plugin_settings(settings):  # pylint: disable=unused-argument
 # Use stub model for testing instead of the real content_libraries app
 OPENEDX_AUTHZ_CONTENT_LIBRARY_MODEL = "stubs.ContentLibrary"
 OPENEDX_AUTHZ_COURSE_OVERVIEW_MODEL = "stubs.CourseOverview"
-OPENEDX_AUTHZ_ORGANIZATION_MODEL = "stubs.Organization"

openedx_authz/tests/api/test_data.py

@@ -761,6 +761,7 @@ def test_get_org(self, external_key, expected_org):
         """Test organization extraction from library glob pattern."""
         self.assertEqual(OrgContentLibraryGlobData.get_org(external_key), expected_org)
 
+    @patch("openedx_authz.api.data.Organization", Organization)
     def test_exists_true_when_org_exists(self):
         """exists() returns True when the org exists."""
         org_name = "DemoX"
@@ -832,6 +833,7 @@ def test_get_org(self, external_key, expected_org):
         """Test organization extraction from course glob pattern."""
         self.assertEqual(OrgCourseOverviewGlobData.get_org(external_key), expected_org)
 
+    @patch("openedx_authz.api.data.Organization", Organization)
     def test_exists_true_when_org_exists(self):
         """exists() returns True when the org exists."""
         org_name = "OpenedX"

openedx_authz/tests/stubs/models.py

@@ -10,19 +10,7 @@
 from opaque_keys.edx.django.models import CourseKeyField, UsageKeyField
 from opaque_keys.edx.keys import CourseKey
 from opaque_keys.edx.locator import LibraryLocatorV2
-
-
-class Organization(models.Model):
-    """Stub model representing an organization for testing purposes.
-
-    .. no_pii:
-    """
-
-    name = models.CharField(max_length=255)
-    short_name = models.CharField(max_length=100)
-
-    def __str__(self):
-        return str(self.name)
+from organizations.models import Organization
 
 
 class ContentLibraryManager(models.Manager):