feat: run linked task now

Author: jorwoods

tableauserverclient/models/linked_tasks_item.py

@@ -1,6 +1,9 @@
+import datetime as dt
 from typing import List, Optional
+
 from defusedxml.ElementTree import fromstring
 
+from tableauserverclient.datetime_helpers import parse_datetime
 from tableauserverclient.models.schedule_item import ScheduleItem
 
 
@@ -74,5 +77,26 @@ def _parse_element(cls, xml, namespace) -> List["LinkedTaskFlowRunItem"]:
         return all_tasks
 
 
+class LinkedTaskJobItem:
+    def __init__(self) -> None:
+        self.id: Optional[str] = None
+        self.linked_task_id: Optional[str] = None
+        self.status: Optional[str] = None
+        self.created_at: Optional[dt.datetime] = None
+
+    @classmethod
+    def from_response(cls, resp: bytes, namespace) -> "LinkedTaskJobItem":
+        parsed_response = fromstring(resp)
+        job = cls()
+        job_xml = parsed_response.find(".//t:linkedTaskJob[@id]", namespaces=namespace)
+        if job_xml is None:
+            raise ValueError("No linked task job found in response")
+        job.id = job_xml.get("id")
+        job.linked_task_id = job_xml.get("linkedTaskId")
+        job.status = job_xml.get("status")
+        job.created_at = parse_datetime(job_xml.get("createdAt"))
+        return job
+
+
 def string_to_bool(s: str) -> bool:
     return s.lower() == "true"

tableauserverclient/server/endpoint/linked_tasks_endpoint.py

@@ -1,9 +1,10 @@
 from typing import List, Optional, Tuple, Union
 
 from tableauserverclient.helpers.logging import logger
-from tableauserverclient.models.linked_tasks_item import LinkedTaskItem
+from tableauserverclient.models.linked_tasks_item import LinkedTaskItem, LinkedTaskJobItem
 from tableauserverclient.models.pagination_item import PaginationItem
 from tableauserverclient.server.endpoint.endpoint import QuerysetEndpoint, api
+from tableauserverclient.server.request_factory import RequestFactory
 from tableauserverclient.server.request_options import RequestOptions
 
 
@@ -33,3 +34,12 @@ def get_by_id(self, linked_task: Union[LinkedTaskItem, str]) -> LinkedTaskItem:
         server_response = self.get_request(url)
         all_group_items = LinkedTaskItem.from_response(server_response.content, self.parent_srv.namespace)
         return all_group_items[0]
+
+    @api(version="3.15")
+    def run_now(self, linked_task: Union[LinkedTaskItem, str]) -> LinkedTaskJobItem:
+        task_id = getattr(linked_task, "id", linked_task)
+        logger.info(f"Running linked task {task_id} now")
+        url = f"{self.baseurl}/{task_id}/runNow"
+        empty_req = RequestFactory.Empty.empty_req()
+        server_response = self.post_request(url, empty_req)
+        return LinkedTaskJobItem.from_response(server_response.content, self.parent_srv.namespace)

test/assets/linked_tasks_run_now.xml

@@ -0,0 +1,7 @@
+<?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.5.xsd">
+<linkedTaskJob id="269a1e5a-1220-4a13-ac01-704982693dd8"
+    linkedTaskId="1b8211dc-51a8-45ce-a831-b5921708e03e"
+    status="InProgress"
+    createdAt="2022-02-15T00:22:22Z"/>
+  </tsResponse>

test/test_linked_tasks.py

@@ -6,11 +6,13 @@
 import requests_mock
 
 import tableauserverclient as TSC
+from tableauserverclient.datetime_helpers import parse_datetime
 from tableauserverclient.models.linked_tasks_item import LinkedTaskItem, LinkedTaskStepItem, LinkedTaskFlowRunItem
 
 asset_dir = (Path(__file__).parent / "assets").resolve()
 
 GET_LINKED_TASKS = asset_dir / "linked_tasks_get.xml"
+RUN_LINKED_TASK_NOW = asset_dir / "linked_tasks_run_now.xml"
 
 
 class TestLinkedTasks(unittest.TestCase):
@@ -99,3 +101,29 @@ def test_get_by_id_obj_linked_task(self):
         assert task.num_steps == 1
         assert task.schedule is not None
         assert task.schedule.id == "be077332-d01d-481b-b2f3-917e463d4dca"
+
+    def test_run_now_str_linked_task(self):
+        id_ = "1b8211dc-51a8-45ce-a831-b5921708e03e"
+
+        with requests_mock.mock() as m:
+            m.post(f"{self.baseurl}/{id_}/runNow", text=RUN_LINKED_TASK_NOW.read_text())
+            job = self.server.linked_tasks.run_now(id_)
+
+        assert job.id == "269a1e5a-1220-4a13-ac01-704982693dd8"
+        assert job.status == "InProgress"
+        assert job.created_at == parse_datetime("2022-02-15T00:22:22Z")
+        assert job.linked_task_id == id_
+
+    def test_run_now_obj_linked_task(self):
+        id_ = "1b8211dc-51a8-45ce-a831-b5921708e03e"
+        in_task = LinkedTaskItem()
+        in_task.id = id_
+
+        with requests_mock.mock() as m:
+            m.post(f"{self.baseurl}/{id_}/runNow", text=RUN_LINKED_TASK_NOW.read_text())
+            job = self.server.linked_tasks.run_now(in_task)
+
+        assert job.id == "269a1e5a-1220-4a13-ac01-704982693dd8"
+        assert job.status == "InProgress"
+        assert job.created_at == parse_datetime("2022-02-15T00:22:22Z")
+        assert job.linked_task_id == id_