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

825 add toggle to add/remove current site to/from element sites #875

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
4e64e34
Update version
jochenklar Dec 12, 2023
e734196
tests: add example users to core test_views
MyPyDavid Dec 14, 2023
fb5304e
chore: add new CanToggleElementCurrentSite permission class and rules
MyPyDavid Dec 14, 2023
8ff469b
chore: add ElementToggleCurrentSiteViewSetMixin class
MyPyDavid Dec 14, 2023
64f1fec
feat: #825 add toggle button for element.sites endpoints components a…
MyPyDavid Dec 14, 2023
0c01099
chore: refactor ElementToggleCurrentSiteViewSetMixin into ViewSet act…
MyPyDavid Feb 12, 2024
59ff5fa
chore: refactor endpoint to toggle-site
MyPyDavid Feb 12, 2024
55b8912
js: refactor toggle site put call in MultiSiteApi and storeElement el…
MyPyDavid Feb 12, 2024
4b0db2e
js: fix show/hide for ToggleCurrentSiteLink
MyPyDavid Feb 12, 2024
e4d525c
js: include toggleCurrentSite action in element components
MyPyDavid Feb 12, 2024
bf61f0b
js: remove console.log
MyPyDavid Feb 12, 2024
b55935c
chore: rename rule to toggle_site, remove is_element_editor and use s…
MyPyDavid Feb 12, 2024
2860398
chore: refactor storeElement signature
MyPyDavid May 15, 2024
25ed018
chore: add action to methods in Api classes and remove MultiSiteApi
MyPyDavid May 15, 2024
00d2218
chore: update element components with signature for storeElements and…
MyPyDavid May 15, 2024
9d38aa5
chore: rename to hasCurrentSite
MyPyDavid May 15, 2024
3f8a311
chore: add element-button class to ReadOnlyIcon for margin-left
MyPyDavid May 15, 2024
5998074
chore: only return super in CanToggleElementCurrentSite.has_permission
MyPyDavid May 15, 2024
4474043
chore: remove unused logger from management/rules
MyPyDavid May 15, 2024
c56f53b
chore: update signature for storeElement in edit components
MyPyDavid May 15, 2024
8757d2c
chore: update signature for storeElement to use default parameters
MyPyDavid May 16, 2024
c8855b9
chore: update signature for storeElement in EditQuestionSet
MyPyDavid May 16, 2024
995a968
js: update ToggleCurrentSiteLink icon and move placement of icon in e…
MyPyDavid May 21, 2024
f0cab0f
js revert: remove elementAction arg from storeElementInit
MyPyDavid May 21, 2024
aa387f9
tests: refactor core multisite test helpers into constants and utils
MyPyDavid May 21, 2024
54c7bad
tests: add locked parameter to update ultisite toggle tests
MyPyDavid May 22, 2024
9235c01
js: remove locked parameter from ToggleCurrentSiteLink component and …
MyPyDavid May 22, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion rdmo/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "2.1.2.dev1"
__version__ = "2.2.0.dev1"
7 changes: 4 additions & 3 deletions rdmo/conditions/tests/test_viewset_condition_multisite.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@

from django.urls import reverse

from ...core.tests import get_obj_perms_status_code
from ...core.tests import multisite_status_map as status_map
from ...core.tests import multisite_users as users
from rdmo.core.tests.constants import multisite_status_map as status_map
from rdmo.core.tests.constants import multisite_users as users
from rdmo.core.tests.utils import get_obj_perms_status_code

from ..models import Condition
from .test_viewset_condition import export_formats, urlnames

Expand Down
11 changes: 11 additions & 0 deletions rdmo/core/permissions.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,14 @@ def has_permission(self, request, view):
return True
else:
return False


class CanToggleElementCurrentSite(DjangoModelPermissions):

perms_map = {
'PUT': ['%(app_label)s.change_%(model_name)s_toggle_site'],
}

@log_result
def has_permission(self, request, view):
return super().has_permission(request, view)
148 changes: 0 additions & 148 deletions rdmo/core/tests/__init__.py
Original file line number Diff line number Diff line change
@@ -1,148 +0,0 @@

from rdmo.core.models import Model

multisite_users = (
('user', 'user'),
('reviewer', 'reviewer'),
('editor', 'editor'),
('example-reviewer', 'example-reviewer'),
('example-editor', 'example-editor'),
('foo-user', 'foo-user'),
('foo-reviewer', 'foo-reviewer'),
('foo-editor', 'foo-editor'),
('bar-user', 'bar-user'),
('bar-reviewer', 'bar-reviewer'),
('bar-editor', 'bar-editor'),
('anonymous', None),
)


