Merge pull request #311 from tableau/async-publishing

Added support for asynchronous publishing on workbook and datasource endpoints

Author: gaoang2148

samples/publish_workbook.py

@@ -29,6 +29,7 @@ def main():
     parser.add_argument('--filepath', '-f', required=True, help='filepath to the workbook to publish')
     parser.add_argument('--logging-level', '-l', choices=['debug', 'info', 'error'], default='error',
                         help='desired logging level (set to error by default)')
+    parser.add_argument('--as-job', '-a', help='Publishing asynchronously', action='store_true')
 
     args = parser.parse_args()
 
@@ -53,8 +54,12 @@ def main():
         # Step 3: If default project is found, form a new workbook item and publish.
         if default_project is not None:
             new_workbook = TSC.WorkbookItem(default_project.id)
-            new_workbook = server.workbooks.publish(new_workbook, args.filepath, overwrite_true)
-            print("Workbook published. ID: {0}".format(new_workbook.id))
+            if args.as_job:
+                new_job = server.workbooks.publish(new_workbook, args.filepath, overwrite_true, as_job=args.as_job)
+                print("Workbook published. JOB ID: {0}".format(new_job.id))
+            else:
+                new_workbook = server.workbooks.publish(new_workbook, args.filepath, overwrite_true, as_job=args.as_job)
+                print("Workbook published. ID: {0}".format(new_workbook.id))
         else:
             error = "The default project could not be found."
             raise LookupError(error)

tableauserverclient/models/job_item.py

@@ -1,11 +1,13 @@
 import xml.etree.ElementTree as ET
 from .target import Target
+from ..datetime_helpers import parse_datetime
 
 
 class JobItem(object):
-    def __init__(self, id_, job_type, created_at, started_at=None, completed_at=None, finish_code=0):
+    def __init__(self, id_, job_type, progress, created_at, started_at=None, completed_at=None, finish_code=0):
         self._id = id_
         self._type = job_type
+        self._progress = progress
         self._created_at = created_at
         self._started_at = started_at
         self._completed_at = completed_at
@@ -19,6 +21,10 @@ def id(self):
     def type(self):
         return self._type
 
+    @property
+    def progress(self):
+        return self._progress
+
     @property
     def created_at(self):
         return self._created_at
@@ -37,7 +43,7 @@ def finish_code(self):
 
     def __repr__(self):
         return "<Job#{_id} {_type} created_at({_created_at}) started_at({_started_at}) completed_at({_completed_at})" \
-               " finish_code({_finish_code})>".format(**self.__dict__)
+               " progress ({_progress}) finish_code({_finish_code})>".format(**self.__dict__)
 
     @classmethod
     def from_response(cls, xml, ns):
@@ -53,8 +59,9 @@ def from_response(cls, xml, ns):
     def _parse_element(cls, element, ns):
         id_ = element.get('id', None)
         type_ = element.get('type', None)
-        created_at = element.get('createdAt', None)
-        started_at = element.get('startedAt', None)
-        completed_at = element.get('completedAt', None)
+        progress = element.get('progress', None)
+        created_at = parse_datetime(element.get('createdAt', None))
+        started_at = parse_datetime(element.get('startedAt', None))
+        completed_at = parse_datetime(element.get('completedAt', None))
         finish_code = element.get('finishCode', -1)
-        return cls(id_, type_, created_at, started_at, completed_at, finish_code)
+        return cls(id_, type_, progress, created_at, started_at, completed_at, finish_code)

tableauserverclient/server/endpoint/datasources_endpoint.py

@@ -151,7 +151,8 @@ def refresh(self, datasource_item):
 
     # Publish datasource
     @api(version="2.0")
-    def publish(self, datasource_item, file_path, mode, connection_credentials=None):
+    @parameter_added_in(as_job='3.0')
+    def publish(self, datasource_item, file_path, mode, connection_credentials=None, as_job=False):
         if not os.path.isfile(file_path):
             error = "File path does not lead to an existing file."
             raise IOError(error)
@@ -174,6 +175,9 @@ def publish(self, datasource_item, file_path, mode, connection_credentials=None)
         if mode == self.parent_srv.PublishMode.Overwrite or mode == self.parent_srv.PublishMode.Append:
             url += '&{0}=true'.format(mode.lower())
 
+        if as_job:
+            url += '&{0}=true'.format('asJob')
+
         # Determine if chunking is required (64MB is the limit for single upload method)
         if os.path.getsize(file_path) >= FILESIZE_LIMIT:
             logger.info('Publishing {0} to server with chunking method (datasource over 64MB)'.format(filename))
@@ -190,6 +194,12 @@ def publish(self, datasource_item, file_path, mode, connection_credentials=None)
                                                                               file_contents,
                                                                               connection_credentials)
         server_response = self.post_request(url, xml_request, content_type)
