Fix: unicode decode errors in exceptions

* fix fresh mypy
* fix fresh futures checker

Author: penguinolog

.pylintrc

@@ -28,7 +28,7 @@ unsafe-load-any-extension=no
 # A comma-separated list of package or module names from where C extensions may
 # be loaded. Extensions are loading into the active Python interpreter and may
 # run arbitrary code
-extension-pkg-whitelist=
+extension-pkg-whitelist=lxml.etree
 
 # Allow optimization of some AST trees. This will activate a peephole AST
 # optimizer, which will apply various small optimizations. For instance, it can

exec_helpers/_log_templates.py

@@ -23,6 +23,7 @@
 # Standard Library
 import abc
 import base64
+
 # noinspection PyCompatibility
 import concurrent.futures
 import copy
@@ -43,7 +44,6 @@
 import threaded
 
 # Exec-Helpers Implementation
-from exec_helpers import _log_templates
 from exec_helpers import api
 from exec_helpers import constants
 from exec_helpers import exceptions
@@ -159,7 +159,7 @@ def __call__(  # type: ignore
                 # If we have only cache reference and temporary getrefcount
                 # reference: close connection before deletion
                 cls.__cache[key].logger.debug("Closing as unused")
-                cls.__cache[key].close()  # type: ignore
+                cls.__cache[key].close()
             del cls.__cache[key]
         # noinspection PyArgumentList
         ssh = super(_MemorizedSSH, cls).__call__(
@@ -185,15 +185,15 @@ def clear_cache(mcs):  # type: (typing.Type[_MemorizedSSH]) -> None
         for ssh in mcs.__cache.values():
             if CPYTHON and sys.getrefcount(ssh) == n_count:  # pragma: no cover
                 ssh.logger.debug("Closing as unused")
-                ssh.close()  # type: ignore
+                ssh.close()
         mcs.__cache = {}
 
     @classmethod
     def close_connections(mcs):  # type: (typing.Type[_MemorizedSSH]) -> None
         """Close connections for selected or all cached records."""
         for ssh in mcs.__cache.values():
             if ssh.is_alive:
-                ssh.close()  # type: ignore
+                ssh.close()
 
 
 class _SudoContext(object):
@@ -459,7 +459,7 @@ def __exit__(self, exc_type, exc_val, exc_tb):  # type: (typing.Any, typing.Any,
         .. versionchanged:: 1.2.1 disconnect enforced on close only not in keepalive mode
         """
         if not self.__keepalive_mode:
-            self.close()  # type: ignore
+            self.close()
         super(SSHClientBase, self).__exit__(exc_type, exc_val, exc_tb)
 
     @property
@@ -498,7 +498,7 @@ def keepalive_mode(self, mode):  # type: (bool) -> None
     def reconnect(self):  # type: () -> None
         """Reconnect SSH session."""
         with self.lock:
-            self.close()  # type: ignore
+            self.close()
 
             self.__ssh = paramiko.SSHClient()
             self.__ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
@@ -577,7 +577,8 @@ def execute_async(
         cmd_for_log = self._mask_command(cmd=command, log_mask_re=log_mask_re)
 
         self.logger.log(
-            level=logging.INFO if verbose else logging.DEBUG, msg=_log_templates.CMD_EXEC.format(cmd=cmd_for_log)
+            level=logging.INFO if verbose else logging.DEBUG,
+            msg="Executing command:\n{cmd!r}\n".format(cmd=cmd_for_log),
         )
 
         chan = self._ssh.get_transport().open_session()
@@ -701,7 +702,7 @@ def poll_pipes():  # type: () -> None
         concurrent.futures.wait([future], 0.001)
         result.set_timestamp()
 
-        wait_err_msg = _log_templates.CMD_WAIT_ERROR.format(result=result, timeout=timeout)
+        wait_err_msg = exceptions.make_timeout_error_message(result=result, timeout=timeout)  # type: ignore
         self.logger.debug(wait_err_msg)
         raise exceptions.ExecHelperTimeoutError(result=result, timeout=timeout)  # type: ignore
 
@@ -743,7 +744,8 @@ def execute_through_host(
         """
         cmd_for_log = self._mask_command(cmd=command, log_mask_re=kwargs.get("log_mask_re", None))
         self.logger.log(
-            level=logging.INFO if verbose else logging.DEBUG, msg=_log_templates.CMD_EXEC.format(cmd=cmd_for_log)
+            level=logging.INFO if verbose else logging.DEBUG,
+            msg="Executing command:\n{cmd!r}\n".format(cmd=cmd_for_log),
         )
 
         if auth is None:

exec_helpers/_ssh_client_base.py

@@ -22,7 +22,6 @@
 import typing
 
 # Exec-Helpers Implementation
-from exec_helpers import _log_templates
 from exec_helpers import proc_enums
 
 if typing.TYPE_CHECKING:  # pragma: no cover
@@ -110,10 +109,36 @@ def __init__(self, result, timeout):  # type: (exec_result.ExecResult, typing.Un
         :param timeout: timeout for command
         :type timeout: typing.Union[int, float]
         """
-        message = _log_templates.CMD_KILL_ERROR.format(result=result, timeout=timeout)
+        stdout_brief = result.stdout_brief.encode(encoding="utf-8", errors="backslashreplace").decode("utf-8")
+        stderr_brief = result.stderr_brief.encode(encoding="utf-8", errors="backslashreplace").decode("utf-8")
+        message = (
+            "Wait for {result.cmd!r} during {timeout!s}s: no return code and no response on SIGTERM + SIGKILL signals!"
+            "\n"
+            "\tSTDOUT:\n"
+            "{stdout_brief}\n"
+            "\tSTDERR:\n"
+            "{stderr_brief}".format(
+                result=result, timeout=timeout, stdout_brief=stdout_brief, stderr_brief=stderr_brief
+            )
+        )
         super(ExecHelperNoKillError, self).__init__(message, result=result, timeout=timeout)
 
 
+def make_timeout_error_message(
+    result, timeout
+):  # type: (exec_result.ExecResult, typing.Union[int, float]) -> typing.Text
+    """Make timeout failed message."""
+    stdout_brief = result.stdout_brief.encode(encoding="utf-8", errors="backslashreplace").decode("utf-8")
+    stderr_brief = result.stderr_brief.encode(encoding="utf-8", errors="backslashreplace").decode("utf-8")
+    return (
+        "Wait for {result.cmd!r} during {timeout!s}s: no return code!\n"
+        "\tSTDOUT:\n"
+        "{stdout_brief}\n"
+        "\tSTDERR:\n"
+        "{stderr_brief}".format(result=result, timeout=timeout, stdout_brief=stdout_brief, stderr_brief=stderr_brief)
+    )
+
+
 class ExecHelperTimeoutError(ExecHelperTimeoutProcessError):
     """Execution timeout.
 
@@ -131,8 +156,9 @@ def __init__(self, result, timeout):  # type: (exec_result.ExecResult, typing.Un
         :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)
+        super(ExecHelperTimeoutError, self).__init__(
+            make_timeout_error_message(result=result, timeout=timeout), result=result, timeout=timeout
+        )
 
 
 class CalledProcessError(ExecCalledProcessError):
@@ -157,12 +183,17 @@ def __init__(
         """
         self.result = result
         self.expected = proc_enums.exit_codes_to_enums(expected)
+        stdout_brief = result.stdout_brief.encode(encoding="utf-8", errors="backslashreplace").decode("utf-8")
+        stderr_brief = result.stderr_brief.encode(encoding="utf-8", errors="backslashreplace").decode("utf-8")
         message = (
             "Command {result.cmd!r} returned exit code {result.exit_code} "
             "while expected {expected}\n"
             "\tSTDOUT:\n"
-            "{result.stdout_brief}\n"
-            "\tSTDERR:\n{result.stderr_brief}".format(result=self.result, expected=self.expected)
+            "{stdout_brief}\n"
+            "\tSTDERR:\n"
+            "{stderr_brief}".format(
+                result=self.result, expected=self.expected, stdout_brief=stdout_brief, stderr_brief=stderr_brief
+            )
         )
         super(CalledProcessError, self).__init__(message)
 

exec_helpers/exceptions.py

@@ -34,7 +34,6 @@
 import threaded
 
 # Exec-Helpers Implementation
-from exec_helpers import _log_templates
 from exec_helpers import _subprocess_helpers
 from exec_helpers import api
 from exec_helpers import exceptions
@@ -50,9 +49,9 @@ class SubprocessExecuteAsyncResult(api.ExecuteAsyncResult):
     """Override original NamedTuple with proper typing."""
 
     @property
-    def interface(self):  # type: () -> subprocess.Popen
+    def interface(self):  # type: () -> subprocess.Popen[typing.Union[str, typing.Text]]
         """Override original NamedTuple with proper typing."""
-        return super(SubprocessExecuteAsyncResult, self).interface
+        return super(SubprocessExecuteAsyncResult, self).interface  # type: ignore
 
 
 class Subprocess(api.ExecHelper):
@@ -165,7 +164,7 @@ def close_streams():  # type: () -> None
             result.set_timestamp()
             close_streams()
 
-        wait_err_msg = _log_templates.CMD_WAIT_ERROR.format(result=result, timeout=timeout)
+        wait_err_msg = exceptions.make_timeout_error_message(result=result, timeout=timeout)
         self.logger.debug(wait_err_msg)
         raise exceptions.ExecHelperTimeoutError(result=result, timeout=timeout)
 
@@ -217,7 +216,8 @@ def execute_async(
         cmd_for_log = self._mask_command(cmd=command, log_mask_re=log_mask_re)
 
         self.logger.log(
-            level=logging.INFO if verbose else logging.DEBUG, msg=_log_templates.CMD_EXEC.format(cmd=cmd_for_log)
+            level=logging.INFO if verbose else logging.DEBUG,
+            msg="Executing command:\n{cmd!r}\n".format(cmd=cmd_for_log),
         )
 
         started = datetime.datetime.utcnow()

exec_helpers/subprocess_runner.py

@@ -53,6 +53,7 @@ deps =
 commands = pip install ./ -vvv -U
 
 [testenv:pylint]
+basepython=python2
 usedevelop = False
 deps =
   pylint<2
@@ -101,6 +102,8 @@ ignore =
   FI16
 # __future__ import "generators" missing
   FI17
+#__future__ import "annotations" missing
+  FI18
 # line break before binary operator
   W503
 # First line should be in imperative mood; try rephrasing