gnetclisdk 1.0.100__py3-none-any.whl → 1.1.0__py3-none-any.whl

gnetclisdk/client.py

@@ -14,7 +14,7 @@ from google.protobuf.message import Message
 
 from .proto import server_pb2, server_pb2_grpc
 from .auth import BasicClientAuthentication, ClientAuthentication, OAuthClientAuthentication
-from .exceptions import parse_grpc_error
+from .exceptions import parse_grpc_error, DeviceConnectError
 from .interceptors import get_auth_client_interceptors
 
 _logger = logging.getLogger(__name__)
@@ -470,6 +470,8 @@ async def grpc_call_wrapper(stub: grpc.UnaryUnaryMultiCallable, request: Any) ->
                 verbose=verbose,
             )
             last_exc.__cause__ = e
+            if gn_exc == DeviceConnectError:
+                continue
             raise last_exc from None
         else:
             last_exc = None

gnetclisdk/config.py

@@ -0,0 +1,54 @@
+from dataclasses import dataclass, asdict, field
+from datetime import timedelta
+
+import yaml
+
+
+@dataclass
+class LogConfig:
+    level: str = "info"
+    json: bool = False
+
+
+@dataclass
+class AuthAppConfig:
+    login: str = ""
+    password: str = ""
+    private_key: str = ""  # path to private key file
+    proxy_jump: str = ""
+    use_agent: bool = False
+    ssh_config: bool = False
+
+
+@dataclass
+class Config:
+    logging: LogConfig = field(default_factory=LogConfig)
+    port: str = ""  # Listen address
+    http_port: str = ""  # Http listen address
+    dev_auth: AuthAppConfig = field(default_factory=AuthAppConfig)
+    dev_conf: str = ""  # Path to yaml with device types
+    tls: bool = False
+    cert_file: str = ""
+    key_file: str = ""
+    basic_auth: str = ""
+    disable_tcp: bool = False
+    unix_socket: str = ""  # Unix socket pat
+    default_read_timeout: timedelta = timedelta(seconds=0)
+    default_cmd_timeout: timedelta = timedelta(seconds=0)
+
+
+def dict_factory(data):
+    return {
+        key: (
+            f"{value.total_seconds()}s"
+            if isinstance(value, timedelta)
+            else value
+        )
+        for key, value in data
+        if value != ""  # skip empty strings
+    }
+
+
+def config_to_yaml(cfg: Config) -> str:
+    cfg_dict = asdict(cfg, dict_factory=dict_factory)
+    return yaml.safe_dump(cfg_dict, sort_keys=False)

gnetclisdk/exceptions.py

@@ -33,7 +33,7 @@ class GnetcliException(Exception):
         super().__init__(self.message)
 
 
-class DeviceConnectError(GnetcliException):
+class DeviceConnectionError(GnetcliException):
     """
     Problem with connection to a device.
     """
@@ -41,6 +41,14 @@ class DeviceConnectError(GnetcliException):
     pass
 
 
