Merge bd6bd9d into 626efc8

README.rst

@@ -121,12 +121,14 @@ Main methods are `execute`, `check_call` and `check_stderr` for simple executing
 and executing, checking return code and checking for empty stderr output.
 This methods are almost the same for `SSHCleint` and `Subprocess`, except specific flags.
 
+.. note:: By default ALL methods have timeout 1 hour, infinite waiting can be enabled, but it's special case.
+
 .. code-block:: python
 
     result = helper.execute(
         command,  # type: str
         verbose=False,  # type: bool
-        timeout=None,  # type: typing.Optional[int]
+        timeout=1 * 60 * 60,  # type: typing.Optional[int]
         **kwargs
     )
 
@@ -136,7 +138,7 @@ This methods are almost the same for `SSHCleint` and `Subprocess`, except specif
     result = helper.check_call(
         command,  # type: str
         verbose=False,  # type: bool
-        timeout=None,  # type: typing.Optional[int]
+        timeout=1 * 60 * 60,  # type: typing.Optional[int]
         error_info=None,  # type: typing.Optional[str]
         expected=None,  # type: typing.Optional[typing.Iterable[int]]
         raise_on_err=True,  # type: bool
@@ -148,7 +150,7 @@ This methods are almost the same for `SSHCleint` and `Subprocess`, except specif
     result = helper.check_stderr(
         command,  # type: str
         verbose=False,  # type: bool
-        timeout=None,  # type: typing.Optional[int]
+        timeout=1 * 60 * 60,  # type: typing.Optional[int]
         error_info=None,  # type: typing.Optional[str]
         raise_on_err=True,  # type: bool
     )
@@ -193,7 +195,7 @@ Possible to call commands in parallel on multiple hosts if it's not produce huge
     results = SSHClient.execute_together(
         remotes,  # type: typing.Iterable[SSHClient]
         command,  # type: str
-        timeout=None,  # type: typing.Optional[int]
+        timeout=1 * 60 * 60,  # type: typing.Optional[int]
         expected=None,  # type: typing.Optional[typing.Iterable[int]]
         raise_on_err=True  # type: bool
     )
@@ -211,7 +213,7 @@ For execute through SSH host can be used `execute_through_host` method:
         command,  # type: str
         auth=None,  # type: typing.Optional[SSHAuth]
         target_port=22,  # type: int
-        timeout=None,  # type: typing.Optional[int]
+        timeout=1 * 60 * 60,  # type: typing.Optional[int]
         verbose=False,  # type: bool
         get_pty=False,  # type: bool
     )

doc/source/SSHClient.rst

@@ -79,14 +79,14 @@ API: SSHClient and SSHAuth.
 
         Open context manager
 
-        .. versionchanged:: 1.1.0 - lock on enter
+        .. versionchanged:: 1.1.0 lock on enter
 
     .. py:method:: __exit__(self, exc_type, exc_val, exc_tb)
 
         Close context manager and disconnect
 
-        .. versionchanged:: 1.0.0 - disconnect enforced on close
-        .. versionchanged:: 1.1.0 - release lock on exit
+        .. versionchanged:: 1.0.0 disconnect enforced on close
+        .. versionchanged:: 1.1.0 release lock on exit
 
     .. py:method:: sudo(enforce=None)
 
@@ -109,9 +109,9 @@ API: SSHClient and SSHAuth.
         :type open_stderr: bool
         :rtype: ``typing.Tuple[paramiko.Channel, paramiko.ChannelFile, paramiko.ChannelFile, paramiko.ChannelFile]``
 
-        .. versionchanged:: 1.2.0 - open_stdout and open_stderr flags
+        .. versionchanged:: 1.2.0 open_stdout and open_stderr flags
 
-    .. py:method:: execute(command, verbose=False, timeout=None, **kwargs)
+    .. py:method:: execute(command, verbose=False, timeout=1*60*60, **kwargs)
 
         Execute command and wait for return code.
 
