Fix tests & move forward: simplify API

Also update copyrights

Author: penguinolog

exec_helpers/_ssh_client_base.py

@@ -174,9 +174,9 @@ def __init__(
         port: typing.Optional[int] = None,
         username: typing.Optional[str] = None,
         password: typing.Optional[str] = None,
+        *,
         private_keys: typing.Optional[typing.Iterable[paramiko.RSAKey]] = None,
         auth: typing.Optional[ssh_auth.SSHAuth] = None,
-        *,
         verbose: bool = True,
         ssh_config: typing.Union[
             str,
@@ -186,6 +186,7 @@ def __init__(
             None,
         ] = None,
         sock: typing.Optional[typing.Union[paramiko.ProxyCommand, paramiko.Channel, socket.socket]] = None,
+        keepalive: bool = True,
     ) -> None:
         """Main SSH Client helper.
 
@@ -214,25 +215,39 @@ def __init__(
             ]
         :param sock: socket for connection. Useful for ssh proxies support
         :type sock: typing.Optional[typing.Union[paramiko.ProxyCommand, paramiko.Channel, socket.socket]]
+        :param keepalive: keepalive mode
+        :type keepalive: bool
 
         .. note:: auth has priority over username/password/private_keys
+        .. note::
+
+            for proxy connection auth information is collected from SSHConfig
+            if ssh_auth_map record is not available
+
+        .. versionchanged:: 6.0.0 private_keys, auth and vebose became keyword-only arguments
+        .. versionchanged:: 6.0.0 added optional ssh_config for ssh-proxy & low level connection parameters handling
+        .. versionchanged:: 6.0.0 added optional sock for manual proxy chain handling
+        .. versionchanged:: 6.0.0 keepalive exposed to constructor
         """
         super(SSHClientBase, self).__init__(
             logger=logging.getLogger(self.__class__.__name__).getChild(f"({host}:{port})")
         )
 
+        # Init ssh config. It's main source for connection parameters
         if isinstance(ssh_config, HostsSSHConfigs):
             self.__ssh_config: HostsSSHConfigs = ssh_config
         else:
             self.__ssh_config = _ssh_helpers.parse_ssh_config(ssh_config, host)
 
+        # Get config. We are not resolving full chain. If you are have a chain by some reason - init config manually.
         config: SSHConfig = self.__ssh_config[host]
 
+        # Save resolved hostname and port
         self.__hostname: str = config.hostname
         self.__port: int = port if port is not None else config.port if config.port is not None else 22
 
         self.__sudo_mode = False
-        self.__keepalive_mode = True
+        self.__keepalive_mode: bool = keepalive
         self.__verbose: bool = verbose
         self.__sock = sock
 
@@ -688,9 +703,9 @@ def proxy_to(
         port: typing.Optional[int] = None,
         username: typing.Optional[str] = None,
         password: typing.Optional[str] = None,
+        *,
         private_keys: typing.Optional[typing.Iterable[paramiko.RSAKey]] = None,
         auth: typing.Optional[ssh_auth.SSHAuth] = None,
-        *,
         verbose: bool = True,
         ssh_config: typing.Union[
             str,
@@ -699,6 +714,7 @@ def proxy_to(
             HostsSSHConfigs,
             None,
         ] = None,
+        keepalive: bool = True,
     ) -> "SSHClientBase":
         """Start new SSH connection using current as proxy.
 
@@ -725,6 +741,8 @@ def proxy_to(
                 HostsSSHConfigs,
                 None
             ]
+        :param keepalive: keepalive mode
+        :type keepalive: bool
         :returns: new ssh client instance using current as a proxy
         :rtype: SSHClientBase
 
@@ -751,6 +769,7 @@ def proxy_to(
             verbose=verbose,
             ssh_config=ssh_config,
             sock=sock,
+            keepalive=keepalive,
         )
 
     def execute_through_host(
@@ -814,9 +833,8 @@ def execute_through_host(
             auth = self.auth
 
         with self.proxy_to(  # type: ignore
-            host=hostname, port=target_port, auth=auth, verbose=verbose, ssh_config=self.ssh_config
+            host=hostname, port=target_port, auth=auth, verbose=verbose, ssh_config=self.ssh_config, keepalive=False
         ) as conn:
-            conn.keepalive_mode = False  # pylint: disable=assigning-non-slot
             return conn.execute(
                 command,
                 timeout=timeout,

exec_helpers/ssh_auth.py

@@ -78,7 +78,10 @@ def __init__(
             for k in keys:
                 if k not in self.__keys:
                     self.__keys.append(k)
-        self.__key_filename: typing.Union[typing.List[str], str, None] = key_filename
+        if key_filename is None or isinstance(key_filename, list):
+            self.__key_filename: typing.Optional[typing.List[str]] = key_filename
+        else:
+            self.__key_filename = [key_filename]
         self.__passphrase: typing.Optional[str] = passphrase
 
     @property
@@ -113,7 +116,7 @@ def public_key(self) -> typing.Optional[str]:
         return self.__get_public_key(self.__key)
 
     @property
-    def key_filename(self) -> typing.Union[typing.List[str], str, None]:
+    def key_filename(self) -> typing.Optional[typing.List[str]]:
         """Key filename(s).
 
         :returns: copy of used key filename (original should not be changed via mutability).
@@ -130,7 +133,7 @@ def enter_password(self, tgt: typing.BinaryIO) -> None:
         :type tgt: typing.BinaryIO
         """
         # noinspection PyTypeChecker
-        tgt.write("{}\n".format(self.__password if self.__password is not None else "").encode("utf-8"))
+        tgt.write(f"{self.__password if self.__password is not None else ''}\n".encode("utf-8"))
 
     def connect(
         self,

test/async_api/test_subprocess.py

@@ -1,4 +1,4 @@
-#    Copyright 2018 Alexey Stepanov aka penguinolog.
+#    Copyright 2018 - 2019 Alexey Stepanov aka penguinolog.
 #
 #    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

test/async_api/test_subprocess_special.py

@@ -1,4 +1,4 @@
-#    Copyright 2018 Alexey Stepanov aka penguinolog.
+#    Copyright 2018 - 2019 Alexey Stepanov aka penguinolog.
 #
 #    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

test/test_exec_result.py

@@ -1,4 +1,4 @@
-#    Copyright 2018 Alexey Stepanov aka penguinolog.
+#    Copyright 2018 - 2019 Alexey Stepanov aka penguinolog.
 
 #    Copyright 2016 Mirantis, Inc.
 #

test/test_sftp.py

@@ -1,4 +1,4 @@
-#    Copyright 2018 Alexey Stepanov aka penguinolog.
+#    Copyright 2018 - 2019 Alexey Stepanov aka penguinolog.
 
 #    Copyright 2016 Mirantis, Inc.
 #

test/test_ssh_client_execute.py

@@ -1,4 +1,4 @@
-#    Copyright 2018 Alexey Stepanov aka penguinolog.
+#    Copyright 2018 - 2019 Alexey Stepanov aka penguinolog.
 #
 #    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
@@ -357,17 +357,19 @@ def test_003_context_manager(ssh, exec_result, run_parameters, mocker) -> None:
     if "height" in run_parameters:
         kwargs["height"] = run_parameters["height"]
 
-    with mocker.patch("threading.RLock") as lock:
-        with ssh:
-            res = ssh.execute(
-                command,
-                stdin=run_parameters["stdin"],
-                open_stdout=run_parameters["open_stdout"],
-                open_stderr=run_parameters["open_stderr"],
-                **kwargs,
-            )
-        lock.acquire_assert_called_once()
-        lock.release_assert_called_once()
+    lock_mock = mocker.patch("threading.RLock")
+
+    with ssh:
+        res = ssh.execute(
+            command,
+            stdin=run_parameters["stdin"],
+            open_stdout=run_parameters["open_stdout"],
+            open_stderr=run_parameters["open_stderr"],
+            **kwargs,
+        )
+    lock_mock.acquire_assert_called_once()
+    lock_mock.release_assert_called_once()
+
     assert isinstance(res, exec_helpers.ExecResult)
     assert res == exec_result
 

test/test_ssh_client_execute_async_special.py

@@ -1,4 +1,4 @@
-#    Copyright 2018 Alexey Stepanov aka penguinolog.
+#    Copyright 2018 - 2019 Alexey Stepanov aka penguinolog.
 #
 #    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

test/test_ssh_client_execute_special.py

@@ -1,4 +1,4 @@
-#    Copyright 2018 Alexey Stepanov aka penguinolog.
+#    Copyright 2018 - 2019 Alexey Stepanov aka penguinolog.
 #
 #    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

test/test_ssh_client_execute_throw_host.py

@@ -1,4 +1,4 @@
-#    Copyright 2018 Alexey Stepanov aka penguinolog.
+#    Copyright 2018 - 2019 Alexey Stepanov aka penguinolog.
 #
 #    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