feat: support updating server extension settings

Author: jorwoods

tableauserverclient/server/endpoint/extensions_endpoint.py

@@ -1,6 +1,7 @@
 from tableauserverclient.models.extensions_item import ExtensionsServer
 from tableauserverclient.server.endpoint.endpoint import Endpoint
 from tableauserverclient.server.endpoint.endpoint import api
+from tableauserverclient.server.request_factory import RequestFactory
 
 
 class Extensions(Endpoint):
@@ -22,3 +23,21 @@ def get_server_settings(self) -> ExtensionsServer:
         """
         response = self.get_request(self._server_baseurl)
         return ExtensionsServer.from_response(response.content, self.parent_srv.namespace)
+
+    @api(version="3.21")
+    def update_server_settings(self, extensions_server: ExtensionsServer) -> ExtensionsServer:
+        """Updates the settings for extensions of a server
+
+        Parameters
+        ----------
+        extensions_server : ExtensionsServer
+            The server extensions settings to update
+
+        Returns
+        -------
+        ExtensionsServer
+            The updated server extensions settings
+        """
+        req = RequestFactory.Extensions.update_server_extensions(extensions_server)
+        response = self.put_request(self._server_baseurl, req)
+        return ExtensionsServer.from_response(response.content, self.parent_srv.namespace)

tableauserverclient/server/request_factory.py

@@ -1624,6 +1624,23 @@ def update_req(self, xml_request: ET.Element, oidc_item: SiteOIDCConfiguration)
         return ET.tostring(xml_request)
 
 
+class ExtensionsRequest:
+    @_tsrequest_wrapped
+    def update_server_extensions(self, xml_request: ET.Element, extensions_server: "ExtensionsServer") -> None:
+        extensions_element = ET.SubElement(xml_request, "extensionsServerSettings")
+        if not isinstance(extensions_server.enabled, bool):
+            raise ValueError(f"Extensions Server missing enabled: {extensions_server}")
+        enabled_element = ET.SubElement(extensions_element, "extensionsGloballyEnabled")
+        enabled_element.text = str(extensions_server.enabled).lower()
+
+        if extensions_server.block_list is None:
+            return
+        for blocked in extensions_server.block_list:
+            blocked_element = ET.SubElement(extensions_element, "blockList")
+            blocked_element.text = blocked
+        return
+
+
 class RequestFactory:
     Auth = AuthRequest()
     Connection = Connection()
@@ -1634,6 +1651,7 @@ class RequestFactory:
     Database = DatabaseRequest()
     DQW = DQWRequest()
     Empty = EmptyRequest()
+    Extensions = ExtensionsRequest()
     Favorite = FavoriteRequest()
     Fileupload = FileuploadRequest()
     Flow = FlowRequest()

test/test_extensions.py

@@ -0,0 +1,59 @@
+from pathlib import Path
+
+import requests_mock
+import pytest
+
+import tableauserverclient as TSC
+
+
+TEST_ASSET_DIR = Path(__file__).parent / "assets"
+
+GET_SERVER_EXT_SETTINGS = TEST_ASSET_DIR / "extensions_server_settings_true.xml"
+GET_SERVER_EXT_SETTINGS_FALSE = TEST_ASSET_DIR / "extensions_server_settings_false.xml"
+
+
+@pytest.fixture(scope="function")
+def server() -> TSC.Server:
+    server = TSC.Server("http://test", False)
+
+    # Fake sign in
+    server._site_id = "dad65087-b08b-4603-af4e-2887b8aafc67"
+    server._auth_token = "j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM"
+    server.version = "3.21"
+
+    return server
+
+
+def test_get_server_extensions_settings(server: TSC.Server) -> None:
+    with requests_mock.mock() as m:
+        m.get(server.extensions._server_baseurl, text=GET_SERVER_EXT_SETTINGS.read_text())
+        ext_settings = server.extensions.get_server_settings()
+
+    assert ext_settings.enabled is True
+    assert ext_settings.block_list is not None
+    assert set(ext_settings.block_list) == {"https://test.com", "https://example.com"}
+
+
+def test_get_server_extensions_settings_false(server: TSC.Server) -> None:
+    with requests_mock.mock() as m:
+        m.get(server.extensions._server_baseurl, text=GET_SERVER_EXT_SETTINGS_FALSE.read_text())
+        ext_settings = server.extensions.get_server_settings()
+
+    assert ext_settings.enabled is False
+    assert ext_settings.block_list is not None
+    assert len(ext_settings.block_list) == 0
+
+
+def test_update_server_extensions_settings(server: TSC.Server) -> None:
+    with requests_mock.mock() as m:
+        m.put(server.extensions._server_baseurl, text=GET_SERVER_EXT_SETTINGS_FALSE.read_text())
+
+        ext_settings = TSC.ExtensionsServer()
+        ext_settings.enabled = False
+        ext_settings.block_list = []
+
+        updated_settings = server.extensions.update_server_settings(ext_settings)
+
+    assert updated_settings.enabled is False
+    assert updated_settings.block_list is not None
+    assert len(updated_settings.block_list) == 0