Skip to content

LLM-Driven Extraction of Unstructured Data — Built for API Deployments & ETL Pipeline Workflows

UN-4398 [MISC] Ask the active auth service for roles in backend tests (#2372)

Chandrasekharan Mee81e18d6678
diff --git a/backend/account_v2/test_organization_list.py b/backend/account_v2/test_organization_list.py
index 9f971b9d0..ffcda1239 100644
--- a/backend/account_v2/test_organization_list.py
+++ b/backend/account_v2/test_organization_list.py
@@ -9,6 +9,7 @@ from drf_spectacular.generators import SchemaGenerator
from rest_framework.request import Request
from rest_framework.test import APIRequestFactory, force_authenticate
from tenant_account_v2.models import OrganizationMember
+from utils.tests.auth_seam import builtin_auth_service, patch_auth_service
from utils.user_context import UserContext
from account_v2 import urls, views
@@ -49,21 +50,11 @@ class OrganizationListTests(TestCase):
UserContext.set_organization_identifier(org_a.organization_id)
self.addCleanup(UserContext.set_organization_identifier, None)
- for target, kwargs in [
- (
- "account_v2.authentication_controller."
- "AuthenticationPluginRegistry.is_plugin_available",
- {"return_value": False},
- ),
- (
- "account_v2.authentication_controller."
- "CacheService.set_user_organizations",
- {},
- ),
- ]:
- patcher = patch(target, **kwargs)
- patcher.start()
- self.addCleanup(patcher.stop)
+ patcher = patch(
+ "account_v2.authentication_controller.CacheService.set_user_organizations"
+ )
+ patcher.start()
+ self.addCleanup(patcher.stop)
self.controller = AuthenticationController()
self.listed = [
@@ -195,9 +186,8 @@ class OrganizationListTests(TestCase):
force_authenticate(raw, user=self.caller)
# org-x has no data on this deployment, as for another region's org.
unknown = OrganizationData(id="org-x", display_name="X", name="org-x")
- with patch(
- "account_v2.authentication_controller.AuthenticationService.user_organizations",
- return_value=[*self.listed, unknown],
+ with patch_auth_service(
+ "user_organizations", return_value=[*self.listed, unknown]
):
response = views.get_organizations(raw)
self.assertEqual(response.status_code, 200)
@@ -288,23 +278,16 @@ class OrganizationListEndpointTests(TestCase):
for o in (org_a, org_b)
]
self.list_organizations = MagicMock(return_value=listed)
+ # The built-in session auth throughout: a plugin's middleware would 401
+ # a session it did not seed. Test sessions have no plugin hook yet.
+ self.enterContext(builtin_auth_service())
for target, value in [
(
"account_v2.authentication_controller."
"AuthenticationService.user_organizations",
self.list_organizations,
),
- # OSS auth throughout, and no write to the shared cache.
- (
- "account_v2.custom_auth_middleware."
- "AuthenticationPluginRegistry.is_plugin_available",
- MagicMock(return_value=False),
- ),
- (
- "account_v2.authentication_controller."
- "AuthenticationPluginRegistry.is_plugin_available",
- MagicMock(return_value=False),
- ),
+ # No write to the shared cache.
(
"account_v2.authentication_controller."
"CacheService.set_user_organizations",
diff --git a/backend/account_v2/test_product_preference.py b/backend/account_v2/test_product_preference.py
index ca1ffc089..41506055f 100644
--- a/backend/account_v2/test_product_preference.py
+++ b/backend/account_v2/test_product_preference.py
@@ -27,8 +27,8 @@ import jsonschema
from django.db import IntegrityError
from django.test import SimpleTestCase, TestCase
from django.utils import timezone
+from utils.tests.auth_seam import builtin_auth_service
-from account_v2.authentication_plugin_registry import AuthenticationPluginRegistry
from account_v2.enums import Product
from account_v2.models import User, UserProductPreference
from account_v2.product_preference import (
@@ -65,11 +65,9 @@ EXISTING_SESSION_FIELDS = {
class _BuiltInSessionAuth(TestCase):
def setUp(self) -> None:
- no_plugin = mock.patch.object(
- AuthenticationPluginRegistry, "is_plugin_available", return_value=False
- )
- no_plugin.start()
- self.addCleanup(no_plugin.stop)
+ # The built-in session auth: a plugin's middleware would 401 a session
+ # it did not seed. Test sessions have no plugin hook yet.
+ self.enterContext(builtin_auth_service())
def _user(email: str, **fields) -> User:
diff --git a/backend/account_v2/tests.py b/backend/account_v2/tests.py
index 5b3d8d8d7..944e33dc2 100644
--- a/backend/account_v2/tests.py
+++ b/backend/account_v2/tests.py
@@ -7,15 +7,14 @@ An organization must never lose its only admin via a role change. The guard
import secrets
from types import SimpleNamespace
-from unittest.mock import patch
from django.test import TestCase
from tenant_account_v2.models import OrganizationMember
+from utils.tests.auth_seam import admin_role, member_role
from utils.user_context import UserContext
from account_v2.authentication_controller import AuthenticationController
from account_v2.custom_exceptions import Forbidden
-from account_v2.enums import UserRole
from account_v2.models import Organization, User
@@ -32,34 +31,25 @@ class LastAdminGuardTests(TestCase):
name="org-a", display_name="Org A", organization_id="org-a"
)
UserContext.set_organization_identifier(self.org.organization_id)
- # Pin the built-in auth service: role vocabulary is plugin-defined, so
- # UserRole below is only meaningful while no auth plugin is installed.
- registry = patch(
- "account_v2.authentication_controller."
- "AuthenticationPluginRegistry.is_plugin_available",
- return_value=False,
- )
- registry.start()
- self.addCleanup(registry.stop)
self.controller = AuthenticationController()
- self.admin = _make_member(self.org, "[email protected]", UserRole.ADMIN.value)
+ self.admin = _make_member(self.org, "[email protected]", admin_role())
def test_sole_admin_cannot_be_demoted(self) -> None:
with self.assertRaises(Forbidden):
self.controller._ensure_not_last_admin_demotion(
- email=self.admin.user.email, new_role=UserRole.USER.value
+ email=self.admin.user.email, new_role=member_role()
)
def test_demotion_allowed_when_another_admin_remains(self) -> None:
- _make_member(self.org, "[email protected]", UserRole.ADMIN.value)
+ _make_member(self.org, "[email protected]", admin_role())
self.controller._ensure_not_last_admin_demotion(
- email=self.admin.user.email, new_role=UserRole.USER.value
+ email=self.admin.user.email, new_role=member_role()
)
def test_non_admin_role_change_is_unaffected(self) -> None:
- member = _make_member(self.org, "[email protected]", UserRole.USER.value)
+ member = _make_member(self.org, "[email protected]", member_role())
self.controller._ensure_not_last_admin_demotion(
- email=member.user.email, new_role=UserRole.USER.value
+ email=member.user.email, new_role=member_role()
)
def test_add_user_role_blocks_sole_admin_demotion(self) -> None:
@@ -69,7 +59,7 @@ class LastAdminGuardTests(TestCase):
request,
self.org.organization_id,
self.admin.user.email,
- UserRole.USER.value,
+ member_role(),
)
def test_remove_user_role_blocks_sole_admin_demotion(self) -> None:
@@ -79,5 +69,5 @@ class LastAdminGuardTests(TestCase):
request,
self.org.organization_id,
self.admin.user.email,
- UserRole.ADMIN.value,
+ admin_role(),
)
diff --git a/backend/global_search/tests/test_budget.py b/backend/global_search/tests/test_budget.py
index 2b5ef29d7..d92f540fb 100644
--- a/backend/global_search/tests/test_budget.py
+++ b/backend/global_search/tests/test_budget.py
@@ -23,7 +23,6 @@ from django.contrib.contenttypes.models import ContentType
from django.db import connection
from django.test import TestCase
from django.test.utils import CaptureQueriesContext
-from unittest.mock import patch
from permissions.roles import ResourceRole
from pipeline_v2.models import Pipeline
from prompt_studio.prompt_studio_core_v2.models import CustomTool
@@ -35,6 +34,7 @@ from tenant_account_v2.models import (
ResourceMembership,
)
from tenant_account_v2.organization_member_service import OrganizationMemberService
+from utils.tests.auth_seam import admin_role, member_role
from utils.user_context import UserContext
from workflow_manager.workflow_v2.models.workflow import Workflow
@@ -76,8 +76,9 @@ class SearchBudgetTests(TestCase):
users = User.objects.bulk_create(
User(username=f"u{i}@big.test", email=f"u{i}@big.test") for i in range(USERS)
)
+ role = member_role()
OrganizationMember.objects.bulk_create(
- OrganizationMember(organization=cls.org, user=u, role="user") for u in users
+ OrganizationMember(organization=cls.org, user=u, role=role) for u in users
)
groups = OrganizationGroup.objects.bulk_create(
OrganizationGroup(organization=cls.org, name=f"g{i}", created_by=users[0])
@@ -88,10 +89,10 @@ class SearchBudgetTests(TestCase):
)
cls.member = users[0]
cls.admin = users[1]
- # The role lookup a request pays is counted: only the role-name check
- # is patched (see setUp), never the predicate that queries it.
+ # The role lookup a request pays is counted: nothing on the admin
+ # predicate is patched.
OrganizationMember.objects.filter(organization=cls.org, user=cls.admin).update(
- role="admin"
+ role=admin_role()
)
common = {"organization": cls.org}
@@ -101,7 +102,9 @@ class SearchBudgetTests(TestCase):
)
rows = [
*Workflow.objects.bulk_create(
- Workflow(workflow_name=_name("wf", i), description=_name("d", i), **common)
+ Workflow(
+ workflow_name=_name("wf", i), description=_name("d", i), **common
+ )
for i in n
),
*CustomTool.objects.bulk_create(
@@ -146,7 +149,9 @@ class SearchBudgetTests(TestCase):
for i in n
),
*ConnectorInstance.objects.bulk_create(
- ConnectorInstance(connector_name=_name("conn", i), connector_id="minio|seed", **common)
+ ConnectorInstance(
+ connector_name=_name("conn", i), connector_id="minio|seed", **common
+ )
for i in n
),
]
@@ -177,7 +182,14 @@ class SearchBudgetTests(TestCase):
row.shared_to_org = True
ResourceMembership.objects.bulk_create(memberships, batch_size=2_000)
ResourceGroupShare.objects.bulk_create(shares, batch_size=2_000)
- for model in (Workflow, CustomTool, APIDeployment, Pipeline, AdapterInstance, ConnectorInstance):
+ for model in (
+ Workflow,
+ CustomTool,
+ APIDeployment,
+ Pipeline,
+ AdapterInstance,
+ ConnectorInstance,
+ ):
model.objects.filter(
pk__in=[r.pk for r in rows if isinstance(r, model) and r.shared_to_org]
).update(shared_to_org=True)
@@ -186,17 +198,6 @@ class SearchBudgetTests(TestCase):
def setUp(self) -> None:
UserContext.set_organization_identifier(self.org.organization_id)
- # Each auth plugin names the admin role differently ("admin" in OSS,
- # "unstract_admin" in cloud). Pin the name check, which is pure
- # Python, so the admin subtest measures an admin in every
- # distribution; the membership query still runs and is counted.
- name_check = patch(
- "account_v2.authentication_controller.AuthenticationController"
- ".is_admin_by_role",
- new=lambda _self, role: role == "admin",
- )
- name_check.start()
- self.addCleanup(name_check.stop)
self.assertTrue(
OrganizationMemberService.is_user_organization_admin(
User.objects.get(pk=self.admin.pk)
@@ -205,7 +206,8 @@ class SearchBudgetTests(TestCase):
def _queries(self, user: User, limit: int) -> list[str]:
"""SQL issued for one search, minus the per-provider savepoints the
- view opens inside a transaction (TestCase always has one)."""
+ view opens inside a transaction (TestCase always has one).
+ """
# A fresh user object, as each request gets: the admin-role memo
# lives on the user, so reusing one would hide that lookup.
user = User.objects.get(pk=user.pk)
@@ -254,6 +256,8 @@ class SearchBudgetTests(TestCase):
for user in (self.member, self.admin):
with self.subTest(user=user.email):
p95 = self._p95_ms(user)
- print(f"[global_search budget] {user.email} p95={p95:.1f}ms (budget {BUDGET_MS}ms)")
+ print(
+ f"[global_search budget] {user.email} p95={p95:.1f}ms (budget {BUDGET_MS}ms)"
+ )
if ASSERT_P95:
self.assertLessEqual(p95, CEILING_MS)
diff --git a/backend/global_search/tests/test_contract.py b/backend/global_search/tests/test_contract.py
index 96c734b4c..53ffe5fd1 100644
--- a/backend/global_search/tests/test_contract.py
+++ b/backend/global_search/tests/test_contract.py
@@ -14,16 +14,17 @@ from pathlib import Path
from unittest.mock import patch
import jsonschema
-from django.db import connection
from account_v2.models import Organization
+from django.db import connection
from django.test import TestCase
from django.urls import resolve
from permissions.roles import ResourceRole
from permissions.tests.base import CoOwnerOrgTestMixin, make_user
from tenant_account_v2.models import OrganizationMember
+from utils.tests.auth_seam import admin_role, builtin_auth_service
from global_search.constants import OSSSearchType as T
-from global_search.oss_providers import AdapterProvider, OSS_PROVIDERS, WorkflowProvider
+from global_search.oss_providers import OSS_PROVIDERS, AdapterProvider, WorkflowProvider
from global_search.providers import SearchProvider
from global_search.tests.base import OSS_BUILDERS, search
from global_search.views import GlobalSearchView
@@ -136,16 +137,15 @@ class SearchContractTests(CoOwnerOrgTestMixin, TestCase):
other = Organization.objects.create(
name="org-b", display_name="Org B", organization_id="org-b"
)
- OrganizationMember.objects.create(organization=other, user=self.admin, role="admin")
# The built-in session auth, so a distribution's auth plugin cannot
- # 401 the request first; the org check runs after either.
- no_plugin = patch(
- "account_v2.custom_auth_middleware.AuthenticationPluginRegistry"
- ".is_plugin_available",
- return_value=False,
+ # 401 the request first; the org check runs after either. Test
+ # sessions have no plugin hook yet. The admin's rows then take the
+ # built-in service's role name.
+ self.enterContext(builtin_auth_service())
+ OrganizationMember.objects.filter(user=self.admin).update(role=admin_role())
+ OrganizationMember.objects.create(
+ organization=other, user=self.admin, role=admin_role()
)
- no_plugin.start()
- self.addCleanup(no_plugin.stop)
self.client.force_login(self.admin)
session = self.client.session
session["organization"] = self.org.organization_id
diff --git a/backend/permissions/tests/base.py b/backend/permissions/tests/base.py
index a5381b8a1..e6f93d4c4 100644
--- a/backend/permissions/tests/base.py
+++ b/backend/permissions/tests/base.py
@@ -9,23 +9,16 @@ import secrets
from collections.abc import Callable
from dataclasses import dataclass
from typing import Any
-from unittest.mock import patch
from account_v2.models import Organization, User
-from permissions.permission import IsOwner
from rest_framework.test import APIRequestFactory
from rest_framework.views import APIView
from tenant_account_v2.models import OrganizationMember
+from utils.tests.auth_seam import admin_role, member_role
from utils.user_context import UserContext
from workflow_manager.workflow_v2.models.workflow import Workflow
-# Admin resolution is auth-plugin backed, so patch it to a deterministic
-# predicate — the ``role="admin"`` membership row alone does not make
-# ``_is_organization_admin`` true.
-_ADMIN_PREDICATE = (
- "tenant_account_v2.organization_member_service."
- "OrganizationMemberService.is_user_organization_admin"
-)
+from permissions.permission import IsOwner
def make_user(email: str, **kwargs: Any) -> User:
@@ -120,7 +113,7 @@ RESOURCE_SPECS: list[ResourceSpec] = [
class CoOwnerOrgTestMixin:
- """setUp helper: one org, members, and a deterministic admin predicate."""
+ """setUp helper: one org and its members, admin by the active auth service's role."""
def _seed_org(self) -> None:
self.org = Organization.objects.create(
@@ -135,18 +128,11 @@ class CoOwnerOrgTestMixin:
self.stranger = make_user("[email protected]") # NOT an org member
for user in (self.owner, self.coowner, self.viewer, self.outsider):
OrganizationMember.objects.create(
- organization=self.org, user=user, role="user"
+ organization=self.org, user=user, role=member_role()
)
OrganizationMember.objects.create(
- organization=self.org, user=self.admin, role="admin"
- )
- patcher = patch(
- _ADMIN_PREDICATE,
- side_effect=lambda u: getattr(u, "email", None) == self.admin.email,
+ organization=self.org, user=self.admin, role=admin_role()
)
- patcher.start()
- # addCleanup is provided by TestCase (this is a mixin combined with it).
- self.addCleanup(patcher.stop) # type: ignore[attr-defined]
def _is_owner_perm(self, user: User, obj: object) -> bool:
"""Run ``IsOwner.has_object_permission`` for ``user`` against ``obj``."""
diff --git a/backend/permissions/tests/test_owner_management.py b/backend/permissions/tests/test_owner_management.py
index b5804799f..888aec6ef 100644
--- a/backend/permissions/tests/test_owner_management.py
+++ b/backend/permissions/tests/test_owner_management.py
@@ -321,12 +321,7 @@ class OwnerNotificationWiringTests(CoOwnerOrgTestMixin, TestCase):
nothing was actually taken from them, so no "access removed" email.
"""
self.workflow.memberships.create(user=self.admin, role=ResourceRole.OWNER)
- with patch(
- "account_v2.authentication_controller.AuthenticationController"
- ".is_admin_by_role",
- side_effect=lambda role: role == "admin",
- ):
- response = self._remove(self.owner, self.admin.pk)
+ response = self._remove(self.owner, self.admin.pk)
self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT)
self.service.send_access_removed_notification.assert_not_called()
diff --git a/backend/platform_audit/tests/base.py b/backend/platform_audit/tests/base.py
index 3610427cc..08ba5106b 100644
--- a/backend/platform_audit/tests/base.py
+++ b/backend/platform_audit/tests/base.py
@@ -1,14 +1,15 @@
"""Shared fixtures: one org with an admin and a member, a second org, and a
-helper that calls a view the way a request would and runs its on-commit writes."""
+helper that calls a view the way a request would and runs its on-commit writes.
+"""
import secrets
from typing import Any
-from unittest.mock import patch
from account_v2.models import Organization, User
from django.test import TestCase
from rest_framework.test import APIRequestFactory, force_authenticate
from tenant_account_v2.models import OrganizationMember
+from utils.tests.auth_seam import admin_role, member_role
from utils.user_context import UserContext
from platform_audit.models import PlatformAuditEvent
@@ -22,17 +23,6 @@ def make_user(email: str, **kwargs: Any) -> User:
class AuditTestBase(TestCase):
def setUp(self) -> None:
- # The built-in auth service, whatever plugin the distribution installs:
- # these tests use its role names ("admin", "user") and patch its
- # identity-provider calls. Under a plugin such as cloud's Auth0, a
- # role="admin" row is not an admin, and the patches would miss.
- no_plugin = patch(
- "account_v2.authentication_plugin_registry.AuthenticationPluginRegistry"
- ".is_plugin_available",
- return_value=False,
- )
- no_plugin.start()
- self.addCleanup(no_plugin.stop)
self.org = Organization.objects.create(
name="org-a", display_name="Org A", organization_id="org-a"
)
@@ -40,13 +30,14 @@ class AuditTestBase(TestCase):
name="org-b", display_name="Org B", organization_id="org-b"
)
self.use_org(self.org)
+ self.admin_role, self.member_role = admin_role(), member_role()
self.admin = make_user("[email protected]", first_name="Ada", last_name="Min")
self.member = make_user("[email protected]")
OrganizationMember.objects.create(
- organization=self.org, user=self.admin, role="admin"
+ organization=self.org, user=self.admin, role=self.admin_role
)
OrganizationMember.objects.create(
- organization=self.org, user=self.member, role="user"
+ organization=self.org, user=self.member, role=self.member_role
)
self.factory = APIRequestFactory()
diff --git a/backend/platform_audit/tests/test_api.py b/backend/platform_audit/tests/test_api.py
index 6f8b8859b..efd767cda 100644
--- a/backend/platform_audit/tests/test_api.py
+++ b/backend/platform_audit/tests/test_api.py
@@ -1,8 +1,7 @@
import csv
import io
import uuid
-from datetime import datetime, timedelta
-from datetime import timezone as dt_timezone
+from datetime import UTC, datetime, timedelta
from types import SimpleNamespace
from unittest.mock import patch
@@ -12,8 +11,8 @@ from django.test import override_settings
from django.utils import timezone
from platform_audit.models import PlatformAuditEvent
-from platform_audit.tests.base import AuditTestBase, make_user
from platform_audit.serializers import AuditEventQuerySerializer
+from platform_audit.tests.base import AuditTestBase, make_user
from platform_audit.views import (
CSV_COLUMNS,
PlatformAuditActionListView,
@@ -195,9 +194,7 @@ class AuditReadApiTests(AuditTestBase):
value="5",
)
response = self._get(LIST)
- self.assertEqual(
- self._ids(response), [str(self.role.id), str(self.rotate.id)]
- )
+ self.assertEqual(self._ids(response), [str(self.role.id), str(self.rotate.id)])
self.assertEqual(response.data["retention_days"], 5)
def test_from_before_retention_still_hides_expired(self) -> None:
@@ -220,7 +217,7 @@ class AuditReadApiTests(AuditTestBase):
# An admin membership, as the role endpoint can grant one, so the
# refusal has to come from the service-account check.
OrganizationMember.objects.create(
- organization=self.org, user=service_account, role="admin"
+ organization=self.org, user=service_account, role=self.admin_role
)
key = SimpleNamespace(id=uuid.uuid4(), name="k", permission="full_access")
views = {"list": LIST, "export": EXPORT, "actions": ACTIONS, "actors": ACTORS}
@@ -235,7 +232,7 @@ class AuditReadApiTests(AuditTestBase):
self.use_org(self.other_org)
OrganizationMember.objects.create(
- organization=self.other_org, user=other_admin, role="admin"
+ organization=self.other_org, user=other_admin, role=self.admin_role
)
response = self._get(LIST, user=other_admin)
self.assertEqual(self._ids(response), [str(self.foreign.id)])
@@ -342,12 +339,16 @@ class AuditReadApiTests(AuditTestBase):
def test_actors_include_removed_members_and_skip_expired(self) -> None:
gone = make_user("[email protected]")
- self._event("member.removed", days_ago=3, actor=gone, actor_email="[email protected]")
+ self._event(
+ "member.removed", days_ago=3, actor=gone, actor_email="[email protected]"
+ )
self._event("member.removed", days_ago=370, actor_email="[email protected]")
gone.delete()
response = self._get(ACTORS)
emails = [row["email"] for row in response.data]
- self.assertEqual(emails, ["[email protected]", "[email protected]", "[email protected]"])
+ self.assertEqual(
+ )
self.assertIsNone(response.data[2]["id"])
@override_settings(TIME_ZONE="Asia/Kolkata")
@@ -356,7 +357,7 @@ class AuditReadApiTests(AuditTestBase):
self.assertTrue(query.is_valid(), query.errors)
self.assertEqual(
query.validated_data["start"],
- datetime(2026, 1, 1, 3, 30, tzinfo=dt_timezone.utc),
+ datetime(2026, 1, 1, 3, 30, tzinfo=UTC),
)
def test_invalid_from_reports_the_parameter_name(self) -> None:
diff --git a/backend/platform_audit/tests/test_events.py b/backend/platform_audit/tests/test_events.py
index 643325a7d..b664ae9be 100644
--- a/backend/platform_audit/tests/test_events.py
+++ b/backend/platform_audit/tests/test_events.py
@@ -1,7 +1,7 @@
"""One test per recorded event type, through the view that records it.
-Identity-provider calls are patched (OSS has no auth plugin); everything else
-runs for real so the stored row is what production would store.
+Identity-provider calls are patched, and the membership rows take the active
+auth service's role names, so the stored row is what production would store.
"""
import uuid
@@ -9,12 +9,12 @@ from unittest.mock import patch
from account_v2.dto import MemberInvitation
from account_v2.models import PlatformKey
+from adapter_processor_v2.models import AdapterInstance, UserDefaultAdapter
+from adapter_processor_v2.views import DefaultAdapterViewSet
from configuration.enums import ConfigKey
from configuration.models import Configuration
-from django.db import OperationalError
from django.conf import settings
-from adapter_processor_v2.models import AdapterInstance, UserDefaultAdapter
-from adapter_processor_v2.views import DefaultAdapterViewSet
+from django.db import OperationalError
from global_api_deployment_key.models import GlobalApiDeploymentKey
from global_api_deployment_key.views import GlobalApiDeploymentKeyViewSet
from notification_v2.views import NotificationSettingsView
@@ -23,16 +23,20 @@ from platform_api.views import PlatformApiKeyViewSet
from platform_settings_v2.views import PlatformKeyViewSet
from tenant_account_v2.group_views import OrganizationGroupViewSet
from tenant_account_v2.invitation_views import InvitationViewSet
-from tenant_account_v2.models import GroupMembership, OrganizationGroup, OrganizationMember
+from tenant_account_v2.models import (
+ GroupMembership,
+ OrganizationGroup,
+ OrganizationMember,
+)
from tenant_account_v2.users_view import OrganizationUserViewSet
from tenant_account_v2.views import organization_settings
+from utils.tests.auth_seam import patch_auth_service
+from utils.user_context import UserContext
from platform_audit.models import PlatformAuditEvent
-from utils.user_context import UserContext
from platform_audit.tests.base import AuditTestBase, make_user
_CONTROLLER = "account_v2.authentication_controller.AuthenticationController"
-_SERVICE = "account_v2.authentication_service.AuthenticationService"
class MemberEventTests(AuditTestBase):
@@ -44,10 +48,16 @@ class MemberEventTests(AuditTestBase):
return side_effect
def test_role_changed_on_assign(self) -> None:
- view = OrganizationUserViewSet.as_view({"post": "assign_organization_role_to_user"})
- with patch(f"{_CONTROLLER}.add_user_role", side_effect=self._set_role("admin")):
+ view = OrganizationUserViewSet.as_view(
+ {"post": "assign_organization_role_to_user"}
+ )
+ with patch(
+ f"{_CONTROLLER}.add_user_role", side_effect=self._set_role(self.admin_role)
+ ):
response = self.call(
- view, "post", data={"email": "[email protected]", "role": "admin"}
+ view,
+ "post",
+ data={"email": "[email protected]", "role": self.admin_role},
)
self.assertEqual(response.status_code, 200)
event = self.only_event(action="member.role_changed")
@@ -56,46 +66,71 @@ class MemberEventTests(AuditTestBase):
self.assertEqual(event.target_id, str(self.member.id))
self.assertEqual(event.target_name, "[email protected]")
self.assertEqual(
- event.changes, {"before": {"role": "user"}, "after": {"role": "admin"}}
+ event.changes,
+ {"before": {"role": self.member_role}, "after": {"role": self.admin_role}},
)
- self.assertEqual(event.summary, "user → admin")
+ self.assertEqual(event.summary, f"{self.member_role} → {self.admin_role}")
def test_role_changed_on_remove(self) -> None:
view = OrganizationUserViewSet.as_view(
{"delete": "remove_organization_role_from_user"}
)
- OrganizationMember.objects.filter(user=self.member).update(role="admin")
- with patch(f"{_CONTROLLER}.remove_user_role", side_effect=self._set_role("user")):
- self.call(view, "delete", data={"email": "[email protected]", "role": "admin"})
+ OrganizationMember.objects.filter(user=self.member).update(role=self.admin_role)
+ with patch(
+ f"{_CONTROLLER}.remove_user_role",
+ side_effect=self._set_role(self.member_role),
+ ):
+ self.call(
+ view,
+ "delete",
+ data={"email": "[email protected]", "role": self.admin_role},
+ )
event = self.only_event(action="member.role_changed")
self.assertEqual(
- event.changes, {"before": {"role": "admin"}, "after": {"role": "user"}}
+ event.changes,
+ {"before": {"role": self.admin_role}, "after": {"role": self.member_role}},
)
def test_role_change_with_unknown_previous_role_omits_before(self) -> None:
- view = OrganizationUserViewSet.as_view({"post": "assign_organization_role_to_user"})
+ view = OrganizationUserViewSet.as_view(
+ {"post": "assign_organization_role_to_user"}
+ )
with (
patch(
"tenant_account_v2.users_view.OrganizationMemberService.get_user_by_email",
side_effect=RuntimeError("db"),
),
- patch(f"{_CONTROLLER}.add_user_role", return_value="admin"),
+ patch(f"{_CONTROLLER}.add_user_role", return_value=self.admin_role),
):
with self.assertLogs("platform_audit.recorder", "ERROR"):
- self.call(view, "post", data={"email": "[email protected]", "role": "admin"})
+ self.call(
+ view,
+ "post",
+ data={"email": "[email protected]", "role": self.admin_role},
+ )
event = self.only_event(action="member.role_changed")
- self.assertEqual(event.changes, {"after": {"role": "admin"}})
- self.assertEqual(event.summary, "role → admin (previous value unavailable)")
+ self.assertEqual(event.changes, {"after": {"role": self.admin_role}})
+ self.assertEqual(
+ event.summary, f"role → {self.admin_role} (previous value unavailable)"
+ )
def test_failed_or_unchanged_role_records_nothing(self) -> None:
- view = OrganizationUserViewSet.as_view({"post": "assign_organization_role_to_user"})
+ view = OrganizationUserViewSet.as_view(
+ {"post": "assign_organization_role_to_user"}
+ )
with patch(f"{_CONTROLLER}.add_user_role", return_value=None):
response = self.call(
- view, "post", data={"email": "[email protected]", "role": "admin"}
+ view,
+ "post",
+ data={"email": "[email protected]", "role": self.admin_role},
)
self.assertEqual(response.status_code, 400)
- with patch(f"{_CONTROLLER}.add_user_role", return_value="user"):
- self.call(view, "post", data={"email": "[email protected]", "role": "user"})
+ with patch(f"{_CONTROLLER}.add_user_role", return_value=self.member_role):
+ self.call(
+ view,
+ "post",
+ data={"email": "[email protected]", "role": self.member_role},
+ )
self.assertEqual(self.events(), [])
def _invite(self, users: list[dict], idp_results: list) -> object:
@@ -103,19 +138,16 @@ class MemberEventTests(AuditTestBase):
identity provider's per-user call answering ``idp_results`` in order.
"""
view = OrganizationUserViewSet.as_view({"post": "invite_user"})
- with (
- patch(f"{_SERVICE}.is_organization_admin", return_value=True),
- patch(f"{_SERVICE}.invite_user", side_effect=idp_results),
- ):
+ with patch_auth_service("invite_user", side_effect=idp_results):
return self.call(view, "post", data={"users": users})
def test_invited_records_only_successful_invites(self) -> None:
# member@ is already a member, so the IdP is never asked about them.
response = self._invite(
[
- {"email": "[email protected]", "role": "user"},
- {"email": "[email protected]", "role": "user"},
- {"email": "[email protected]", "role": "user"},
+ {"email": "[email protected]", "role": self.member_role},
+ {"email": "[email protected]", "role": self.member_role},
+ {"email": "[email protected]", "role": self.member_role},
],
[True, False],
)
@@ -126,16 +158,16 @@ class MemberEventTests(AuditTestBase):
(event.target_type, event.target_id, event.target_name),
("invitation", "[email protected]", "[email protected]"),
)
- self.assertEqual(event.changes, {"after": {"role": "user"}})
- self.assertEqual(event.summary, "as user")
+ self.assertEqual(event.changes, {"after": {"role": self.member_role}})
+ self.assertEqual(event.summary, f"as {self.member_role}")
def test_invites_sent_before_a_failing_one_are_still_recorded(self) -> None:
# The IdP raises on the third: the first two invitations were sent.
response = self._invite(
[
- {"email": "[email protected]", "role": "user"},
- {"email": "[email protected]", "role": "admin"},
- {"email": "[email protected]", "role": "user"},
+ {"email": "[email protected]", "role": self.member_role},
+ {"email": "[email protected]", "role": self.admin_role},
+ {"email": "[email protected]", "role": self.member_role},
],
[True, True, RuntimeError("idp 429")],
)
@@ -145,7 +177,7 @@ class MemberEventTests(AuditTestBase):
(e.target_name, e.changes["after"]["role"])
for e in self.events(action="member.invited")
),
- [("[email protected]", "user"), ("[email protected]", "admin")],
+ [("[email protected]", self.member_role), ("[email protected]", self.admin_role)],
)
def test_a_failing_organisation_lookup_does_not_stop_invites(self) -> None:
@@ -157,7 +189,7 @@ class MemberEventTests(AuditTestBase):
view_context.get_organization.side_effect = OperationalError("db")
recorder_context.get_organization.side_effect = OperationalError("db")
response = self._invite(
- [{"email": "[email protected]", "role": "user"}], [True]
+ [{"email": "[email protected]", "role": self.member_role}], [True]
)
self.assertEqual(response.status_code, 200)
self.assertEqual(self.events(), [])
@@ -165,18 +197,20 @@ class MemberEventTests(AuditTestBase):
def test_each_invite_records_its_own_role(self) -> None:
self._invite(
[
- {"email": "[email protected]", "role": "admin"},
- {"email": "[email protected]", "role": "user"},
+ {"email": "[email protected]", "role": self.admin_role},
+ {"email": "[email protected]", "role": self.member_role},
],
[True, True],
)
self.assertEqual(
sorted(e.summary for e in self.events(action="member.invited")),
- ["as admin", "as user"],
+ sorted([f"as {self.admin_role}", f"as {self.member_role}"]),
)
def test_removed_records_the_previous_role(self) -> None:
- view = OrganizationUserViewSet.as_view({"delete": "remove_members_from_organization"})
+ view = OrganizationUserViewSet.as_view(
+ {"delete": "remove_members_from_organization"}
+ )
with patch(f"{_CONTROLLER}.remove_users_from_organization", return_value=True):
response = self.call(view, "delete", data={"emails": ["[email protected]"]})
self.assertEqual(response.status_code, 200)
@@ -184,11 +218,13 @@ class MemberEventTests(AuditTestBase):
self.assert_admin_actor(event)
self.assertEqual(event.target_id, str(self.member.id))
self.assertEqual(event.target_name, "[email protected]")
- self.assertEqual(event.changes, {"before": {"role": "user"}})
- self.assertEqual(event.summary, "was user")
+ self.assertEqual(event.changes, {"before": {"role": self.member_role}})
+ self.assertEqual(event.summary, f"was {self.member_role}")
def test_removal_with_an_unreadable_snapshot_is_still_recorded(self) -> None:
- view = OrganizationUserViewSet.as_view({"delete": "remove_members_from_organization"})
+ view = OrganizationUserViewSet.as_view(
+ {"delete": "remove_members_from_organization"}
+ )
with (
patch(
"tenant_account_v2.users_view.OrganizationMemberService.get_user_by_email",
@@ -208,14 +244,18 @@ class MemberEventTests(AuditTestBase):
)
def test_a_failed_removal_records_nothing(self) -> None:
- view = OrganizationUserViewSet.as_view({"delete": "remove_members_from_organization"})
+ view = OrganizationUserViewSet.as_view(
+ {"delete": "remove_members_from_organization"}
+ )
with patch(f"{_CONTROLLER}.remove_users_from_organization", return_value=False):
response = self.call(view, "delete", data={"emails": ["[email protected]"]})
self.assertEqual(response.status_code, 400)
self.assertEqual(self.events(), [])
def test_a_non_member_in_the_list_is_skipped_not_fatal(self) -> None:
- view = OrganizationUserViewSet.as_view({"delete": "remove_members_from_organization"})
+ view = OrganizationUserViewSet.as_view(
+ {"delete": "remove_members_from_organization"}
+ )
with patch(f"{_CONTROLLER}.remove_users_from_organization", return_value=True):
self.call(
view,
@@ -227,7 +267,9 @@ class MemberEventTests(AuditTestBase):
def test_invitation_revoked_resolves_the_email(self) -> None:
view = InvitationViewSet.as_view({"delete": "delete_invitation"})
- invitation = MemberInvitation(id="inv-1", email="[email protected]", roles=["user"])
+ invitation = MemberInvitation(
+ id="inv-1", email="[email protected]", roles=[self.member_role]
+ )
with (
patch(f"{_CONTROLLER}.get_user_invitations", return_value=[invitation]),
patch(f"{_CONTROLLER}.delete_user_invitation", return_value=True),
@@ -243,7 +285,9 @@ class MemberEventTests(AuditTestBase):
def test_a_failed_revoke_records_nothing(self) -> None:
view = InvitationViewSet.as_view({"delete": "delete_invitation"})
- invitation = MemberInvitation(id="inv-1", email="[email protected]", roles=["user"])
+ invitation = MemberInvitation(
+ id="inv-1", email="[email protected]", roles=[self.member_role]
+ )
with (
patch(f"{_CONTROLLER}.get_user_invitations", return_value=[invitation]),
patch(f"{_CONTROLLER}.delete_user_invitation", return_value=False),
@@ -339,14 +383,17 @@ class GroupEventTests(AuditTestBase):
users = [make_user(email) for email in emails]
for user in users:
OrganizationMember.objects.create(
- organization=self.org, user=user, role="user"
+ organization=self.org, user=user, role=self.member_role
)
with patch(
"utils.user_context.UserContext.get_organization",
wraps=UserContext.get_organization,
) as spy:
self.call(
- add, "post", data={"user_ids": [u.id for u in users]}, pk=self.group.pk
+ add,
+ "post",
+ data={"user_ids": [u.id for u in users]},
+ pk=self.group.pk,
)
lookups.append(spy.call_count)
self.assertEqual(lookups[0], lookups[1])
@@ -405,7 +452,10 @@ class PlatformApiKeyEventTests(AuditTestBase):
event = self.only_event(action="key.changed")
self.assertEqual(
event.changes,
- {"before": {"permission": "read_write"}, "after": {"permission": "full_access"}},
+ {
+ "before": {"permission": "read_write"},
+ "after": {"permission": "full_access"},
+ },
)
self.assertEqual(event.summary, "changed permission")
@@ -685,7 +735,8 @@ class DefaultProfileEventTests(AuditTestBase):
class PlatformSettingEventTests(AuditTestBase):
def test_organization_setting_changed(self) -> None:
"""Its flags are the storage of two capabilities (UN-4399), so a change
- is recorded once, as the capability changing."""
+ is recorded once, as the capability changing.
+ """
response = self.call(
organization_settings,
"patch",
diff --git a/backend/platform_audit/tests/test_resource_events.py b/backend/platform_audit/tests/test_resource_events.py
index 0cd5df2d1..f6db0598e 100644
--- a/backend/platform_audit/tests/test_resource_events.py
+++ b/backend/platform_audit/tests/test_resource_events.py
@@ -45,7 +45,9 @@ class ResourceEventTestBase(AuditTestBase):
def create_workflow(self, name: str = "wf") -> Workflow:
response = self.call(
- WorkflowViewSet.as_view({"post": "create"}), "post", data={"workflow_name": name}
+ WorkflowViewSet.as_view({"post": "create"}),
+ "post",
+ data={"workflow_name": name},
)
self.assertEqual(response.status_code, 201, response.data)
return Workflow.objects.get(workflow_name=name)
@@ -91,9 +93,7 @@ class ResourceEventTestBase(AuditTestBase):
class CreateAndDeleteTests(ResourceEventTestBase):
def _delete(self, viewset, resource, pk) -> None:
- response = self.call(
- viewset.as_view({"delete": "destroy"}), "delete", pk=str(pk)
- )
+ response = self.call(viewset.as_view({"delete": "destroy"}), "delete", pk=str(pk))
self.assertIn(response.status_code, (200, 204), getattr(response, "data", None))
def test_adapter(self) -> None:
@@ -175,9 +175,13 @@ class CreateAndDeleteTests(ResourceEventTestBase):
)
self.assertEqual(response.status_code, 201, response.data)
api = APIDeployment.objects.get(api_name="my-api")
- self.assert_resource_event(Action.RESOURCE_CREATED, "api_deployment", api.id, "my api")
+ self.assert_resource_event(
+ Action.RESOURCE_CREATED, "api_deployment", api.id, "my api"
+ )
self._delete(APIDeploymentViewSet, api, api.id)
- self.assert_resource_event(Action.RESOURCE_DELETED, "api_deployment", api.id, "my api")
+ self.assert_resource_event(
+ Action.RESOURCE_DELETED, "api_deployment", api.id, "my api"
+ )
def test_pipeline(self) -> None:
workflow = self.create_workflow()
@@ -338,7 +342,9 @@ class SharingTests(ResourceEventTestBase):
self.group = OrganizationGroup.objects.create(organization=self.org, name="Ops")
def _share(self, viewset, pk, data):
- response = self.call(viewset.as_view({"post": "share"}), "post", data=data, pk=str(pk))
+ response = self.call(
+ viewset.as_view({"post": "share"}), "post", data=data, pk=str(pk)
+ )
self.assertEqual(response.status_code, 200, getattr(response, "data", None))
def test_records_each_changed_axis(self) -> None:
@@ -357,7 +363,11 @@ class SharingTests(ResourceEventTestBase):
self.assertEqual(
event.changes,
{
- "before": {"shared_users": [], "shared_groups": [], "shared_to_org": False},
+ "before": {
+ "shared_users": [],
+ "shared_groups": [],
+ "shared_to_org": False,
+ },
"after": {
"shared_users": ["[email protected]"],
"shared_groups": ["Ops"],
@@ -378,7 +388,10 @@ class SharingTests(ResourceEventTestBase):
self.assertEqual(
[e.changes for e in events],
[
- {"before": {"shared_users": []}, "after": {"shared_users": ["[email protected]"]}},
+ {
+ "before": {"shared_users": []},
+ "after": {"shared_users": ["[email protected]"]},
+ },
{"before": {"shared_to_org": False}, "after": {"shared_to_org": True}},
],
)
@@ -387,14 +400,20 @@ class SharingTests(ResourceEventTestBase):
adapter = self.create_adapter()
self._share(AdapterInstanceViewSet, adapter.id, {"shared_to_org": True})
self.assert_resource_event(
- Action.RESOURCE_SHARING_CHANGED, "adapter_instance", adapter.id, "my-llm", "LLM"
+ Action.RESOURCE_SHARING_CHANGED,
+ "adapter_instance",
+ adapter.id,
+ "my-llm",
+ "LLM",
)
def test_co_owner_added_and_removed(self) -> None:
coowner = make_user("[email protected]")
from tenant_account_v2.models import OrganizationMember
- OrganizationMember.objects.create(organization=self.org, user=coowner, role="user")
+ OrganizationMember.objects.create(
+ organization=self.org, user=coowner, role=self.member_role
+ )
response = self.call(
WorkflowViewSet.as_view({"post": "add_co_owner"}),
"post",
@@ -403,9 +422,15 @@ class SharingTests(ResourceEventTestBase):
)
self.assertEqual(response.status_code, 200, response.data)
added = self.assert_resource_event(
- Action.RESOURCE_CO_OWNER_ADDED, "workflow", self.workflow.id, "wf", "[email protected]"
+ Action.RESOURCE_CO_OWNER_ADDED,
+ "workflow",
+ self.workflow.id,
+ "wf",
+ )
+ self.assertEqual(
+ added.metadata, {"user_id": coowner.id, "email": "[email protected]"}
)
- self.assertEqual(added.metadata, {"user_id": coowner.id, "email": "[email protected]"})
response = self.call(
WorkflowViewSet.as_view({"delete": "remove_co_owner"}),
"delete",
@@ -414,7 +439,11 @@ class SharingTests(ResourceEventTestBase):
)
self.assertEqual(response.status_code, 204)
self.assert_resource_event(
- Action.RESOURCE_CO_OWNER_REMOVED, "workflow", self.workflow.id, "wf", "[email protected]"
+ Action.RESOURCE_CO_OWNER_REMOVED,
+ "workflow",
+ self.workflow.id,
+ "wf",
)
@@ -426,7 +455,7 @@ class CoOwnerRaceTests(ResourceEventTestBase):
self.workflow = self.create_workflow()
self.coowner = make_user("[email protected]")
OrganizationMember.objects.create(
- organization=self.org, user=self.coowner, role="user"
+ organization=self.org, user=self.coowner, role=self.member_role
)
def _context(self) -> dict:
@@ -515,9 +544,7 @@ class CoOwnerRaceTests(ResourceEventTestBase):
self.assertTrue(serializer.is_valid(), serializer.errors)
self.workflow.memberships.create(user=self.coowner, role=ResourceRole.OWNER)
self.assertFalse(serializer.save())
- self.assertEqual(
- self.workflow.memberships.filter(user=self.coowner).count(), 1
- )
+ self.assertEqual(self.workflow.memberships.filter(user=self.coowner).count(), 1)
def test_a_remove_another_request_already_made_changes_nothing(self) -> None:
self.workflow.memberships.create(user=self.coowner, role=ResourceRole.OWNER)
@@ -553,9 +580,11 @@ class OrgScopingTests(ResourceEventTestBase):
from tenant_account_v2.models import OrganizationMember
OrganizationMember.objects.create(
- organization=self.other_org, user=other_admin, role="admin"
+ organization=self.other_org, user=other_admin, role=self.admin_role
)
self.use_org(self.other_org)
- response = self.call(PlatformAuditEventListView.as_view(), "get", user=other_admin)
+ response = self.call(
+ PlatformAuditEventListView.as_view(), "get", user=other_admin
+ )
self.assertEqual(response.status_code, 200, response.data)
self.assertEqual(response.data["results"], [])
diff --git a/backend/tenant_account_v2/test_capabilities.py b/backend/tenant_account_v2/test_capabilities.py
index 47a09d6c9..191946f7a 100644
--- a/backend/tenant_account_v2/test_capabilities.py
+++ b/backend/tenant_account_v2/test_capabilities.py
@@ -1,7 +1,9 @@
"""Organisation capability permissions (UN-4399).
-The OSS auth service treats the ``admin`` role as admin, so the fixtures'
-roles drive ``is_user_organization_admin`` directly.
+The fixtures' roles come from the active auth service (``utils.tests.auth_seam``),
+so they drive ``is_user_organization_admin`` directly under any distribution.
+The classes whose role changes go through the identity provider pin the built-in
+service instead, and say why.
"""
import importlib
@@ -35,6 +37,7 @@ from platform_api.models import ApiKeyPermission, PlatformApiKey
from platform_api.views import PlatformApiKeyViewSet
from platform_audit.tests.base import AuditTestBase, make_user
from rest_framework.exceptions import PermissionDenied
+from utils.tests.auth_seam import builtin_auth_service
from utils.user_context import UserContext
from workflow_manager.workflow_v2.models.workflow import Workflow
from workflow_manager.workflow_v2.views import WorkflowViewSet
@@ -130,7 +133,7 @@ class CapabilityTestBase(AuditTestBase):
self.service_account = make_user("[email protected]", is_service_account=True)
# As platform_api.services gives every platform key's service account.
OrganizationMember.objects.create(
- organization=self.org, user=self.service_account, role="user"
+ organization=self.org, user=self.service_account, role=self.member_role
)
def restrict(self, key: Capability, restricted: bool) -> None:
@@ -568,10 +571,14 @@ class AdminOnlyEndpointsMatrixTests(CapabilityTestBase):
"""
def setUp(self) -> None:
+ # Role changes go through the identity provider, and under a plugin
+ # they take its role ids, not names: these check the built-in service's
+ # path. A plugin's is checked in that plugin's own tests.
+ self.enterContext(builtin_auth_service())
super().setUp()
self.colleague = make_user("[email protected]")
OrganizationMember.objects.create(
- organization=self.org, user=self.colleague, role="user"
+ organization=self.org, user=self.colleague, role=self.member_role
)
workflow = Workflow.objects.create(
workflow_name="wf", organization=self.org, created_by=self.member
@@ -603,7 +610,7 @@ class AdminOnlyEndpointsMatrixTests(CapabilityTestBase):
view,
"post",
user=user,
- data={"email": "[email protected]", "role": "user"},
+ data={"email": "[email protected]", "role": self.member_role},
)
ok_status = 200
else:
@@ -638,11 +645,15 @@ class MemberManagementGuardrailTests(CapabilityTestBase):
"""With 'Any member', a member manages non-admin members only."""
def setUp(self) -> None:
+ # Role changes go through the identity provider, and under a plugin
+ # they take its role ids, not names: these check the built-in service's
+ # path. A plugin's is checked in that plugin's own tests.
+ self.enterContext(builtin_auth_service())
super().setUp()
self.restrict(Capability.MANAGE_MEMBERS, False)
self.colleague = make_user("[email protected]")
OrganizationMember.objects.create(
- organization=self.org, user=self.colleague, role="user"
+ organization=self.org, user=self.colleague, role=self.member_role
)
self.assign = OrganizationUserViewSet.as_view(
{"post": "assign_organization_role_to_user"}
@@ -654,27 +665,33 @@ class MemberManagementGuardrailTests(CapabilityTestBase):
)
def test_a_member_cannot_grant_admin(self) -> None:
- response = self._assign("[email protected]", "admin")
+ response = self._assign("[email protected]", self.admin_role)
self.assertEqual(response.status_code, 403)
- self.assertEqual(OrganizationMember.objects.get(user=self.colleague).role, "user")
+ self.assertEqual(
+ OrganizationMember.objects.get(user=self.colleague).role, self.member_role
+ )
def test_a_member_cannot_change_their_own_role(self) -> None:
- self.assertEqual(self._assign("[email protected]", "user").status_code, 403)
+ self.assertEqual(
+ self._assign("[email protected]", self.member_role).status_code, 403
+ )
def test_a_member_cannot_change_an_admins_role(self) -> None:
# A second admin, so the last-admin guard is not what refuses it.
second = make_user("[email protected]")
OrganizationMember.objects.create(
- organization=self.org, user=second, role="admin"
+ organization=self.org, user=second, role=self.admin_role
+ )
+ self.assertEqual(self._assign(second.email, self.member_role).status_code, 403)
+ self.assertEqual(
+ OrganizationMember.objects.get(user=second).role, self.admin_role
)
- self.assertEqual(self._assign(second.email, "user").status_code, 403)
- self.assertEqual(OrganizationMember.objects.get(user=second).role, "admin")
def test_a_member_cannot_revoke_admin(self) -> None:
# A second admin, so the last-admin guard is not what refuses it.
second = make_user("[email protected]")
OrganizationMember.objects.create(
- organization=self.org, user=second, role="admin"
+ organization=self.org, user=second, role=self.admin_role
)
view = OrganizationUserViewSet.as_view(
{"delete": "remove_organization_role_from_user"}
@@ -683,10 +700,12 @@ class MemberManagementGuardrailTests(CapabilityTestBase):
view,
"delete",
user=self.member,
- data={"email": second.email, "role": "admin"},
+ data={"email": second.email, "role": self.admin_role},
)
self.assertEqual(response.status_code, 403)
- self.assertEqual(OrganizationMember.objects.get(user=second).role, "admin")
+ self.assertEqual(
+ OrganizationMember.objects.get(user=second).role, self.admin_role
+ )
def test_a_member_cannot_remove_a_role(self) -> None:
# Removing someone's only role removes them, which stays admin-only.
@@ -697,7 +716,7 @@ class MemberManagementGuardrailTests(CapabilityTestBase):
view,
"delete",
user=self.member,
- data={"email": "[email protected]", "role": "user"},
+ data={"email": "[email protected]", "role": self.member_role},
)
self.assertEqual(response.status_code, 403)
self.assertEqual(
@@ -712,9 +731,13 @@ class MemberManagementGuardrailTests(CapabilityTestBase):
for restricted in (True, False):
self.restrict(Capability.MANAGE_MEMBERS, restricted)
with self.subTest(restricted=restricted):
- controller.authorize_invite(admin, ["admin", "user", None])
- controller.authorize_role_change(admin, target, "admin")
- controller.authorize_role_change(admin, target, "user", removing=True)
+ controller.authorize_invite(
+ admin, [self.admin_role, self.member_role, None]
+ )
+ controller.authorize_role_change(admin, target, self.admin_role)
+ controller.authorize_role_change(
+ admin, target, self.member_role, removing=True
+ )
def test_admins_only_refuses_members_removing_roles(self) -> None:
self.restrict(Capability.MANAGE_MEMBERS, True)
@@ -725,7 +748,7 @@ class MemberManagementGuardrailTests(CapabilityTestBase):
view,
"delete",
user=self.member,
- data={"email": "[email protected]", "role": "user"},
+ data={"email": "[email protected]", "role": self.member_role},
)
self.assertEqual(response.status_code, 403)
@@ -736,7 +759,7 @@ class MemberManagementGuardrailTests(CapabilityTestBase):
controller.invite_user(
admin=self.member,
org_id=self.org.organization_id,
- user_list=[{"email": "[email protected]", "role": "admin"}],
+ user_list=[{"email": "[email protected]", "role": self.admin_role}],
request=None,
)
invite.assert_not_called()
@@ -744,9 +767,9 @@ class MemberManagementGuardrailTests(CapabilityTestBase):
def test_a_member_invites_with_the_user_role_only(self) -> None:
controller = AuthenticationController()
actor = OrganizationMember.objects.get(user=self.member)
- controller.authorize_invite(actor, ["user", None])
+ controller.authorize_invite(actor, [self.member_role, None])
with self.assertRaises(Forbidden):
- controller.authorize_invite(actor, ["user", "admin"])
+ controller.authorize_invite(actor, [self.member_role, self.admin_role])
def test_a_plugin_that_names_no_member_roles_refuses_members(self) -> None:
# A plugin that does not define the member-role hooks refuses
@@ -754,21 +777,23 @@ class MemberManagementGuardrailTests(CapabilityTestBase):
controller = AuthenticationController()
controller.auth_service = SimpleNamespace(
is_organization_admin=lambda member: False,
- is_admin_by_role=lambda role: role == "admin",
+ is_admin_by_role=lambda role: role == self.admin_role,
)
actor = OrganizationMember.objects.get(user=self.member)
target = OrganizationMember.objects.get(user=self.colleague)
with self.assertRaises(Forbidden):
- controller.authorize_invite(actor, ["user"])
+ controller.authorize_invite(actor, [self.member_role])
with self.assertRaises(Forbidden):
- controller.authorize_role_change(actor, target, "user")
+ controller.authorize_role_change(actor, target, self.member_role)
def test_admins_only_refuses_members_everything(self) -> None:
self.restrict(Capability.MANAGE_MEMBERS, True)
actor = OrganizationMember.objects.get(user=self.member)
with self.assertRaises(Forbidden):
- AuthenticationController().authorize_invite(actor, ["user"])
- self.assertEqual(self._assign("[email protected]", "user").status_code, 403)
+ AuthenticationController().authorize_invite(actor, [self.member_role])
+ self.assertEqual(
+ self._assign("[email protected]", self.member_role).status_code, 403
+ )
class PlatformApiKeyGuardrailTests(CapabilityTestBase):
@@ -1122,7 +1147,7 @@ class GlobalDeploymentKeyGuardrailTests(CapabilityTestBase):
# the creator check can refuse it.
colleague = make_user("[email protected]")
OrganizationMember.objects.create(
- organization=self.org, user=colleague, role="user"
+ organization=self.org, user=colleague, role=self.member_role
)
self.mine.grant_owner(colleague)
theirs = GlobalApiDeploymentKey.objects.create(
@@ -1165,7 +1190,7 @@ class GlobalDeploymentKeyGuardrailTests(CapabilityTestBase):
key = GlobalApiDeploymentKey.objects.get(pk=response.data["id"])
self.assertFalse(key.created_by_member)
# Demoted, still owning the key's deployment.
- OrganizationMember.objects.filter(user=self.admin).update(role="user")
+ OrganizationMember.objects.filter(user=self.admin).update(role=self.member_role)
demoted = type(self.admin).objects.get(pk=self.admin.pk)
for action, method in (
({"get": "retrieve"}, "get"),
@@ -1215,7 +1240,7 @@ class GlobalDeploymentKeyGuardrailTests(CapabilityTestBase):
def test_a_creator_promoted_to_admin_keeps_their_keys_working(self) -> None:
key = self._member_key()
self.mine.memberships.filter(user=self.member).delete()
- OrganizationMember.objects.filter(user=self.member).update(role="admin")
+ OrganizationMember.objects.filter(user=self.member).update(role=self.admin_role)
key = GlobalApiDeploymentKey.objects.get(pk=key.pk)
self.assertTrue(self._authenticates(key))
diff --git a/backend/utils/tests/auth_seam.py b/backend/utils/tests/auth_seam.py
new file mode 100644
index 000000000..08a6eaf62
--- /dev/null
+++ b/backend/utils/tests/auth_seam.py
@@ -0,0 +1,76 @@
+"""Reach the authentication seam the way production code does.
+
+A distribution can install an auth plugin that replaces the built-in
+``AuthenticationService`` (cloud installs Auth0). The plugin names roles its own
+way and makes its own identity-provider calls. A test that hardcodes the
+built-in behaviour -- a ``role="admin"`` row, a patch on
+``AuthenticationService`` -- passes here and fails under the plugin, or passes
+there without exercising it.
+
+So ask the active service instead of assuming the answer: build membership rows
+with :func:`admin_role` / :func:`member_role`, and stub identity-provider calls
+with :func:`patch_auth_service`. One test then checks the feature under every
+distribution. Only a test whose subject *is* the built-in service pins it, with
+:func:`builtin_auth_service`.
+"""
+
+from typing import Any
+from unittest.mock import patch
+
+from account_v2.authentication_controller import AuthenticationController
+from account_v2.authentication_plugin_registry import AuthenticationPluginRegistry
+from account_v2.enums import UnstractRole, UserRole
+
+
+def active_auth_service() -> Any:
+ """The auth service production code would use: the plugin's, else built-in."""
+ return AuthenticationController().auth_service
+
+
+def admin_role() -> str:
+ """The role name the active auth service treats as organisation admin."""
+ return _role_names()[0]
+
+
+def member_role() -> str:
+ """The role name of an ordinary, non-admin organisation member."""
+ return _role_names()[1]
+
+
+def patch_auth_service(attribute: str, **kwargs: Any) -> Any:
+ """``patch.object`` on the active auth service's class.
+
+ Patches the class, not one instance: ``AuthenticationController`` builds a
+ fresh service per request, and a patch on ``AuthenticationService`` misses
+ when a plugin's class is the one in use. Use it for identity-provider calls
+ (``invite_user``, ``user_organizations``, ...) -- the boundary a unit test
+ should not cross -- and let the role logic run for real.
+ """
+ return patch.object(type(active_auth_service()), attribute, **kwargs)
+
+
+def builtin_auth_service() -> Any:
+ """Run on the built-in ``AuthenticationService`` whatever plugin is installed.
+
+ Under a plugin this turns the plugin off, so the test no longer checks the
+ distribution it runs in. Use it only when the built-in service is the
+ subject, and say why in a comment. In a ``TestCase``:
+ ``self.enterContext(builtin_auth_service())``.
+ """
+ return patch.object(
+ AuthenticationPluginRegistry, "is_plugin_available", return_value=False
+ )
+
+
+def _role_names() -> tuple[str, str]:
+ service = active_auth_service()
+ # The built-in service speaks UserRole; the plugins speak UnstractRole.
+ for roles in (UserRole, UnstractRole):
+ if service.is_admin_by_role(roles.ADMIN) and not service.is_admin_by_role(
+ roles.USER
+ ):
+ return roles.ADMIN.value, roles.USER.value
+ raise AssertionError(
+ f"{type(service).__name__} treats neither {UserRole.ADMIN!r} nor "
+ f"{UnstractRole.ADMIN!r} as admin; teach utils.tests.auth_seam its roles."
+ )
diff --git a/backend/utils/tests/test_auth_seam.py b/backend/utils/tests/test_auth_seam.py
new file mode 100644
index 000000000..3e546d0bf
--- /dev/null
+++ b/backend/utils/tests/test_auth_seam.py
@@ -0,0 +1,22 @@
+"""The seam helpers answer from the active auth service, and say when they cannot."""
+
+from django.test import SimpleTestCase
+
+from utils.tests.auth_seam import (
+ active_auth_service,
+ admin_role,
+ member_role,
+ patch_auth_service,
+)
+
+
+class RoleNameTests(SimpleTestCase):
+ def test_roles_match_the_active_service(self) -> None:
+ service = active_auth_service()
+ self.assertTrue(service.is_admin_by_role(admin_role()))
+ self.assertFalse(service.is_admin_by_role(member_role()))
+
+ def test_unknown_role_vocabulary_fails_loudly(self) -> None:
+ with patch_auth_service("is_admin_by_role", return_value=False):
+ with self.assertRaisesRegex(AssertionError, "teach utils.tests.auth_seam"):
+ admin_role()
diff --git a/tests/README.md b/tests/README.md
index 0d2724e3f..9b6f679dc 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -333,6 +333,27 @@ List what a group would run (no DB required):
cd backend && uv run --group test pytest . -m integration --collect-only -q
```
+### Backend: tests that touch auth or roles
+
+A distribution can install an auth plugin that replaces the built-in
+`AuthenticationService`, and the same backend tests then run under it. Such a
+plugin names roles its own way and makes its own identity-provider calls. A
+test that hardcodes the built-in behaviour passes here and fails there. So ask
+the active service, with the helpers in `backend/utils/tests/auth_seam.py`:
+
+| Instead of | Use |
+|---|---|
+| `role="admin"` / `role="user"` on a membership row | `admin_role()` / `member_role()` |
+| `patch.object(AuthenticationService, "invite_user", ...)` | `patch_auth_service("invite_user", ...)` |
+| patching `is_admin_by_role` or `is_user_organization_admin` | a row with `admin_role()`; let the role check run |
+| patching `AuthenticationPluginRegistry.is_plugin_available` | `builtin_auth_service()`, only when the built-in service is the subject |
+
+`builtin_auth_service()` turns any plugin off, so the test stops checking the
+distribution it runs in. Use it only when the test's subject is the built-in
+service (its session login, or a role change through its identity-provider
+path). Say why in a comment. `backend/tenant_account_v2/test_capabilities.py`
+shows both cases.
+
### Other services / new areas
Outside backend, markers are manual (`workers` enforces `--strict-markers`).