-        new_datasource = DatasourceItem.from_response(server_response.content, self.parent_srv.namespace)[0]
-        logger.info('Published {0} (ID: {1})'.format(filename, new_datasource.id))
-        return new_datasource
+
+        if as_job:
+            new_job = JobItem.from_response(server_response.content, self.parent_srv.namespace)[0]
+            logger.info('Published {0} (JOB_ID: {1}'.format(filename, new_job.id))
+            return new_job
+        else:
+            new_datasource = DatasourceItem.from_response(server_response.content, self.parent_srv.namespace)[0]
+            logger.info('Published {0} (ID: {1})'.format(filename, new_datasource.id))
+            return new_datasource

tableauserverclient/server/endpoint/workbooks_endpoint.py

@@ -199,7 +199,8 @@ def _get_wb_preview_image(self, workbook_item):
 
     # Publishes workbook. Chunking method if file over 64MB
     @api(version="2.0")
-    def publish(self, workbook_item, file_path, mode, connection_credentials=None):
+    @parameter_added_in(as_job='3.0')
+    def publish(self, workbook_item, file_path, mode, connection_credentials=None, as_job=False):
         if not os.path.isfile(file_path):
             error = "File path does not lead to an existing file."
             raise IOError(error)
@@ -225,6 +226,9 @@ def publish(self, workbook_item, file_path, mode, connection_credentials=None):
             error = 'Workbooks cannot be appended.'
             raise ValueError(error)
 
+        if as_job:
+            url += '&{0}=true'.format('asJob')
+
         # Determine if chunking is required (64MB is the limit for single upload method)
         if os.path.getsize(file_path) >= FILESIZE_LIMIT:
             logger.info('Publishing {0} to server with chunking method (workbook over 64MB)'.format(filename))
@@ -241,6 +245,11 @@ def publish(self, workbook_item, file_path, mode, connection_credentials=None):
                                                                             file_contents,
                                                                             connection_credentials)
         server_response = self.post_request(url, xml_request, content_type)
-        new_workbook = WorkbookItem.from_response(server_response.content, self.parent_srv.namespace)[0]
-        logger.info('Published {0} (ID: {1})'.format(filename, new_workbook.id))
-        return new_workbook
+        if as_job:
+            new_job = JobItem.from_response(server_response.content, self.parent_srv.namespace)[0]
+            logger.info('Published {0} (JOB_ID: {1}'.format(filename, new_job.id))
+            return new_job
+        else:
+            new_workbook = WorkbookItem.from_response(server_response.content, self.parent_srv.namespace)[0]
+            logger.info('Published {0} (ID: {1})'.format(filename, new_workbook.id))
+            return new_workbook

test/assets/datasource_publish_async.xml

@@ -0,0 +1,4 @@
+<?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.0.xsd">
+	<job id="9a373058-af5f-4f83-8662-98b3e0228a73" mode="Asynchronous" type="PublishDatasource" progress="0" createdAt="2018-06-30T00:54:54Z" finishCode="1"/>
+</tsResponse>

test/assets/workbook_publish_async.xml

@@ -0,0 +1,4 @@
+<?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.0.xsd">
+	<job id="7c3d599e-949f-44c3-94a1-f30ba85757e4" mode="Asynchronous" type="PublishWorkbook" progress="0" createdAt="2018-06-29T23:22:32Z" finishCode="1"/>
+</tsResponse>

test/test_datasource.py

@@ -11,6 +11,7 @@
 GET_BY_ID_XML = 'datasource_get_by_id.xml'
 POPULATE_CONNECTIONS_XML = 'datasource_populate_connections.xml'
 PUBLISH_XML = 'datasource_publish.xml'
+PUBLISH_XML_ASYNC = 'datasource_publish_async.xml'
 UPDATE_XML = 'datasource_update.xml'
 UPDATE_CONNECTION_XML = 'datasource_connection_update.xml'
 
@@ -172,9 +173,11 @@ def test_publish(self):
         with requests_mock.mock() as m:
             m.post(self.baseurl, text=response_xml)
             new_datasource = TSC.DatasourceItem('SampleDS', 'ee8c6e70-43b6-11e6-af4f-f7b0d8e20760')
+            publish_mode = self.server.PublishMode.CreateNew
+
             new_datasource = self.server.datasources.publish(new_datasource,
                                                              asset('SampleDS.tds'),
-                                                             mode=self.server.PublishMode.CreateNew)
+                                                             mode=publish_mode)
 
         self.assertEqual('e76a1461-3b1d-4588-bf1b-17551a879ad9', new_datasource.id)
         self.assertEqual('SampleDS', new_datasource.name)
@@ -186,6 +189,24 @@ def test_publish(self):
         self.assertEqual('default', new_datasource.project_name)
         self.assertEqual('5de011f8-5aa9-4d5b-b991-f462c8dd6bb7', new_datasource.owner_id)
 
