cloudru-qa-ssh-client 1.0.0__py3-none-any.whl

cloudru_qa_ssh_client-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ssh_client/__init__.py

@@ -0,0 +1,18 @@
+from . import options, utils
+from .client import BaseAsyncSSHClient, BaseSSHClient, ClientOption, InitSSHClient
+from .clients.asyncssh_client import AsyncSSHClient
+from .clients.paramiko_client import SyncSSHClient
+from .results import LiveSSHResult, SSHResult
+
+__all__ = [
+    "AsyncSSHClient",
+    "BaseAsyncSSHClient",
+    "BaseSSHClient",
+    "ClientOption",
+    "InitSSHClient",
+    "LiveSSHResult",
+    "SSHResult",
+    "SyncSSHClient",
+    "options",
+    "utils",
+]

ssh_client/client.py

@@ -0,0 +1,357 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from collections.abc import Callable
+from copy import copy, deepcopy
+from typing import TYPE_CHECKING, Self, Unpack, cast
+
+from .config import SSHClientConfig
+
+if TYPE_CHECKING:
+    from types import TracebackType
+
+    from .results import LiveSSHResult, SSHResult
+    from .types import (
+        AsyncCloseable,
+        Closeable,
+        ExecuteOptions,
+        LiveExecuteOptions,
+        OperationDecorator,
+        OutputCallback,
+        RequestHook,
+        ResponseHook,
+    )
+    from .utils.retries import RetryPolicy
+
+type ClientOption = Callable[["InitSSHClient"], None]
+
+
+class InitSSHClient:
+    """Configure SSH clients through built-in and custom options."""
+
+    DEFAULT_TIMEOUT = 30
+
+    def __init__(self, host: str, port: int = 22, *options: ClientOption) -> None:
+        """Apply options to this client.
+
+        :param host: SSH server hostname.
+        :param port: SSH server port.
+        :param options: Options receiving the actual client instance.
+        """
+        self.host = host
+        self.port = port
+        self._config = SSHClientConfig(timeout=self.DEFAULT_TIMEOUT)
+        self._request_hooks: list[RequestHook] = []
+        self._response_hooks: list[ResponseHook] = []
+        self._connect_decorators: list[OperationDecorator] = []
+        self._execute_decorators: list[OperationDecorator] = []
+        for option in options:
+            option(self)
+
+    @property
+    def username(self) -> str | None:
+        """Return the configured username."""
+        return self._config.username
+
+    @username.setter
+    def username(self, value: str | None) -> None:
+        """Set the username.
+
+        :param value: New client setting.
+        """
+        self._config.username = value
+
+    @property
+    def password(self) -> str | None:
+        """Return the configured password."""
+        return self._config.password
+
+    @password.setter
+    def password(self, value: str | None) -> None:
+        """Set the password.
+
+        :param value: New client setting.
+        """
+        self._config.password = value
+
+    @property
+    def private_key_path(self) -> str | None:
+        """Return the configured private key path."""
+        return self._config.private_key_path
+
+    @private_key_path.setter
+    def private_key_path(self, value: str | None) -> None:
+        """Set the private key path.
+
+        :param value: New client setting.
+        """
+        self._config.private_key_path = value
+
+    @property
+    def known_hosts(self) -> str | None:
+        """Return the configured known hosts."""
+        return self._config.known_hosts
+
+    @known_hosts.setter
+    def known_hosts(self, value: str | None) -> None:
+        """Set the known hosts.
+
+        :param value: New client setting.
+        """
+        self._config.known_hosts = value
+
+    @property
+    def timeout(self) -> float:
+        """Return the configured timeout."""
+        return self._config.timeout
+
+    @timeout.setter
+    def timeout(self, value: float) -> None:
+        """Set the timeout.
+
+        :param value: New client setting.
+        """
+        self._config.timeout = value
+
+    @property
+    def connection_timeout(self) -> float | None:
+        """Return the configured connection timeout."""
+        return self._config.connection_timeout
+
+    @connection_timeout.setter
+    def connection_timeout(self, value: float | None) -> None:
+        """Set the connection timeout.
+
+        :param value: New client setting.
+        """
+        self._config.connection_timeout = value
+
+    @property
+    def connection_retry(self) -> RetryPolicy | None:
+        """Return the configured connection retry."""
+        return self._config.connection_retry
+
+    @connection_retry.setter
+    def connection_retry(self, value: RetryPolicy | None) -> None:
+        """Set the connection retry.
+
+        :param value: New client setting.
+        """
+        self._config.connection_retry = value
+
+    @property
+    def command_retry(self) -> RetryPolicy | None:
+        """Return the configured command retry."""
+        return self._config.command_retry
+
+    @command_retry.setter
+    def command_retry(self, value: RetryPolicy | None) -> None:
+        """Set the command retry.
+
+        :param value: New client setting.
+        """
+        self._config.command_retry = value
+
+    @property
+    def live_stdout_callback(self) -> OutputCallback | None:
+        """Return the configured live stdout callback."""
+        return self._config.live_stdout_callback
+
+    @live_stdout_callback.setter
+    def live_stdout_callback(self, value: OutputCallback | None) -> None:
+        """Set the live stdout callback.
+
+        :param value: New client setting.
+        """
+        self._config.live_stdout_callback = value
+
+    @property
+    def live_stderr_callback(self) -> OutputCallback | None:
+        """Return the configured live stderr callback."""
+        return self._config.live_stderr_callback
+
+    @live_stderr_callback.setter
+    def live_stderr_callback(self, value: OutputCallback | None) -> None:
+        """Set the live stderr callback.
+
+        :param value: New client setting.
+        """
+        self._config.live_stderr_callback = value
+
+    def add_request_hook(self, hook: RequestHook) -> None:
+        """Register a request observer.
+
+        :param hook: Request callback.
+        """
+        self._request_hooks.append(hook)
+
+    def add_response_hook(self, hook: ResponseHook) -> None:
+        """Register a response observer.
+
+        :param hook: Response callback.
+        """
+        self._response_hooks.append(hook)
+
+    def add_connect_decorator(self, decorator: OperationDecorator) -> None:
+        """Register a connection wrapper.
+
+        :param decorator: Operation-preserving decorator.
+        """
+        self._connect_decorators.append(decorator)
+
+    def add_execute_decorator(self, decorator: OperationDecorator) -> None:
+        """Register a command wrapper.
+
+        :param decorator: Operation-preserving decorator.
+        """
+        self._execute_decorators.append(decorator)
+
+    def with_options(self, *temp_options: ClientOption) -> Self:
+        """Create a disconnected copy with independent settings and hooks.
+
+        :param temp_options: Options overriding the copied settings.
+        :return: Independent client of the same type.
+        """
+        temporary = copy(self)
+        for option in temp_options:
+            option(temporary)
+        return temporary
+
+    def __copy__(self) -> Self:
+        """Copy options without copying live transport resources."""
+        temporary = type(self).__new__(type(self))
+        cast("dict[str, object]", temporary.__dict__).update(
+            {
+                **cast("dict[str, object]", self.__dict__),
+                "_config": deepcopy(self._config),
+                "_client": None,
+                "_connected": False,
+                "_request_hooks": self._request_hooks.copy(),
+                "_response_hooks": self._response_hooks.copy(),
+                "_connect_decorators": self._connect_decorators.copy(),
+                "_execute_decorators": self._execute_decorators.copy(),
+            }
+        )
+        return temporary
+
+    def _request(self, command: str) -> None:
+        for hook in self._request_hooks:
+            hook(host=self.host, port=self.port, username=self.username, command=command)
+
+    def _response(self, command: str, result: SSHResult | LiveSSHResult) -> None:
+        for hook in self._response_hooks:
+            hook(host=self.host, command=command, result=result)
+
+    def _decorate[T](self, operation: Callable[[], T], decorators: list[OperationDecorator]) -> Callable[[], T]:
+        for decorator in reversed(decorators):
+            operation = decorator(operation)
+        return operation
+
+
+class BaseSSHClient[ConnectionT: Closeable](InitSSHClient, ABC):
+    """Manage the lifetime of a synchronous SSH transport."""
+
+    def __init__(self, host: str, port: int = 22, *options: ClientOption) -> None:
+        """Configure the client without opening a connection.
+
+        :param host: SSH server hostname.
+        :param port: SSH server port.
+        :param options: Client options.
+        """
+        self._client: ConnectionT | None = None
+        self._connected = False
+        super().__init__(host, port, *options)
+
+    @property
+    def client(self) -> ConnectionT | None:
+        """Return the most recently created transport."""
+        return self._client
+
+    def __enter__(self) -> Self:
+        """Return this client for scoped cleanup."""
+        return self
+
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_val: BaseException | None,
+        exc_tb: TracebackType | None,
+    ) -> None:
+        """Release the transport on context exit."""
+        self.close()
+
+    def close(self) -> None:
+        """Close active and partially opened transports."""
+        if self._client is not None:
+            self._client.close()
+        self._connected = False
+
+    @abstractmethod
+    def connect(self) -> None:
+        """Open an authenticated connection."""
+        ...
+
+    @abstractmethod
+    def execute(self, command: str | list[str], **options: Unpack[ExecuteOptions]) -> SSHResult:
+        """Run a command and collect stdout and stderr."""
+        ...
+
+    @abstractmethod
+    def execute_live(self, command: str | list[str], **options: Unpack[LiveExecuteOptions]) -> LiveSSHResult:
+        """Run a command while emitting output lines."""
+        ...
+
+
+class BaseAsyncSSHClient[ConnectionT: AsyncCloseable](InitSSHClient, ABC):
+    """Manage the lifetime of an asynchronous SSH transport."""
+
+    def __init__(self, host: str, port: int = 22, *options: ClientOption) -> None:
+        """Configure the client without opening a connection.
+
+        :param host: SSH server hostname.
+        :param port: SSH server port.
+        :param options: Client options.
+        """
+        self._client: ConnectionT | None = None
+        self._connected = False
+        super().__init__(host, port, *options)
+
+    @property
+    def client(self) -> ConnectionT | None:
+        """Return the most recently created transport."""
+        return self._client
+
+    async def __aenter__(self) -> Self:
+        """Return this client for scoped cleanup."""
+        return self
+
+    async def __aexit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_val: BaseException | None,
+        exc_tb: TracebackType | None,
+    ) -> None:
+        """Wait for transport shutdown on context exit."""
+        await self.aclose()
+
+    async def aclose(self) -> None:
+        """Close the transport and wait for resources to be released."""
+        if self._client is not None:
+            self._client.close()
+            await self._client.wait_closed()
+        self._connected = False
+
+    @abstractmethod
+    async def connect(self) -> None:
+        """Open an authenticated connection."""
+        ...
+
+    @abstractmethod
+    async def execute(self, command: str | list[str], **options: Unpack[ExecuteOptions]) -> SSHResult:
+        """Run a command and collect stdout and stderr."""
+        ...
+
+    @abstractmethod
+    async def execute_live(self, command: str | list[str], **options: Unpack[LiveExecuteOptions]) -> LiveSSHResult:
+        """Run a command while emitting output lines."""
+        ...