Better timeout handling, exit codes enum update

(cherry picked from commit 00a91bd)

Author: penguinolog

README.rst

@@ -110,7 +110,6 @@ Context manager is available, connection is closed and lock is released on exit
 Subprocess
 ----------
 
-No initialization required.
 Context manager is available, subprocess is killed and lock is released on exit from context.
 
 Base methods
@@ -138,7 +137,7 @@ This methods are almost the same for `SSHCleint` and `Subprocess`, except specif
         verbose=False,  # type: bool
         timeout=1 * 60 * 60,  # type: type: typing.Union[int, float, None]
         error_info=None,  # type: typing.Optional[str]
-        expected=None,  # type: typing.Optional[typing.Iterable[int]]
+        expected=(0,),  # type: typing.Iterable[typing.Union[int, ExitCodes]]
         raise_on_err=True,  # type: bool
         **kwargs
     )

exec_helpers/__init__.py

@@ -16,6 +16,8 @@
 
 from __future__ import absolute_import
 
+import typing
+
 import pkg_resources
 
 from .proc_enums import ExitCodes
@@ -26,6 +28,7 @@
     CalledProcessError,
     ParallelCallProcessError,
     ParallelCallExceptions,
+    ExecHelperNoKillError,
     ExecHelperTimeoutError,
 )
 
@@ -42,6 +45,7 @@
     "CalledProcessError",
     "ParallelCallExceptions",
     "ParallelCallProcessError",
+    "ExecHelperNoKillError",
     "ExecHelperTimeoutError",
     "ExecHelper",
     "SSHClient",
@@ -51,7 +55,7 @@
     "SubprocessExecuteAsyncResult",
     "ExitCodes",
     "ExecResult",
-)
+)  # type: typing.Tuple[str, ...]
 
 try:  # pragma: no cover
     __version__ = pkg_resources.get_distribution(__name__).version

exec_helpers/_log_templates.py

@@ -22,6 +22,14 @@
 
 CMD_EXEC = "Executing command:\n{cmd!r}\n"
 
