scim2-server 0.8.0__tar.gz → 0.8.2__tar.gz

{scim2_server-0.8.0 → scim2_server-0.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scim2-server
-Version: 0.8.0
+Version: 0.8.2
 Summary: SCIM server core for any storage and web framework
 Keywords: scim,scim2,provisioning,rfc7643,rfc7644
 Author: Yaal Coop, Christian Friedrich Coors
@@ -212,6 +212,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Environment :: Web Environment
@@ -229,6 +230,8 @@ Provides-Extra: precis
 Provides-Extra: testing
 Description-Content-Type: text/markdown
 
+<img alt="python-scim logo" src="https://raw.githubusercontent.com/python-scim/.github/refs/heads/main/python-scim.svg" height="72" align="right">
+
 # scim2-server
 
 A Python library that serves the SCIM protocol over any storage, built upon

{scim2_server-0.8.0 → scim2_server-0.8.2}/README.md

@@ -1,3 +1,5 @@
+<img alt="python-scim logo" src="https://raw.githubusercontent.com/python-scim/.github/refs/heads/main/python-scim.svg" height="72" align="right">
+
 # scim2-server
 
 A Python library that serves the SCIM protocol over any storage, built upon

{scim2_server-0.8.0 → scim2_server-0.8.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "scim2-server"
-version = "0.8.0"
+version = "0.8.2"
 description = "SCIM server core for any storage and web framework"
 readme = "README.md"
 keywords = [
@@ -21,6 +21,7 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
     "Programming Language :: Python :: Implementation :: CPython",
     "License :: OSI Approved :: Apache Software License",
     "Environment :: Web Environment",
@@ -79,6 +80,7 @@ doc = [
 ]
 
 [tool.uv]
+required-version = ">=0.12.13"
 exclude-newer = "14 days"
 
 [tool.uv.exclude-newer-package]
@@ -166,6 +168,7 @@ env_list = [
     "py312",
     "py313",
     "py314",
+    "py315",
     "minversions",
     "doc",
     "coverage",
@@ -196,6 +199,10 @@ uv_resolution = "lowest-direct"
 
 [tool.tox.env.doc]
 dependency_groups = ["doc"]
+extras = [
+    "cursor",
+    "testing",
+]
 commands = [[
     "sphinx-build",
     "-W",

{scim2_server-0.8.0 → scim2_server-0.8.2}/pyproject.toml.orig

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "scim2-server"
-version = "0.8.0"
+version = "0.8.2"
 description = "SCIM server core for any storage and web framework"
 authors = [
     {name="Yaal Coop", email="contact@yaal.coop"},
@@ -20,6 +20,7 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
     "Programming Language :: Python :: Implementation :: CPython",
     "License :: OSI Approved :: Apache Software License",
     "Environment :: Web Environment",
@@ -76,6 +77,7 @@ doc = [
 ]
 
 [tool.uv]
+required-version = ">=0.12.13"
 exclude-newer = "14 days"
 exclude-newer-package = { scim2-models = false, scim2-client = false, scim2-server = false, scim2-cli = false, scim2-tester = false, pytest-scim2-server = false }
 
@@ -155,6 +157,7 @@ env_list = [
     "py312",
     "py313",
     "py314",
+    "py315",
     "minversions",
     "doc",
     "coverage",
@@ -179,6 +182,7 @@ uv_resolution = "lowest-direct"
 
 [tool.tox.env.doc]
 dependency_groups = ["doc"]
+extras = ["cursor", "testing"]
 commands = [
     ["sphinx-build", "-W", "--keep-going", "--builder", "html", "doc", "build/sphinx/html"],
 ]

{scim2_server-0.8.0 → scim2_server-0.8.2}/scim2_server/testing.py

@@ -29,12 +29,16 @@ from typing import Union
 from typing import cast
 
 import pytest
+from pydantic import ValidationError
 from scim2_models import Context
+from scim2_models import InvalidFilterException
+from scim2_models import InvalidPathException
 from scim2_models import NotFoundException
 from scim2_models import PreconditionFailedException
 from scim2_models import Resource
 from scim2_models import ResourceType
 from scim2_models import ResponseParameters
+from scim2_models import ScimFilter
 from scim2_models import ScimProvider
 from scim2_models import SearchRequest
 from scim2_models import UniquenessException
@@ -50,6 +54,100 @@ from scim2_server.utils import parametrize
 
 T = TypeVar("T")
 
+ENTERPRISE = "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
+
+SEARCH_USERS: list[dict[str, Any]] = [
+    {
+        "userName": "alice",
+        "displayName": "Alice",
+        "title": "Boss",
+        "name": {"givenName": "Alice", "familyName": "Liddell"},
+        "active": True,
+        "emails": [
+            {"value": "alice@home.example", "type": "home"},
+            {"value": "alice@work.example", "type": "work", "primary": True},
+        ],
+        ENTERPRISE: {"employeeNumber": "100"},
+    },
+    {
+        "userName": "Bob",
+        "active": False,
+        "emails": [{"value": "bob@work.example", "type": "work"}],
+    },
+    {
+        "userName": "carol",
+        "title": "",
+        "name": {"familyName": "smith"},
+        ENTERPRISE: {"employeeNumber": "2"},
+    },
+    {
+        "userName": "dave_%",
+        "title": "50% off",
+        "emails": [{"value": "dave@home.example"}],
+    },
+]
+"""The users the filter and sort tests search, with the case, missing values and
+``LIKE`` wildcards a translation into a query tends to get wrong."""
+
+SEARCH_FILTERS = [
+    'userName eq "ALICE"',
+    'userName ne "alice"',
+    'userName sw "dave_"',
+    'userName ew "_%"',
+    'userName co "a"',
+    'userName gt "b"',
+    'userName le "carol"',
+    'title eq "boss"',
+    'title ne "Boss"',
+    'not (title eq "Boss")',
+    "title eq null",
+    "title ne null",
+    "title gt null",
+    "title pr",
+    'title co "%"',
+    'title lt "c"',
+    "displayName pr",
+    "name pr",
+    "name.givenName pr",
+    'name.familyName eq "SMITH"',
+    "active eq true",
+    "active eq false",
+    "not (active eq true)",
+    "active ne true",
+    'meta.created co "20"',
+    "active pr",
+    "emails pr",
+    'emails eq "alice@work.example"',
+    'emails ne "alice@work.example"',
+    'emails co "WORK"',
+    'emails.type eq "work"',
+    "emails.type pr",
+    "emails.primary eq true",
+    'emails[type eq "work" and value co "alice"]',
+    'emails[type eq "home" and primary eq true]',
+    'emails[value ne "alice@work.example"]',
+    'emails[not (type eq "work")]',
+    "emails[type pr]",
+    'meta.created gt "2000-01-01T00:00:00Z"',
+    'meta.lastModified lt "2000-01-01T00:00:00Z"',
+    f'{ENTERPRISE}:employeeNumber eq "100"',
+    f'{ENTERPRISE}:employeeNumber gt "10"',
+    'title eq "Boss" or userName eq "Bob"',
+    'title eq "Boss" and active eq false',
+]
+
+SEARCH_SORTS = [
+    "userName",
+    "title",
+    "displayName",
+    "name.familyName",
+    "active",
+    "emails",
+    "emails.type",
+    "meta.created",
+    f"{ENTERPRISE}:employeeNumber",
+]
+
 
 class ScimStorageContract:
     """The rules every :class:`~scim2_server.storage.ScimStorage` follows.
@@ -135,6 +233,18 @@ class ScimStorageContract:
             for user_name in user_names
         ]
 
+    def create_group(
+        self,
+        storage: ScimStorage,
+        group_type: ResourceType,
+        group_model: Any,
+        member: Any,
+    ) -> Any:
+        return storage.create(
+            group_type,
+            group_model(display_name="admins", members=[{"value": member.id}]),
+        )
+
     def test_create_fills_the_identifier_and_the_meta(
         self, storage: Any, user_type: ResourceType, user_model: Any
     ) -> None:
@@ -400,8 +510,8 @@ class ScimStorageContract:
         group_model: Any,
     ) -> None:
         """A search on a resource type returns its resources only, and counts them."""
-        self.create_users(storage, user_type, user_model, "alice", "bob")
-        storage.create(group_type, group_model(display_name="admins"))
+        users = self.create_users(storage, user_type, user_model, "alice", "bob")
+        self.create_group(storage, group_type, group_model, users[0])
 
         page = self.search(storage, [user_type], self.search_request([user_model]))
 
@@ -497,8 +607,8 @@ class ScimStorageContract:
     ) -> None:
         """A search on several resource types returns their resources as one collection."""
         self.require(self.supports_root_search, "searching at the root")
-        self.create_users(storage, user_type, user_model, "alice")
-        storage.create(group_type, group_model(display_name="admins"))
+        (user,) = self.create_users(storage, user_type, user_model, "alice")
+        self.create_group(storage, group_type, group_model, user)
 
         page = self.search(
             storage,
@@ -524,8 +634,8 @@ class ScimStorageContract:
         """An attribute a resource type does not declare matches none of its resources."""
         self.require(self.supports_root_search, "searching at the root")
         self.require(self.announces(provider, "filter"), "filtering")
-        self.create_users(storage, user_type, user_model, "alice")
-        storage.create(group_type, group_model(display_name="admins"))
+        (user,) = self.create_users(storage, user_type, user_model, "alice")
+        self.create_group(storage, group_type, group_model, user)
 
         page = self.search(
             storage,
@@ -536,6 +646,94 @@ class ScimStorageContract:
         assert page.total == 1
         assert page.resources[0].user_name == "alice"
 
+    def search_users(self) -> list[dict[str, Any]]:
+        """Return the users the filter and sort tests search.
+
+        Override it to leave out the attributes the storage does not store.
+        """
+        return SEARCH_USERS
+
+    def search_request_or_skip(
+        self, models: list[type[Resource[Any]]], **parameters: Any
+    ) -> SearchRequest[Any]:
+        """Build a search request, and skip the current test when the models do not declare an attribute of the filter or the sort."""
+        try:
+            return self.search_request(models, **parameters)
+        except ValidationError as exception:
+            errors = exception.errors()
+            if any(
+                error["type"] not in ("scim_invalidFilter", "scim_invalidPath")
+                for error in errors
+            ):
+                raise
+            pytest.skip(f"The models refuse the search: {errors[0]['msg']}")
+
+    def search_or_skip(
+        self,
+        storage: Any,
+        resource_types: list[ResourceType],
+        search_request: SearchRequest[Any],
+    ) -> Any:
+        """Search a storage, and skip the current test when the storage refuses the filter or the sort."""
+        try:
+            return self.search(storage, resource_types, search_request)
+        except (InvalidFilterException, InvalidPathException) as exception:
+            pytest.skip(f"The storage refuses the search: {exception.detail}")
+
+    @pytest.mark.parametrize("scim_filter", SEARCH_FILTERS)
+    def test_search_filters_as_the_filter_evaluator(
+        self,
+        storage: Any,
+        provider: ScimProvider,
+        user_type: ResourceType,
+        user_model: Any,
+        scim_filter: str,
+    ) -> None:
+        """A filter keeps the resources that ScimFilter.match keeps, and the total counts them."""
+        self.require(self.announces(provider, "filter"), "filtering")
+        for user in self.search_users():
+            storage.create(user_type, user_model.model_validate(user))
+        stored = self.search(storage, [user_type], self.search_request([user_model]))
+        search_request = self.search_request_or_skip([user_model], filter=scim_filter)
+
+        page = self.search_or_skip(storage, [user_type], search_request)
+
+        evaluator = cast(ScimFilter[Any], search_request.filter)
+        expected = [r.id for r in stored.resources if evaluator.match(r)]
+        assert page.total == len(expected)
+        assert sorted(r.id for r in page.resources) == sorted(expected)
+
+    @pytest.mark.parametrize("sort_order", ["ascending", "descending"])
+    @pytest.mark.parametrize("sort_by", SEARCH_SORTS)
+    def test_search_sorts_as_search_request_sort(
+        self,
+        storage: Any,
+        provider: ScimProvider,
+        user_type: ResourceType,
+        user_model: Any,
+        sort_by: str,
+        sort_order: str,
+    ) -> None:
+        """A sorted search orders the resources as SearchRequest.sort does.
+
+        Resources with the same sort value may come in any order.
+        """
+        self.require(self.announces(provider, "sort"), "sorting")
+        for user in self.search_users():
+            storage.create(user_type, user_model.model_validate(user))
+        stored = self.search(storage, [user_type], self.search_request([user_model]))
+        search_request = self.search_request_or_skip(
+            [user_model], sort_by=sort_by, sort_order=sort_order
+        )
+
+        page = self.search_or_skip(storage, [user_type], search_request)
+
+        expected = search_request.sort(stored.resources)
+        assert sorted(r.id for r in page.resources) == sorted(r.id for r in expected)
+        assert [search_request.sort_value(r) for r in page.resources] == [
+            search_request.sort_value(r) for r in expected
+        ]
+
     def walk(
         self,
         storage: Any,
@@ -573,6 +771,7 @@ class ScimStorageContract:
         self, storage: Any, user_type: ResourceType, user_model: Any
     ) -> None:
         """Following the next cursors returns every resource once, count by count."""
+        self.require(storage.supports_cursors, "cursor pagination")
         names = ["alice", "bob", "carol", "dave", "erin"]
         self.create_users(storage, user_type, user_model, *names)
 
@@ -593,6 +792,7 @@ class ScimStorageContract:
         user_model: Any,
     ) -> None:
         """The pages of a sorted search follow each other in the sort order."""
+        self.require(storage.supports_cursors, "cursor pagination")
         self.require(self.announces(provider, "sort"), "sorting")
         self.create_users(
             storage, user_type, user_model, "dave", "alice", "carol", "bob"
@@ -625,7 +825,9 @@ class ScimStorageContract:
         user_model: Any,
     ) -> None:
         """Resources with the same sort value, or without one, are returned once, even across pages."""
+        self.require(storage.supports_cursors, "cursor pagination")
         self.require(self.announces(provider, "sort"), "sorting")
+        self.require("nick_name" in user_model.model_fields, "nickName")
         for user_name, nick_name in [
             ("alice", "twin"),
             ("bob", None),
@@ -651,6 +853,7 @@ class ScimStorageContract:
         self, storage: Any, user_type: ResourceType, user_model: Any
     ) -> None:
         """Following the previous cursors from the last page returns the same pages, back to the first."""
+        self.require(storage.supports_cursors, "cursor pagination")
         self.create_users(
             storage, user_type, user_model, "alice", "bob", "carol", "dave", "erin"
         )
@@ -669,6 +872,7 @@ class ScimStorageContract:
         self, storage: Any, user_type: ResourceType, user_model: Any, deleted: str
     ) -> None:
         """Deleting a resource already returned does not skip nor repeat the next ones."""
+        self.require(storage.supports_cursors, "cursor pagination")
         self.create_users(
             storage, user_type, user_model, "alice", "bob", "carol", "dave", "erin"
         )
@@ -690,6 +894,7 @@ class ScimStorageContract:
         self, storage: Any, user_type: ResourceType, user_model: Any
     ) -> None:
         """Creating a resource between two pages does not skip nor repeat the existing ones."""
+        self.require(storage.supports_cursors, "cursor pagination")
         self.create_users(
             storage, user_type, user_model, "alice", "bob", "carol", "dave", "erin"
         )
@@ -711,6 +916,7 @@ class ScimStorageContract:
         self, storage: Any, user_type: ResourceType, user_model: Any
     ) -> None:
         """Deleting the first resource of a page does not change the page before it."""
+        self.require(storage.supports_cursors, "cursor pagination")
         self.create_users(
             storage, user_type, user_model, "alice", "bob", "carol", "dave", "erin"
         )
@@ -750,9 +956,10 @@ class ScimStorageContract:
         group_model: Any,
     ) -> None:
         """A cursor pages the resources of several resource types as one collection."""
+        self.require(storage.supports_cursors, "cursor pagination")
         self.require(self.supports_root_search, "searching at the root")
         users = self.create_users(storage, user_type, user_model, "alice", "bob")
-        group = storage.create(group_type, group_model(display_name="admins"))
+        group = self.create_group(storage, group_type, group_model, users[0])
 
         pages = self.walk(
             storage,