@@ -124,7 +124,9 @@ API: SSHClient and SSHAuth.
         :rtype: ExecResult
         :raises: ExecHelperTimeoutError
 
-    .. py:method:: check_call(command, verbose=False, timeout=None, error_info=None, expected=None, raise_on_err=True, **kwargs)
+        .. versionchanged:: 1.2.0 default timeout 1 hour
+
+    .. py:method:: check_call(command, verbose=False, timeout=1*60*60, error_info=None, expected=None, raise_on_err=True, **kwargs)
 
         Execute command and check for return code.
 
@@ -143,7 +145,9 @@ API: SSHClient and SSHAuth.
         :rtype: ExecResult
         :raises: CalledProcessError
 
-    .. py:method:: check_stderr(command, verbose=False, timeout=None, error_info=None, raise_on_err=True, **kwargs)
+        .. versionchanged:: 1.2.0 default timeout 1 hour
+
+    .. py:method:: check_stderr(command, verbose=False, timeout=1*60*60, error_info=None, raise_on_err=True, **kwargs)
 
         Execute command expecting return code 0 and empty STDERR.
 
@@ -161,8 +165,9 @@ API: SSHClient and SSHAuth.
         :raises: CalledProcessError
 
         .. note:: expected return codes can be overridden via kwargs.
+        .. versionchanged:: 1.2.0 default timeout 1 hour
 
-    .. py:method:: execute_through_host(hostname, command, auth=None, target_port=22, verbose=False, timeout=None, get_pty=False, **kwargs)
+    .. py:method:: execute_through_host(hostname, command, auth=None, target_port=22, verbose=False, timeout=1*60*60, get_pty=False, **kwargs)
 
         Execute command on remote host through currently connected host.
 
@@ -183,7 +188,9 @@ API: SSHClient and SSHAuth.
         :rtype: ExecResult
         :raises: ExecHelperTimeoutError
 
-    .. py:classmethod:: execute_together(remotes, command, timeout=None, expected=None, raise_on_err=True, **kwargs)
+        .. versionchanged:: 1.2.0 default timeout 1 hour
+
+    .. py:classmethod:: execute_together(remotes, command, timeout=1*60*60, expected=None, raise_on_err=True, **kwargs)
 
         Execute command on multiple remotes in async mode.
 
@@ -202,6 +209,8 @@ API: SSHClient and SSHAuth.
         :raises: ParallelCallProcessError
         :raises: ParallelCallExceptions
 
+        .. versionchanged:: 1.2.0 default timeout 1 hour
+
     .. py:method:: open(path, mode='r')
 
         Open file on remote using SFTP session.

doc/source/Subprocess.rst

@@ -16,15 +16,15 @@ API: Subprocess
 
         Open context manager
 
-        .. versionchanged:: 1.1.0 - lock on enter
+        .. versionchanged:: 1.1.0 lock on enter
 
     .. py:method:: __exit__(self, exc_type, exc_val, exc_tb)
 
         Close context manager
 
-        .. versionchanged:: 1.1.0 - release lock on exit
+        .. versionchanged:: 1.1.0 release lock on exit
 
-    .. py:method:: execute(command, verbose=False, timeout=None, **kwargs)
+    .. py:method:: execute(command, verbose=False, timeout=1*60*60, **kwargs)
 
         Execute command and wait for return code.
 
@@ -37,10 +37,13 @@ API: Subprocess
         :rtype: ExecResult
         :raises: ExecHelperTimeoutError
 
-        .. versionchanged:: 1.1.0 - make method
-        .. versionchanged:: 1.2.0 - open_stdout and open_stderr flags
+        .. versionchanged:: 1.1.0 make method
+        .. versionchanged:: 1.2.0
 