multisite_status_map = {
'list': {
'foo-user': 403, 'foo-reviewer': 200, 'foo-editor': 200,
'bar-user': 403, 'bar-reviewer': 200, 'bar-editor': 200,
'user': 403, 'example-reviewer': 200, 'example-editor': 200,
'anonymous': 401, 'reviewer': 200, 'editor': 200,
},
'detail': {
'foo-user': 404, 'foo-reviewer': 200, 'foo-editor': 200,
'bar-user': 404, 'bar-reviewer': 200, 'bar-editor': 200,
'user': 404, 'example-reviewer': 200, 'example-editor': 200,
'anonymous': 401, 'reviewer': 200, 'editor': 200,
},
'nested': {
'foo-user': 404, 'foo-reviewer': 200, 'foo-editor': 200,
'bar-user': 404, 'bar-reviewer': 200, 'bar-editor': 200,
'user': 404, 'example-reviewer': 200, 'example-editor': 200,
'anonymous': 401, 'reviewer': 200, 'editor': 200,
},
'create': {
'foo-user': 403, 'foo-reviewer': 403, 'foo-editor': 201,
'bar-user': 403, 'bar-reviewer': 403, 'bar-editor': 201,
'user': 403, 'example-reviewer': 403, 'example-editor': 201,
'anonymous': 401, 'reviewer': 403, 'editor': 201,
},
'copy': {
'foo-user': 404, 'foo-reviewer': 403, 'foo-editor': 201,
'bar-user': 404, 'bar-reviewer': 403, 'bar-editor': 201,
'user': 404, 'example-reviewer': 403, 'example-editor': 201,
'anonymous': 401, 'reviewer': 403, 'editor': 201,
},
'update': {
'foo-user': 404, 'foo-reviewer': 403, 'foo-editor': 200,
'bar-user': 404, 'bar-reviewer': 403, 'bar-editor': 200,
'user': 404, 'example-reviewer': 403, 'example-editor': 200,
'anonymous': 401, 'reviewer': 403, 'editor': 200,
},
'delete': {
'foo-user': 404, 'foo-reviewer': 403, 'foo-editor': 204,
'bar-user': 404, 'bar-reviewer': 403, 'bar-editor': 204,
'user': 404, 'example-reviewer': 403, 'example-editor': 204,
'anonymous': 401, 'reviewer': 403, 'editor': 204,
}
}


status_map_object_permissions = {
'copy': {
'all-element': {
'foo-reviewer': 403, 'foo-editor': 201,
'bar-reviewer': 403, 'bar-editor': 201,
'example-reviewer': 403, 'example-editor': 201,
},
'foo-element': {
'foo-reviewer': 403, 'foo-editor': 201,
'bar-reviewer': 404, 'bar-editor': 404,
'example-reviewer': 404, 'example-editor': 404,
},
'bar-element': {
'foo-reviewer': 404, 'foo-editor': 404,
'bar-reviewer': 403, 'bar-editor': 201,
'example-reviewer': 404, 'example-editor': 404,
}
},
'update': {
'all-element': {
'foo-reviewer': 403, 'foo-editor': 200,
'bar-reviewer': 403, 'bar-editor': 200,
'example-reviewer': 403, 'example-editor': 200,
},
'foo-element': {
'foo-reviewer': 403, 'foo-editor': 200,
'bar-reviewer': 404, 'bar-editor': 404,
'example-reviewer': 404, 'example-editor': 404,
},
'bar-element': {
'foo-reviewer': 404, 'foo-editor': 404,
'bar-reviewer': 403, 'bar-editor': 200,
'example-reviewer': 404, 'example-editor': 404,
}
},
'delete': {
'all-element': {
'foo-reviewer': 403, 'foo-editor': 204,
'bar-reviewer': 403, 'bar-editor': 204,
'example-reviewer': 403, 'example-editor': 204,
},
'foo-element': {
'foo-reviewer': 403, 'foo-editor': 204,
'bar-reviewer': 404, 'bar-editor': 404,
'example-reviewer': 404, 'example-editor': 404,
},
'bar-element': {
'foo-reviewer': 404, 'foo-editor': 404,
'bar-reviewer': 403, 'bar-editor': 204,
'example-reviewer': 404, 'example-editor': 404,
}
},
}


def get_obj_perms_status_code(instance, username, method):
''' looks for the object permissions of the instance and returns the status code '''

if isinstance(instance, Model):
try:
if not instance.editors.exists():
return multisite_status_map[method][username]
except AttributeError as e:
raise AttributeError(f'instance {instance} should have an editors attribute') from e
elif isinstance(instance, str):
pass