+class DeviceConnectError(GnetcliException):
+    """
+    Problem with connecting to a device.
+    """
+
+    pass
+
+
 class UnknownDevice(GnetcliException):
     """
     Host is not found in inventory
@@ -49,7 +57,7 @@ class UnknownDevice(GnetcliException):
     pass
 
 
-class DeviceAuthError(DeviceConnectError):
+class DeviceAuthError(DeviceConnectionError):
     """
     Unable to authenticate on a device.
     """
@@ -140,9 +148,12 @@ def parse_grpc_error(grpc_error: grpc.aio.AioRpcError) -> Tuple[Type[GnetcliExce
             return DeviceAuthError, verbose
         elif detail in {"connection_error", "busy_error"}:
             verbose = ""
-            return DeviceConnectError, verbose
+            return DeviceConnectionError, verbose
         elif detail in {"exec_error", "generic_error"}:
             verbose = ""
             return ExecError, verbose
+        elif detail == "connect_error":
+            verbose = str(error_info)
+            return DeviceConnectError, verbose
 
     return GnetcliException, ""

gnetclisdk/starter.py

@@ -0,0 +1,102 @@
+import asyncio
+import json
+import logging
+from asyncio.subprocess import Process
+from json import JSONDecodeError
+from subprocess import DEVNULL, PIPE, TimeoutExpired
+
+from gnetclisdk.config import Config, LogConfig, AuthAppConfig, config_to_yaml
+
+logger = logging.getLogger(__name__)
+
+DEFAULT_GNETCLI_SERVER_CONF = Config(
+    logging=LogConfig(level="debug", json=True),
+    dev_auth=AuthAppConfig(use_agent=True, ssh_config=True),
+)
+
+
+class GnetcliStarter:
+    def __init__(
+        self,
+        server_path: str,
+        server_conf: Config = DEFAULT_GNETCLI_SERVER_CONF,
+        start_timeout: int = 5,
+        stop_timeout: int = 10,
+    ):
+        self._server_path = server_path
+        self._server_conf = server_conf
+        self._running = False
+        self._proc: Process | None = None
+        self._start_timeout = start_timeout
+        self._stop_timeout = stop_timeout
+
+    async def _start(self) -> Process:
+        logger.debug("Starting Gnetcli server: %s", self._server_path)
+        proc = await asyncio.create_subprocess_exec(
+            self._server_path,
+            "--conf-file",
+            "-",
+            stdout=DEVNULL,  # we do not read stdout
+            stderr=PIPE,
+            stdin=PIPE,
+        )
+        self._running = True
+        conf_yaml = config_to_yaml(self._server_conf)
+        proc.stdin.write(conf_yaml.encode())
+        await proc.stdin.drain()
+        proc.stdin.close()
+        return proc
+
+    async def _wait_url(self) -> str:
+        while proc := self._proc:
+            output = await proc.stderr.readline()
+            if output == "" and proc.returncode is not None:
+                break
+            if not output:
+                continue
+            logger.debug("gnetcli output: %s", output.strip())
+            try:
+                data = json.loads(output)
+            except JSONDecodeError:
+                logger.error("cannot decode data")
+                continue
+            if data.get("msg") == "init tcp socket":
+                logger.debug("Tcp socket found")
+                return data.get("address")
+            if data.get("msg") == "init unix socket":
+                logger.debug("Unix socket found")
+                return "unix:" + data.get("path")
+            if data.get("level") == "panic":
+                logger.error("gnetcli error %s", data)
+        return ""  # stopped
+
+    async def __aenter__(self) -> str:
+        self._proc = await self._start()
+        try:
+            return await asyncio.wait_for(
+                self._wait_url(), timeout=self._start_timeout
+            )
+        except asyncio.TimeoutError:
+            logger.error("gnetcli _wait_url timeout, terminating")
+            await self._terminate()
+            raise RuntimeError("gnetcli start failed")
+
+    async def _terminate(self) -> None:
+        if (proc := self._proc) is None:
+            return
+        if proc.returncode is not None:
+            logger.error(
+                "gnetcli already terminated with code: %s", proc.returncode
+            )
+            return
+        proc.terminate()
+        try:
+            await asyncio.wait_for(proc.wait(), timeout=self._stop_timeout)
+        except TimeoutExpired:
+            logger.debug("gnetcli terminate failed, killing")
+            self._proc.kill()
+        self._proc = None
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb):
+        self.running = False
+        await self._terminate()

{gnetclisdk-1.0.100.dist-info → gnetclisdk-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gnetclisdk
-Version: 1.0.100
+Version: 1.1.0
 Summary: Client for Gnetcli GRPC-server
 Home-page: https://github.com/annetutil/gnetcli
 Author: Alexander Balezin
@@ -16,6 +16,7 @@ Description-Content-Type: text/markdown
 Requires-Dist: protobuf>=4.24.4
 Requires-Dist: grpcio>=1.59.2
 Requires-Dist: googleapis-common-protos>=1.61.0
+Requires-Dist: pyyaml
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

gnetclisdk-1.1.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+gnetclisdk/auth.py,sha256=GwM7H7Ecb-gwqUTkQorifNB_mtnZfgeS46gOW2Vx1U4,1246
+gnetclisdk/client.py,sha256=5LEIvHqWk2EVSw4xsaVWPOFahPAiuMObMe2bb9YStu8,19806
+gnetclisdk/config.py,sha256=8Zj9oJdZXE27fMHQy2DBdC6KXdL8flDQ2w3fgc7xXNs,1364
+gnetclisdk/exceptions.py,sha256=Cg94IdDAzQ9Q56Tdif6ladV1IcdBUg0TPa54OBVhJD0,4038
+gnetclisdk/interceptors.py,sha256=apj3l4lnR2ZcsA49odptrBC0kTDmP6Mp0EzYkeEJz9Y,7010
+gnetclisdk/starter.py,sha256=h3Qd6STKGfoobmxSUf2R8DdOqqd7HA4HDcTyEj0eygM,3432
+gnetclisdk/proto/server_pb2.py,sha256=v_A3rRjuWKa7rPOrsAPOl_oLmfD4sqT5ELpAyM3cUI0,8126
+gnetclisdk/proto/server_pb2.pyi,sha256=66Oq_YbkGgEQt9ea-P64H58hiUZoMhqptlMQdl2IAaw,8402
+gnetclisdk/proto/server_pb2_grpc.py,sha256=H_CmevWcjvGTvp4TmzEV-TJRPq2SsQ6UgoCDc-hosyo,12805
+gnetclisdk-1.1.0.dist-info/METADATA,sha256=QPnFLuTdBzkK3SfYS6LbxVTQ_3bXHQYh6RdehItUUlY,1814
+gnetclisdk-1.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+gnetclisdk-1.1.0.dist-info/top_level.txt,sha256=MNjS8LEt6d2rZ-dUbV2cnqkuTMu3EqEL2eiSvUZuUlA,11
+gnetclisdk-1.1.0.dist-info/RECORD,,

gnetclisdk-1.0.100.dist-info/RECORD

@@ -1,11 +0,0 @@
-gnetclisdk/auth.py,sha256=GwM7H7Ecb-gwqUTkQorifNB_mtnZfgeS46gOW2Vx1U4,1246
-gnetclisdk/client.py,sha256=BGLamlnThZkx1NdojblX_iTTRtmhyIcuGpFUe_2bo-4,19716
-gnetclisdk/exceptions.py,sha256=FVaj3X5163yPFsglfsw3MaZ9r3OE_Cih9N7EL1NTGgo,3791
-gnetclisdk/interceptors.py,sha256=apj3l4lnR2ZcsA49odptrBC0kTDmP6Mp0EzYkeEJz9Y,7010
-gnetclisdk/proto/server_pb2.py,sha256=v_A3rRjuWKa7rPOrsAPOl_oLmfD4sqT5ELpAyM3cUI0,8126
-gnetclisdk/proto/server_pb2.pyi,sha256=66Oq_YbkGgEQt9ea-P64H58hiUZoMhqptlMQdl2IAaw,8402
-gnetclisdk/proto/server_pb2_grpc.py,sha256=H_CmevWcjvGTvp4TmzEV-TJRPq2SsQ6UgoCDc-hosyo,12805
-gnetclisdk-1.0.100.dist-info/METADATA,sha256=eQdSPuAcYAWUtC3Cwrum7gNen7X5j2GiWOF9xyIrkDE,1794
-gnetclisdk-1.0.100.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-gnetclisdk-1.0.100.dist-info/top_level.txt,sha256=MNjS8LEt6d2rZ-dUbV2cnqkuTMu3EqEL2eiSvUZuUlA,11
-gnetclisdk-1.0.100.dist-info/RECORD,,