Skip to content
Open
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: 4 additions & 2 deletions tableauserverclient/server/endpoint/databases_endpoint.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import logging
from typing import TYPE_CHECKING
from collections.abc import Iterable
from collections.abc import Iterable, Sequence

from tableauserverclient.models.permissions_item import PermissionsRule
from tableauserverclient.server.endpoint.default_permissions_endpoint import _DefaultPermissionsEndpoint
Expand Down Expand Up @@ -191,7 +191,9 @@ def update_table_default_permissions(
return self._default_permissions.update_default_permissions(item, rules, Resource.Table)

@api(version="3.5")
def delete_table_default_permissions(self, rule: PermissionsRule, item: DatabaseItem) -> None:
def delete_table_default_permissions(
self, rule: PermissionsRule | Sequence[PermissionsRule], item: DatabaseItem
) -> None:
self._default_permissions.delete_default_permission(item, rule, Resource.Table)

@api(version="3.5")
Expand Down
41 changes: 24 additions & 17 deletions tableauserverclient/server/endpoint/default_permissions_endpoint.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,28 +51,35 @@ def update_default_permissions(
return permissions

def delete_default_permission(
self, resource: BaseItem, rule: PermissionsRule, content_type: Resource | str
self,
resource: BaseItem,
rule: PermissionsRule | Sequence[PermissionsRule],
content_type: Resource | str,
) -> None:
for capability, mode in rule.capabilities.items():
# Made readability better but line is too long, will make this look better
url = (
"{baseurl}/{content_id}/default-permissions/"
"{content_type}/{grantee_type}/{grantee_id}/{cap}/{mode}".format(
baseurl=self.owner_baseurl(),
content_id=resource.id,
content_type=plural_type(content_type),
grantee_type=rule.grantee.tag_name + "s",
grantee_id=rule.grantee.id,
cap=capability,
mode=mode,
# The REST API deletes one capability at a time. Accept a list here,
# the same way PermissionsEndpoint.delete does, so callers can remove
# every default rule they were given.
rules = [rule] if isinstance(rule, PermissionsRule) else list(rule)
for one_rule in rules:
for capability, mode in one_rule.capabilities.items():
url = (
"{baseurl}/{content_id}/default-permissions/"
"{content_type}/{grantee_type}/{grantee_id}/{cap}/{mode}".format(
baseurl=self.owner_baseurl(),
content_id=resource.id,
content_type=plural_type(content_type),
grantee_type=one_rule.grantee.tag_name + "s",
grantee_id=one_rule.grantee.id,
cap=capability,
mode=mode,
)
)
)

logger.debug(f"Removing {mode} permission for capability {capability}")
logger.debug(f"Removing {mode} permission for capability {capability}")

self.delete_request(url)
self.delete_request(url)

logger.info(f"Deleted permission for {rule.grantee.tag_name} {rule.grantee.id} item {resource.id}")
logger.info(f"Deleted permission for {one_rule.grantee.tag_name} {one_rule.grantee.id} item {resource.id}")

def populate_default_permissions(self, item: BaseItem, content_type: Resource | str) -> None:
if not item.id:
Expand Down
55 changes: 37 additions & 18 deletions tableauserverclient/server/endpoint/projects_endpoint.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from tableauserverclient.models.permissions_item import PermissionsRule
from tableauserverclient.models import ProjectItem, PaginationItem, Resource

from collections.abc import Sequence
from typing import TYPE_CHECKING

from tableauserverclient.server.query import QuerySet
Expand Down Expand Up @@ -731,9 +732,11 @@ def update_table_default_permissions(
return self._default_permissions.update_default_permissions(item, rules, Resource.Table)

@api(version="2.1")
def delete_workbook_default_permissions(self, item: ProjectItem, rule: PermissionsRule) -> None:
def delete_workbook_default_permissions(
self, item: ProjectItem, rule: PermissionsRule | Sequence[PermissionsRule]
) -> None:
"""
Deletes the specified default permission rule from the project.
Deletes one default permission rule, or each rule in a list, from the project.

REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission

Expand All @@ -752,9 +755,11 @@ def delete_workbook_default_permissions(self, item: ProjectItem, rule: Permissio
self._default_permissions.delete_default_permission(item, rule, Resource.Workbook)

@api(version="2.1")
def delete_datasource_default_permissions(self, item: ProjectItem, rule: PermissionsRule) -> None:
def delete_datasource_default_permissions(
self, item: ProjectItem, rule: PermissionsRule | Sequence[PermissionsRule]
) -> None:
"""
Deletes the specified default permission rule from the project.
Deletes one default permission rule, or each rule in a list, from the project.

REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission

Expand All @@ -773,9 +778,11 @@ def delete_datasource_default_permissions(self, item: ProjectItem, rule: Permiss
self._default_permissions.delete_default_permission(item, rule, Resource.Datasource)

@api(version="3.2")
def delete_metric_default_permissions(self, item: ProjectItem, rule: PermissionsRule) -> None:
def delete_metric_default_permissions(
self, item: ProjectItem, rule: PermissionsRule | Sequence[PermissionsRule]
) -> None:
"""
Deletes the specified default permission rule from the project.
Deletes one default permission rule, or each rule in a list, from the project.

REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission

Expand All @@ -794,9 +801,11 @@ def delete_metric_default_permissions(self, item: ProjectItem, rule: Permissions
self._default_permissions.delete_default_permission(item, rule, Resource.Metric)

@api(version="3.4")
def delete_datarole_default_permissions(self, item: ProjectItem, rule: PermissionsRule) -> None:
def delete_datarole_default_permissions(
self, item: ProjectItem, rule: PermissionsRule | Sequence[PermissionsRule]
) -> None:
"""
Deletes the specified default permission rule from the project.
Deletes one default permission rule, or each rule in a list, from the project.

REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission

Expand All @@ -815,9 +824,11 @@ def delete_datarole_default_permissions(self, item: ProjectItem, rule: Permissio
self._default_permissions.delete_default_permission(item, rule, Resource.Datarole)

@api(version="3.4")
def delete_flow_default_permissions(self, item: ProjectItem, rule: PermissionsRule) -> None:
def delete_flow_default_permissions(
self, item: ProjectItem, rule: PermissionsRule | Sequence[PermissionsRule]
) -> None:
"""
Deletes the specified default permission rule from the project.
Deletes one default permission rule, or each rule in a list, from the project.

REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission

Expand All @@ -836,9 +847,11 @@ def delete_flow_default_permissions(self, item: ProjectItem, rule: PermissionsRu
self._default_permissions.delete_default_permission(item, rule, Resource.Flow)

@api(version="3.4")
def delete_lens_default_permissions(self, item: ProjectItem, rule: PermissionsRule) -> None:
def delete_lens_default_permissions(
self, item: ProjectItem, rule: PermissionsRule | Sequence[PermissionsRule]
) -> None:
"""
Deletes the specified default permission rule from the project.
Deletes one default permission rule, or each rule in a list, from the project.

REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission

Expand All @@ -857,9 +870,11 @@ def delete_lens_default_permissions(self, item: ProjectItem, rule: PermissionsRu
self._default_permissions.delete_default_permission(item, rule, Resource.Lens)

@api(version="3.23")
def delete_virtualconnection_default_permissions(self, item: ProjectItem, rule: PermissionsRule) -> None:
def delete_virtualconnection_default_permissions(
self, item: ProjectItem, rule: PermissionsRule | Sequence[PermissionsRule]
) -> None:
"""
Deletes the specified default permission rule from the project.
Deletes one default permission rule, or each rule in a list, from the project.

REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission

Expand All @@ -878,9 +893,11 @@ def delete_virtualconnection_default_permissions(self, item: ProjectItem, rule:
self._default_permissions.delete_default_permission(item, rule, Resource.VirtualConnection)

@api(version="3.23")
def delete_database_default_permissions(self, item: ProjectItem, rule: PermissionsRule) -> None:
def delete_database_default_permissions(
self, item: ProjectItem, rule: PermissionsRule | Sequence[PermissionsRule]
) -> None:
"""
Deletes the specified default permission rule from the project.
Deletes one default permission rule, or each rule in a list, from the project.

REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission

Expand All @@ -899,9 +916,11 @@ def delete_database_default_permissions(self, item: ProjectItem, rule: Permissio
self._default_permissions.delete_default_permission(item, rule, Resource.Database)

@api(version="3.23")
def delete_table_default_permissions(self, item: ProjectItem, rule: PermissionsRule) -> None:
def delete_table_default_permissions(
self, item: ProjectItem, rule: PermissionsRule | Sequence[PermissionsRule]
) -> None:
"""
Deletes the specified default permission rule from the project.
Deletes one default permission rule, or each rule in a list, from the project.

REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission

Expand Down
30 changes: 30 additions & 0 deletions test/test_project.py
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,36 @@ def test_delete_workbook_default_permission(server: TSC.Server) -> None:
server.projects.delete_workbook_default_permissions(item=single_project, rule=rules)


def test_delete_workbook_default_permissions_accepts_a_list(server: TSC.Server) -> None:
project = TSC.ProjectItem("test", "1d0304cd-3796-429f-b815-7258370b9b74")
project._id = "9dbd2263-16b5-46e1-9c43-a76bb8ab65fb"
group_a = "c8f2773a-c83a-11e8-8c8f-33e6d787b506"
group_b = "d9e3884b-d94b-22f9-9d54-44f7e898c617"
rules = [
TSC.PermissionsRule(
grantee=TSC.GroupItem.as_reference(group_a),
capabilities={TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow},
),
TSC.PermissionsRule(
grantee=TSC.GroupItem.as_reference(group_b),
capabilities={TSC.Permission.Capability.Write: TSC.Permission.Mode.Deny},
),
]

with requests_mock.mock() as m:
m.delete(
f"{server.projects.baseurl}/{project.id}/default-permissions/workbooks/groups/{group_a}/Read/Allow",
status_code=204,
)
m.delete(
f"{server.projects.baseurl}/{project.id}/default-permissions/workbooks/groups/{group_b}/Write/Deny",
status_code=204,
)
server.projects.delete_workbook_default_permissions(project, rules)

assert m.call_count == 2


def test_populate_virtualconnection_default_permissions(server: TSC.Server) -> None:
response_xml = POPULATE_VIRTUALCONNECTION_DEFAULT_PERMISSIONS_XML.read_text()

Expand Down