+CMD_KILL_ERROR = (
+    "Wait for {result.cmd!r} during {timeout!s}s: no return code and no response on SIGTERM + SIGKILL signals!\n"
+    "\tSTDOUT:\n"
+    "{result.stdout_brief}\n"
+    "\tSTDERR:\n"
+    "{result.stderr_brief}"
+)
+
 CMD_WAIT_ERROR = (
     "Wait for {result.cmd!r} during {timeout!s}s: no return code!\n"
     "\tSTDOUT:\n"

exec_helpers/_ssh_client_base.py

@@ -786,7 +786,7 @@ def execute_together(
         remotes,  # type: typing.Iterable[SSHClientBase]
         command,  # type: str
         timeout=constants.DEFAULT_TIMEOUT,  # type: typing.Union[int, float, None]
-        expected=None,  # type: typing.Optional[typing.Iterable[int]]
+        expected=(proc_enums.EXPECTED,),  # type: typing.Iterable[typing.Union[int, proc_enums.ExitCodes]]
         raise_on_err=True,  # type: bool
         **kwargs  # type: typing.Any
     ):  # type: (...) -> typing.Dict[typing.Tuple[str, int], exec_result.ExecResult]
@@ -799,7 +799,7 @@ def execute_together(
         :param timeout: Timeout for command execution.
         :type timeout: typing.Union[int, float, None]
         :param expected: expected return codes (0 by default)
-        :type expected: typing.Optional[typing.Iterable[]]
+        :type expected: typing.Iterable[typing.Union[int, proc_enums.ExitCodes]]
         :param raise_on_err: Raise exception on unexpected return code
         :type raise_on_err: bool
         :param kwargs: additional parameters for execute_async call.
@@ -811,6 +811,8 @@ def execute_together(
 
         .. versionchanged:: 1.2.0 default timeout 1 hour
         .. versionchanged:: 1.2.0 log_mask_re regex rule for masking cmd
+        .. versionchanged:: 1.10.0 Exception class can be substituted
+        .. versionchanged:: 1.10.0 Expected is not optional, defaults os dependent
         """
 
         @threaded.threadpooled
@@ -833,7 +835,6 @@ def get_result(remote):  # type: (SSHClientBase) -> exec_result.ExecResult
             async_result.interface.close()
             return res
 
-        expected = expected or [proc_enums.ExitCodes.EX_OK]
         expected = proc_enums.exit_codes_to_enums(expected)
 
         futures = {remote: get_result(remote) for remote in set(remotes)}  # Use distinct remotes

exec_helpers/api.py

@@ -280,7 +280,7 @@ def check_call(
         verbose=False,  # type: bool
         timeout=constants.DEFAULT_TIMEOUT,  # type: typing.Union[int, float, None]
         error_info=None,  # type: typing.Optional[str]
-        expected=None,  # type: typing.Optional[typing.Iterable[typing.Union[int, proc_enums.ExitCodes]]]
+        expected=(proc_enums.EXPECTED,),  # type: typing.Iterable[typing.Union[int, proc_enums.ExitCodes]]
         raise_on_err=True,  # type: bool
         **kwargs  # type: typing.Any
     ):  # type: (...) -> exec_result.ExecResult
@@ -295,7 +295,7 @@ def check_call(
         :param error_info: Text for error details, if fail happens
         :type error_info: typing.Optional[str]
         :param expected: expected return codes (0 by default)
-        :type expected: typing.Optional[typing.Iterable[typing.Union[int, proc_enums.ExitCodes]]]
+        :type expected: typing.Iterable[typing.Union[int, proc_enums.ExitCodes]]
         :param raise_on_err: Raise exception on unexpected return code
         :type raise_on_err: bool
         :param kwargs: additional parameters for call.
@@ -306,6 +306,8 @@ def check_call(
         :raises CalledProcessError: Unexpected exit code
 
         .. versionchanged:: 1.2.0 default timeout 1 hour
+        .. versionchanged:: 1.10.0 Exception class can be substituted
+        .. versionchanged:: 1.10.0 Expected is not optional, defaults os dependent
         """
         expected_codes = proc_enums.exit_codes_to_enums(expected)
         ret = self.execute(command, verbose, timeout, **kwargs)

exec_helpers/exceptions.py

@@ -28,6 +28,7 @@
 
 __all__ = (
     "ExecHelperError",
+    "ExecHelperNoKillError",
     "ExecHelperTimeoutError",
     "ExecCalledProcessError",
     "CalledProcessError",
@@ -54,25 +55,27 @@ class ExecCalledProcessError(ExecHelperError):
     __slots__ = ()
 
 
-class ExecHelperTimeoutError(ExecCalledProcessError):
-    """Execution timeout.
-
-    .. versionchanged:: 1.3.0 provide full result and timeout inside.
-    .. versionchanged:: 1.3.0 subclass ExecCalledProcessError
-    """
+class ExecHelperTimeutProcessError(ExecCalledProcessError):
+    """Timeout based errors."""
 
     __slots__ = ("result", "timeout")
 
-    def __init__(self, result, timeout):  # type: (exec_result.ExecResult, typing.Union[int, float]) -> None
+    def __init__(
+        self,
+        message,  # type: str,
+        result,  # type: exec_result.ExecResult
+        timeout  # type: typing.Union[int, float]
+    ):  # type: (...) -> None
         """Exception for error on process calls.
 
+        :param message: exception message
+        :type message: str
         :param result: execution result
         :type result: exec_result.ExecResult
         :param timeout: timeout for command
         :type timeout: typing.Union[int, float]
         """
-        message = _log_templates.CMD_WAIT_ERROR.format(result=result, timeout=timeout)
-        super(ExecHelperTimeoutError, self).__init__(message)
+        super(ExecHelperTimeutProcessError, self).__init__(message)
         self.result = result
         self.timeout = timeout
 
@@ -92,6 +95,47 @@ def stderr(self):  # type: () -> typing.Text
         return self.result.stderr_str
 
 
+class ExecHelperNoKillError(ExecHelperTimeutProcessError):
+    """Impossible to kill process.
+
+    .. versionadded:: 1.10.0
+    """
+
+    __slots__ = ()
+
+    def __init__(self, result, timeout):  # type: (exec_result.ExecResult, typing.Union[int, float]) -> None
+        """Exception for error on process calls.
+
+        :param result: execution result
+        :type result: exec_result.ExecResult
+        :param timeout: timeout for command
+        :type timeout: typing.Union[int, float]
+        """
+        message = _log_templates.CMD_KILL_ERROR.format(result=result, timeout=timeout)
+        super(ExecHelperNoKillError, self).__init__(message, result=result, timeout=timeout)
+
+
+class ExecHelperTimeoutError(ExecHelperTimeutProcessError):
+    """Execution timeout.
+
+    .. versionchanged:: 1.3.0 provide full result and timeout inside.
+    .. versionchanged:: 1.3.0 subclass ExecCalledProcessError
+    """
+
+    __slots__ = ()
+
+    def __init__(self, result, timeout):  # type: (exec_result.ExecResult, typing.Union[int, float]) -> None
+        """Exception for error on process calls.
+
+        :param result: execution result
+        :type result: exec_result.ExecResult
+        :param timeout: timeout for command
+        :type timeout: typing.Union[int, float]
+        """
+        message = _log_templates.CMD_WAIT_ERROR.format(result=result, timeout=timeout)
+        super(ExecHelperTimeoutError, self).__init__(message, result=result, timeout=timeout)
+
+
 class CalledProcessError(ExecCalledProcessError):
     """Exception for error on process calls."""
 
@@ -100,19 +144,19 @@ class CalledProcessError(ExecCalledProcessError):
     def __init__(
         self,
         result,  # type: exec_result.ExecResult
-        expected=None,  # type: typing.Optional[typing.Iterable[typing.Union[int, proc_enums.ExitCodes]]]
+        expected=(proc_enums.EXPECTED,),  # type: typing.Iterable[typing.Union[int, proc_enums.ExitCodes]]
     ):  # type: (...) -> None
         """Exception for error on process calls.
 
         :param result: execution result
         :type result: exec_result.ExecResult
         :param expected: expected return codes
-        :type expected: typing.Optional[typing.Iterable[typing.Union[int, proc_enums.ExitCodes]]]
+        :type expected: typing.Iterable[typing.Union[int, proc_enums.ExitCodes]]
 
         .. versionchanged:: 1.1.1 - provide full result
+        .. versionchanged:: 1.10.0 Expected is not optional, defaults os dependent
         """
         self.result = result
-        expected = expected or [proc_enums.ExitCodes.EX_OK]
         self.expected = proc_enums.exit_codes_to_enums(expected)
         message = (
             "Command {result.cmd!r} returned exit code {result.exit_code} "
@@ -154,7 +198,7 @@ def __init__(
         command,  # type: str
         errors,  # type: typing.Dict[typing.Tuple[str, int], exec_result.ExecResult]
         results,  # type: typing.Dict[typing.Tuple[str, int], exec_result.ExecResult]
-        expected=None,  # type: typing.Optional[typing.List[typing.Union[int, proc_enums.ExitCodes]]]
+        expected=(proc_enums.EXPECTED,),  # type: typing.Iterable[typing.Union[int, proc_enums.ExitCodes]]
         **kwargs  # type: typing.Any
     ):  # type: (...) -> None
         """Exception raised during parallel call as result of exceptions.
@@ -166,10 +210,12 @@ def __init__(
         :param results: all results
         :type results: typing.Dict[typing.Tuple[str, int], ExecResult]
         :param expected: expected return codes
-        :type expected: typing.Optional[typing.List[typing.Union[int, proc_enums.ExitCodes]]]
-        :keyword _message: error message override
+        :type expected: typing.Iterable[typing.Union[int, proc_enums.ExitCodes]]
+        :param _message: message override
+        :type _message: typing.Optional[str]
+
+        .. versionchanged:: 1.10.0 Expected is not optional, defaults os dependent
         """
-        expected = expected or [proc_enums.ExitCodes.EX_OK]
         prep_expected = proc_enums.exit_codes_to_enums(expected)
         message = kwargs.get("_message", None) or (
             "Command {cmd!r} "
@@ -203,7 +249,7 @@ def __init__(
         exceptions,  # type: typing.Dict[typing.Tuple[str, int], Exception]
         errors,  # type: typing.Dict[typing.Tuple[str, int], exec_result.ExecResult]
         results,  # type: typing.Dict[typing.Tuple[str, int], exec_result.ExecResult]
-        expected=None,  # type: typing.Optional[typing.List[typing.Union[int, proc_enums.ExitCodes]]]
+        expected=(proc_enums.EXPECTED,),  # type: typing.List[typing.Union[int, proc_enums.ExitCodes]]
         **kwargs  # type: typing.Any
     ):  # type: (...) -> None
         """Exception during parallel execution.
@@ -217,10 +263,12 @@ def __init__(
         :param results: all results
         :type results: typing.Dict[typing.Tuple[str, int], ExecResult]
         :param expected: expected return codes
-        :type expected: typing.Optional[typing.List[typing.Union[int, proc_enums.ExitCodes]]]
-        :keyword _message: error message override
+        :type expected: typing.Iterable[typing.Union[int, proc_enums.ExitCodes]]
+        :param _message: message override
+        :type _message: typing.Optional[str]
+
+        .. versionchanged:: 1.10.0 Expected is not optional, defaults os dependent
         """
-        expected = expected or [proc_enums.ExitCodes.EX_OK]
         prep_expected = proc_enums.exit_codes_to_enums(expected)
         message = kwargs.get("_message", None) or (
             "Command {cmd!r} "

exec_helpers/exec_result.py

@@ -61,7 +61,7 @@ def __init__(
         stdin=None,  # type: typing.Union[bytes, str, bytearray, None]
         stdout=None,  # type: typing.Optional[typing.Iterable[bytes]]
         stderr=None,  # type: typing.Optional[typing.Iterable[bytes]]
-        exit_code=proc_enums.ExitCodes.EX_INVALID,  # type: typing.Union[int, proc_enums.ExitCodes]
+        exit_code=proc_enums.INVALID,  # type: typing.Union[int, proc_enums.ExitCodes]
     ):  # type: (...) -> None
         """Command execution result.
 
@@ -96,7 +96,7 @@ def __init__(
         else:
             self._stderr = ()
 
-        self.__exit_code = proc_enums.ExitCodes.EX_INVALID  # type: typing.Union[int, proc_enums.ExitCodes]
+        self.__exit_code = proc_enums.INVALID  # type: typing.Union[int, proc_enums.ExitCodes]
         self.__timestamp = None
         self.exit_code = exit_code
 
@@ -369,7 +369,7 @@ def exit_code(self, new_val):  # type: (typing.Union[int, proc_enums.ExitCodes])
             raise TypeError("Exit code is strictly int, got {!r}".format(new_val))
         with self.stdout_lock, self.stderr_lock:
             self.__exit_code = proc_enums.exit_code_to_enum(new_val)
-            if self.__exit_code != proc_enums.ExitCodes.EX_INVALID:
+            if self.__exit_code != proc_enums.INVALID:
                 self.__timestamp = datetime.datetime.utcnow()  # type: ignore
 
     def __deserialize(self, fmt):  # type: (str) -> typing.Any