appmesh 1.2.6__py3-none-any.whl → 1.3.0__py3-none-any.whl

appmesh/appmesh_client.py

@@ -13,7 +13,7 @@ import uuid
 from enum import Enum, unique
 from datetime import datetime
 from http import HTTPStatus
-from typing import Optional
+from typing import Optional, Tuple, final
 from urllib import parse
 
 import aniso8601
@@ -31,7 +31,11 @@ _SSL_CA_PEM_FILE = "/opt/appmesh/ssl/ca.pem"
 _SSL_CLIENT_PEM_FILE = "/opt/appmesh/ssl/client.pem"
 _SSL_CLIENT_PEM_KEY_FILE = "/opt/appmesh/ssl/client-key.pem"
 HTTP_USER_AGENT_HEADER_NAME = "User-Agent"
-HTTP_USER_AGENT = "appmeshsdk/py"
+HTTP_USER_AGENT = "appmesh/python"
+HTTP_USER_AGENT_TCP = "appmesh/python/tcp"
+HTTP_HEADER_KEY_X_SEND_FILE_SOCKET = "X-Send-File-Socket"
+HTTP_HEADER_KEY_X_RECV_FILE_SOCKET = "X-Recv-File-Socket"
+HTTP_HEADER_KEY_X_TARGET_HOST = "X-Target-Host"
 
 
 def _get_str_item(data: dict, key):
@@ -296,7 +300,7 @@ class App(object):
         return output
 
 
-class Run(object):
+class AppRun(object):
     """
     Application run object indicate to a remote run from run_async()
     """
@@ -397,6 +401,7 @@ class AppMeshClient(metaclass=abc.ABCMeta):
         self._jwt_token = token
 
     @property
+    @final
     def delegate_host(self) -> str:
         """property for delegate_host
 
@@ -406,6 +411,7 @@ class AppMeshClient(metaclass=abc.ABCMeta):
         return self._delegate_host
 
     @delegate_host.setter
+    @final
     def delegate_host(self, host: str) -> None:
         """setter for delegate_host
 
@@ -1241,13 +1247,13 @@ class AppMeshClient(metaclass=abc.ABCMeta):
         )
         if resp.status_code != HTTPStatus.OK:
             raise Exception(resp.text)
-        return Run(self, resp.json()["name"], resp.json()["process_uuid"])
+        return AppRun(self, resp.json()["name"], resp.json()["process_uuid"])
 
-    def run_async_wait(self, run: Run, stdout_print: bool = True, timeout: int = 0) -> int:
+    def run_async_wait(self, run: AppRun, stdout_print: bool = True, timeout: int = 0) -> int:
         """Wait for an async run to be finished
 
         Args:
-            run (Run): asyncrized run result from run_async().
+            run (AppRun): asyncrized run result from run_async().
             stdout_print (bool, optional): print remote stdout to local or not.
             timeout (int, optional): wait max timeout seconds and return if not finished, 0 means wait until finished
 
@@ -1282,7 +1288,7 @@ class AppMeshClient(metaclass=abc.ABCMeta):
         stdout_print: bool = True,
         max_time_seconds=DEFAULT_RUN_APP_TIMEOUT_SECONDS,
         life_cycle_seconds=DEFAULT_RUN_APP_LIFECYCLE_SECONDS,
-    ) -> int:
+    ) -> Tuple[int, str]:
         """Block run a command remotely, 'name' attribute in app_json dict used to run an existing application
         The synchronized run will block the process until the remote run is finished then return the result from HTTP response
 
@@ -1294,6 +1300,7 @@ class AppMeshClient(metaclass=abc.ABCMeta):
 
         Returns:
             int: process exit code, return None if no exit code.
+            str: stdout text
         """
         path = "/appmesh/app/syncrun"
         resp = self._request_http(
@@ -1310,7 +1317,7 @@ class AppMeshClient(metaclass=abc.ABCMeta):
                 exit_code = int(resp.headers.get("Exit-Code"))
         elif stdout_print:
             print(resp.text)
-        return exit_code
+        return exit_code, resp.text
 
     def _request_http(self, method: Method, path: str, query: dict = None, header: dict = None, body=None) -> requests.Response:
         """REST API
@@ -1332,9 +1339,9 @@ class AppMeshClient(metaclass=abc.ABCMeta):
             header["Authorization"] = "Bearer " + self.jwt_token
         if self.delegate_host and len(self.delegate_host) > 0:
             if ":" in self.delegate_host:
-                header["X-Target-Host"] = self.delegate_host
+                header[HTTP_HEADER_KEY_X_TARGET_HOST] = self.delegate_host
             else:
-                header["X-Target-Host"] = self.delegate_host + ":" + str(parse.urlsplit(self.server_url).port)
+                header[HTTP_HEADER_KEY_X_TARGET_HOST] = self.delegate_host + ":" + str(parse.urlsplit(self.server_url).port)
         header[HTTP_USER_AGENT_HEADER_NAME] = HTTP_USER_AGENT
 
         if method is AppMeshClient.Method.GET:
@@ -1499,11 +1506,8 @@ class AppMeshClientTCP(AppMeshClient):
         if super().jwt_token:
             appmesh_requst.headers["Authorization"] = "Bearer " + super().jwt_token
         if super().delegate_host and len(super().delegate_host) > 0:
-            if ":" in super().delegate_host:
-                appmesh_requst.headers["X-Target-Host"] = super().delegate_host
-            else:
-                appmesh_requst.headers["X-Target-Host"] = super().delegate_host + ":" + str(parse.urlsplit(self.server_url).port)
-        appmesh_requst.headers[HTTP_USER_AGENT_HEADER_NAME] = HTTP_USER_AGENT
+            raise Exception("Not support delegate request in TCP mode")
+        appmesh_requst.headers[HTTP_USER_AGENT_HEADER_NAME] = HTTP_USER_AGENT_TCP
         appmesh_requst.uuid = str(uuid.uuid1())
         appmesh_requst.http_method = method.value
         appmesh_requst.request_uri = path
@@ -1524,13 +1528,13 @@ class AppMeshClientTCP(AppMeshClient):
             for k, v in query.items():
                 appmesh_requst.querys[k] = v
         data = appmesh_requst.serialize()
-        self.__socket_client.sendall(len(data).to_bytes(TCP_MESSAGE_HEADER_LENGTH, "big", signed=False))
+        self.__socket_client.sendall(len(data).to_bytes(TCP_MESSAGE_HEADER_LENGTH, byteorder="big", signed=False))
         self.__socket_client.sendall(data)
 
         # https://developers.google.com/protocol-buffers/docs/pythontutorial
         # https://stackoverflow.com/questions/33913308/socket-module-how-to-send-integer
         resp_data = bytes()
-        resp_data = self.__recvall(int.from_bytes(self.__recvall(TCP_MESSAGE_HEADER_LENGTH), "big", signed=False))
+        resp_data = self.__recvall(int.from_bytes(self.__recvall(TCP_MESSAGE_HEADER_LENGTH), byteorder="big", signed=False))
         if resp_data is None or len(resp_data) == 0:
             self.__close_socket()
             raise Exception("socket connection broken")
