8000 Add support for View Permissions by t8y8 · Pull Request #526 · tableau/server-client-python · GitHub
[go: up one dir, main page]

Skip to content

Add support for View Permissions #526

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

Merged
merged 1 commit into from
Apr 14, 2020
Merged
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
1 change: 1 addition & 0 deletions tableauserverclient/models/permissions_item.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ class Resource:
Flow = 'flow'
Table = 'table'
Database = 'database'
View = 'view'


class PermissionsRule(object):
Expand Down
11 changes: 11 additions & 0 deletions tableauserverclient/models/view_item.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ def __init__(self):
self._sheet_type = None
self._updated_at = None
self._workbook_id = None
self._permissions = None
self.tags = set()

def _set_preview_image(self, preview_image):
Expand Down Expand Up @@ -106,6 +107,16 @@ def updated_at(self):
def workbook_id(self):
return self._workbook_id

@property
def permissions(self):
if self._permissions is None:
error = "View item must be populated with permissions first."
raise UnpopulatedPropertyError(error)
return self._permissions()

def _set_permissions(self, permissions):
self._permissions = permissions

@classmethod
def from_response(cls, resp, ns, workbook_id=''):
return cls.from_xml_element(ET.fromstring(resp), ns, workbook_id)
Expand Down
14 changes: 14 additions & 0 deletions tableauserverclient/server/endpoint/views_endpoint.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from .endpoint import Endpoint, api
from .exceptions import MissingRequiredFieldError
from .resource_tagger import _ResourceTagger
from .permissions_endpoint import _PermissionsEndpoint
from .. import RequestFactory, ViewItem, PaginationItem
from ...models.tag_item import TagItem
import logging
Expand All @@ -13,6 +14,7 @@ class Views(Endpoint):
def __init__(self, parent_srv):
super(Views, self).__init__(parent_srv)
self._resource_tagger = _ResourceTagger(parent_srv)
self._permissions = _PermissionsEndpoint(parent_srv, lambda: self.baseurl)

# Used because populate_preview_image functionaliy requires workbook endpoint
@property
Expand Down Expand Up @@ -109,6 +111,18 @@ def _get_view_csv(self, view_item, req_options):
csv = server_response.iter_content(1024)
return csv

@api(version='3.2')
def populate_permissions(self, item):
self._permissions.populate(item)

@api(version='3.2')
def update_permissions(self, resource, rules):
return self._permissions.update(resource, rules)

@api(version='3.2')
def delete_permission(self, item, capability_item):
return self._permissions.delete(item, capability_item)

# Update view. Currently only tags can be updated
def update(self, view_item):
if not view_item.id:
Expand Down
19 changes: 19 additions & 0 deletions test/assets/view_populate_permissions.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?xml version='1.0' encoding='UTF-8'?>
<tsResponse xmlns="http://tableau.com/api"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://tableau.com/api http://tableau.com/api/ts-api-3.7.xsd">
<permissions>
<view id="e490bec4-2652-4fda-8c4e-f087db6fa328" name="Overview">
<owner id="26183d16-82f7-4fcf-b163-0e607bf292bc"/>
</view>
<granteeCapabilities>
<group id="c8f2773a-c83a-11e8-8c8f-33e6d787b506"/>
<capabilities>
<capability name="ExportData" mode="Allow"/>
<capability name="ViewComments" mode="Allow"/>
<capability name="AddComment" mode="Allow"/>
<capability name="Read" mode="Allow"/>
<capability name="ExportImage" mode="Allow"/>
</capabilities>
</granteeCapabilities>
</permissions>
</tsResponse>
21 changes: 21 additions & 0 deletions test/assets/view_update_permissions.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?xml version='1.0' encoding='UTF-8'?>
<tsResponse xmlns="http://tableau.com/api" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://tableau.com/api http://tableau.com/api/ts-api-2.3.xsd">
<permissions>
<view id="21778de4-b7b9-44bc-a599-1506a2639ace" name="ComplianceDashboard">
<owner id="91d5931a-2cd6-4dbc-8b7c-211e85cf5fa3" />
</view>
<granteeCapabilities>
<group id="5e5e1978-71fa-11e4-87dd-7382f5c437af" />
<capabilities>
<capability name="Read" mode="Deny" />
</capabilities>
</granteeCapabilities>
<granteeCapabilities>
<user id="7c37ee24-c4b1-42b6-a154-eaeab7ee330a" />
<capabilities>
<capability name="Write" mode="Allow" />
</capabilities>
</granteeCapabilities>
</permissions>
</tsResponse>

