Properly collect coverage on azure

(cherry picked from commit d1c92f8)

better coverage: remove useless lines from abstract methods, branches

(cherry picked from commit a47b657)

use libyaml pyyaml, when it possible

(cherry picked from commit 66a8e5b)

fix bandit checker

(cherry picked from commit 32022ad)

rename ssh connection logger to separate from logger path

(cherry picked from commit c6f9705)

Properly work with isfile/isdir/islink

* add islink
* add symlink (`os.symlink` mimic)
* add chmod (`os.chmod` mimic)

(cherry picked from commit 5e9bea3)

Fix pylint warnings: install isort with toml support

Author: penguinolog

.coveragerc

@@ -1,16 +1,19 @@
 [run]
 source =
-    exec_helpers
+  exec_helpers
 omit =
-    test/*
-
+  test/*
+branch = True
 [report]
 exclude_lines =
-    # Have to re-enable the standard pragma
-    pragma: no cover
+  # Have to re-enable the standard pragma
+  pragma: no cover
+
+  # Don't complain about missing debug-only code:
+  def __repr__
 
-    # Don't complain about missing debug-only code:
-    def __repr__
+  # Don't complain if tests don't hit defensive assertion code:
+    raise NotImplementedError
 
-    # Don't complain if non-runnable code isn't run:
-    if __name__ == .__main__.:
+  # Don't complain if non-runnable code isn't run:
+  if __name__ == .__main__.:

.travis.yml

@@ -47,7 +47,7 @@ jobs:
       install:
         - *upgrade_python_toolset
         - *install_deps
-        - pip install --upgrade "pylint < 2.0"
+        - pip install --upgrade "pylint < 2.0" isort[pyproject,requirements]
       script:
         - pylint exec_helpers
     - <<: *static_analysis

doc/source/SSHClient.rst

@@ -271,31 +271,39 @@ API: SSHClient and SSHAuth.
 
         Open file on remote using SFTP session.
 
+        :param path: filesystem object path
         :type path: ``str``
+        :param mode: open file mode ('t' is not supported)
         :type mode: ``str``
+        :return: file.open() stream
+        :rtype: ``paramiko.SFTPFile``
 
     .. py:method:: exists(path)
 
         Check for file existence using SFTP session.
 
+        :param path: filesystem object path
         :type path: ``str``
+        :return: path is valid (object exists)
         :rtype: ``bool``
 
     .. py:method:: stat(path)
 
         Get stat info for path with following symlinks.
 
+        :param path: filesystem object path
         :type path: ``str``
+        :return: stat like information for remote path
         :rtype: ``paramiko.sftp_attr.SFTPAttributes``
 
     .. py:method:: utime(path, times=None):
 
         Set atime, mtime.
 
         :param path: filesystem object path
-        :type path: str
+        :type path: ``str``
         :param times: (atime, mtime)
-        :type times: typing.Optional[typing.Tuple[int, int]]
+        :type times: ``typing.Optional[typing.Tuple[int, int]]``
         :rtype: None
 
         .. versionadded:: 1.0.0
@@ -304,16 +312,47 @@ API: SSHClient and SSHAuth.
 
         Check, that path is file using SFTP session.
 
+        :param path: remote path to validate
         :type path: ``str``
+        :return: path is file
         :rtype: ``bool``
 
     .. py:method:: isdir(path)
 
         Check, that path is directory using SFTP session.
 
+        :param path: remote path to validate
+        :type path: ``str``
+        :return: path is directory
+        :rtype: ``bool``
+
+    .. py:method:: islink(path)
+
+        Check, that path is symlink using SFTP session.
+
+        :param path: remote path to validate
         :type path: ``str``
+        :return: path is symlink
         :rtype: ``bool``
 
+    .. py:method:: symlink(source, dest)
+
+        Produce symbolic link like `os.symlink`.
+
+        :param source: source path
+        :type source: ``str``
+        :param dest: source path
+        :type dest: ``str``
+
+    .. py:method:: chmod(path, mode)
+
+        Change the mode (permissions) of a file like `os.chmod`.
+
+        :param path: filesystem object path
+        :type path: ``str``
+        :param mode: new permissions
+        :type mode: ``int``
+
     **Non standard methods:**
 
     .. py:method:: mkdir(path)

exec_helpers/_ssh_client_base.py

@@ -290,7 +290,7 @@ def __init__(
         .. note:: auth has priority over username/password/private_keys
         """
         super(SSHClientBase, self).__init__(
-            logger=logging.getLogger(self.__class__.__name__).getChild("{host}:{port}".format(host=host, port=port))
+            logger=logging.getLogger(self.__class__.__name__).getChild("({host}:{port})".format(host=host, port=port))
         )
 
         self.__hostname = host
@@ -952,7 +952,7 @@ def isfile(self, path):  # type: (typing.Union[str, typing.Text]) -> bool
         """
         try:
             attrs = self._sftp.lstat(path)
-            return attrs.st_mode & stat.S_IFREG != 0  # type: ignore
+            return stat.S_ISREG(attrs.st_mode)
         except IOError:
             return False
 
@@ -966,6 +966,40 @@ def isdir(self, path):  # type: (typing.Union[str, typing.Text]) -> bool
         """
         try:
             attrs = self._sftp.lstat(path)
-            return attrs.st_mode & stat.S_IFDIR != 0  # type: ignore
+            return stat.S_ISDIR(attrs.st_mode)
         except IOError:
             return False
+
+    def islink(self, path):  # type: (typing.Union[str, typing.Text]) -> bool
+        """Check, that path is symlink using SFTP session.
+
+        :param path: remote path to validate
+        :type path: str
+        :return: path is symlink
+        :rtype: bool
+        """
+        try:
+            attrs = self._sftp.lstat(path)
+            return stat.S_ISLNK(attrs.st_mode)
+        except IOError:
+            return False
+
+    def symlink(self, source, dest):  # type: (typing.Union[str, typing.Text], typing.Union[str, typing.Text]) -> None
+        """Produce symbolic link like `os.symlink`.
+
+        :param source: source path
+        :type source: str
+        :param dest: source path
+        :type dest: str
+        """
+        self._sftp.symlink(source, dest)  # pragma: no cover
+
+    def chmod(self, path, mode):  # type: (typing.Union[str, typing.Text],int) -> None
+        """Change the mode (permissions) of a file like `os.chmod`.
+
+        :param path: filesystem object path
+        :type path: str
+        :param mode: new permissions
+        :type mode: int
+        """
+        self._sftp.chmod(path, mode)  # pragma: no cover

exec_helpers/api.py

@@ -282,7 +282,6 @@ def execute_async(
         .. versionchanged:: 1.4.0 Use typed NamedTuple as result
         .. versionchanged:: 1.12.0 support chroot
         """
-        raise NotImplementedError  # pragma: no cover
 
     @abc.abstractmethod
     def _exec_command(
@@ -315,7 +314,6 @@ def _exec_command(
 
         .. versionchanged:: 1.2.0 log_mask_re regex rule for masking cmd
         """
-        raise NotImplementedError  # pragma: no cover
 
     def execute(
         self,

exec_helpers/exec_result.py

@@ -486,6 +486,8 @@ def __deserialize(self, fmt):  # type: (typing.Text) -> typing.Any
             if fmt == "json":
                 return json.loads(self.stdout_str, encoding="utf-8")
             if fmt == "yaml":
+                if yaml.__with_libyaml__:
+                    return yaml.load(self.stdout_str, Loader=yaml.CSafeLoader)  # nosec  # Safe
                 return yaml.safe_load(self.stdout_str)
         except Exception:
             tmpl = " stdout is not valid {fmt}:\n" "{{stdout!r}}\n".format(fmt=fmt)

test/test_sftp.py

@@ -159,6 +159,38 @@ def __init__(self, mode):
         self.assertFalse(result)
         lstat.assert_called_once_with(dst)
 
+    def test_islink(self, client, *args):
+        class Attrs:
+            def __init__(self, mode):
+                self.st_mode = mode
+
+        ssh, _sftp = self.prepare_sftp_file_tests(client)
+        lstat = mock.Mock()
+        _sftp.attach_mock(lstat, "lstat")
+        lstat.return_value = Attrs(stat.S_IFLNK)
+        dst = "/etc/passwd"
+
+        # noinspection PyTypeChecker
+        result = ssh.islink(dst)
+        self.assertTrue(result)
+        lstat.assert_called_once_with(dst)
+
+        # Negative scenario
+        lstat.reset_mock()
+        lstat.return_value = Attrs(stat.S_IFREG)
+
+        # noinspection PyTypeChecker
+        result = ssh.islink(dst)
+        self.assertFalse(result)
+        lstat.assert_called_once_with(dst)
+
+        lstat.reset_mock()
+        lstat.side_effect = IOError
+        # noinspection PyTypeChecker
+        result = ssh.islink(dst)
+        self.assertFalse(result)
+        lstat.assert_called_once_with(dst)
+
     @mock.patch("exec_helpers.ssh_client.SSHClient.exists")
     @mock.patch("exec_helpers.ssh_client.SSHClient.execute")
     def test_mkdir(self, execute, exists, *args):

tox.ini

@@ -56,6 +56,7 @@ commands = pip install ./ -vvv -U
 usedevelop = False
 deps =
   pylint<2
+  isort[pyproject,requirements]
   -r{toxinidir}/CI_REQUIREMENTS.txt
 commands = pylint exec_helpers