Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix dbusers - Groups and indexed data #1192

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ CHANGELOG
- Chore: Update multidict dependency
[rboixaderg]

- Fix: Update group in standard API
[rboixaderg]

- Fix: Delete indexed_name property in indexes in User and Group interfaces
[rboixaderg]


6.4.4 (2023-11-20)
------------------
Expand Down
6 changes: 3 additions & 3 deletions guillotina/contrib/dbusers/content/groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ class IGroupManager(IFolder):


class IGroup(IFolder, IPrincipal):
index_field("name", index_name="group_name", type="textkeyword")
index_field("name", type="searchabletext")
name = schema.TextLine(title=_("Group name"), required=False)

description = schema.TextLine(title=_("Group Description"), required=False)

index_field("user_roles", index_name="group_user_roles", type="textkeyword")
index_field("user_roles", type="textkeyword")
user_roles = schema.List(title=_("Roles"), value_type=schema.TextLine(), required=False)

index_field("users", index_name="group_users", type="textkeyword")
index_field("users", type="textkeyword")
users = schema.List(title=_("Users"), value_type=schema.TextLine(), required=False, default=[])


Expand Down
4 changes: 2 additions & 2 deletions guillotina/contrib/dbusers/content/users.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ class IUser(IFolder, IPrincipal):

username = schema.TextLine(title=_("Username"), required=False)

index_field("email", index_name="user_email", type="keyword")
index_field("email", type="keyword")
email = schema.TextLine(title=_("Email"), required=False)

index_field("name", index_name="user_name", type="textkeyword")
index_field("name", type="searchabletext")
name = schema.TextLine(title=_("Name"), required=False)

read_permission(password="guillotina.Nobody")
Expand Down
6 changes: 3 additions & 3 deletions guillotina/contrib/dbusers/services/groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ async def process_catalog_obj(self, obj) -> dict:
return {
"@name": obj.get("@name"),
"id": obj.get("id"),
"title": obj.get("group_name"),
"users": obj.get("group_users") or [],
"roles": obj.get("group_user_roles") or [],
"title": obj.get("name"),
"users": obj.get("users") or [],
"roles": obj.get("user_roles") or [],
}


Expand Down
4 changes: 2 additions & 2 deletions guillotina/contrib/dbusers/services/users.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ async def process_catalog_obj(self, obj) -> dict:
return {
"@name": obj.get("@name"),
"id": obj.get("id"),
"fullname": obj.get("user_name"),
"email": obj.get("user_email"),
"fullname": obj.get("name"),
"email": obj.get("email"),
"roles": obj.get("user_roles") or [],
}
25 changes: 17 additions & 8 deletions guillotina/contrib/dbusers/subscribers.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,17 +64,26 @@ async def on_group_removed(group: Group, event: ObjectAddedEvent) -> None:
@configure.subscriber(for_=(IGroup, IBeforeObjectModifiedEvent))
async def on_group_modified(group: Group, event: BeforeObjectModifiedEvent) -> None:
# keep group.users updated with changes from users
old_users = group.users or []
users_added = set() - set(old_users)
users_removed = set(old_users) - set()
users_added = []
users_removed = []
changes = event.payload.get("users", None)
if changes is None:
return
for user, is_new in changes.items():
if is_new:
users_added.add(user)
else:
users_removed.add(user)

if isinstance(changes, list):
for user in changes:
if user not in group.users:
users_added.append(user)

for user in group.users:
if user not in changes:
users_removed.append(user)
else:
for user, is_new in changes.items():
if is_new and user not in group.users:
users_added.append(user)
elif not is_new:
users_removed.append(user)
await _update_users(group.id, users_added, users_removed)