-    .. py:method:: check_call(command, verbose=False, timeout=None, error_info=None, expected=None, raise_on_err=True, **kwargs)
+            open_stdout and open_stderr flags
+            default timeout 1 hour
+
+    .. py:method:: check_call(command, verbose=False, timeout=1*60*60, error_info=None, expected=None, raise_on_err=True, **kwargs)
 
         Execute command and check for return code.
 
@@ -59,9 +62,10 @@ API: Subprocess
         :rtype: ExecResult
         :raises: CalledProcessError
 
-        .. versionchanged:: 1.1.0 - make method
+        .. versionchanged:: 1.1.0 make method
+        .. versionchanged:: 1.2.0 default timeout 1 hour
 
-    .. py:method:: check_stderr(command, verbose=False, timeout=None, error_info=None, raise_on_err=True, **kwargs)
+    .. py:method:: check_stderr(command, verbose=False, timeout=1*60*60, error_info=None, raise_on_err=True, **kwargs)
 
         Execute command expecting return code 0 and empty STDERR.
 
@@ -80,4 +84,5 @@ API: Subprocess
 
         .. note:: expected return codes can be overridden via kwargs.
 
-        .. versionchanged:: 1.1.0 - make method
+        .. versionchanged:: 1.1.0 make method
+        .. versionchanged:: 1.2.0 default timeout 1 hour

exec_helpers/_log_templates.py

@@ -17,6 +17,7 @@
 """Text templates for logging."""
 
 from __future__ import absolute_import
+from __future__ import division
 from __future__ import unicode_literals
 
 CMD_EXEC = "Executing command:\n{cmd!s}\n"

exec_helpers/_ssh_client_base.py

@@ -16,6 +16,8 @@
 
 """SSH client helper based on Paramiko. Base class."""
 
+from __future__ import absolute_import
+from __future__ import division
 from __future__ import unicode_literals
 
 import base64
@@ -37,11 +39,12 @@
 import threaded
 import six
 
-from exec_helpers import exceptions
+from exec_helpers import constants
 from exec_helpers import exec_result
-from exec_helpers import _log_templates
+from exec_helpers import exceptions
 from exec_helpers import proc_enums
 from exec_helpers import ssh_auth
+from exec_helpers import _log_templates
 
 __all__ = ('SSHClientBase', )
 
@@ -474,16 +477,16 @@ def __del__(self):
     def __enter__(self):
         """Get context manager.
 
-        .. versionchanged:: 1.1.0 - lock on enter
+        .. versionchanged:: 1.1.0 lock on enter
         """
         self.lock.acquire()
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
         """Exit context manager.
 
-        .. versionchanged:: 1.0.0 - disconnect enforced on close
-        .. versionchanged:: 1.1.0 - release lock on exit
+        .. versionchanged:: 1.0.0 disconnect enforced on close
+        .. versionchanged:: 1.1.0 release lock on exit
         """
         self.close()
         self.lock.release()
@@ -534,7 +537,7 @@ def execute_async(
             typing.Optional[paramiko.ChannelFile],
         ]
 
-        .. versionchanged:: 1.2.0 - open_stdout and open_stderr flags
+        .. versionchanged:: 1.2.0 open_stdout and open_stderr flags
         """
         message = _log_templates.CMD_EXEC.format(cmd=command.rstrip())
         self.logger.debug(message)
@@ -690,7 +693,7 @@ def execute(
         self,
         command,  # type: str
         verbose=False,  # type: bool
-        timeout=None,  # type: typing.Optional[int]
+        timeout=constants.DEFAULT_TIMEOUT,  # type: typing.Optional[int]
         **kwargs
     ):  # type: (...) -> exec_result.ExecResult
         """Execute command and wait for return code.
