Merge branch 'jorwoods/test_datasource_style' into jorwoods/pytestify_ssl

Author: jorwoods

CODEOWNERS

@@ -0,0 +1,2 @@
+#ECCN:Open Source
+#GUSINFO:Open Source,Open Source Workflow

tableauserverclient/models/datasource_item.py

@@ -535,13 +535,15 @@ def _parse_element(datasource_xml: ET.Element, ns: dict) -> tuple:
 
         project_id = None
         project_name = None
+        project = None
         project_elem = datasource_xml.find(".//t:project", namespaces=ns)
         if project_elem is not None:
             project = ProjectItem.from_xml(project_elem, ns)
             project_id = project_elem.get("id", None)
             project_name = project_elem.get("name", None)
 
         owner_id = None
+        owner = None
         owner_elem = datasource_xml.find(".//t:owner", namespaces=ns)
         if owner_elem is not None:
             owner = UserItem.from_xml(owner_elem, ns)

tableauserverclient/server/request_factory.py

@@ -184,6 +184,9 @@ def _generate_xml(self, datasource_item: DatasourceItem, connection_credentials=
             project_element = ET.SubElement(datasource_element, "project")
             project_element.attrib["id"] = datasource_item.project_id
 
+        if datasource_item.description is not None:
+            datasource_element.attrib["description"] = datasource_item.description
+
         if connection_credentials is not None and connections is not None:
             raise RuntimeError("You cannot set both `connections` and `connection_credentials`")
 
@@ -196,7 +199,7 @@ def _generate_xml(self, datasource_item: DatasourceItem, connection_credentials=
                 _add_connections_element(connections_element, connection)
         return ET.tostring(xml_request)
 
-    def update_req(self, datasource_item):
+    def update_req(self, datasource_item: DatasourceItem) -> bytes:
         xml_request = ET.Element("tsRequest")
         datasource_element = ET.SubElement(xml_request, "datasource")
         if datasource_item.name:
@@ -219,6 +222,8 @@ def update_req(self, datasource_item):
             datasource_element.attrib["certificationNote"] = str(datasource_item.certification_note)
         if datasource_item.encrypt_extracts is not None:
             datasource_element.attrib["encryptExtracts"] = str(datasource_item.encrypt_extracts).lower()
+        if datasource_item.description is not None:
+            datasource_element.attrib["description"] = datasource_item.description
 
         return ET.tostring(xml_request)
 

test/assets/datasource_get_no_owner.xml

@@ -0,0 +1,16 @@
+<?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">
+    <pagination pageNumber="1" pageSize="100" totalAvailable="2" />
+    <datasources>
+        <datasource id="e76a1461-3b1d-4588-bf1b-17551a879ad9" name="SampleDS" size="4096" contentUrl="SampleDS" description="SampleDsDescription" type="dataengine" createdAt="2016-08-11T21:22:40Z" updatedAt="2016-08-11T21:34:17Z" encryptExtracts="false" hasExtracts="true" useRemoteQueryAgent="false" webpageUrl="https://web.com">
+            <tags />
+        </datasource>
+        <datasource id="9dbd2263-16b5-46e1-9c43-a76bb8ab65fb" name="Sample datasource" description="description Sample" size="10240" contentUrl="Sampledatasource" type="dataengine" createdAt="2016-08-04T21:31:55Z" updatedAt="2016-08-04T21:31:55Z" encryptExtracts="true" hasExtracts="false" useRemoteQueryAgent="true" webpageUrl="https://page.com">
+            <tags>
+                <tag label="world" />
+                <tag label="indicators" />
+                <tag label="sample" />
+            </tags>
+        </datasource>
+    </datasources>
+</tsResponse>

test/test_datasource.py

@@ -24,6 +24,7 @@
 GET_EMPTY_XML = TEST_ASSET_DIR / "datasource_get_empty.xml"
 GET_BY_ID_XML = TEST_ASSET_DIR / "datasource_get_by_id.xml"
 GET_XML_ALL_FIELDS = TEST_ASSET_DIR / "datasource_get_all_fields.xml"
+GET_NO_OWNER = TEST_ASSET_DIR / "datasource_get_no_owner.xml"
 POPULATE_CONNECTIONS_XML = TEST_ASSET_DIR / "datasource_populate_connections.xml"
 POPULATE_PERMISSIONS_XML = TEST_ASSET_DIR / "datasource_populate_permissions.xml"
 PUBLISH_XML = TEST_ASSET_DIR / "datasource_publish.xml"
@@ -850,3 +851,57 @@ def test_get_datasource_all_fields(server) -> None:
     assert datasources[0].owner.last_login == parse_datetime("2025-02-04T06:39:20Z")
     assert datasources[0].owner.name == "[email protected]"
     assert datasources[0].owner.site_role == "SiteAdministratorCreator"
+
+
+def test_update_description(server: TSC.Server) -> None:
+    response_xml = UPDATE_XML.read_text()
+    with requests_mock.mock() as m:
+        m.put(server.datasources.baseurl + "/9dbd2263-16b5-46e1-9c43-a76bb8ab65fb", text=response_xml)
+        single_datasource = TSC.DatasourceItem("1d0304cd-3796-429f-b815-7258370b9b74", "Sample datasource")
+        single_datasource.owner_id = "dd2239f6-ddf1-4107-981a-4cf94e415794"
+        single_datasource._content_url = "Sampledatasource"
+        single_datasource._id = "9dbd2263-16b5-46e1-9c43-a76bb8ab65fb"
+        single_datasource.certified = True
+        single_datasource.certification_note = "Warning, here be dragons."
+        single_datasource.description = "Sample description"
+        _ = server.datasources.update(single_datasource)
+
+        history = m.request_history[0]
+    body = fromstring(history.body)
+    ds_elem = body.find(".//datasource")
+    assert ds_elem is not None
+    assert ds_elem.attrib["description"] == "Sample description"
+
+
+def test_publish_description(server: TSC.Server) -> None:
+    response_xml = PUBLISH_XML.read_text()
+    with requests_mock.mock() as m:
+        m.post(server.datasources.baseurl, text=response_xml)
+        single_datasource = TSC.DatasourceItem("1d0304cd-3796-429f-b815-7258370b9b74", "Sample datasource")
+        single_datasource.owner_id = "dd2239f6-ddf1-4107-981a-4cf94e415794"
+        single_datasource._content_url = "Sampledatasource"
+        single_datasource._id = "9dbd2263-16b5-46e1-9c43-a76bb8ab65fb"
+        single_datasource.certified = True
+        single_datasource.certification_note = "Warning, here be dragons."
+        single_datasource.description = "Sample description"
+        _ = server.datasources.publish(single_datasource, TEST_ASSET_DIR / "SampleDS.tds", server.PublishMode.CreateNew)
+
+        history = m.request_history[0]
+    boundary = history.body[: history.body.index(b"\r\n")].strip()
+    parts = history.body.split(boundary)
+    request_payload = next(part for part in parts if b"request_payload" in part)
+    xml_payload = request_payload.strip().split(b"\r\n")[-1]
+    body = fromstring(xml_payload)
+    ds_elem = body.find(".//datasource")
+    assert ds_elem is not None
+    assert ds_elem.attrib["description"] == "Sample description"
+
+
+def test_get_datasource_no_owner(server: TSC.Server) -> None:
+    with requests_mock.mock() as m:
+        m.get(server.datasources.baseurl, text=GET_NO_OWNER.read_text())
+        datasources, _ = server.datasources.get()
+
+    datasource = datasources[0]
+    assert datasource.owner is None
+    assert datasource.project is None