Merge branch 'development' into jorwoods/combining_permissionsrules

Author: jacalata

pyproject.toml

@@ -32,7 +32,7 @@ classifiers = [
 repository = "https://github.com/tableau/server-client-python"
 
 [project.optional-dependencies]
-test = ["argparse", "black==23.7", "mock", "mypy==1.4", "pytest>=7.0", "pytest-cov", "pytest-subtests",
+test = ["black==23.7", "build", "mypy==1.4", "pytest>=7.0", "pytest-cov", "pytest-subtests",
     "requests-mock>=1.0,<2.0"]
 
 [tool.black]

tableauserverclient/models/datasource_item.py

@@ -47,6 +47,7 @@ def __init__(self, project_id: Optional[str] = None, name: Optional[str] = None)
         self._initial_tags: Set = set()
         self._project_name: Optional[str] = None
         self._revisions = None
+        self._size: Optional[int] = None
         self._updated_at = None
         self._use_remote_query_agent = None
         self._webpage_url = None
@@ -182,6 +183,10 @@ def revisions(self) -> List[RevisionItem]:
             raise UnpopulatedPropertyError(error)
         return self._revisions()
 
+    @property
+    def size(self) -> Optional[int]:
+        return self._size
+
     def _set_connections(self, connections):
         self._connections = connections
 
@@ -217,6 +222,7 @@ def _parse_common_elements(self, datasource_xml, ns):
                 updated_at,
                 use_remote_query_agent,
                 webpage_url,
+                size,
             ) = self._parse_element(datasource_xml, ns)
             self._set_values(
                 ask_data_enablement,
@@ -237,6 +243,7 @@ def _parse_common_elements(self, datasource_xml, ns):
                 updated_at,
                 use_remote_query_agent,
                 webpage_url,
+                size,
             )
         return self
 
@@ -260,6 +267,7 @@ def _set_values(
         updated_at,
         use_remote_query_agent,
         webpage_url,
+        size,
     ):
         if ask_data_enablement is not None:
             self._ask_data_enablement = ask_data_enablement
@@ -297,6 +305,8 @@ def _set_values(
             self._use_remote_query_agent = str(use_remote_query_agent).lower() == "true"
         if webpage_url:
             self._webpage_url = webpage_url
+        if size is not None:
+            self._size = int(size)
 
     @classmethod
     def from_response(cls, resp: str, ns: Dict) -> List["DatasourceItem"]:
@@ -330,6 +340,7 @@ def _parse_element(datasource_xml: ET.Element, ns: Dict) -> Tuple:
         has_extracts = datasource_xml.get("hasExtracts", None)
         use_remote_query_agent = datasource_xml.get("useRemoteQueryAgent", None)
         webpage_url = datasource_xml.get("webpageUrl", None)
+        size = datasource_xml.get("size", None)
 
         tags = None
         tags_elem = datasource_xml.find(".//t:tags", namespaces=ns)
@@ -372,4 +383,5 @@ def _parse_element(datasource_xml: ET.Element, ns: Dict) -> Tuple:
             updated_at,
             use_remote_query_agent,
             webpage_url,
+            size,
         )

tableauserverclient/server/request_factory.py

@@ -1061,8 +1061,13 @@ class Connection(object):
     @_tsrequest_wrapped
     def update_req(self, xml_request: ET.Element, connection_item: "ConnectionItem") -> None:
         connection_element = ET.SubElement(xml_request, "connection")
-        if connection_item.server_address is not None:
-            connection_element.attrib["serverAddress"] = connection_item.server_address.lower()
+        if (server_address := connection_item.server_address) is not None:
+            if (conn_type := connection_item.connection_type) is not None:
+                if conn_type.casefold() != "odata".casefold():
+                    server_address = server_address.lower()
+            else:
+                server_address = server_address.lower()
+            connection_element.attrib["serverAddress"] = server_address
         if connection_item.server_port is not None:
             connection_element.attrib["serverPort"] = str(connection_item.server_port)
         if connection_item.username is not None:

test/assets/datasource_get.xml

@@ -2,12 +2,12 @@
 <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" 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">
+        <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">
             <project id="ee8c6e70-43b6-11e6-af4f-f7b0d8e20760" name="default" />
             <owner id="5de011f8-5aa9-4d5b-b991-f462c8dd6bb7" />
             <tags />
         </datasource>
-        <datasource id="9dbd2263-16b5-46e1-9c43-a76bb8ab65fb" name="Sample datasource" description="description Sample" 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">
+        <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">
             <project id="ee8c6e70-43b6-11e6-af4f-f7b0d8e20760" name="default" />
             <owner id="5de011f8-5aa9-4d5b-b991-f462c8dd6bb7" />
             <tags>
@@ -17,4 +17,4 @@
             </tags>
         </datasource>
     </datasources>
-</tsResponse>
+</tsResponse>

test/assets/odata_connection.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 https://help.tableau.com/samples/en-us/rest_api/ts-api_3_23.xsd">
+    <connections>
+        <connection id="17376070-64d1-4d17-acb4-a56e4b5b1768" type="odata" embedPassword="false" serverAddress="https://odata.website.com/TestODataEndpoint" userName="" queryTaggingEnabled="false">
+            <datasource id="d82f784e-178f-4b7e-a723-d8f615155a42" name="People (services.odata.org/ODataPeopleService/People)"/>
+        </connection>
+    </connections>
+</tsResponse>

test/test_datasource.py

@@ -52,6 +52,7 @@ def test_get(self) -> None:
         self.assertEqual("dataengine", all_datasources[0].datasource_type)
         self.assertEqual("SampleDsDescription", all_datasources[0].description)
         self.assertEqual("SampleDS", all_datasources[0].content_url)
+        self.assertEqual(4096, all_datasources[0].size)
         self.assertEqual("2016-08-11T21:22:40Z", format_datetime(all_datasources[0].created_at))
         self.assertEqual("2016-08-11T21:34:17Z", format_datetime(all_datasources[0].updated_at))
         self.assertEqual("default", all_datasources[0].project_name)
@@ -67,6 +68,7 @@ def test_get(self) -> None:
         self.assertEqual("dataengine", all_datasources[1].datasource_type)
         self.assertEqual("description Sample", all_datasources[1].description)
         self.assertEqual("Sampledatasource", all_datasources[1].content_url)
+        self.assertEqual(10240, all_datasources[1].size)
         self.assertEqual("2016-08-04T21:31:55Z", format_datetime(all_datasources[1].created_at))
         self.assertEqual("2016-08-04T21:31:55Z", format_datetime(all_datasources[1].updated_at))
         self.assertEqual("default", all_datasources[1].project_name)

test/test_workbook.py

@@ -22,6 +22,7 @@
 GET_EMPTY_XML = os.path.join(TEST_ASSET_DIR, "workbook_get_empty.xml")
 GET_INVALID_DATE_XML = os.path.join(TEST_ASSET_DIR, "workbook_get_invalid_date.xml")
 GET_XML = os.path.join(TEST_ASSET_DIR, "workbook_get.xml")
+ODATA_XML = os.path.join(TEST_ASSET_DIR, "odata_connection.xml")
 POPULATE_CONNECTIONS_XML = os.path.join(TEST_ASSET_DIR, "workbook_populate_connections.xml")
 POPULATE_PDF = os.path.join(TEST_ASSET_DIR, "populate_pdf.pdf")
 POPULATE_POWERPOINT = os.path.join(TEST_ASSET_DIR, "populate_powerpoint.pptx")
@@ -944,3 +945,31 @@ def test_bad_download_response(self) -> None:
             )
             file_path = self.server.workbooks.download("9dbd2263-16b5-46e1-9c43-a76bb8ab65fb", td)
             self.assertTrue(os.path.exists(file_path))
+
+    def test_odata_connection(self) -> None:
+        self.baseurl = self.server.workbooks.baseurl
+        workbook = TSC.WorkbookItem("project", "test")
+        workbook._id = "06b944d2-959d-4604-9305-12323c95e70e"
+        connection = TSC.ConnectionItem()
+        url = "https://odata.website.com/TestODataEndpoint"
+        connection.server_address = url
+        connection._connection_type = "odata"
+        connection._id = "17376070-64d1-4d17-acb4-a56e4b5b1768"
+
+        creds = TSC.ConnectionCredentials("", "", True)
+        connection.connection_credentials = creds
+        with open(ODATA_XML, "rb") as f:
+            response_xml = f.read().decode("utf-8")
+
+        with requests_mock.mock() as m:
+            m.put(f"{self.baseurl}/{workbook.id}/connections/{connection.id}", text=response_xml)
+            self.server.workbooks.update_connection(workbook, connection)
+
+            history = m.request_history
+
+        request = history[0]
+        xml = fromstring(request.body)
+        xml_connection = xml.find(".//connection")
+
+        assert xml_connection is not None
+        self.assertEqual(xml_connection.get("serverAddress"), url)