if 'foo-' in str(instance):
instance_obj_perms_key = 'foo-element'
elif 'bar-' in str(instance):
instance_obj_perms_key = 'bar-element'
else:
instance_obj_perms_key = 'all-element'

try:
method_instance_obj_perms_map = status_map_object_permissions[method][instance_obj_perms_key]
except KeyError as e:
raise KeyError(f'instance ({instance_obj_perms_key}) should be defined in status_map_object_permissions') from e
try:
return method_instance_obj_perms_map[username]
except KeyError:
# not all users are defined in the method_instance_perms_map
return multisite_status_map[method][username]
139 changes: 139 additions & 0 deletions rdmo/core/tests/constants.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@

multisite_status_map = {
'list': {
'foo-user': 403, 'foo-reviewer': 200, 'foo-editor': 200,
'bar-user': 403, 'bar-reviewer': 200, 'bar-editor': 200,
'user': 403, 'example-reviewer': 200, 'example-editor': 200,
'anonymous': 401, 'reviewer': 200, 'editor': 200,
},
'detail': {
'foo-user': 404, 'foo-reviewer': 200, 'foo-editor': 200,
'bar-user': 404, 'bar-reviewer': 200, 'bar-editor': 200,
'user': 404, 'example-reviewer': 200, 'example-editor': 200,
'anonymous': 401, 'reviewer': 200, 'editor': 200,
},
'nested': {
'foo-user': 404, 'foo-reviewer': 200, 'foo-editor': 200,
'bar-user': 404, 'bar-reviewer': 200, 'bar-editor': 200,
'user': 404, 'example-reviewer': 200, 'example-editor': 200,
'anonymous': 401, 'reviewer': 200, 'editor': 200,
},
'create': {
'foo-user': 403, 'foo-reviewer': 403, 'foo-editor': 201,
'bar-user': 403, 'bar-reviewer': 403, 'bar-editor': 201,
'user': 403, 'example-reviewer': 403, 'example-editor': 201,
'anonymous': 401, 'reviewer': 403, 'editor': 201,
},
'copy': {
'foo-user': 404, 'foo-reviewer': 403, 'foo-editor': 201,
'bar-user': 404, 'bar-reviewer': 403, 'bar-editor': 201,
'user': 404, 'example-reviewer': 403, 'example-editor': 201,
'anonymous': 401, 'reviewer': 403, 'editor': 201,
},
'update': {
'foo-user': 404, 'foo-reviewer': 403, 'foo-editor': 200,
'bar-user': 404, 'bar-reviewer': 403, 'bar-editor': 200,
'user': 404, 'example-reviewer': 403, 'example-editor': 200,
'anonymous': 401, 'reviewer': 403, 'editor': 200,
},
'delete': {
'foo-user': 404, 'foo-reviewer': 403, 'foo-editor': 204,
'bar-user': 404, 'bar-reviewer': 403, 'bar-editor': 204,
'user': 404, 'example-reviewer': 403, 'example-editor': 204,
'anonymous': 401, 'reviewer': 403, 'editor': 204,
},
'toggle-site': {
# foo-editor is not permitted to apply own site(foo.com) in test run(example.com)
'foo-user': 403, 'foo-reviewer': 403, 'foo-editor': 403,
# bar-editor is not permitted to apply own site(bar.com) in test run(example.com)
'bar-user': 403, 'bar-reviewer': 403, 'bar-editor': 403,
'user': 403, 'example-reviewer': 403, 'example-editor': 200,
'anonymous': 401, 'reviewer': 403, 'editor': 200,
},
}
status_map_object_permissions = {
'copy': {
'all-element': {
'foo-reviewer': 403, 'foo-editor': 201,
'bar-reviewer': 403, 'bar-editor': 201,
'example-reviewer': 403, 'example-editor': 201,
},
'foo-element': {
'foo-reviewer': 403, 'foo-editor': 201,
'bar-reviewer': 404, 'bar-editor': 404,
'example-reviewer': 404, 'example-editor': 404,
},
'bar-element': {
'foo-reviewer': 404, 'foo-editor': 404,
'bar-reviewer': 403, 'bar-editor': 201,
'example-reviewer': 404, 'example-editor': 404,
}
},
'update': {
'all-element': {
'foo-reviewer': 403, 'foo-editor': 200,
'bar-reviewer': 403, 'bar-editor': 200,
'example-reviewer': 403, 'example-editor': 200,
},
'foo-element': {
'foo-reviewer': 403, 'foo-editor': 200,
'bar-reviewer': 404, 'bar-editor': 404,
'example-reviewer': 404, 'example-editor': 404,
},
'bar-element': {
'foo-reviewer': 404, 'foo-editor': 404,
'bar-reviewer': 403, 'bar-editor': 200,
'example-reviewer': 404, 'example-editor': 404,
}
},
'delete': {
'all-element': {
'foo-reviewer': 403, 'foo-editor': 204,
'bar-reviewer': 403, 'bar-editor': 204,
'example-reviewer': 403, 'example-editor': 204,
},
'foo-element': {
'foo-reviewer': 403, 'foo-editor': 204,
'bar-reviewer': 404, 'bar-editor': 404,
'example-reviewer': 404, 'example-editor': 404,
},
'bar-element': {
'foo-reviewer': 404, 'foo-editor': 404,
'bar-reviewer': 403, 'bar-editor': 204,
'example-reviewer': 404, 'example-editor': 404,
}
},
'toggle-site': {
'all-element': {
# foo-editor can not apply own site(foo.com) in test run(example.com)
'foo-reviewer': 403, 'foo-editor': 403,
# bar-editor can not apply own site(bar.com) in test run(example.com)
'bar-reviewer': 403, 'bar-editor': 403,
'example-reviewer': 403, 'example-editor': 200,
},
'foo-element': {
'foo-reviewer': 403, 'foo-editor': 403,
'bar-reviewer': 403, 'bar-editor': 403,
'example-reviewer': 403, 'example-editor': 200,
},
'bar-element': {
'foo-reviewer': 403, 'foo-editor': 403,
'bar-reviewer': 403, 'bar-editor': 403,
'example-reviewer': 403, 'example-editor': 200,
}
}
}
multisite_users = (
('user', 'user'),
('reviewer', 'reviewer'),
('editor', 'editor'),
('example-reviewer', 'example-reviewer'),
('example-editor', 'example-editor'),
('foo-user', 'foo-user'),
('foo-reviewer', 'foo-reviewer'),
('foo-editor', 'foo-editor'),
('bar-user', 'bar-user'),
('bar-reviewer', 'bar-reviewer'),
('bar-editor', 'bar-editor'),
('anonymous', None),
)
4 changes: 3 additions & 1 deletion rdmo/core/tests/test_views.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
('reviewer', 'reviewer'),
('user', 'user'),
('api', 'api'),
('example-editor', 'example-editor'),
('example-reviewer', 'example-reviewer'),
)


