add timeout for API calls

Author: saklar13

cloudshell/rest/api.py

@@ -19,13 +19,16 @@
 from cloudshell.rest.models import ShellInfo, StandardInfo
 from cloudshell.rest.progress_bar import iter_resp_with_pb, upload_with_pb
 
+DEFAULT_API_TIMEOUT = 15
+
 
 @define
 class PackagingRestApiClient:
     host: str
     _token: str = field(repr=False)
     port: int = 9000
     _show_progress: bool = field(default=False, repr=False)
+    _api_timeout: int = field(default=DEFAULT_API_TIMEOUT, repr=False)
     _api_url: str = field(init=False)
     _headers: dict[str, str] = field(init=False)
 
@@ -42,20 +45,23 @@ def login(
         domain: str = "Global",
         port: int = 9000,
         show_progress: bool = False,
+        api_timeout: int = DEFAULT_API_TIMEOUT,
     ) -> Self:
         url = urljoin(_get_api_url(host, port), "Auth/Login")
         req_data = {
             "username": username,
             "password": password,
             "domain": domain,
         }
-        resp = requests.put(url, data=req_data)
+        resp = requests.put(url, data=req_data, timeout=api_timeout)
         if resp.status_code == 401:
             raise LoginFailedError(resp.text)
         elif resp.status_code != 200:
             raise PackagingRestApiError(resp.text)
         token = resp.text.strip("'\"")
-        return cls(host, token, port, show_progress=show_progress)
+        return cls(
+            host, token, port, show_progress=show_progress, api_timeout=api_timeout
+        )
 
     def add_shell_from_buffer(self, file_obj: BinaryIO | bytes) -> None:
         """Add a new Shell from the buffer or binary."""
@@ -64,7 +70,9 @@ def add_shell_from_buffer(self, file_obj: BinaryIO | bytes) -> None:
         headers = self._headers.copy()
 
         with upload_with_pb(req_data, headers, show=self._show_progress) as new_data:
-            resp = requests.post(url, data=new_data, headers=headers)
+            resp = requests.post(
+                url, data=new_data, headers=headers, timeout=self._api_timeout
+            )
 
         if resp.status_code != 201:
             msg = f"Can't add shell, response: {resp.text}"
@@ -87,7 +95,9 @@ def update_shell_from_buffer(
         headers = self._headers.copy()
 
         with upload_with_pb(req_data, headers, show=self._show_progress) as new_data:
-            resp = requests.put(url, data=new_data, headers=headers)
+            resp = requests.put(
+                url, data=new_data, headers=headers, timeout=self._api_timeout
+            )
 
         if resp.status_code == 404:
             raise ShellNotFound()
@@ -106,7 +116,7 @@ def update_shell(
     def get_installed_standards(self) -> list[dict]:
         """Gets all standards installed on CloudShell."""
         url = urljoin(self._api_url, "Standards")
-        resp = requests.get(url, headers=self._headers)
+        resp = requests.get(url, headers=self._headers, timeout=self._api_timeout)
         if resp.status_code == 404:
             raise FeatureUnavailable()
         elif resp.status_code != 200:
@@ -120,7 +130,7 @@ def get_installed_standards_as_models(self) -> list[StandardInfo]:
     def get_shell(self, shell_name: str) -> dict:
         """Get a Shell's information."""
         url = urljoin(self._api_url, f"Shells/{shell_name}")
-        resp = requests.get(url, headers=self._headers)
+        resp = requests.get(url, headers=self._headers, timeout=self._api_timeout)
         if resp.status_code == 404:
             raise FeatureUnavailable()
         elif resp.status_code == 400:
@@ -136,7 +146,7 @@ def get_shell_as_model(self, shell_name: str) -> ShellInfo:
     def delete_shell(self, shell_name: str) -> None:
         """Delete a Shell from the CloudShell."""
         url = urljoin(self._api_url, f"Shells/{shell_name}")
-        resp = requests.delete(url, headers=self._headers)
+        resp = requests.delete(url, headers=self._headers, timeout=self._api_timeout)
         if resp.status_code == 404:
             raise FeatureUnavailable()
         elif resp.status_code == 400:
@@ -148,7 +158,13 @@ def export_package(self, topologies: list[str]) -> Generator[bytes, None, None]:
         """Export a package with the topologies from the CloudShell."""
         url = urljoin(self._api_url, "Package/ExportPackage")
         req_data = {"TopologyNames": topologies}
-        resp = requests.post(url, headers=self._headers, json=req_data, stream=True)
+        resp = requests.post(
+            url,
+            headers=self._headers,
+            json=req_data,
+            stream=True,
+            timeout=self._api_timeout,
+        )
 
         if resp.status_code == 404:
             raise FeatureUnavailable()
@@ -172,7 +188,9 @@ def import_package_from_buffer(self, file_obj: BinaryIO | bytes) -> None:
         headers = self._headers.copy()
 
         with upload_with_pb(req_data, headers, show=self._show_progress) as new_data:
-            resp = requests.post(url, data=new_data, headers=headers)
+            resp = requests.post(
+                url, data=new_data, headers=headers, timeout=self._api_timeout
+            )
 
         if resp.status_code == 404:
             raise FeatureUnavailable()