Expand Down
2 changes: 1 addition & 1 deletion guillotina/contrib/dbusers/users.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ async def get_user(self, token: typing.Dict) -> typing.Optional[IPrincipal]:
json->>'type_name' = 'User'
AND parent_id != 'DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD'
AND json->>'container_id' = $1::varchar
AND lower(json->>'user_email') = lower($2::varchar)
AND lower(json->>'email') = lower($2::varchar)
"""
async with txn.lock:
row = await conn.fetchrow(sql, container.id, token.get("id"))
Expand Down
9 changes: 9 additions & 0 deletions guillotina/tests/dbusers/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@
"password": "password",
}

second_user_data = {
"@type": "User",
"name": "Second user name",
"id": "foobar_2",
"username": "foobar_2",
"email": "[email protected]",
"password": "password",
}

user_data_id_email = {
"@type": "User",
"name": "Foobar",
Expand Down
104 changes: 102 additions & 2 deletions guillotina/tests/dbusers/test_manage_groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,13 @@ async def user_data():
return settings.user_data.copy()


@pytest.fixture()
async def second_user_data():
return settings.second_user_data.copy()


@pytest.mark.app_settings(settings.DEFAULT_SETTINGS)
async def test_ensure_crud_groups(dbusers_requester, user_data):
async def test_ensure_crud_groups(dbusers_requester, user_data, second_user_data):
async with dbusers_requester as requester:
resp, status_code = await requester("POST", "/db/guillotina/groups", data=json.dumps(_group))
assert status_code == 201
Expand All @@ -43,6 +48,7 @@ async def test_ensure_crud_groups(dbusers_requester, user_data):
# create the user
resp, status_code = await requester("GET", "/db/guillotina/users")
resp, status_code = await requester("POST", "/db/guillotina/users", data=json.dumps(user_data))
resp, status_code = await requester("POST", "/db/guillotina/users", data=json.dumps(second_user_data))

data = {"users": {"foobar": True}}
resp, status = await requester("PATCH", "/db/guillotina/@groups/foo", data=json.dumps(data))
Expand All @@ -60,20 +66,114 @@ async def test_ensure_crud_groups(dbusers_requester, user_data):

resp, status = await requester("GET", "/db/guillotina/users/foobar")
assert resp["user_groups"] == ["foo"]
data = {"users": {"foobar": False}}

data = {"users": {"foobar": True}}
resp, status = await requester("PATCH", "/db/guillotina/@groups/foo", data=json.dumps(data))
assert status == 204

resp, status = await requester("GET", "/db/guillotina/users/foobar")
assert resp["user_groups"] == ["foo"]

data = {"users": {"foobar": False, "foobar_2": True}}
resp, status = await requester("PATCH", "/db/guillotina/@groups/foo", data=json.dumps(data))
assert status == 204
resp, status = await requester("GET", "/db/guillotina/@groups/foo")
assert len(resp["users"]["items"]) == 1
resp, status = await requester("GET", "/db/guillotina/users/foobar")
assert resp["user_groups"] == []
resp, status = await requester("GET", "/db/guillotina/users/foobar_2")
assert resp["user_groups"] == ["foo"]

data = {"users": {"foobar": False, "foobar_2": False}}
resp, status = await requester("PATCH", "/db/guillotina/@groups/foo", data=json.dumps(data))
assert status == 204
resp, status = await requester("GET", "/db/guillotina/@groups/foo")
assert len(resp["users"]["items"]) == 0
resp, status = await requester("GET", "/db/guillotina/users/foobar")
assert resp["user_groups"] == []
resp, status = await requester("GET", "/db/guillotina/users/foobar_2")
assert resp["user_groups"] == []

# ensure we cannot patch invalid users
data = {"users": {"foobarx": True}}
resp, status = await requester("PATCH", "/db/guillotina/@groups/foo", data=json.dumps(data))
assert status == 412


@pytest.mark.app_settings(settings.DEFAULT_SETTINGS)
async def test_ensure_crud_groups_using_standard_api(dbusers_requester, user_data, second_user_data):
async with dbusers_requester as requester:
resp, status_code = await requester("POST", "/db/guillotina/groups", data=json.dumps(_group))
assert status_code == 201

data = {"user_roles": ["guillotina.Manager", "guillotina.Tester"]}

resp, status = await requester("PATCH", "/db/guillotina/groups/foo", data=json.dumps(data))
assert status == 204
resp, status = await requester("GET", "/db/guillotina/groups/foo")
assert set(resp["user_roles"]) == set(["guillotina.Manager", "guillotina.Tester"])

data = {"user_roles": ["guillotina.Tester"]}
resp, status = await requester("PATCH", "/db/guillotina/groups/foo", data=json.dumps(data))
assert status == 204
resp, status = await requester("GET", "/db/guillotina/groups/foo")
assert set(resp["user_roles"]) == set(["guillotina.Tester"])

# create the user
resp, status_code = await requester("GET", "/db/guillotina/users")
resp, status_code = await requester("POST", "/db/guillotina/users", data=json.dumps(user_data))
resp, status_code = await requester("POST", "/db/guillotina/users", data=json.dumps(second_user_data))

data = {"users": ["foobar"]}
resp, status = await requester("PATCH", "/db/guillotina/groups/foo", data=json.dumps(data))
assert status == 204
resp, status = await requester("GET", "/db/guillotina/groups/foo")
assert resp["users"] == ["foobar"]

# fix bug https://github.com/plone/guillotina/issues/1069
resp, status = await requester(
"PATCH", "/db/guillotina/groups/foo", data=json.dumps({"user_roles": ["guillotina.Reader"]})
)
assert status == 204
resp, status = await requester("GET", "/db/guillotina/groups/foo")
assert resp["users"] == ["foobar"]

resp, status = await requester("GET", "/db/guillotina/users/foobar")
assert resp["user_groups"] == ["foo"]

data = {"users": ["foobar"]}
resp, status = await requester("PATCH", "/db/guillotina/groups/foo", data=json.dumps(data))
assert status == 204

resp, status = await requester("GET", "/db/guillotina/users/foobar")
assert resp["user_groups"] == ["foo"]

data = {"users": ["foobar_2"]}
resp, status = await requester("PATCH", "/db/guillotina/groups/foo", data=json.dumps(data))
assert status == 204
resp, status = await requester("GET", "/db/guillotina/groups/foo")
assert len(resp["users"]) == 1
resp, status = await requester("GET", "/db/guillotina/users/foobar")
assert resp["user_groups"] == []
resp, status = await requester("GET", "/db/guillotina/users/foobar_2")
assert resp["user_groups"] == ["foo"]

data = {"users": []}
resp, status = await requester("PATCH", "/db/guillotina/groups/foo", data=json.dumps(data))
assert status == 204
resp, status = await requester("GET", "/db/guillotina/groups/foo")
assert len(resp["users"]) == 0
resp, status = await requester("GET", "/db/guillotina/users/foobar")
assert resp["user_groups"] == []
resp, status = await requester("GET", "/db/guillotina/users/foobar_2")
assert resp["user_groups"] == []

# ensure we cannot patch invalid users
data = {"users": {"foobarx": True}}
resp, status = await requester("PATCH", "/db/guillotina/groups/foo", data=json.dumps(data))
assert status == 412


settings_with_catalog = copy.deepcopy(settings.DEFAULT_SETTINGS)
settings_with_catalog["applications"].append("guillotina.contrib.catalog.pg")
settings_with_catalog.setdefault("load_utilities", {}) # type: ignore
Expand Down
83 changes: 83 additions & 0 deletions guillotina/tests/dbusers/test_search.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
from . import settings

import copy
import json
import os
import pytest


pytestmark = pytest.mark.asyncio

NOT_POSTGRES = os.environ.get("DATABASE", "DUMMY") in ("cockroachdb", "DUMMY")
PG_CATALOG_SETTINGS = copy.deepcopy(settings.DEFAULT_SETTINGS)
PG_CATALOG_SETTINGS["applications"].append("guillotina.contrib.catalog.pg")
PG_CATALOG_SETTINGS.setdefault("load_utilities", {}) # type: ignore
PG_CATALOG_SETTINGS["load_utilities"]["catalog"] = { # type: ignore
"provides": "guillotina.interfaces.ICatalogUtility",
"factory": "guillotina.contrib.catalog.pg.utility.PGSearchUtility",
}


@pytest.mark.app_settings(PG_CATALOG_SETTINGS)
@pytest.mark.skipif(NOT_POSTGRES, reason="Only PG")
async def test_search_user(dbusers_requester):
async with dbusers_requester as requester:
# Create a user
_, status_code = await requester("POST", "/db/guillotina/users", data=json.dumps(settings.user_data))
assert status_code == 201

_, status_code = await requester(
"POST", "/db/guillotina/users", data=json.dumps(settings.second_user_data)
)
assert status_code == 201

resp, status_code = await requester("GET", "/db/guillotina/@search?type_name=User")
assert status_code == 200
assert resp["items_total"] == 2
assert "name" in resp["items"][0]
assert "email" in resp["items"][0]

resp, status_code = await requester("GET", "/db/guillotina/@search?type_name=User&name=user")
assert status_code == 200
assert resp["items_total"] == 1

resp, status_code = await requester("GET", "/db/guillotina/@search?type_name=User&name=foobar")
assert status_code == 200
assert resp["items_total"] == 1

resp, status_code = await requester("GET", "/db/guillotina/@search?type_name=User&name=unknownname")
assert status_code == 200
assert resp["items_total"] == 0

resp, status_code = await requester("GET", "/db/guillotina/@search?type_name=User&[email protected]")
assert status_code == 200
assert resp["items_total"] == 1

resp, status_code = await requester(
"GET", "/db/guillotina/@search?type_name=User&[email protected]"
)
assert status_code == 200
assert resp["items_total"] == 0


@pytest.mark.app_settings(PG_CATALOG_SETTINGS)
@pytest.mark.skipif(NOT_POSTGRES, reason="Only PG")
async def test_search_groups(dbusers_requester):
async with dbusers_requester as requester:
_, status_code = await requester(
"POST", "/db/guillotina/groups", data=json.dumps(settings.group_data)
)
assert status_code == 201

resp, status_code = await requester("GET", "/db/guillotina/@search?type_name=Group")
assert status_code == 200
assert resp["items_total"] == 1
assert "name" in resp["items"][0]

resp, status_code = await requester("GET", "/db/guillotina/@search?type_name=Group&name=foobar")
assert status_code == 200
assert resp["items_total"] == 1

resp, status_code = await requester("GET", "/db/guillotina/@search?type_name=Group&name=unknownname")
assert status_code == 200
assert resp["items_total"] == 0