58 changes: 57 additions & 1 deletion test/test_view.py
6D40
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import tableauserverclient as TSC

from tableauserverclient.datetime_helpers import format_datetime
from tableauserverclient import UserItem, GroupItem, PermissionsRule

TEST_ASSET_DIR = os.path.join(os.path.dirname(__file__), 'assets')

Expand All @@ -13,13 +14,15 @@
POPULATE_PREVIEW_IMAGE = os.path.join(TEST_ASSET_DIR, 'Sample View Image.png')
POPULATE_PDF = os.path.join(TEST_ASSET_DIR, 'populate_pdf.pdf')
POPULATE_CSV = os.path.join(TEST_ASSET_DIR, 'populate_csv.csv')
POPULATE_PERMISSIONS_XML = os.path.join(TEST_ASSET_DIR, 'view_populate_permissions.xml')
UPDATE_PERMISSIONS = os.path.join(TEST_ASSET_DIR, 'view_update_permissions.xml')
UPDATE_XML = os.path.join(TEST_ASSET_DIR, 'workbook_update.xml')


class ViewTests(unittest.TestCase):
def setUp(self):
self.server = TSC.Server('http://test')
self.server.version = '2.7'
self.server.version = '3.2'

# Fake sign in
self.server._site_id = 'dad65087-b08b-4603-af4e-2887b8aafc67'
Expand Down Expand Up @@ -170,6 +173,59 @@ def test_populate_image_missing_id(self):
single_view._id = None
self.assertRaises(TSC.MissingRequiredFieldError, self.server.views.populate_image, single_view)

def test_populate_permissions(self):
with open(POPULATE_PERMISSIONS_XML, 'rb') as f:
response_xml = f.read().decode('utf-8')
with requests_mock.mock() as m:
m.get(self.baseurl + "/e490bec4-2652-4fda-8c4e-f087db6fa328/permissions", text=response_xml)
single_view = TSC.ViewItem()
single_view._id = "e490bec4-2652-4fda-8c4e-f087db6fa328"

self.server.views.populate_permissions(single_view)
permissions = single_view.permissions

self.assertEqual(permissions[0].grantee.tag_name, 'group')
self.assertEqual(permissions[0].grantee.id, 'c8f2773a-c83a-11e8-8c8f-33e6d787b506')
self.assertDictEqual(permissions[0].capabilities, {
TSC.Permission.Capability.ViewComments: TSC.Permission.Mode.Allow,
TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow,
TSC.Permission.Capability.AddComment: TSC.Permission.Mode.Allow,
TSC.Permission.Capability.ExportData: TSC.Permission.Mode.Allow,
TSC.Permission.Capability.ExportImage: TSC.Permission.Mode.Allow,

})

def test_add_permissions(self):
with open(UPDATE_PERMISSIONS, 'rb') as f:
response_xml = f.read().decode('utf-8')

single_view = TSC.ViewItem()
single_view._id = '21778de4-b7b9-44bc-a599-1506a2639ace'

bob = UserItem.as_reference("7c37ee24-c4b1-42b6-a154-eaeab7ee330a")
group_of_people = GroupItem.as_reference("5e5e1978-71fa-11e4-87dd-7382f5c437af")

new_permissions = [
PermissionsRule(bob, {'Write': 'Allow'}),
PermissionsRule(group_of_people, {'Read': 'Deny'})
]

with requests_mock.mock() as m:
m.put(self.baseurl + "/21778de4-b7b9-44bc-a599-1506a2639ace/permissions", text=response_xml)
permissions = self.server.views.update_permissions(single_view, new_permissions)

self.assertEqual(permissions[0].grantee.tag_name, 'group')
self.assertEqual(permissions[0].grantee.id, '5e5e1978-71fa-11e4-87dd-7382f5c437af')
self.assertDictEqual(permissions[0].capabilities, {
TSC.Permission.Capability.Read: TSC.Permission.Mode.Deny
})

self.assertEqual(permissions[1].grantee.tag_name, 'user')
self.assertEqual(permissions[1].grantee.id, '7c37ee24-c4b1-42b6-a154-eaeab7ee330a')
self.assertDictEqual(permissions[1].capabilities, {
TSC.Permission.Capability.Write: TSC.Permission.Mode.Allow
})

def test_update_tags(self):
with open(ADD_TAGS_XML, 'rb') as f:
add_tags_xml = f.read().decode('utf-8')
Expand Down
0