feat: publish custom views

Author: jorwoods

tableauserverclient/server/endpoint/custom_views_endpoint.py

@@ -1,8 +1,11 @@
 import io
 import logging
 import os
+from pathlib import Path
 from typing import List, Optional, Tuple, Union
 
+from tableauserverclient.config import BYTES_PER_MB, FILESIZE_LIMIT_MB
+from tableauserverclient.filesys_helpers import get_file_object_size
 from tableauserverclient.server.endpoint.endpoint import QuerysetEndpoint, api
 from tableauserverclient.server.endpoint.exceptions import MissingRequiredFieldError
 from tableauserverclient.models import CustomViewItem, PaginationItem
@@ -130,3 +133,33 @@ def download(self, view_item: CustomViewItem, file: PathOrFileW) -> PathOrFileW:
             f.write(server_response.content)
 
         return file
+
+    @api(version="3.21")
+    def publish(self, view_item: CustomViewItem, file: PathOrFileR) -> Optional[CustomViewItem]:
+        url = self.expurl
+        if isinstance(file, io_types_r):
+            size = get_file_object_size(file)
+        elif isinstance(file, (str, Path)) and (p := Path(file)).is_file():
+            size = p.stat().st_size
+        else:
+            raise ValueError("File path or file object required for publishing custom view.")
+
+        if size >= FILESIZE_LIMIT_MB * BYTES_PER_MB:
+            upload_session_id = self.parent_srv.fileuploads.upload(file)
+            url = f"{url}?uploadSessionId={upload_session_id}"
+            xml_request, content_type = RequestFactory.CustomView.publish_req_chunked(view_item)
+        else:
+            if isinstance(file, io_types_r):
+                file.seek(0)
+                contents = file.read()
+                if view_item.name is None:
+                    raise MissingRequiredFieldError("Custom view item missing name.")
+                filename = view_item.name
+            elif isinstance(file, (str, Path)):
+                filename = Path(file).name
+                contents = Path(file).read_bytes()
+
+            xml_request, content_type = RequestFactory.CustomView.publish_req(view_item, filename, contents)
+
+        server_response = self.post_request(url, xml_request, content_type)
+        return CustomViewItem.from_response(server_response.content, self.parent_srv.namespace)

tableauserverclient/server/request_factory.py

@@ -1,4 +1,5 @@
 import xml.etree.ElementTree as ET
+
 from typing import Any, Dict, Iterable, List, Optional, Tuple, TYPE_CHECKING, Union
 
 from requests.packages.urllib3.fields import RequestField
@@ -1267,6 +1268,49 @@ def update_req(self, xml_request: ET.Element, custom_view_item: CustomViewItem):
         if custom_view_item.name is not None:
             updating_element.attrib["name"] = custom_view_item.name
 
+    @_tsrequest_wrapped
+    def _publish_xml(self, xml_request: ET.Element, custom_view_item: CustomViewItem) -> bytes:
+        custom_view_element = ET.SubElement(xml_request, "customView")
+        if (name := custom_view_item.name) is not None:
+            custom_view_element.attrib["name"] = name
+        else:
+            raise ValueError(f"Custom View Item missing name: {custom_view_item}")
+        if (shared := custom_view_item.shared) is not None:
+            custom_view_element.attrib["shared"] = str(shared).lower()
+        else:
+            raise ValueError(f"Custom View Item missing shared: {custom_view_item}")
+        if (owner := custom_view_item.owner) is not None:
+            owner_element = ET.SubElement(custom_view_element, "owner")
+            if (owner_id := owner.id) is not None:
+                owner_element.attrib["id"] = owner_id
+            else:
+                raise ValueError(f"Custom View Item owner missing id: {owner}")
+        else:
+            raise ValueError(f"Custom View Item missing owner: {custom_view_item}")
+        if (workbook := custom_view_item.workbook) is not None:
+            workbook_element = ET.SubElement(custom_view_element, "workbook")
+            if (workbook_id := workbook.id) is not None:
+                workbook_element.attrib["id"] = workbook_id
+            else:
+                raise ValueError(f"Custom View Item workbook missing id: {workbook}")
+        else:
+            raise ValueError(f"Custom View Item missing workbook: {custom_view_item}")
+
+        return ET.tostring(xml_request)
+
+    def publish_req_chunked(self, custom_view_item: CustomViewItem):
+        xml_request = self._publish_xml(custom_view_item)
+        parts = {"request_payload": ("", xml_request, "text/xml")}
+        return _add_multipart(parts)
+
+    def publish_req(self, custom_view_item: CustomViewItem, filename: str, file_contents: bytes):
+        xml_request = self._publish_xml(custom_view_item)
+        parts = {
+            "request_payload": ("", xml_request, "text/xml"),
+            "tableau_customview": (filename, file_contents, "application/octet-stream"),
+        }
+        return _add_multipart(parts)
+
 
 class GroupSetRequest:
     @_tsrequest_wrapped

test/test_custom_view.py

@@ -1,12 +1,16 @@
+from contextlib import ExitStack
 import io
 import os
 from pathlib import Path
+from tempfile import TemporaryDirectory
 import unittest
 
 import requests_mock
 
 import tableauserverclient as TSC
+from tableauserverclient.config import BYTES_PER_MB
 from tableauserverclient.datetime_helpers import format_datetime
+from tableauserverclient.server.endpoint.exceptions import MissingRequiredFieldError
 
 TEST_ASSET_DIR = Path(__file__).parent / "assets"
 