+    def test_publish_async(self):
+        response_xml = read_xml_asset(PUBLISH_XML_ASYNC)
+        with requests_mock.mock() as m:
+            m.post(self.baseurl, text=response_xml)
+            new_datasource = TSC.DatasourceItem('SampleDS', 'ee8c6e70-43b6-11e6-af4f-f7b0d8e20760')
+            publish_mode = self.server.PublishMode.CreateNew
+
+            new_job = self.server.datasources.publish(new_datasource,
+                                                      asset('SampleDS.tds'),
+                                                      mode=publish_mode,
+                                                      as_job=True)
+
+        self.assertEqual('9a373058-af5f-4f83-8662-98b3e0228a73', new_job.id)
+        self.assertEqual('PublishDatasource', new_job.type)
+        self.assertEqual('0', new_job.progress)
+        self.assertEqual('2018-06-30T00:54:54Z', format_datetime(new_job.created_at))
+        self.assertEqual('1', new_job.finish_code)
+
     def test_delete(self):
         with requests_mock.mock() as m:
             m.delete(self.baseurl + '/9dbd2263-16b5-46e1-9c43-a76bb8ab65fb', status_code=204)

test/test_workbook.py

@@ -15,6 +15,7 @@
 POPULATE_VIEWS_XML = os.path.join(TEST_ASSET_DIR, 'workbook_populate_views.xml')
 POPULATE_VIEWS_USAGE_XML = os.path.join(TEST_ASSET_DIR, 'workbook_populate_views_usage.xml')
 PUBLISH_XML = os.path.join(TEST_ASSET_DIR, 'workbook_publish.xml')
+PUBLISH_ASYNC_XML = os.path.join(TEST_ASSET_DIR, 'workbook_publish_async.xml')
 UPDATE_XML = os.path.join(TEST_ASSET_DIR, 'workbook_update.xml')
 
 
@@ -285,10 +286,17 @@ def test_publish(self):
             response_xml = f.read().decode('utf-8')
         with requests_mock.mock() as m:
             m.post(self.baseurl, text=response_xml)
-            new_workbook = TSC.WorkbookItem(name='Sample', show_tabs=False,
+
+            new_workbook = TSC.WorkbookItem(name='Sample',
+                                            show_tabs=False,
                                             project_id='ee8c6e70-43b6-11e6-af4f-f7b0d8e20760')
-            new_workbook = self.server.workbooks.publish(new_workbook, os.path.join(TEST_ASSET_DIR, 'SampleWB.twbx'),
-                                                         self.server.PublishMode.CreateNew)
+
+            sample_workbok = os.path.join(TEST_ASSET_DIR, 'SampleWB.twbx')
+            publish_mode = self.server.PublishMode.CreateNew
+
+            new_workbook = self.server.workbooks.publish(new_workbook,
+                                                         sample_workbok,
+                                                         publish_mode)
 
         self.assertEqual('a8076ca1-e9d8-495e-bae6-c684dbb55836', new_workbook.id)
         self.assertEqual('RESTAPISample', new_workbook.name)
@@ -304,10 +312,34 @@ def test_publish(self):
         self.assertEqual('GDP per capita', new_workbook.views[0].name)
         self.assertEqual('RESTAPISample_0/sheets/GDPpercapita', new_workbook.views[0].content_url)
 
+    def test_publish_async(self):
+        with open(PUBLISH_ASYNC_XML, 'rb') as f:
+            response_xml = f.read().decode('utf-8')
+        with requests_mock.mock() as m:
+            m.post(self.baseurl, text=response_xml)
+
+            new_workbook = TSC.WorkbookItem(name='Sample',
+                                            show_tabs=False,
+                                            project_id='ee8c6e70-43b6-11e6-af4f-f7b0d8e20760')
+
+            sample_workbok = os.path.join(TEST_ASSET_DIR, 'SampleWB.twbx')
+            publish_mode = self.server.PublishMode.CreateNew
+
+            new_job = self.server.workbooks.publish(new_workbook,
+                                                    sample_workbok,
+                                                    publish_mode,
+                                                    as_job=True)
+
+        self.assertEqual('7c3d599e-949f-44c3-94a1-f30ba85757e4', new_job.id)
+        self.assertEqual('PublishWorkbook', new_job.type)
+        self.assertEqual('0', new_job.progress)
+        self.assertEqual('2018-06-29T23:22:32Z', format_datetime(new_job.created_at))
+        self.assertEqual('1', new_job.finish_code)
+
     def test_publish_invalid_file(self):
         new_workbook = TSC.WorkbookItem('test', 'ee8c6e70-43b6-11e6-af4f-f7b0d8e20760')
-        self.assertRaises(IOError, self.server.workbooks.publish, new_workbook,
-                          '.', self.server.PublishMode.CreateNew)
+        self.assertRaises(IOError, self.server.workbooks.publish, new_workbook, '.',
+                          self.server.PublishMode.CreateNew)
 
     def test_publish_invalid_file_type(self):
         new_workbook = TSC.WorkbookItem('test', 'ee8c6e70-43b6-11e6-af4f-f7b0d8e20760')