python-useful-helpers / exec-helpers / 40924888230

89%

push

github

Fix SFTP path checks hiding a failed reconnect, restore the SFTP tests (#175)

* Port the skipped SFTP tests to pytest

mkdir, rm_rf, upload and download were tested only by skipped tests whose
mocks no longer matched the code (os.path and os.walk instead of pathlib).

- Rewrite them as pytest functions on the shared conftest fixtures.
- Use a temporary local tree instead of mocking the local filesystem.
- Cover upload into a remote directory and download of a missing path and
  of a directory.

* Raise a failed reconnect from the SFTP path checks

Since 8.2.1 a closed client reconnects before opening SFTP, but exists,
isfile, isdir and islink did that inside the try that maps OSError to
False. A reconnect that failed with a socket error (connection refused,
host unreachable) was therefore reported as a missing path, and a caller
skipped a cleanup or an upload without any error.

- Open the session before the try, so only an error from lstat becomes False.
- Document the raised exceptions in the docstrings and in SSHClient.rst.

* Create the remote directory when uploading a directory

upload() copied the contents of a local directory but never created the
remote directory they go into. A target that did not exist yet was
created only as a side effect of mkdir -p for a subdirectory, so the
upload failed when a file came first, and an empty directory produced
nothing.

- Create the target directory before copying what is inside the source.
- Test upload into an existing remote directory and to a new path.

344 of 442 branches covered (77.83%)

Branch coverage included in aggregate %.

9 of 9 new or added lines in 2 files covered. (100.0%)

1747 of 1919 relevant lines covered (91.04%)

6.95 hits per line