@@ -703,6 +706,8 @@ def execute(
         :type timeout: typing.Optional[int]
         :rtype: ExecResult
         :raises: ExecHelperTimeoutError
+
+        .. versionchanged:: 1.2.0 default timeout 1 hour
         """
         (
             chan,  # type: paramiko.channel.Channel
@@ -726,7 +731,7 @@ def check_call(
         self,
         command,  # type: str
         verbose=False,  # type: bool
-        timeout=None,  # type: typing.Optional[int]
+        timeout=constants.DEFAULT_TIMEOUT,  # type: typing.Optional[int]
         error_info=None,  # type: typing.Optional[str]
         expected=None,  # type: typing.Optional[typing.Iterable[]]
         raise_on_err=True,  # type: bool
@@ -748,6 +753,8 @@ def check_call(
         :type raise_on_err: bool
         :rtype: ExecResult
         :raises: CalledProcessError
+
+        .. versionchanged:: 1.2.0 default timeout 1 hour
         """
         expected = proc_enums.exit_codes_to_enums(expected)
         ret = self.execute(command, verbose, timeout, **kwargs)
@@ -770,7 +777,7 @@ def check_stderr(
         self,
         command,  # type: str
         verbose=False,  # type: bool
-        timeout=None,  # type: typing.Optional[int]
+        timeout=constants.DEFAULT_TIMEOUT,  # type: typing.Optional[int]
         error_info=None,  # type: typing.Optional[str]
         raise_on_err=True,  # type: bool
         **kwargs
@@ -791,6 +798,7 @@ def check_stderr(
         :raises: CalledProcessError
 
         .. note:: expected return codes can be overridden via kwargs.
+        .. versionchanged:: 1.2.0 default timeout 1 hour
         """
         ret = self.check_call(
             command, verbose, timeout=timeout,
@@ -816,7 +824,7 @@ def execute_through_host(
         auth=None,  # type: typing.Optional[ssh_auth.SSHAuth]
         target_port=22,  # type: int
         verbose=False,  # type: bool
-        timeout=None,  # type: typing.Optional[int]
+        timeout=constants.DEFAULT_TIMEOUT,  # type: typing.Optional[int]
         get_pty=False,  # type: bool
         **kwargs
     ):  # type: (...) -> exec_result.ExecResult
@@ -838,6 +846,8 @@ def execute_through_host(
         :type get_pty: bool
         :rtype: ExecResult
         :raises: ExecHelperTimeoutError
+
+        .. versionchanged:: 1.2.0 default timeout 1 hour
         """
         if auth is None:
             auth = self.auth
@@ -880,7 +890,7 @@ def execute_together(
         cls,
         remotes,  # type: typing.Iterable[SSHClientBase]
         command,  # type: str
-        timeout=None,  # type: typing.Optional[int]
+        timeout=constants.DEFAULT_TIMEOUT,  # type: typing.Optional[int]
         expected=None,  # type: typing.Optional[typing.Iterable[]]
         raise_on_err=True,  # type: bool
         **kwargs
@@ -901,6 +911,8 @@ def execute_together(
         :rtype: typing.Dict[typing.Tuple[str, int], exec_result.ExecResult]
         :raises: ParallelCallProcessError
         :raises: ParallelCallExceptions
+
+        .. versionchanged:: 1.2.0 default timeout 1 hour
         """
         @threaded.threadpooled
         def get_result(

exec_helpers/constants.py

@@ -0,0 +1,27 @@
+#    Copyright 2018 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
+#    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.
+
+"""Global constants."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+
+MINUTE = 60
+HOUR = 60 * MINUTE
+
+
+# Default command timeout
+DEFAULT_TIMEOUT = 1 * HOUR

exec_helpers/exceptions.py

@@ -15,6 +15,8 @@
 """Package specific exceptions."""
 
 from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
 
 import typing
 

exec_helpers/exec_result.py

@@ -17,6 +17,7 @@
 """Execution restult."""
 
 from __future__ import absolute_import
+from __future__ import division
 from __future__ import unicode_literals
 
 import datetime

exec_helpers/proc_enums.py

@@ -20,6 +20,7 @@
 """
 
 from __future__ import absolute_import
+from __future__ import division
 from __future__ import unicode_literals
 
 import enum