@@ -1557,18 +1561,21 @@ class AppMeshClientTCP(AppMeshClient):
         Returns:
             bool: success or failure.
         """
-        resp = self._request_http(AppMeshClient.Method.GET, path="/appmesh/file/download", header={"File-Path": file_path})
-        if resp.status_code == HTTPStatus.OK:
+        header = {}
+        header["File-Path"] = file_path
+        header[HTTP_HEADER_KEY_X_RECV_FILE_SOCKET] = "true"
+        resp = self._request_http(AppMeshClient.Method.GET, path="/appmesh/file/download", header=header)
+        if resp.status_code == HTTPStatus.OK and HTTP_HEADER_KEY_X_RECV_FILE_SOCKET in resp.headers:
             with open(local_file, "wb") as fp:
                 chunk_data = bytes()
-                chunk_size = int.from_bytes(self.__recvall(TCP_MESSAGE_HEADER_LENGTH), "big", signed=False)
+                chunk_size = int.from_bytes(self.__recvall(TCP_MESSAGE_HEADER_LENGTH), byteorder="big", signed=False)
                 while chunk_size > 0:
                     chunk_data = self.__recvall(chunk_size)
                     if chunk_data is None or len(chunk_data) == 0:
                         self.__close_socket()
                         raise Exception("socket connection broken")
                     fp.write(chunk_data)
-                    chunk_size = int.from_bytes(self.__recvall(TCP_MESSAGE_HEADER_LENGTH), "big", signed=False)
+                    chunk_size = int.from_bytes(self.__recvall(TCP_MESSAGE_HEADER_LENGTH), byteorder="big", signed=False)
             if "File-Mode" in resp.headers:
                 os.chmod(path=local_file, mode=int(resp.headers["File-Mode"]))
             if "File-User" in resp.headers and "File-Group" in resp.headers:
@@ -1604,15 +1611,16 @@ class AppMeshClientTCP(AppMeshClient):
             header["File-User"] = str(file_stat.st_uid)
             header["File-Group"] = str(file_stat.st_gid)
             header["Content-Type"] = "text/plain"
+            header[HTTP_HEADER_KEY_X_SEND_FILE_SOCKET] = "true"
             # https://stackoverflow.com/questions/22567306/python-requests-file-upload
             resp = self._request_http(AppMeshClient.Method.POST, path="/appmesh/file/upload", header=header)
-            if resp.status_code == HTTPStatus.OK:
-                chunk_size = 1024 * 4  # 131072 bytes, default max ssl buffer size
+            if resp.status_code == HTTPStatus.OK and HTTP_HEADER_KEY_X_SEND_FILE_SOCKET in resp.headers:
+                chunk_size = 8 * 1024  # (8 KB in bytes), 131072 bytes (128 KB) is default max ssl buffer size
                 chunk_data = fp.read(chunk_size)
                 while chunk_data:
-                    self.__socket_client.sendall(len(chunk_data).to_bytes(TCP_MESSAGE_HEADER_LENGTH, "big", signed=False))
+                    self.__socket_client.sendall(len(chunk_data).to_bytes(TCP_MESSAGE_HEADER_LENGTH, byteorder="big", signed=False))
                     self.__socket_client.sendall(chunk_data)
                     chunk_data = fp.read(chunk_size)
-                self.__socket_client.sendall(int(0).to_bytes(TCP_MESSAGE_HEADER_LENGTH, "big", signed=False))
+                self.__socket_client.sendall(int(0).to_bytes(TCP_MESSAGE_HEADER_LENGTH, byteorder="big", signed=False))
                 return True, ""
             return False, resp.json()[REST_TEXT_MESSAGE_JSON_KEY]

{appmesh-1.2.6.dist-info → appmesh-1.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: appmesh
-Version: 1.2.6
+Version: 1.3.0
 Summary: Client SDK for App Mesh
 Home-page: https://github.com/laoshanxi/app-mesh
 Author: laoshanxi
@@ -31,7 +31,7 @@ App Mesh is a `Multi-Tenant`, `Cloud Native`, `Micro Service` application manage
 
 App Mesh is similar to Kubernetes but is much more lightweight, supporting both containerized and native applications.
 
-<div align=center><img src="https://github.com/laoshanxi/app-mesh/raw/main/docs/source/diagram.jpg" align=center /></div>
+<div align=center><img src="https://github.com/laoshanxi/picture/raw/master/appmesh/diagram.png" align=center /></div>
 
 ## Features
 
@@ -43,7 +43,7 @@ Cloud native | Schedule cloud-level applications to run on multiple hosts with r
 Micro service application | ⚡️ [Consul micro-service cluster management](https://app-mesh.readthedocs.io/en/latest/CONSUL.html)
 Extra Features | Collect host/app resource usage <br> Remote shell command execution <br> File upload/download interface <br> Hot-update support `systemctl reload appmesh` <br> Bash completion <br> Reverse proxy <br> [Web GUI](https://github.com/laoshanxi/app-mesh-ui)
 Platform support | X86_64 <br> ARM32 <br> ARM64
-SDK | [Python](https://app-mesh.readthedocs.io/en/latest/api/appmesh_client.html) <br> [Golang](https://github.com/laoshanxi/app-mesh/blob/main/src/sdk/go/appmesh_client.go) <br> [JavaScript](https://www.npmjs.com/package/appmesh) <br> [Swagger OpenAPI Specification](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/laoshanxi/app-mesh/main/src/daemon/rest/openapi.yaml)
+SDK | [Python](https://app-mesh.readthedocs.io/en/latest/api/appmesh_client.html) <br> [Golang](https://github.com/laoshanxi/app-mesh/blob/main/src/sdk/go/appmesh_client.go) <br> [JavaScript](https://www.npmjs.com/package/appmesh) <br> [Java](https://github.com/laoshanxi/app-mesh/packages/2227502) <br> [Swagger OpenAPI Specification](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/laoshanxi/app-mesh/main/src/daemon/rest/openapi.yaml)
 
 ## Getting started
 

appmesh-1.3.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+appmesh/__init__.py,sha256=xRdXeFHEieRauuJZElbEBASgXG0ZzU1a5_0isAhM7Gw,11
+appmesh/appmesh_client.py,sha256=1K0n44MLVPJUUSN4Lg-SK49Vjn4yveW1PymaceW7nUI,62911
+appmesh-1.3.0.dist-info/METADATA,sha256=Qkniderc7hlYrnsPZ4S2wWR6JYtROtrHruko3kdXUdc,11031
+appmesh-1.3.0.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
+appmesh-1.3.0.dist-info/top_level.txt,sha256=-y0MNQOGJxUzLdHZ6E_Rfv5_LNCkV-GTmOBME_b6pg8,8
+appmesh-1.3.0.dist-info/RECORD,,

{appmesh-1.2.6.dist-info → appmesh-1.3.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (72.1.0)
+Generator: setuptools (74.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

appmesh-1.2.6.dist-info/RECORD

@@ -1,6 +0,0 @@
-appmesh/__init__.py,sha256=xRdXeFHEieRauuJZElbEBASgXG0ZzU1a5_0isAhM7Gw,11
-appmesh/appmesh_client.py,sha256=XJNMUIyBj97JiRfQ3Y11Hk76nQLKtIy6fszUUO-_nmM,62408
-appmesh-1.2.6.dist-info/METADATA,sha256=3OdzuZkZp3ehs-ng7iVXzBQNh4CGJywiFXyFfynILQM,10966
-appmesh-1.2.6.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
-appmesh-1.2.6.dist-info/top_level.txt,sha256=-y0MNQOGJxUzLdHZ6E_Rfv5_LNCkV-GTmOBME_b6pg8,8
-appmesh-1.2.6.dist-info/RECORD,,