@@ -15,6 +19,8 @@
 POPULATE_PREVIEW_IMAGE = os.path.join(TEST_ASSET_DIR, "Sample View Image.png")
 CUSTOM_VIEW_UPDATE_XML = os.path.join(TEST_ASSET_DIR, "custom_view_update.xml")
 CUSTOM_VIEW_DOWNLOAD = TEST_ASSET_DIR / "custom_view_download.json"
+FILE_UPLOAD_INIT = TEST_ASSET_DIR / "fileupload_initialize.xml"
+FILE_UPLOAD_APPEND = TEST_ASSET_DIR / "fileupload_append.xml"
 
 
 class CustomViewTests(unittest.TestCase):
@@ -146,3 +152,97 @@ def test_download(self) -> None:
             self.server.custom_views.download(cv, data)
 
         assert data.getvalue() == content
+
+    def test_publish_filepath(self) -> None:
+        cv = TSC.CustomViewItem(name="test")
+        cv._owner = TSC.UserItem()
+        cv._owner._id = "dd2239f6-ddf1-4107-981a-4cf94e415794"
+        cv._workbook = TSC.WorkbookItem()
+        cv._workbook._id = "1f951daf-4061-451a-9df1-69a8062664f2"
+        with requests_mock.mock() as m:
+            m.post(self.server.custom_views.expurl, status_code=201, text=Path(GET_XML).read_text())
+            view = self.server.custom_views.publish(cv, CUSTOM_VIEW_DOWNLOAD)
+
+        assert view is not None
+        assert isinstance(view, TSC.CustomViewItem)
+        assert view.id is not None
+        assert view.name is not None
+
+    def test_publish_file_str(self) -> None:
+        cv = TSC.CustomViewItem(name="test")
+        cv._owner = TSC.UserItem()
+        cv._owner._id = "dd2239f6-ddf1-4107-981a-4cf94e415794"
+        cv._workbook = TSC.WorkbookItem()
+        cv._workbook._id = "1f951daf-4061-451a-9df1-69a8062664f2"
+        with requests_mock.mock() as m:
+            m.post(self.server.custom_views.expurl, status_code=201, text=Path(GET_XML).read_text())
+            view = self.server.custom_views.publish(cv, str(CUSTOM_VIEW_DOWNLOAD))
+
+        assert view is not None
+        assert isinstance(view, TSC.CustomViewItem)
+        assert view.id is not None
+        assert view.name is not None
+
+    def test_publish_file_io(self) -> None:
+        cv = TSC.CustomViewItem(name="test")
+        cv._owner = TSC.UserItem()
+        cv._owner._id = "dd2239f6-ddf1-4107-981a-4cf94e415794"
+        cv._workbook = TSC.WorkbookItem()
+        cv._workbook._id = "1f951daf-4061-451a-9df1-69a8062664f2"
+        data = io.BytesIO(CUSTOM_VIEW_DOWNLOAD.read_bytes())
+        with requests_mock.mock() as m:
+            m.post(self.server.custom_views.expurl, status_code=201, text=Path(GET_XML).read_text())
+            view = self.server.custom_views.publish(cv, data)
+
+        assert view is not None
+        assert isinstance(view, TSC.CustomViewItem)
+        assert view.id is not None
+        assert view.name is not None
+
+    def test_publish_missing_owner_id(self) -> None:
+        cv = TSC.CustomViewItem(name="test")
+        cv._owner = TSC.UserItem()
+        cv._workbook = TSC.WorkbookItem()
+        cv._workbook._id = "1f951daf-4061-451a-9df1-69a8062664f2"
+        with requests_mock.mock() as m:
+            m.post(self.server.custom_views.expurl, status_code=201, text=Path(GET_XML).read_text())
+            with self.assertRaises(ValueError):
+                self.server.custom_views.publish(cv, CUSTOM_VIEW_DOWNLOAD)
+
+    def test_publish_missing_wb_id(self) -> None:
+        cv = TSC.CustomViewItem(name="test")
+        cv._owner = TSC.UserItem()
+        cv._owner._id = "dd2239f6-ddf1-4107-981a-4cf94e415794"
+        cv._workbook = TSC.WorkbookItem()
+        with requests_mock.mock() as m:
+            m.post(self.server.custom_views.expurl, status_code=201, text=Path(GET_XML).read_text())
+            with self.assertRaises(ValueError):
+                self.server.custom_views.publish(cv, CUSTOM_VIEW_DOWNLOAD)
+
+    def test_large_publish(self):
+        cv = TSC.CustomViewItem(name="test")
+        cv._owner = TSC.UserItem()
+        cv._owner._id = "dd2239f6-ddf1-4107-981a-4cf94e415794"
+        cv._workbook = TSC.WorkbookItem()
+        cv._workbook._id = "1f951daf-4061-451a-9df1-69a8062664f2"
+        with ExitStack() as stack:
+            temp_dir = stack.enter_context(TemporaryDirectory())
+            file_path = Path(temp_dir) / "test_file"
+            file_path.write_bytes(os.urandom(65 * BYTES_PER_MB))
+            mock = stack.enter_context(requests_mock.mock())
+            # Mock initializing upload
+            mock.post(self.server.fileuploads.baseurl, status_code=201, text=FILE_UPLOAD_INIT.read_text())
+            # Mock the upload
+            mock.put(
+                f"{self.server.fileuploads.baseurl}/7720:170fe6b1c1c7422dadff20f944d58a52-1:0",
+                text=FILE_UPLOAD_APPEND.read_text(),
+            )
+            # Mock the publish
+            mock.post(self.server.custom_views.expurl, status_code=201, text=Path(GET_XML).read_text())
+
+            view = self.server.custom_views.publish(cv, file_path)
+
+        assert view is not None
+        assert isinstance(view, TSC.CustomViewItem)
+        assert view.id is not None
+        assert view.name is not None