Expand Down Expand Up @@ -57,7 +59,7 @@ def test_i18n_switcher(db, client):
def test_can_view_management(db, client, username, password):
client.login(username=username, password=password)
response = client.get(reverse('management'))
if username in ('editor', 'reviewer', 'api'):
if username in ('editor', 'reviewer', 'api', 'example-editor', 'example-reviewer'):
assert response.status_code == 200
else:
assert response.status_code == 403
32 changes: 32 additions & 0 deletions rdmo/core/tests/utils.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
from rdmo.core.models import Model
from rdmo.core.tests.constants import multisite_status_map, status_map_object_permissions


def get_obj_perms_status_code(instance, username, method):
''' looks for the object permissions of the instance and returns the status code '''

if isinstance(instance, Model):
try:
if not instance.editors.exists():
return multisite_status_map[method][username]
except AttributeError as e:
raise AttributeError(f'instance {instance} should have an editors attribute') from e
elif isinstance(instance, str):
pass

if 'foo-' in str(instance):
instance_obj_perms_key = 'foo-element'
elif 'bar-' in str(instance):
instance_obj_perms_key = 'bar-element'
else:
instance_obj_perms_key = 'all-element'

try:
method_instance_obj_perms_map = status_map_object_permissions[method][instance_obj_perms_key]
except KeyError as e:
raise KeyError(f'instance ({instance_obj_perms_key}) should be defined in status_map_object_permissions') from e
try:
return method_instance_obj_perms_map[username]
except KeyError:
# not all users are defined in the method_instance_perms_map
return multisite_status_map[method][username]
7 changes: 4 additions & 3 deletions rdmo/domain/tests/test_viewset_attribute_multisite.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@

from django.urls import reverse

from ...core.tests import get_obj_perms_status_code
from ...core.tests import multisite_status_map as status_map
from ...core.tests import multisite_users as users
from rdmo.core.tests.constants import multisite_status_map as status_map
from rdmo.core.tests.constants import multisite_users as users
from rdmo.core.tests.utils import get_obj_perms_status_code

from ..models import Attribute
from .test_viewset_attribute import urlnames

Expand Down