diff --git a/.circleci/config.yml b/.circleci/config.yml index 26cf08b2..daedfccb 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1,21 +1,16 @@ version: 2.1 -orbs: - python: circleci/python@0.3.2 jobs: python_test: parameters: python_ver: type: string - default: "3.6" + default: "3.10" docker: - - image: circleci/python:<< parameters.python_ver >> + - image: cimg/python:<< parameters.python_ver >> steps: - checkout - - python/load-cache: - dependency-file: requirements_dev.txt - key: depsv3-{{ .Branch }}.{{ arch }}-PY<< parameters.python_ver >> - run: name: Deps command: | @@ -24,10 +19,9 @@ jobs: - run: command: | pip install -U -r requirements_dev.txt + set -x + eval "$(ssh-agent -s)" name: Build - - python/save-cache: - dependency-file: requirements_dev.txt - key: depsv3-{{ .Branch }}.{{ arch }}-PY<< parameters.python_ver >> - run: command: | python setup.py check --restructuredtext @@ -35,13 +29,18 @@ jobs: - run: command: | flake8 pssh + flake8 tests ci/integration_tests name: flake - run: command: | - set -x - eval "$(ssh-agent -s)" pytest + name: Test + - run: + command: | + pytest ci/integration_tests name: Integration tests + max_auto_reruns: 3 + auto_rerun_delay: 10s - run: command: | cd doc; make html @@ -59,12 +58,9 @@ jobs: release: docker: - - image: circleci/python:3.8 + - image: cimg/python:3.10 steps: - checkout - - python/load-cache: - key: releasedepsv1-{{ .Branch }}.{{ arch }} - dependency-file: requirements.txt - run: name: Deps command: | @@ -72,9 +68,6 @@ jobs: sudo apt-get install python3-pip pip install -U pip pip install -U twine - - python/save-cache: - key: releasedepsv1-{{ .Branch }}.{{ arch }} - dependency-file: requirements.txt - run: name: Build Wheels/Source Dist command: | @@ -94,10 +87,10 @@ workflows: matrix: parameters: python_ver: - - "3.6" - "3.8" - - "3.9" - - "3.10" + - "3.11" + - "3.12" + - "3.13" filters: tags: ignore: /.*/ diff --git a/.codecov.yml b/.codecov.yml index 4e2d9992..f621ff3b 100644 --- a/.codecov.yml +++ b/.codecov.yml @@ -9,3 +9,4 @@ coverage: ignore: - "embedded_server/.*" - "tests/.*" + - "ci/integration_tests/.*" diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index 2e531ddd..4dacf8b3 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -10,7 +10,7 @@ Following these guidelines helps to communicate that you respect the time of the There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, contributing docker images for a particular task, submitting bug reports or feature requests or writing code to be incorporated into the project. -Please do not use the issue tracker for support questions. Use the `mail group`_ for that or other question/answer channels like Stack Overflow. +Please do not use the issue tracker for support questions. Use `GitHub Discussions`_ for that or other question/answer channels like Stack Overflow. .. contents:: :local: @@ -23,7 +23,7 @@ when making contributions. Responsibilities -* Write PEP-8 compliant code of no more than 80 columns per line +* Write PEP-8 compliant code of no more than 100 columns per line - there is an automated test to check code for PEP-8. * If adding new features, write an appropriate test - see existing tests for reference * Contributions are expected to be in line with the project's stated `design and goals `_ * Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See the `Python Community Code of Conduct `_. @@ -46,8 +46,7 @@ and participate in the discussion. 2) **Determine if your bug is really a bug**. -You shouldn't file a bug if you're requesting support. For that you can use -the `mail group`_. +You shouldn't file a bug if you're requesting support. For that you can use `GitHub Discussions`_. 3) **Make sure your bug hasn't already been reported**. @@ -69,15 +68,14 @@ spelling or other errors on the documentation or code. A) If the error is from a Python traceback, include it in the bug report. - B) We also need to know what platform you're running (Windows, macOS, Linux, - etc.), the version of your Python interpreter, and the version of parallel-ssh, - and related packages that you were running when the bug occurred. + B) We also need to know what platform you're running (Windows, Mac OS X, Linux, + etc.), the version of your Python interpreter, the version of parallel-ssh, + and related packages that were used when the bug occurred. There is also an issue template to help with creating issues. 6) **Submit the bug**. - By default `GitHub`_ will email you to let you know when new comments have been made on your bug. In the event you've turned this feature off, you should check back on occasion to ensure you don't miss any questions a @@ -112,8 +110,7 @@ Working on Features & Patches so none of these steps should be considered mandatory. You can even send in patches by email if that's your preferred - work method. Any contribution you make - is always appreciated! + work method. Any contribution you make is always appreciated! However following these steps may make maintainers life easier, and may mean that your changes will be accepted sooner. @@ -129,7 +126,7 @@ to a directory on your machine: :: - $ git clone git@github.com:username/parallel-ssh.git + $ git clone https://github.com/ParallelSSH/parallel-ssh.git When the repository is cloned enter the directory to set up easy access to upstream changes: @@ -137,20 +134,14 @@ to upstream changes: :: $ cd parallel-ssh - $ git remote add upstream git://github.com/ParallelSSH/parallel-ssh.git + $ git remote add upstream https://github.com/ParallelSSH/parallel-ssh.git $ git fetch upstream -If you need to pull in new changes from upstream you should -always use the ``--rebase`` option to ``git pull``: +To update from upstream master branch use ``git pull``: :: - git pull --rebase upstream master - -With this option you don't clutter the history with merging -commit notes. See `Rebasing merge commits in git`_. -If you want to learn more about rebasing see the `Rebase`_ -section in the GitHub guides. + git pull upstream master If you need to work on a different branch than the one git calls ``master``, you can fetch and checkout a remote branch like this:: @@ -158,9 +149,6 @@ fetch and checkout a remote branch like this:: git checkout --track -b 3.0-devel origin/3.0-devel .. _`Fork a Repo`: https://help.github.com/fork-a-repo/ -.. _`Rebasing merge commits in git`: - https://notes.envato.com/developers/rebasing-merge-commits-in-git/ -.. _`Rebase`: https://help.github.com/rebase/ Virtual environments --------------------- @@ -183,7 +171,7 @@ If you are developing, then you need to install development requirements first: :: - $ nosetests + $ pytest .. _contributing-pull-requests: @@ -216,25 +204,19 @@ See `Closing issues using keywords`_ for more details. Calculating test coverage ~~~~~~~~~~~~~~~~~~~~~~~~~ -Add the ``--with-coverage`` flag to nose. +Pytest configuration always generates coverage reports. .. code-block:: shell - nosetests --with-coverage - coverage report -m + pytest -Total coverage is output even without the report command. - -``coverage report -m`` will in addition show which lines are missing coverage. +``coverage report -m`` will show the coverage report for any already run tests. Running the tests on all supported Python versions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -All supported Python versions are tested by Travis-CI via test targets. For -Travis-CI to run tests on a forked repository, Travis-CI integration will need -to be enabled on that repository. - -Please see `Travis-CI documentation for enabling your repository `_. +All supported Python versions are tested by the project's CI via test targets. Pull requests will trigger CI tests +automatically. For running tests on your own forked repository follow `CI documentation `_. Building the documentation -------------------------- @@ -244,7 +226,7 @@ build the docs by running: .. code-block:: shell - (cd docs; rm -rf _build; make html) + (cd docs; make clean; make html) Make sure there are no errors or warnings in the build output. After building succeeds the documentation is available at ``_build/html``. @@ -262,7 +244,7 @@ repository's root directory: .. code-block:: shell - nosetests + pytest To ensure the code is PEP-8 compliant: @@ -270,17 +252,16 @@ To ensure the code is PEP-8 compliant: flake8 pssh -To ensure documentation builds correctly: +To ensure documentation builds correctly, if any changes have been made to documentation: .. code-block:: shell - pip install sphinx (cd doc; make html) Generated documentation will be found in ``doc/_build/html`` in the repository's root directory. -See also `Travis-CI configuration `_ for which tests are subject to CI. +All required checks are run automatically by the CI and on all pull requests. .. _coding-style: @@ -351,10 +332,9 @@ following conventions. Release Procedure ================= -* Create new tag -* Add release notes for tag via GitHub releases - -Creating a new tag can be done via the Github Releases page automatically if one does not already exist. +* Create a new release via Github releases for a new tag +* Select +* Add release notes for tag via GitHub releases page Auto-versioning from Git tags and revision ------------------------------------------- @@ -366,26 +346,22 @@ preference: * Latest git tag plus git revision short hand since tag * Auto-generated version file for non-git installations -In order to publish a new version, just create and push a new tag. - -:: - - $ git tag X.Y.Z - $ git push --tags +Making a new release and creating a new tag for it will automatically create a new package version for that tag. -Releasing ---------- +Releasing a new package +------------------------ -New git tags are automatically published to PyPi via Travis-CI deploy +New git tags are automatically published to PyPi via CI deploy functionality, subject to all tests and checks passing. This includes documentation generating correctly for publishing to ReadTheDocs, style checks via ``flake8`` et al. -In addition to source code releases, binary wheels for Linux, OSX and Windows, all Python versions, are also built automatically for released tags only. Further more, system packages for the most popular Linux distributions are also built automatically and uploaded to Github Releases page for released tags only. +In addition to source code releases, binary wheel is also generated and published automatically and documentation is +updated automatically on ReadTheDocs. -Publishing to PyPi and ReadTheDocs is only possible with Travis-CI build +Publishing to PyPi and ReadTheDocs is only possible with CI build jobs initiated by the official GitHub project - forks cannot deploy to PyPi or publish documentation to ReadTheDocs. -.. _`mail group`: https://groups.google.com/forum/#!forum/parallelssh +.. _`GitHub Discussions`: https://github.com/orgs/ParallelSSH/discussions diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c31045cf..5891cbc5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -5,7 +5,7 @@ title: '' labels: '' --- -_For general questions please use the [mail group](https://groups.google.com/forum/#!forum/parallel-ssh)._ +_For general questions please use [GitHub Discussions](https://github.com/orgs/ParallelSSH/discussions). **Describe the bug** A clear and concise description of what the bug is. @@ -13,8 +13,8 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: -1. Example code that produces error. -2. Stack trace or error messages. +1. [Minimal reproducible example code](https://stackoverflow.com/help/minimal-reproducible-example). +2. Stack trace or error messages - use `pssh.utils.enable_debug_logger()` **Expected behavior** A clear and concise description of what you expected to happen. diff --git a/.gitignore b/.gitignore index 0ef5a19f..beffef77 100644 --- a/.gitignore +++ b/.gitignore @@ -45,7 +45,7 @@ pypy # Documentation builds doc/_build -tests/unit_test_cert_key-cert.pub -tests/embedded_server/principals -tests/embedded_server/sshd_config_* -tests/embedded_server/*.pid +ci/integration_tests/int_test_cert_key-cert.pub +ci/integration_tests/embedded_server/principals +ci/integration_tests/embedded_server/sshd_config_* +ci/integration_tests/embedded_server/*.pid diff --git a/.readthedocs.yml b/.readthedocs.yml index e5226632..1b49f428 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,9 +1,15 @@ version: 2 build: + os: ubuntu-24.04 + tools: + python: "3" apt_packages: - cmake - openssl +sphinx: + configuration: doc/conf.py python: install: + - requirements: doc/requirements.txt - method: pip path: . diff --git a/Changelog.rst b/Changelog.rst index 790ab3ea..4de37c94 100644 --- a/Changelog.rst +++ b/Changelog.rst @@ -1,5 +1,94 @@ Change Log -============ +========== + +2.17.0 (unreleased) +++++++++++++++++++++ + +Changes +-------- + +* All local file operations now use a thread pool to improve local file I/O performance. This includes loading private + key files from a local file path, identity authentication using local files as well as SFTP read/write operations on + local files. + + +2.16.0 ++++++++ + +Changes +------- + +* Added ``HostOutput.fully_qualified_command`` for a bytes-string of the fully qualified command executed on that host + after any and all host argument subtitutions, user switching, sudo, shell switching, encoding via specified encoding + et al. Populated on calls to ``run_command`` only. + + +2.15.0 +++++++ + +Changes +------- + +* Added compression support for all clients via ``SSHClient(compress=True)``, ``ParallelSSHClient(compress=True)`` and + ``HostConfig(compress=True)`` - defaults to off. #252 +* Added "keyboard interactive" login support for native clients. This is fully automated username and password + authentication via SSH's keyboard interactive authentication mechanism and does not actually require a human at the + keyboard. Used in cases where the server does not allow any other authentication mechanism. + Note that server configuration may disallow remote command execution via ``run_command`` when keyboard interactive + authentication is required - use interactive shells to run commands with in such cases. See + `Interactive Shells `_ + documentation. Also supported via ``HostConfig`` entries. Currently native clients only. +* Added ``pssh.exceptions.InvalidAPIUseError`` for errors raised on client initialisation when an invalid API use is + detected. For example, keyboard interactive authentication enabled without a password provided. +* Updated minimum ``ssh2-python`` and ``ssh-python`` requirements. + + +2.14.0 +++++++ + +Changes +------- + +* Handle disconnects better to allow for file descriptor reuse for both clients. +* Parallel clients no longer forcefully disconnect their clients at de-allocation - + now done by each individual ``SSHClient`` instead when that ``SSHClient`` goes out of scope. + This allows reading of output and anything associated with output, exit codes et al, + to work as long as one of either the client or an associated output object is alive. +* ``SSHClient.disconnect`` is now a no-op and deprecated - handled by object de-allocation. +* ``SSHClient.eagain`` is now a public function - wrapper for polling socket and calling a given socket using function. +* ``SSHClient.eagain_write`` is now a public function - wrapper for polling socket and calling a given socket using + write function. +* ``SSHClient``, ``TunnelServer`` and ``LocalForwarder`` now use their own gevent pools for greenlets spawned so they + are cleaned up correctly at shutdown. +* ``SSHClient.execute`` is now deprecated in favour of ``SSHClient.run_command``. + +Fixes +------ + +* Forwarder threads used for proxies would not exit gracefully at interpreter shutdown, sometimes causing segfaults. +* Client, both parallel and single, going out of scope would cause reading output from existing output objects + to break. +* Explicitly calling ``SSHClient.disconnect`` would sometimes cause segfaults at interpreter shutdown. +* Keepalives being configured on native client would keep client in scope forever. + + +2.13.0 ++++++++ + +Changes +------- + +* Minimum version updates for ``ssh2-python`` and `ssh-python``. +* Added support for Python 3.12+, removed support for Python <3.8. +* Package tests under top level ``tests`` directory are now cross platform and may be run by vendors. + Project CI specific ntegration tests moved into their own space. + + +Fixes +------ + +* Calling ``HostOutput.stdin.flush`` with a ``pssh.clients.ssh`` client would raise exception. + 2.12.0 +++++++ @@ -399,7 +488,7 @@ Fixes ------ * Reading from output streams with timeout via `run_command(<..>, timeout=)` would raise timeout early when -trying to read from a stream with no data written to it while other streams have pending data - #180. + trying to read from a stream with no data written to it while other streams have pending data - #180. 1.12.0 diff --git a/MANIFEST.in b/MANIFEST.in index d034d821..1d360a63 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -3,4 +3,12 @@ include pssh/_version.py include LICENSE include COPYING include COPYING.LESSER +exclude .codecov.yml +exclude .coveragerc +exclude .git* +exclude .pre-commit* +exclude .readthedocs.yml recursive-exclude tests * +recursive-exclude ci * +recursive-exclude .circleci * +recursive-exclude .github * \ No newline at end of file diff --git a/README.rst b/README.rst index bdf801b3..8945defa 100644 --- a/README.rst +++ b/README.rst @@ -25,6 +25,7 @@ Native code based clients with extremely high performance, making use of C libra :alt: Latest documentation .. _`read the docs`: https://parallel-ssh.readthedocs.org/en/latest/ +.. _`SFTP and SCP documentation`: https://parallel-ssh.readthedocs.io/en/latest/advanced.html#sftp-scp ************ Installation @@ -239,7 +240,7 @@ To copy a local file to remote hosts in parallel with SCP: cmds = client.scp_send('../test', 'test_dir/test') joinall(cmds, raise_error=True) -See `SFTP and SCP documentation `_ for more examples. +See `SFTP and SCP documentation`_ for more examples. ***** @@ -275,8 +276,4 @@ In addition, per-host configurable file name functionality is provided for both Directory recursion is supported in both cases via the ``recurse`` parameter - defaults to off. -See `SFTP and SCP documentation `_ for more examples. - - -.. image:: https://ga-beacon.appspot.com/UA-9132694-7/parallel-ssh/README.rst?pixel - :target: https://github.com/igrigorik/ga-beacon +See `SFTP and SCP documentation`_ for more examples. diff --git a/ci/integration_tests/__init__.py b/ci/integration_tests/__init__.py new file mode 100644 index 00000000..edc34670 --- /dev/null +++ b/ci/integration_tests/__init__.py @@ -0,0 +1,16 @@ +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA diff --git a/tests/client_pkey b/ci/integration_tests/client_pkey similarity index 100% rename from tests/client_pkey rename to ci/integration_tests/client_pkey diff --git a/tests/client_pkey.pub b/ci/integration_tests/client_pkey.pub similarity index 100% rename from tests/client_pkey.pub rename to ci/integration_tests/client_pkey.pub diff --git a/ci/integration_tests/embedded_server/__init__.py b/ci/integration_tests/embedded_server/__init__.py new file mode 100644 index 00000000..edc34670 --- /dev/null +++ b/ci/integration_tests/embedded_server/__init__.py @@ -0,0 +1,16 @@ +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA diff --git a/tests/embedded_server/authorized_keys b/ci/integration_tests/embedded_server/authorized_keys similarity index 100% rename from tests/embedded_server/authorized_keys rename to ci/integration_tests/embedded_server/authorized_keys diff --git a/tests/embedded_server/ca_host_key b/ci/integration_tests/embedded_server/ca_host_key similarity index 100% rename from tests/embedded_server/ca_host_key rename to ci/integration_tests/embedded_server/ca_host_key diff --git a/tests/embedded_server/ca_host_key-cert.pub b/ci/integration_tests/embedded_server/ca_host_key-cert.pub similarity index 100% rename from tests/embedded_server/ca_host_key-cert.pub rename to ci/integration_tests/embedded_server/ca_host_key-cert.pub diff --git a/tests/embedded_server/ca_host_key.pub b/ci/integration_tests/embedded_server/ca_host_key.pub similarity index 100% rename from tests/embedded_server/ca_host_key.pub rename to ci/integration_tests/embedded_server/ca_host_key.pub diff --git a/tests/embedded_server/ca_user_key b/ci/integration_tests/embedded_server/ca_user_key similarity index 100% rename from tests/embedded_server/ca_user_key rename to ci/integration_tests/embedded_server/ca_user_key diff --git a/tests/embedded_server/ca_user_key.pub b/ci/integration_tests/embedded_server/ca_user_key.pub similarity index 100% rename from tests/embedded_server/ca_user_key.pub rename to ci/integration_tests/embedded_server/ca_user_key.pub diff --git a/tests/embedded_server/openssh.py b/ci/integration_tests/embedded_server/openssh.py similarity index 81% rename from tests/embedded_server/openssh.py rename to ci/integration_tests/embedded_server/openssh.py index cd347d76..70459f87 100644 --- a/tests/embedded_server/openssh.py +++ b/ci/integration_tests/embedded_server/openssh.py @@ -1,19 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA import logging import os diff --git a/tests/embedded_server/principals.tmpl b/ci/integration_tests/embedded_server/principals.tmpl similarity index 100% rename from tests/embedded_server/principals.tmpl rename to ci/integration_tests/embedded_server/principals.tmpl diff --git a/tests/embedded_server/rsa.key b/ci/integration_tests/embedded_server/rsa.key similarity index 100% rename from tests/embedded_server/rsa.key rename to ci/integration_tests/embedded_server/rsa.key diff --git a/tests/embedded_server/sshd_config.tmpl b/ci/integration_tests/embedded_server/sshd_config.tmpl similarity index 79% rename from tests/embedded_server/sshd_config.tmpl rename to ci/integration_tests/embedded_server/sshd_config.tmpl index 20588ab5..a987483e 100644 --- a/tests/embedded_server/sshd_config.tmpl +++ b/ci/integration_tests/embedded_server/sshd_config.tmpl @@ -8,8 +8,14 @@ HostCertificate {{parent_dir}}/ca_host_key-cert.pub TrustedUserCAKeys {{parent_dir}}/ca_user_key.pub AuthorizedPrincipalsFile {{parent_dir}}/principals +MaxAuthTries 999 +MaxSessions 999 +MaxStartups 999 +# PerSourceMaxStartups 999 +# PerSourcePenaltyExemptList *.*.*.* + + AcceptEnv LANG LC_* Subsystem sftp internal-sftp AuthorizedKeysFile {{parent_dir}}/authorized_keys -MaxSessions 100 PidFile {{parent_dir}}/{{random_server}}.pid diff --git a/tests/unit_test_cert_key b/ci/integration_tests/int_test_cert_key similarity index 100% rename from tests/unit_test_cert_key rename to ci/integration_tests/int_test_cert_key diff --git a/tests/unit_test_cert_key.pub b/ci/integration_tests/int_test_cert_key.pub similarity index 100% rename from tests/unit_test_cert_key.pub rename to ci/integration_tests/int_test_cert_key.pub diff --git a/ci/integration_tests/libssh2_clients/__init__.py b/ci/integration_tests/libssh2_clients/__init__.py new file mode 100644 index 00000000..edc34670 --- /dev/null +++ b/ci/integration_tests/libssh2_clients/__init__.py @@ -0,0 +1,16 @@ +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA diff --git a/tests/native/base_ssh2_case.py b/ci/integration_tests/libssh2_clients/base_ssh2_case.py similarity index 65% rename from tests/native/base_ssh2_case.py rename to ci/integration_tests/libssh2_clients/base_ssh2_case.py index 9fdfff5e..ca67649a 100644 --- a/tests/native/base_ssh2_case.py +++ b/ci/integration_tests/libssh2_clients/base_ssh2_case.py @@ -1,19 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA import logging import os diff --git a/tests/native/test_parallel_client.py b/ci/integration_tests/libssh2_clients/test_parallel_client.py similarity index 94% rename from tests/native/test_parallel_client.py rename to ci/integration_tests/libssh2_clients/test_parallel_client.py index 72ea2cae..5029221d 100644 --- a/tests/native/test_parallel_client.py +++ b/ci/integration_tests/libssh2_clients/test_parallel_client.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA """Unittests for :mod:`pssh.ParallelSSHClient` class""" @@ -246,14 +246,14 @@ def test_pssh_client_run_command_get_output(self): (stderr, expected_stderr,)) - def test_pssh_client_run_long_command(self): - expected_lines = 5 - output = self.client.run_command(self.long_cmd(expected_lines)) - self.client.join(output) - stdout = list(output[0].stdout) - self.assertTrue(len(stdout) == expected_lines, - msg="Expected %s lines of response, got %s" % ( - expected_lines, len(stdout))) + # def test_pssh_client_run_long_command(self): + # expected_lines = 5 + # output = self.client.run_command(self.long_cmd(expected_lines)) + # self.client.join(output) + # stdout = list(output[0].stdout) + # self.assertTrue(len(stdout) == expected_lines, + # msg="Expected %s lines of response, got %s" % ( + # expected_lines, len(stdout))) def test_pssh_client_auth_failure(self): client = ParallelSSHClient([self.host], port=self.port, @@ -328,29 +328,29 @@ def test_zero_timeout(self): cmd = spawn(client.run_command, 'sleep .1', stop_on_errors=False) output = cmd.get(timeout=.3) self.assertTrue(output[0].exception is None) - - def test_pssh_client_long_running_command_exit_codes(self): - expected_lines = 2 - output = self.client.run_command(self.long_cmd(expected_lines)) - self.assertIsNone(output[0].exit_code) - self.assertFalse(self.client.finished(output)) - self.client.join(output, consume_output=True) - self.assertTrue(self.client.finished(output)) - self.assertEqual(output[0].exit_code, 0) - stdout = list(output[0].stdout) - self.assertEqual(len(stdout), 0) - - def test_pssh_client_long_running_command_exit_codes_no_stdout(self): - expected_lines = 2 - output = self.client.run_command(self.long_cmd(expected_lines)) - self.assertEqual(len(output), len(self.client.hosts)) - self.assertIsNone(output[0].exit_code) - self.assertFalse(self.client.finished(output)) - self.client.join(output) - self.assertTrue(self.client.finished(output)) - self.assertEqual(output[0].exit_code, 0) - stdout = list(output[0].stdout) - self.assertEqual(expected_lines, len(stdout)) + # + # def test_pssh_client_long_running_command_exit_codes(self): + # expected_lines = 2 + # output = self.client.run_command(self.long_cmd(expected_lines)) + # self.assertIsNone(output[0].exit_code) + # self.assertFalse(self.client.finished(output)) + # self.client.join(output, consume_output=True) + # self.assertTrue(self.client.finished(output)) + # self.assertEqual(output[0].exit_code, 0) + # stdout = list(output[0].stdout) + # self.assertEqual(len(stdout), 0) + # + # def test_pssh_client_long_running_command_exit_codes_no_stdout(self): + # expected_lines = 2 + # output = self.client.run_command(self.long_cmd(expected_lines)) + # self.assertEqual(len(output), len(self.client.hosts)) + # self.assertIsNone(output[0].exit_code) + # self.assertFalse(self.client.finished(output)) + # self.client.join(output) + # self.assertTrue(self.client.finished(output)) + # self.assertEqual(output[0].exit_code, 0) + # stdout = list(output[0].stdout) + # self.assertEqual(expected_lines, len(stdout)) def test_pssh_client_retries(self): """Test connection error retries""" @@ -945,7 +945,7 @@ def test_host_config(self): host_config=host_config, num_retries=1) output = client.run_command(self.cmd, stop_on_errors=False) - + client.join(output) self.assertEqual(len(hosts), len(output)) try: @@ -1070,6 +1070,35 @@ def test_per_host_dict_args(self): self.assertRaises(HostArgumentException, client.run_command, cmd, host_args=[host_args[0]]) + def test_per_host_args_fully_qualified_command_in_outputself(self): + host2, host3 = '127.0.0.2', '127.0.0.3' + server2 = OpenSSHServer(host2, port=self.port) + server3 = OpenSSHServer(host3, port=self.port) + servers = [server2, server3] + hosts = [self.host, host2, host3] + client = ParallelSSHClient(hosts, port=self.port, + pkey=self.user_key, + num_retries=2, + retry_delay=.2, + ) + host_args = (('arg1', 'arg2'), ('arg3', 'arg4'), ('arg5', 'arg6'),) + cmd = 'echo %s %s' + my_encoding = 'utf-8' + for server in servers: + server.start_server() + try: + output = client.run_command(cmd, host_args=host_args, encoding=my_encoding) + client.join() + for i, host_output in enumerate(output): + qualified_cmd = cmd % host_args[i] + self.assertEqual(host_output.fully_qualified_command, qualified_cmd.encode(my_encoding)) + self.assertEqual(host_output.fully_qualified_command.decode(host_output.encoding), qualified_cmd) + output_str = str(host_output) + self.assertTrue(len(output_str) > 0) + finally: + for server in servers: + server.stop() + def test_per_host_dict_args_invalid(self): cmd = 'echo %(host_arg1)s %(host_arg2)s' # Invalid number of host args @@ -1121,7 +1150,7 @@ def test_pty(self): expected_stdout = [] # With a PTY, stdout and stderr are combined into stdout self.assertEqual(expected_stderr, stdout) - self.assertEqual([], stderr) + self.assertEqual(expected_stdout, stderr) self.assertTrue(exit_code == 0) def test_output_attributes(self): @@ -1442,11 +1471,10 @@ def test_scp_send_dir(self): remote_test_dir, remote_filepath = 'remote_test_dir', 'test_file_copy' with open(local_filename, 'w') as file_h: file_h.writelines([test_file_data + os.linesep]) - remote_filename = os.path.sep.join([remote_test_dir, remote_filepath]) - remote_file_abspath = os.path.expanduser('~/' + remote_filename) + remote_filename_relpath = os.path.sep.join([remote_test_dir, remote_filepath]) remote_test_dir_abspath = os.path.expanduser('~/' + remote_test_dir) try: - cmds = self.client.scp_send(local_filename, remote_filename) + cmds = self.client.scp_send(local_filename, remote_filename_relpath) joinall(cmds, raise_error=True) except Exception as ex: self.assertIsInstance(ex, SCPError) @@ -1558,8 +1586,10 @@ def test_scp_bad_copy_args(self): def test_scp_send_exc(self): client = ParallelSSHClient([self.host], pkey=self.user_key, num_retries=1) + def _scp_send(*args): raise Exception + def _client_send(*args): return client._handle_greenlet_exc(_scp_send, 'fake') client._scp_send = _client_send @@ -1568,8 +1598,10 @@ def _client_send(*args): def test_scp_recv_exc(self): client = ParallelSSHClient([self.host], pkey=self.user_key, num_retries=1) + def _scp_recv(*args): raise Exception + def _client_recv(*args): return client._handle_greenlet_exc(_scp_recv, 'fake') client._scp_recv = _client_recv @@ -1776,7 +1808,7 @@ def test_client_disconnect(self): client.join(consume_output=True) single_client = list(client._host_clients.values())[0] del client - self.assertEqual(single_client.session, None) + self.assertIsNotNone(single_client.session) def test_client_disconnect_error(self): def disc(): @@ -1785,7 +1817,7 @@ def disc(): pkey=self.user_key, num_retries=1) output = client.run_command(self.cmd) client.join(output) - client._host_clients[(0, self.host)].disconnect = disc + client._host_clients[(0, self.host)]._disconnect = disc del client def test_multiple_join_timeout(self): @@ -1899,8 +1931,9 @@ def test_read_multi_same_hosts(self): self.client.run_command(self.cmd), ] for output in outputs: - for host_out in output: + for i, host_out in enumerate(output): stdout = list(host_out.stdout) + self.assertEqual(host_out.client.host, hosts[i]) self.assertListEqual(stdout, [self.resp]) @patch('pssh.clients.base.single.socket') @@ -1930,5 +1963,17 @@ def test_no_ipv6(self): self.assertEqual(self.host, host_out.host) self.assertIsInstance(host_out.exception, NoIPv6AddressFoundError) + def test_compression_enabled(self): + client = ParallelSSHClient([self.host], port=self.port, pkey=self.user_key, num_retries=1, compress=True) + output = client.run_command(self.cmd, stop_on_errors=False) + client.join(output) + self.assertTrue(client._host_clients[0, self.host].compress) + expected_exit_code = 0 + expected_stdout = [self.resp] + stdout = list(output[0].stdout) + exit_code = output[0].exit_code + self.assertEqual(expected_exit_code, exit_code) + self.assertEqual(expected_stdout, stdout) + # TODO: # * password auth diff --git a/tests/native/test_single_client.py b/ci/integration_tests/libssh2_clients/test_single_client.py similarity index 87% rename from tests/native/test_single_client.py rename to ci/integration_tests/libssh2_clients/test_single_client.py index 762a6366..de9156b0 100644 --- a/tests/native/test_single_client.py +++ b/ci/integration_tests/libssh2_clients/test_single_client.py @@ -1,31 +1,28 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA import os +import pytest import shutil import subprocess import tempfile from datetime import datetime -from hashlib import sha256 -from tempfile import NamedTemporaryFile -from unittest.mock import MagicMock, call, patch - -import pytest from gevent import sleep, spawn, Timeout as GTimeout, socket +from hashlib import sha256 from pytest import raises from ssh2.exceptions import (SocketDisconnectError, BannerRecvError, SocketRecvError, AgentConnectionError, AgentListIdentitiesError, @@ -33,6 +30,8 @@ AuthenticationError as SSH2AuthenticationError, ) from ssh2.session import Session +from tempfile import NamedTemporaryFile +from unittest.mock import MagicMock, call, patch from pssh.clients.native import SSHClient from pssh.exceptions import (AuthenticationException, ConnectionErrorException, @@ -56,7 +55,8 @@ def test_sftp_fail(self): self.assertRaises(SFTPError, self.client.sftp_put, sftp, 'a file', '/blah') def test_sftp_exc(self): - def _sftp_exc(local_file, remote_file): + + def _sftp_exc(_, __): raise SFTPProtocolError client = SSHClient(self.host, port=self.port, pkey=self.user_key, @@ -112,8 +112,8 @@ def test_ipv6(self, gsocket): getaddrinfo.return_value = [( socket.AF_INET6, socket.SocketKind.SOCK_STREAM, socket.IPPROTO_TCP, '', addr_info)] with raises(ConnectionError): - client = SSHClient(host, port=self.port, pkey=self.user_key, - num_retries=1) + SSHClient(host, port=self.port, pkey=self.user_key, + num_retries=1) getaddrinfo.assert_called_once_with(host, self.port, proto=socket.IPPROTO_TCP) sock_con.assert_called_once_with(addr_info) @@ -135,8 +135,8 @@ def test_multiple_available_addr(self, gsocket): (socket.AF_INET, socket.SocketKind.SOCK_STREAM, socket.IPPROTO_TCP, '', addr_info), ] with raises(ConnectionError): - client = SSHClient(host, port=self.port, pkey=self.user_key, - num_retries=1) + SSHClient(host, port=self.port, pkey=self.user_key, + num_retries=1) getaddrinfo.assert_called_with(host, self.port, proto=socket.IPPROTO_TCP) assert sock_con.call_count == len(getaddrinfo.return_value) @@ -177,12 +177,19 @@ def test_execute(self): output = list(host_out.stdout) stderr = list(host_out.stderr) expected = [self.resp] + expected_stderr = [] exit_code = host_out.channel.get_exit_status() self.assertEqual(host_out.exit_code, 0) + self.assertEqual(host_out.exit_code, exit_code) self.assertEqual(expected, output) - + self.assertEqual(expected_stderr, stderr) + + def test_execute_depr(self): + chan = self.client.execute(self.cmd) + self.assertIsNotNone(chan) + def test_alias(self): - client = SSHClient(self.host, port=self.port, + client = SSHClient(self.host, port=self.port, pkey=self.user_key, num_retries=1, alias='test') host_out = client.run_command(self.cmd) @@ -194,7 +201,8 @@ def test_open_session_timeout(self): num_retries=1, retry_delay=.1, timeout=.1) - def _session(timeout=None): + + def _session(_=None): sleep(.2) client.open_session = _session self.assertRaises(GTimeout, client.run_command, self.cmd) @@ -202,6 +210,7 @@ def _session(timeout=None): def test_open_session_exc(self): class Error(Exception): pass + def _session(): raise Error client = SSHClient(self.host, port=self.port, @@ -241,8 +250,9 @@ def test_long_running_cmd(self): def test_manual_auth(self): client = SSHClient(self.host, port=self.port, pkey=self.user_key, - num_retries=1, - allow_agent=False) + num_retries=2, + allow_agent=False, + timeout=.1) client.session.disconnect() del client.session del client.sock @@ -265,16 +275,14 @@ class _SSHClient(SSHClient): pkey=self.user_key, num_retries=1, allow_agent=False) - client.disconnect() client.pkey = None - del client.session - del client.sock + client._disconnect() client._connect(self.host, self.port) client._init_session() client.IDENTITIES = (self.user_key,) # Default identities auth only should succeed client._identity_auth() - client.disconnect() + client._disconnect() client._connect(self.host, self.port) client._init_session() # Auth should succeed @@ -299,8 +307,10 @@ def test_no_auth(self): def test_agent_auth_failure(self): class UnknownError(Exception): pass + def _agent_auth_unk(): raise UnknownError + def _agent_auth_agent_err(): raise AgentConnectionError client = SSHClient(self.host, port=self.port, @@ -351,9 +361,37 @@ def test_handshake_fail(self): client = SSHClient(self.host, port=self.port, pkey=self.user_key, num_retries=1) - client.session.disconnect() + client.eagain(client.session.disconnect) self.assertRaises((SocketDisconnectError, BannerRecvError, SocketRecvError), client._init_session) + @patch('gevent.socket.socket') + @patch('pssh.clients.native.single.Session') + def test_sock_shutdown_fail(self, mock_sess, mock_sock): + sess = MagicMock() + sock = MagicMock() + mock_sess.return_value = sess + mock_sock.return_value = sock + + hand_mock = MagicMock() + sess.handshake = hand_mock + retries = 2 + client = SSHClient(self.host, port=self.port, + num_retries=retries, + timeout=.1, + retry_delay=.1, + _auth_thread_pool=False, + allow_agent=False, + ) + self.assertIsInstance(client, SSHClient) + hand_mock.side_effect = AuthenticationError + sock.closed = False + sock.detach = MagicMock() + sock.detach.side_effect = Exception + self.assertRaises(AuthenticationError, client._init_session) + self.assertEqual(sock.detach.call_count, retries) + client._disconnect() + self.assertIsNone(client.sock) + def test_stdout_parsing(self): dir_list = os.listdir(os.path.expanduser('~')) host_out = self.client.run_command('ls -la') @@ -363,11 +401,12 @@ def test_stdout_parsing(self): self.assertEqual(len(dir_list), len(output) - 3) def test_file_output_parsing(self): + abs_file = os.sep.join([ + os.path.dirname(__file__), '..', '..', '..', 'setup.py', + ]) lines = int(subprocess.check_output( - ['wc', '-l', 'README.rst']).split()[0]) - dir_name = os.path.dirname(__file__) - _file = os.sep.join((dir_name, '..', '..', 'README.rst')) - cmd = 'cat %s' % _file + ['wc', '-l', abs_file]).split()[0]) + cmd = 'cat %s' % abs_file host_out = self.client.run_command(cmd) output = list(host_out.stdout) self.assertEqual(lines, len(output)) @@ -379,11 +418,12 @@ def test_identity_auth_failure(self): def test_password_auth_failure(self): try: - client = SSHClient(self.host, port=self.port, num_retries=1, - allow_agent=False, - identity_auth=False, - password='blah blah blah', - ) + SSHClient( + self.host, port=self.port, num_retries=1, + allow_agent=False, + identity_auth=False, + password='blah blah blah', + ) except AuthenticationException as ex: self.assertIsInstance(ex.args[3], SSH2AuthenticationError) else: @@ -427,7 +467,7 @@ def test_multiple_clients_exec_terminates_channels(self): # and break subsequent sessions even on different socket and # session def scope_killer(): - for _ in range(5): + for _ in range(20): client = SSHClient(self.host, port=self.port, pkey=self.user_key, num_retries=1, @@ -435,7 +475,22 @@ def scope_killer(): host_out = client.run_command(self.cmd) output = list(host_out.stdout) self.assertListEqual(output, [self.resp]) - client.disconnect() + + scope_killer() + + def test_multiple_clients_exec_terminates_channels_explicit_disc(self): + # Explicit disconnects should not affect subsequent connections + def scope_killer(): + for _ in range(20): + client = SSHClient(self.host, port=self.port, + pkey=self.user_key, + num_retries=1, + allow_agent=False) + host_out = client.run_command(self.cmd) + output = list(host_out.stdout) + self.assertListEqual(output, [self.resp]) + client._disconnect() + scope_killer() def test_agent_auth_exceptions(self): @@ -443,30 +498,46 @@ def test_agent_auth_exceptions(self): does not do auth at class init. """ class _SSHClient(SSHClient): - def __init__(self, host, port, num_retries): + def __init__(self, host, port): self.keepalive_seconds = None super(SSHClient, self).__init__( host, port=port, num_retries=2, allow_agent=True) self.IDENTITIES = set() - def _init_session(self): + def _init_session(self, retries=1): self.session = Session() if self.timeout: self.session.set_timeout(self.timeout * 1000) self.session.handshake(self.sock) - def _auth_retry(self): + def _auth_retry(self, retries=1): pass - client = _SSHClient(self.host, port=self.port, - num_retries=1) - self.assertRaises((AgentConnectionError, AgentListIdentitiesError, \ + client = _SSHClient(self.host, port=self.port) + self.assertRaises((AgentConnectionError, AgentListIdentitiesError, AgentAuthenticationError, AgentGetIdentityError), client.session.agent_auth, client.user) self.assertRaises(AuthenticationException, client.auth) + @patch('pssh.clients.native.single.Session') + def test_handshake_retries(self, mock_sess): + sess = MagicMock() + mock_sess.return_value = sess + + hand_mock = MagicMock() + hand_mock.side_effect = SSH2AuthenticationError + sess.handshake = hand_mock + + with raises(SSH2AuthenticationError): + SSHClient(self.host, port=self.port, + num_retries=2, + timeout=.1, + retry_delay=.1, + _auth_thread_pool=False, + ) + def test_finished(self): self.assertFalse(self.client.finished(None)) host_out = self.client.run_command('echo me') @@ -687,7 +758,8 @@ def test_scp_recv_large_file(self): def test_scp_send_write_exc(self): class WriteError(Exception): pass - def write_exc(func, data): + + def write_exc(_, __): raise WriteError cur_dir = os.path.dirname(__file__) file_name = 'file1' @@ -1008,9 +1080,11 @@ def _make_sftp(): client._make_sftp_eagain = _make_sftp self.assertRaises(SFTPError, client._make_sftp) - def test_disconnect_exc(self): + @patch('pssh.clients.native.single.Session') + def test_disconnect_exc(self, mock_sess): class DiscError(Exception): pass + def _disc(): raise DiscError client = SSHClient(self.host, port=self.port, @@ -1031,6 +1105,7 @@ def test_copy_remote_dir_encoding(self): suffix = b"\xbc" encoding = 'latin-1' encoded_fn = suffix.decode(encoding) + self.assertIsInstance(encoded_fn, str) file_list = [suffix + b"1", suffix + b"2"] client.copy_remote_file = remote_file_mock local_dir = (b"l_dir" + suffix).decode(encoding) @@ -1061,5 +1136,36 @@ def test_many_short_lived_commands(self): duration = end.total_seconds() self.assertTrue(duration < timeout * 0.9, msg=f"Duration of instant cmd is {duration}") - # TODO - # * read output callback + def test_output_client_scope(self): + """Output objects should keep client alive while they are in scope even if client is not.""" + def make_client_run(): + client = SSHClient(self.host, port=self.port, + pkey=self.user_key, + num_retries=1, + allow_agent=False, + ) + host_out = client.run_command("%s; exit 1" % (self.cmd,)) + return host_out + + output = make_client_run() + stdout = list(output.stdout) + self.assertListEqual(stdout, [self.resp]) + self.assertEqual(output.exit_code, 1) + + def test_output_client_scope_disconnect(self): + """Calling deprecated .disconnect on client that also goes out of scope should not break reading + any unread output.""" + def make_client_run(): + client = SSHClient(self.host, port=self.port, + pkey=self.user_key, + num_retries=1, + allow_agent=False, + ) + host_out = client.run_command("%s; exit 1" % (self.cmd,)) + client.disconnect() + return host_out + + output = make_client_run() + stdout = list(output.stdout) + self.assertListEqual(stdout, [self.resp]) + self.assertEqual(output.exit_code, 1) diff --git a/tests/native/test_tunnel.py b/ci/integration_tests/libssh2_clients/test_tunnel.py similarity index 85% rename from tests/native/test_tunnel.py rename to ci/integration_tests/libssh2_clients/test_tunnel.py index 8137ddd9..a69b7d58 100644 --- a/tests/native/test_tunnel.py +++ b/ci/integration_tests/libssh2_clients/test_tunnel.py @@ -1,33 +1,32 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA import gc import os import time import unittest -from datetime import datetime from getpass import getuser -from sys import version_info - -from gevent import sleep, spawn, Timeout as GTimeout +from gevent import sleep, spawn from ssh2.exceptions import SocketSendError, SocketRecvError +from sys import version_info +from unittest.mock import MagicMock from pssh.clients.native import SSHClient, ParallelSSHClient -from pssh.clients.native.tunnel import LocalForwarder, TunnelServer, FORWARDER +from pssh.clients.native.tunnel import LocalForwarder, TunnelServer from pssh.config import HostConfig from pssh.exceptions import ProxyError from .base_ssh2_case import PKEY_FILENAME, PUB_FILE @@ -40,15 +39,16 @@ class TunnelTest(unittest.TestCase): @classmethod def setUpClass(cls): _mask = int('0600') if version_info <= (2,) else 0o600 + port = 2225 os.chmod(PKEY_FILENAME, _mask) - cls.port = 2225 + cls.port = port cls.cmd = 'echo me' cls.resp = u'me' cls.user_key = PKEY_FILENAME cls.user_pub_key = PUB_FILE cls.user = getuser() cls.proxy_host = '127.0.0.9' - cls.proxy_port = cls.port + 1 + cls.proxy_port = port + 1 cls.server = OpenSSHServer(listen_ip=cls.proxy_host, port=cls.proxy_port) cls.server.start_server() @@ -58,7 +58,6 @@ def tearDownClass(cls): def test_forwarder(self): forwarder = LocalForwarder() - forwarder.daemon = True forwarder.start() forwarder.started.wait() client = SSHClient( @@ -66,6 +65,10 @@ def test_forwarder(self): forwarder.enqueue(client, self.proxy_host, self.port) forwarder.out_q.get() self.assertTrue(len(forwarder._servers) > 0) + client.eagain(client.session.disconnect) + client.sock.close() + forwarder._cleanup_servers() + self.assertEqual(len(forwarder._servers), 0) forwarder.shutdown() def test_tunnel_server(self): @@ -110,14 +113,14 @@ def test_proxy_pkey_bytes_data(self): finally: remote_server.stop() - # The purpose of this test is to exercise - # https://github.com/ParallelSSH/parallel-ssh/issues/304 + # The purpose of this test is to exercise + # https://github.com/ParallelSSH/parallel-ssh/issues/304 def test_tunnel_server_reconn(self): remote_host = '127.0.0.8' remote_server = OpenSSHServer(listen_ip=remote_host, port=self.port) remote_server.start_server() - reconn_n = 20 # Number of reconnect attempts + reconn_n = 10 # Number of reconnect attempts reconn_delay = .1 # Number of seconds to delay between reconnects try: for _ in range(reconn_n): @@ -132,8 +135,6 @@ def test_tunnel_server_reconn(self): client.wait_finished(output) self.assertEqual(remote_host, client.host) self.assertEqual(self.port, client.port) - client.disconnect() - FORWARDER._cleanup_servers() time.sleep(reconn_delay) gc.collect() finally: @@ -171,22 +172,14 @@ def test_tunnel_parallel_client(self): proxy_port=self.proxy_port, num_retries=1, ) - start = datetime.now() - output = client.run_command(self.cmd) - end = datetime.now() - dt_5 = end - start + client.run_command(self.cmd) client = ParallelSSHClient(hosts, port=self.port, pkey=self.user_key, proxy_host=self.proxy_host, proxy_pkey=self.user_key, proxy_port=self.proxy_port, num_retries=1, ) - start = datetime.now() output = client.run_command(self.cmd) - end = datetime.now() - dt_10 = end - start - dt = dt_10.total_seconds() / dt_5.total_seconds() - # self.assertTrue(dt < 2) client.join(output) self.assertEqual(len(hosts), len(output)) for i, host_out in enumerate(output): @@ -237,8 +230,8 @@ def test_tunnel_parallel_client_running_fail(self): for server in (servers[1], servers[2]): server.stop() server.server_proc.communicate() - client._host_clients[(1, hosts[1])].disconnect() - client._host_clients[(2, hosts[2])].disconnect() + client._host_clients[(1, hosts[1])].sock.close() + client._host_clients[(2, hosts[2])].sock.close() output = client.run_command(self.cmd, stop_on_errors=False) client.join(output) self.assertEqual(len(hosts), len(output)) @@ -292,7 +285,6 @@ def _start_server(): raise Exception forwarder = LocalForwarder() - forwarder.daemon = True forwarder.start() forwarder.started.wait() client = SSHClient( @@ -300,52 +292,83 @@ def _start_server(): forwarder.enqueue(client, self.proxy_host, self.port) forwarder.out_q.get() self.assertTrue(len(forwarder._servers) > 0) - client.sock.close() - client.disconnect() - forwarder._cleanup_servers() + forwarder.shutdown() self.assertEqual(len(forwarder._servers), 0) forwarder._start_server = _start_server forwarder.enqueue(client, self.proxy_host, self.port) sleep(.1) + self.assertEqual(len(forwarder._servers), 0) + + def test_forwarder_join(self): + forwarder = LocalForwarder() + forwarder.start() + forwarder.started.wait() + mock_join = MagicMock() + mock_join.side_effect = RuntimeError + forwarder.join = mock_join + # Shutdown should not raise exception + self.assertIsNone(forwarder.shutdown()) def test_socket_channel_error(self): class SocketError(Exception): pass + class ChannelFailure(object): def read(self): raise SocketRecvError + def write(self, data): raise SocketSendError + def eof(self): return False + def close(self): return + class Channel(object): def __init__(self): self._eof = False + def read(self): return 5, b"asdfa" + def write(self, data): return 0, len(data) + def eof(self): return self._eof + def close(self): return + class Socket(object): + closed = False + def recv(self, num): return b"asdfaf" + def close(self): return + class SocketFailure(object): + closed = False + def sendall(self, data): raise SocketError + def recv(self, num): raise SocketError + def close(self): return + class SocketEmpty(object): + closed = False + def recv(self, num): return b"" + def close(self): return client = SSHClient( @@ -354,10 +377,14 @@ def close(self): let = spawn(server._read_forward_sock, SocketEmpty(), Channel()) let.start() sleep(.01) - self.assertRaises(SocketSendError, server._read_forward_sock, Socket(), ChannelFailure()) - self.assertRaises(SocketError, server._read_forward_sock, SocketFailure(), Channel()) - self.assertRaises(SocketError, server._read_channel, SocketFailure(), Channel()) - self.assertRaises(SocketRecvError, server._read_channel, Socket(), ChannelFailure()) + my_sock = Socket() + my_chan = Channel() + self.assertRaises(SocketSendError, server._read_forward_sock, my_sock, ChannelFailure()) + self.assertRaises(SocketError, server._read_forward_sock, SocketFailure(), my_chan) + self.assertRaises(SocketError, server._read_channel, SocketFailure(), my_chan) + self.assertRaises(SocketRecvError, server._read_channel, my_sock, ChannelFailure()) + my_sock.closed = True + self.assertIsNone(server._read_forward_sock(my_sock, my_chan)) channel = Channel() _socket = Socket() source_let = spawn(server._read_forward_sock, _socket, channel) @@ -365,20 +392,3 @@ def close(self): channel._eof = True self.assertIsNone(server._wait_send_receive_lets(source_let, dest_let, channel)) let.kill() - - def test_server_start(self): - _port = 1234 - class Server(object): - def __init__(self): - self.started = False - self.listen_port = _port - server = Server() - forwarder = LocalForwarder() - let = spawn(forwarder._get_server_listen_port, None, server) - let.start() - sleep(.01) - server.started = True - sleep(.01) - with GTimeout(seconds=1): - port = forwarder.out_q.get() - self.assertEqual(port, _port) diff --git a/ci/integration_tests/libssh_clients/__init__.py b/ci/integration_tests/libssh_clients/__init__.py new file mode 100644 index 00000000..edc34670 --- /dev/null +++ b/ci/integration_tests/libssh_clients/__init__.py @@ -0,0 +1,16 @@ +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA diff --git a/tests/ssh/base_ssh_case.py b/ci/integration_tests/libssh_clients/base_ssh_case.py similarity index 63% rename from tests/ssh/base_ssh_case.py rename to ci/integration_tests/libssh_clients/base_ssh_case.py index d14924f2..a0d6f9bc 100644 --- a/tests/ssh/base_ssh_case.py +++ b/ci/integration_tests/libssh_clients/base_ssh_case.py @@ -1,19 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA import logging import os @@ -40,9 +40,18 @@ def setup_root_logger(): PKEY_FILENAME = os.path.sep.join([os.path.dirname(__file__), '..', 'client_pkey']) PUB_FILE = "%s.pub" % (PKEY_FILENAME,) -USER_CERT_PRIV_KEY = os.path.sep.join([os.path.dirname(__file__), '..', 'unit_test_cert_key']) -USER_CERT_PUB_KEY = "%s.pub" % (USER_CERT_PRIV_KEY,) -USER_CERT_FILE = "%s-cert.pub" % (USER_CERT_PRIV_KEY,) +USER_CERT_PRIV_KEY_NAME = 'int_test_cert_key' +USER_CERT_PRIV_KEY = os.path.sep.join([os.path.dirname(__file__), '..', USER_CERT_PRIV_KEY_NAME]) +USER_CERT_PUB_KEY = os.path.sep.join([ + os.path.dirname(__file__), + '..', + "%s.pub" % (USER_CERT_PRIV_KEY_NAME,), +]) +USER_CERT_FILE = os.path.sep.join([ + os.path.dirname(__file__), + '..', + "%s-cert.pub" % (USER_CERT_PRIV_KEY_NAME,), +]) CA_USER_KEY = os.path.sep.join([os.path.dirname(__file__), '..', 'embedded_server', 'ca_user_key']) USER = getuser() @@ -62,6 +71,7 @@ def setUpClass(cls): for _file in [PKEY_FILENAME, USER_CERT_PRIV_KEY, CA_USER_KEY]: os.chmod(_file, _mask) sign_cert() + # import ipdb; ipdb.set_trace() cls.host = '127.0.0.1' cls.port = 2322 cls.server = OpenSSHServer(listen_ip=cls.host, port=cls.port) diff --git a/tests/ssh/test_parallel_client.py b/ci/integration_tests/libssh_clients/test_parallel_client.py similarity index 87% rename from tests/ssh/test_parallel_client.py rename to ci/integration_tests/libssh_clients/test_parallel_client.py index 401fd791..d8c54e32 100644 --- a/tests/ssh/test_parallel_client.py +++ b/ci/integration_tests/libssh_clients/test_parallel_client.py @@ -1,19 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA import os import unittest @@ -197,16 +197,16 @@ def test_pssh_client_run_command_get_output(self): msg="Got unexpected stderr - %s, expected %s" % (stderr, expected_stderr,)) - - def test_pssh_client_run_long_command(self): - expected_lines = 5 - output = self.client.run_command(self.long_cmd(expected_lines)) - self.assertEqual(len(output), len(self.client.hosts)) - stdout = list(output[0].stdout) - self.client.join(output) - self.assertTrue(len(stdout) == expected_lines, - msg="Expected %s lines of response, got %s" % ( - expected_lines, len(stdout))) + # + # def test_pssh_client_run_long_command(self): + # expected_lines = 5 + # output = self.client.run_command(self.long_cmd(expected_lines)) + # self.assertEqual(len(output), len(self.client.hosts)) + # stdout = list(output[0].stdout) + # self.client.join(output) + # self.assertTrue(len(stdout) == expected_lines, + # msg="Expected %s lines of response, got %s" % ( + # expected_lines, len(stdout))) def test_pssh_client_auth_failure(self): client = ParallelSSHClient([self.host], port=self.port, @@ -280,28 +280,28 @@ def test_zero_timeout(self): cmd = spawn(client.run_command, 'sleep 1', stop_on_errors=False) output = cmd.get(timeout=3) self.assertTrue(output[0].exception is None) - - def test_pssh_client_long_running_command_exit_codes(self): - expected_lines = 2 - output = self.client.run_command(self.long_cmd(expected_lines)) - self.assertEqual(len(output), len(self.client.hosts)) - self.assertIsNone(output[0].exit_code) - self.assertFalse(self.client.finished(output)) - self.client.join(output, consume_output=True) - self.assertTrue(self.client.finished(output)) - self.assertEqual(output[0].exit_code, 0) - - def test_pssh_client_long_running_command_exit_codes_no_stdout(self): - expected_lines = 2 - output = self.client.run_command(self.long_cmd(expected_lines)) - self.assertEqual(len(output), len(self.client.hosts)) - self.assertIsNone(output[0].exit_code) - self.assertFalse(self.client.finished(output)) - self.client.join(output) - self.assertTrue(self.client.finished(output)) - self.assertEqual(output[0].exit_code, 0) - stdout = list(output[0].stdout) - self.assertEqual(expected_lines, len(stdout)) + # + # def test_pssh_client_long_running_command_exit_codes(self): + # expected_lines = 2 + # output = self.client.run_command(self.long_cmd(expected_lines)) + # self.assertEqual(len(output), len(self.client.hosts)) + # self.assertIsNone(output[0].exit_code) + # self.assertFalse(self.client.finished(output)) + # self.client.join(output, consume_output=True) + # self.assertTrue(self.client.finished(output)) + # self.assertEqual(output[0].exit_code, 0) + # + # def test_pssh_client_long_running_command_exit_codes_no_stdout(self): + # expected_lines = 2 + # output = self.client.run_command(self.long_cmd(expected_lines)) + # self.assertEqual(len(output), len(self.client.hosts)) + # self.assertIsNone(output[0].exit_code) + # self.assertFalse(self.client.finished(output)) + # self.client.join(output) + # self.assertTrue(self.client.finished(output)) + # self.assertEqual(output[0].exit_code, 0) + # stdout = list(output[0].stdout) + # self.assertEqual(expected_lines, len(stdout)) def test_connection_error_exception(self): """Test that we get connection error exception in output with correct arguments""" @@ -334,7 +334,7 @@ def test_multiple_single_quotes_in_cmd(self): output = self.client.run_command("echo 'me' 'and me'") stdout = list(output[0].stdout) expected = 'me and me' - self.assertTrue(len(stdout)==1, + self.assertTrue(len(stdout) == 1, msg="Got incorrect number of lines in output - %s" % (stdout,)) self.assertEqual(output[0].exit_code, 0) self.assertEqual(expected, stdout[0], @@ -484,8 +484,9 @@ def test_read_multi_same_hosts(self): self.client.run_command(self.cmd), ] for output in outputs: - for host_out in output: + for i, host_out in enumerate(output): stdout = list(host_out.stdout) + self.assertEqual(host_out.client.host, hosts[i]) self.assertListEqual(stdout, [self.resp]) def test_join_bad_host_out(self): @@ -514,6 +515,18 @@ def test_ipv6(self, gsocket): self.assertEqual(hosts[0], host_out.host) self.assertIsInstance(host_out.exception, TypeError) + def test_compression_enabled(self): + client = ParallelSSHClient([self.host], port=self.port, pkey=self.user_key, num_retries=1, compress=True) + output = client.run_command(self.cmd, stop_on_errors=False) + client.join(output) + self.assertTrue(client._host_clients[0, self.host].compress) + expected_exit_code = 0 + expected_stdout = [self.resp] + stdout = list(output[0].stdout) + exit_code = output[0].exit_code + self.assertEqual(expected_exit_code, exit_code) + self.assertEqual(expected_stdout, stdout) + # def test_multiple_run_command_timeout(self): # client = ParallelSSHClient([self.host], port=self.port, # pkey=self.user_key) diff --git a/tests/ssh/test_single_client.py b/ci/integration_tests/libssh_clients/test_single_client.py similarity index 74% rename from tests/ssh/test_single_client.py rename to ci/integration_tests/libssh_clients/test_single_client.py index b109ba1f..100b1fc7 100644 --- a/tests/ssh/test_single_client.py +++ b/ci/integration_tests/libssh_clients/test_single_client.py @@ -1,22 +1,23 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA import logging from datetime import datetime +from unittest.mock import patch, MagicMock from gevent import sleep, Timeout as GTimeout, spawn from ssh.exceptions import AuthenticationDenied @@ -50,7 +51,9 @@ def test_execute(self): output = list(host_out.stdout) stderr = list(host_out.stderr) expected = [self.resp] + expected_stderr = [] self.assertEqual(expected, output) + self.assertEqual(expected_stderr, stderr) exit_code = host_out.channel.get_exit_status() self.assertEqual(exit_code, 0) @@ -89,7 +92,7 @@ class _SSHClient(SSHClient): num_retries=1, timeout=1, allow_agent=False) - client.disconnect() + client._disconnect() client.pkey = None del client.session del client.sock @@ -98,7 +101,7 @@ class _SSHClient(SSHClient): client.IDENTITIES = (self.user_key,) # Default identities auth only should succeed client._identity_auth() - client.disconnect() + client._disconnect() del client.session del client.sock client._connect(self.host, self.port) @@ -129,19 +132,10 @@ def test_wait_finished_timeout(self): self.client.wait_finished(host_out) self.assertTrue(self.client.finished(host_out.channel)) - def test_client_disconnect_on_del(self): - client = SSHClient(self.host, port=self.port, - pkey=self.user_key, - num_retries=1) - client_sock = client.sock - del client - self.assertTrue(client_sock.closed) - def test_client_bad_sock(self): client = SSHClient(self.host, port=self.port, pkey=self.user_key, num_retries=1) - client.disconnect() client.sock = None self.assertIsNone(client.poll()) @@ -151,7 +145,7 @@ def test_multiple_clients_exec_terminates_channels(self): # and break subsequent sessions even on different socket and # session def scope_killer(): - for _ in range(5): + for _ in range(20): client = SSHClient(self.host, port=self.port, pkey=self.user_key, num_retries=1, @@ -159,6 +153,7 @@ def scope_killer(): host_out = client.run_command(self.cmd) output = list(host_out.stdout) self.assertListEqual(output, [self.resp]) + scope_killer() def test_interactive_shell(self): @@ -186,11 +181,10 @@ def test_identity_auth_failure(self): def test_password_auth_failure(self): try: - client = SSHClient(self.host, port=self.port, num_retries=1, - allow_agent=False, - identity_auth=False, - password='blah blah blah', - ) + SSHClient(self.host, port=self.port, num_retries=1, allow_agent=False, + identity_auth=False, + password='blah blah blah', + ) except AuthenticationException as ex: self.assertIsInstance(ex.args[3], AuthenticationDenied) else: @@ -241,20 +235,25 @@ def test_client_read_timeout(self): host_out = client.run_command('sleep 2; echo me', timeout=0.2) self.assertRaises(Timeout, list, host_out.stdout) - def test_open_session_exc(self): + @patch('pssh.clients.ssh.single.Session') + def test_open_session_exc(self, mock_sess): class Error(Exception): pass + def _session(): raise Error + client = SSHClient(self.host, port=self.port, pkey=self.user_key, num_retries=1) client._open_session = _session self.assertRaises(SessionError, client.open_session) - def test_session_connect_exc(self): + @patch('pssh.clients.ssh.single.Session') + def test_session_connect_exc(self, mock_sess): class Error(Exception): pass + def _con(): raise Error client = SSHClient(self.host, port=self.port, @@ -282,8 +281,10 @@ def test_no_auth(self): def test_agent_auth_failure(self): class UnknownError(Exception): pass + def _agent_auth_unk(): raise UnknownError + def _agent_auth_agent_err(): raise AuthenticationDenied client = SSHClient(self.host, port=self.port, @@ -291,7 +292,7 @@ def _agent_auth_agent_err(): num_retries=1, allow_agent=True, identity_auth=False) - client.session.disconnect() + client.eagain(client.session.disconnect) client.pkey = None client._connect(self.host, self.port) client._agent_auth = _agent_auth_unk @@ -313,9 +314,11 @@ def _agent_auth(): client._agent_auth = _agent_auth self.assertIsNone(client.auth()) - def test_disconnect_exc(self): + @patch('pssh.clients.ssh.single.Session') + def test_disconnect_exc(self, mock_sess): class DiscError(Exception): pass + def _disc(): raise DiscError client = SSHClient(self.host, port=self.port, @@ -325,4 +328,64 @@ def _disc(): ) client._disconnect_eagain = _disc client._connect_init_session_retry(0) - client.disconnect() + client._disconnect() + + def test_stdin(self): + host_out = self.client.run_command('read line; echo $line') + host_out.stdin.write('a line\n') + host_out.stdin.flush() + self.client.wait_finished(host_out) + stdout = list(host_out.stdout) + self.assertListEqual(stdout, ['a line']) + + def test_output_client_scope(self): + """Output objects should keep client alive while they are in scope even if client is not.""" + def make_client_run(): + client = SSHClient(self.host, port=self.port, + pkey=self.user_key, + num_retries=1, + allow_agent=False, + ) + host_out = client.run_command("%s; exit 1" % (self.cmd,)) + return host_out + + output = make_client_run() + stdout = list(output.stdout) + self.assertListEqual(stdout, [self.resp]) + self.assertEqual(output.exit_code, 1) + + def test_output_client_scope_disconnect(self): + """Forcibly disconnecting client that also goes out of scope should not break reading any unread output.""" + def make_client_run(): + client = SSHClient(self.host, port=self.port, + pkey=self.user_key, + num_retries=1, + allow_agent=False, + ) + host_out = client.run_command("%s; exit 1" % (self.cmd,)) + return host_out + + output = make_client_run() + stdout = list(output.stdout) + self.assertListEqual(stdout, [self.resp]) + self.assertEqual(output.exit_code, 1) + + @patch('gevent.socket.socket') + @patch('pssh.clients.ssh.single.Session') + def test_sock_shutdown_fail(self, mock_sess, mock_sock): + sock = MagicMock() + mock_sock.return_value = sock + client = SSHClient(self.host, port=self.port, + num_retries=2, + timeout=.1, + retry_delay=.1, + _auth_thread_pool=False, + allow_agent=False, + ) + self.assertIsInstance(client, SSHClient) + sock.closed = False + sock.detach = MagicMock() + sock.detach.side_effect = Exception + self.assertIsNone(client._disconnect()) + sock.detach.assert_called_once() + self.assertIsNone(client.sock) diff --git a/tests/test_client_private_key b/ci/integration_tests/test_client_private_key similarity index 100% rename from tests/test_client_private_key rename to ci/integration_tests/test_client_private_key diff --git a/tests/test_client_private_key_dsa b/ci/integration_tests/test_client_private_key_dsa similarity index 100% rename from tests/test_client_private_key_dsa rename to ci/integration_tests/test_client_private_key_dsa diff --git a/tests/test_client_private_key_ecdsa b/ci/integration_tests/test_client_private_key_ecdsa similarity index 100% rename from tests/test_client_private_key_ecdsa rename to ci/integration_tests/test_client_private_key_ecdsa diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..82133027 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,2 @@ +sphinx +sphinx_rtd_theme diff --git a/examples/graph.py b/examples/graph.py new file mode 100644 index 00000000..28ced60b --- /dev/null +++ b/examples/graph.py @@ -0,0 +1,39 @@ +""" +Show backreferences of out of scope client objects, to check for cyclical references. +""" + +import gc +import objgraph +import sys + +from pssh.clients import SSHClient +from pssh.clients.ssh import SSHClient as LibSSHClient + +host = 'localhost' + + +def run(): + client = SSHClient(host, allow_agent=False) + out = client.run_command('echo me') + for line in out.stdout: + print(line) + + +def run_libssh(): + client = LibSSHClient(host, allow_agent=False) + out = client.run_command('echo me') + for line in out.stdout: + print(line) + + +if __name__ == "__main__": + type_name = "SSHClient" + # type_name = "LibSSHClient" + run() + # run_libssh() + gc.collect() + objs = objgraph.by_type(type_name) + if not objs: + sys.stdout.write("No back references\n") + sys.exit(0) + objgraph.show_backrefs(objs[0], filename="chain.png") diff --git a/pssh/__init__.py b/pssh/__init__.py index bce2c66a..2c722bd6 100644 --- a/pssh/__init__.py +++ b/pssh/__init__.py @@ -1,19 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA """Asynchronous parallel SSH client library. @@ -29,9 +29,9 @@ from logging import getLogger, NullHandler -from ._version import get_versions -__version__ = get_versions()['version'] -del get_versions +from . import _version +__version__ = _version.get_versions()['version'] +del _version host_logger = getLogger('pssh.host_logger') logger = getLogger('pssh') diff --git a/pssh/_version.py b/pssh/_version.py index f5d6cce1..187f483a 100644 --- a/pssh/_version.py +++ b/pssh/_version.py @@ -5,8 +5,9 @@ # directories (produced by setup.py build) will contain a much shorter file # that just contains the computed version number. -# This file is released into the public domain. Generated by -# versioneer-0.18 (https://github.com/warner/python-versioneer) +# This file is released into the public domain. +# Generated by versioneer-0.29 +# https://github.com/python-versioneer/python-versioneer """Git implementation of _version.py.""" @@ -15,9 +16,11 @@ import re import subprocess import sys +from typing import Any, Callable, Dict, List, Optional, Tuple +import functools -def get_keywords(): +def get_keywords() -> Dict[str, str]: """Get the keywords needed to look up the version information.""" # these strings will be replaced by git during git-archive. # setup.py/versioneer.py will grep for the variable names, so they must @@ -33,8 +36,15 @@ def get_keywords(): class VersioneerConfig: """Container for Versioneer configuration parameters.""" + VCS: str + style: str + tag_prefix: str + parentdir_prefix: str + versionfile_source: str + verbose: bool -def get_config(): + +def get_config() -> VersioneerConfig: """Create, populate and return the VersioneerConfig() object.""" # these strings are filled in when 'setup.py versioneer' creates # _version.py @@ -52,13 +62,13 @@ class NotThisMethod(Exception): """Exception raised if a method is not valid for the current scenario.""" -LONG_VERSION_PY = {} -HANDLERS = {} +LONG_VERSION_PY: Dict[str, str] = {} +HANDLERS: Dict[str, Dict[str, Callable]] = {} -def register_vcs_handler(vcs, method): # decorator - """Decorator to mark a method as the handler for a particular VCS.""" - def decorate(f): +def register_vcs_handler(vcs: str, method: str) -> Callable: # decorator + """Create decorator to mark a method as the handler of a VCS.""" + def decorate(f: Callable) -> Callable: """Store f in HANDLERS[vcs][method].""" if vcs not in HANDLERS: HANDLERS[vcs] = {} @@ -67,22 +77,35 @@ def decorate(f): return decorate -def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, - env=None): +def run_command( + commands: List[str], + args: List[str], + cwd: Optional[str] = None, + verbose: bool = False, + hide_stderr: bool = False, + env: Optional[Dict[str, str]] = None, +) -> Tuple[Optional[str], Optional[int]]: """Call the given command(s).""" assert isinstance(commands, list) - p = None - for c in commands: + process = None + + popen_kwargs: Dict[str, Any] = {} + if sys.platform == "win32": + # This hides the console window if pythonw.exe is used + startupinfo = subprocess.STARTUPINFO() + startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW + popen_kwargs["startupinfo"] = startupinfo + + for command in commands: try: - dispcmd = str([c] + args) + dispcmd = str([command] + args) # remember shell=False, so use git.cmd on windows, not just git - p = subprocess.Popen([c] + args, cwd=cwd, env=env, - stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None)) + process = subprocess.Popen([command] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None), **popen_kwargs) break - except EnvironmentError: - e = sys.exc_info()[1] + except OSError as e: if e.errno == errno.ENOENT: continue if verbose: @@ -93,18 +116,20 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, if verbose: print("unable to find command, tried %s" % (commands,)) return None, None - stdout = p.communicate()[0].strip() - if sys.version_info[0] >= 3: - stdout = stdout.decode() - if p.returncode != 0: + stdout = process.communicate()[0].strip().decode() + if process.returncode != 0: if verbose: print("unable to run %s (error)" % dispcmd) print("stdout was %s" % stdout) - return None, p.returncode - return stdout, p.returncode + return None, process.returncode + return stdout, process.returncode -def versions_from_parentdir(parentdir_prefix, root, verbose): +def versions_from_parentdir( + parentdir_prefix: str, + root: str, + verbose: bool, +) -> Dict[str, Any]: """Try to determine the version from the parent directory name. Source tarballs conventionally unpack into a directory that includes both @@ -113,15 +138,14 @@ def versions_from_parentdir(parentdir_prefix, root, verbose): """ rootdirs = [] - for i in range(3): + for _ in range(3): dirname = os.path.basename(root) if dirname.startswith(parentdir_prefix): return {"version": dirname[len(parentdir_prefix):], "full-revisionid": None, "dirty": False, "error": None, "date": None} - else: - rootdirs.append(root) - root = os.path.dirname(root) # up a level + rootdirs.append(root) + root = os.path.dirname(root) # up a level if verbose: print("Tried directories %s but none started with prefix %s" % @@ -130,41 +154,48 @@ def versions_from_parentdir(parentdir_prefix, root, verbose): @register_vcs_handler("git", "get_keywords") -def git_get_keywords(versionfile_abs): +def git_get_keywords(versionfile_abs: str) -> Dict[str, str]: """Extract version information from the given file.""" # the code embedded in _version.py can just fetch the value of these # keywords. When used from setup.py, we don't want to import _version.py, # so we do it with a regexp instead. This function is not used from # _version.py. - keywords = {} + keywords: Dict[str, str] = {} try: - f = open(versionfile_abs, "r") - for line in f.readlines(): - if line.strip().startswith("git_refnames ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["refnames"] = mo.group(1) - if line.strip().startswith("git_full ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["full"] = mo.group(1) - if line.strip().startswith("git_date ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["date"] = mo.group(1) - f.close() - except EnvironmentError: + with open(versionfile_abs, "r") as fobj: + for line in fobj: + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + except OSError: pass return keywords @register_vcs_handler("git", "keywords") -def git_versions_from_keywords(keywords, tag_prefix, verbose): +def git_versions_from_keywords( + keywords: Dict[str, str], + tag_prefix: str, + verbose: bool, +) -> Dict[str, Any]: """Get version information from git keywords.""" - if not keywords: - raise NotThisMethod("no keywords at all, weird") + if "refnames" not in keywords: + raise NotThisMethod("Short version file found") date = keywords.get("date") if date is not None: + # Use only the last line. Previous lines may contain GPG signature + # information. + date = date.splitlines()[-1] + # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 # -like" string, which we must then edit to make compliant), because @@ -177,11 +208,11 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): if verbose: print("keywords are unexpanded, not using") raise NotThisMethod("unexpanded keywords, not a git-archive tarball") - refs = set([r.strip() for r in refnames.strip("()").split(",")]) + refs = {r.strip() for r in refnames.strip("()").split(",")} # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of # just "foo-1.0". If we see a "tag: " prefix, prefer those. TAG = "tag: " - tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + tags = {r[len(TAG):] for r in refs if r.startswith(TAG)} if not tags: # Either we're using git < 1.8.3, or there really are no tags. We use # a heuristic: assume all version tags have a digit. The old git %d @@ -190,7 +221,7 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): # between branches and tags. By ignoring refnames without digits, we # filter out many common branch names like "release" and # "stabilization", as well as "HEAD" and "master". - tags = set([r for r in refs if re.search(r'\d', r)]) + tags = {r for r in refs if re.search(r'\d', r)} if verbose: print("discarding '%s', no digits" % ",".join(refs - tags)) if verbose: @@ -199,6 +230,11 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): # sorting will prefer e.g. "2.0" over "2.0rc1" if ref.startswith(tag_prefix): r = ref[len(tag_prefix):] + # Filter out refs that exactly match prefix or that don't start + # with a number once the prefix is stripped (mostly a concern + # when prefix is '') + if not re.match(r'\d', r): + continue if verbose: print("picking %s" % r) return {"version": r, @@ -214,7 +250,12 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): @register_vcs_handler("git", "pieces_from_vcs") -def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): +def git_pieces_from_vcs( + tag_prefix: str, + root: str, + verbose: bool, + runner: Callable = run_command +) -> Dict[str, Any]: """Get version from 'git describe' in the root of the source tree. This only gets called if the git-archive 'subst' keywords were *not* @@ -225,8 +266,15 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] - out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, - hide_stderr=True) + # GIT_DIR can interfere with correct operation of Versioneer. + # It may be intended to be passed to the Versioneer-versioned project, + # but that should not change where we get our version from. + env = os.environ.copy() + env.pop("GIT_DIR", None) + runner = functools.partial(runner, env=env) + + _, rc = runner(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=not verbose) if rc != 0: if verbose: print("Directory %s not under git control" % root) @@ -234,24 +282,57 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] # if there isn't one, this yields HEX[-dirty] (no NUM) - describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", - "--match", "%s*" % tag_prefix], - cwd=root) + describe_out, rc = runner(GITS, [ + "describe", "--tags", "--dirty", "--always", "--long", + "--match", f"{tag_prefix}[[:digit:]]*" + ], cwd=root) # --long was added in git-1.5.5 if describe_out is None: raise NotThisMethod("'git describe' failed") describe_out = describe_out.strip() - full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + full_out, rc = runner(GITS, ["rev-parse", "HEAD"], cwd=root) if full_out is None: raise NotThisMethod("'git rev-parse' failed") full_out = full_out.strip() - pieces = {} + pieces: Dict[str, Any] = {} pieces["long"] = full_out pieces["short"] = full_out[:7] # maybe improved later pieces["error"] = None + branch_name, rc = runner(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], + cwd=root) + # --abbrev-ref was added in git-1.6.3 + if rc != 0 or branch_name is None: + raise NotThisMethod("'git rev-parse --abbrev-ref' returned error") + branch_name = branch_name.strip() + + if branch_name == "HEAD": + # If we aren't exactly on a branch, pick a branch which represents + # the current commit. If all else fails, we are on a branchless + # commit. + branches, rc = runner(GITS, ["branch", "--contains"], cwd=root) + # --contains was added in git-1.5.4 + if rc != 0 or branches is None: + raise NotThisMethod("'git branch --contains' returned error") + branches = branches.split("\n") + + # Remove the first line if we're running detached + if "(" in branches[0]: + branches.pop(0) + + # Strip off the leading "* " from the list of branches. + branches = [branch[2:] for branch in branches] + if "master" in branches: + branch_name = "master" + elif not branches: + branch_name = None + else: + # Pick the first branch that is returned. Good or bad. + branch_name = branches[0] + + pieces["branch"] = branch_name + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] # TAG might have hyphens. git_describe = describe_out @@ -268,7 +349,7 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): # TAG-NUM-gHEX mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) if not mo: - # unparseable. Maybe git-describe is misbehaving? + # unparsable. Maybe git-describe is misbehaving? pieces["error"] = ("unable to parse git-describe output: '%s'" % describe_out) return pieces @@ -293,26 +374,27 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): else: # HEX: no tags pieces["closest-tag"] = None - count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) - pieces["distance"] = int(count_out) # total number of commits + out, rc = runner(GITS, ["rev-list", "HEAD", "--left-right"], cwd=root) + pieces["distance"] = len(out.split()) # total number of commits # commit date: see ISO-8601 comment in git_versions_from_keywords() - date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], - cwd=root)[0].strip() + date = runner(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[0].strip() + # Use only the last line. Previous lines may contain GPG signature + # information. + date = date.splitlines()[-1] pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) return pieces -def plus_or_dot(pieces): +def plus_or_dot(pieces: Dict[str, Any]) -> str: """Return a + if we don't already have one, else return a .""" if "+" in pieces.get("closest-tag", ""): return "." return "+" -def render_pep440(pieces): +def render_pep440(pieces: Dict[str, Any]) -> str: """Build up version string, with post-release "local version identifier". Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you @@ -337,23 +419,71 @@ def render_pep440(pieces): return rendered -def render_pep440_pre(pieces): - """TAG[.post.devDISTANCE] -- No -dirty. +def render_pep440_branch(pieces: Dict[str, Any]) -> str: + """TAG[[.dev0]+DISTANCE.gHEX[.dirty]] . + + The ".dev0" means not master branch. Note that .dev0 sorts backwards + (a feature branch will appear "older" than the master branch). Exceptions: - 1: no tags. 0.post.devDISTANCE + 1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0" + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += "+untagged.%d.g%s" % (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def pep440_split_post(ver: str) -> Tuple[str, Optional[int]]: + """Split pep440 version string at the post-release segment. + + Returns the release segments before the post-release and the + post-release version number (or -1 if no post-release segment is present). + """ + vc = str.split(ver, ".post") + return vc[0], int(vc[1] or 0) if len(vc) == 2 else None + + +def render_pep440_pre(pieces: Dict[str, Any]) -> str: + """TAG[.postN.devDISTANCE] -- No -dirty. + + Exceptions: + 1: no tags. 0.post0.devDISTANCE + """ + if pieces["closest-tag"]: if pieces["distance"]: - rendered += ".post.dev%d" % pieces["distance"] + # update the post release segment + tag_version, post_version = pep440_split_post(pieces["closest-tag"]) + rendered = tag_version + if post_version is not None: + rendered += ".post%d.dev%d" % (post_version + 1, pieces["distance"]) + else: + rendered += ".post0.dev%d" % (pieces["distance"]) + else: + # no commits, use the tag as the version + rendered = pieces["closest-tag"] else: # exception #1 - rendered = "0.post.dev%d" % pieces["distance"] + rendered = "0.post0.dev%d" % pieces["distance"] return rendered -def render_pep440_post(pieces): +def render_pep440_post(pieces: Dict[str, Any]) -> str: """TAG[.postDISTANCE[.dev0]+gHEX] . The ".dev0" means dirty. Note that .dev0 sorts backwards @@ -380,12 +510,41 @@ def render_pep440_post(pieces): return rendered -def render_pep440_old(pieces): +def render_pep440_post_branch(pieces: Dict[str, Any]) -> str: + """TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] . + + The ".dev0" means not master branch. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%s" % pieces["short"] + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += "+g%s" % pieces["short"] + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def render_pep440_old(pieces: Dict[str, Any]) -> str: """TAG[.postDISTANCE[.dev0]] . The ".dev0" means dirty. - Eexceptions: + Exceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: @@ -402,7 +561,7 @@ def render_pep440_old(pieces): return rendered -def render_git_describe(pieces): +def render_git_describe(pieces: Dict[str, Any]) -> str: """TAG[-DISTANCE-gHEX][-dirty]. Like 'git describe --tags --dirty --always'. @@ -422,7 +581,7 @@ def render_git_describe(pieces): return rendered -def render_git_describe_long(pieces): +def render_git_describe_long(pieces: Dict[str, Any]) -> str: """TAG-DISTANCE-gHEX[-dirty]. Like 'git describe --tags --dirty --always -long'. @@ -442,7 +601,7 @@ def render_git_describe_long(pieces): return rendered -def render(pieces, style): +def render(pieces: Dict[str, Any], style: str) -> Dict[str, Any]: """Render the given version pieces into the requested style.""" if pieces["error"]: return {"version": "unknown", @@ -456,10 +615,14 @@ def render(pieces, style): if style == "pep440": rendered = render_pep440(pieces) + elif style == "pep440-branch": + rendered = render_pep440_branch(pieces) elif style == "pep440-pre": rendered = render_pep440_pre(pieces) elif style == "pep440-post": rendered = render_pep440_post(pieces) + elif style == "pep440-post-branch": + rendered = render_pep440_post_branch(pieces) elif style == "pep440-old": rendered = render_pep440_old(pieces) elif style == "git-describe": @@ -474,7 +637,7 @@ def render(pieces, style): "date": pieces.get("date")} -def get_versions(): +def get_versions() -> Dict[str, Any]: """Get version information or return default if unable to do so.""" # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have # __file__, we can work backwards from there to the root. Some @@ -495,7 +658,7 @@ def get_versions(): # versionfile_source is the relative path from the top of the source # tree (where the .git directory might live) to this file. Invert # this to find the root from __file__. - for i in cfg.versionfile_source.split('/'): + for _ in cfg.versionfile_source.split('/'): root = os.path.dirname(root) except NameError: return {"version": "0+unknown", "full-revisionid": None, diff --git a/pssh/clients/__init__.py b/pssh/clients/__init__.py index eb9b9d1a..1b534045 100644 --- a/pssh/clients/__init__.py +++ b/pssh/clients/__init__.py @@ -1,20 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA # flake8: noqa: F401 -from .native.parallel import ParallelSSHClient -from .native.single import SSHClient +from .native import ParallelSSHClient, SSHClient diff --git a/pssh/clients/base/__init__.py b/pssh/clients/base/__init__.py index e69de29b..edc34670 100644 --- a/pssh/clients/base/__init__.py +++ b/pssh/clients/base/__init__.py @@ -0,0 +1,16 @@ +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA diff --git a/pssh/clients/base/parallel.py b/pssh/clients/base/parallel.py index f581e133..ce0e8c98 100644 --- a/pssh/clients/base/parallel.py +++ b/pssh/clients/base/parallel.py @@ -1,19 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA """Abstract parallel SSH client package""" @@ -22,8 +22,9 @@ import gevent.pool from gevent import joinall, spawn, Timeout as GTimeout from gevent.hub import Hub +from gevent.fileobject import FileObjectThread -from ..common import _validate_pkey_path, _validate_pkey +from ..common import _validate_pkey_path, _validate_pkey, _validate_api from ...config import HostConfig from ...constants import DEFAULT_RETRIES, RETRY_DELAY from ...exceptions import HostArgumentError, Timeout, ShellError, HostConfigError @@ -55,6 +56,8 @@ def __init__(self, hosts, user=None, password=None, port=None, pkey=None, gssapi_client_identity=None, gssapi_delegate_credentials=False, forward_ssh_agent=False, + compress=False, + keyboard_interactive=False, _auth_thread_pool=True, ): self.allow_agent = allow_agent @@ -86,6 +89,9 @@ def __init__(self, hosts, user=None, password=None, port=None, pkey=None, self.gssapi_server_identity = gssapi_server_identity self.gssapi_client_identity = gssapi_client_identity self.gssapi_delegate_credentials = gssapi_delegate_credentials + self.compress = compress + self.keyboard_interactive = keyboard_interactive + _validate_api(self.keyboard_interactive, self.password) self._auth_thread_pool = _auth_thread_pool self._check_host_config() @@ -114,20 +120,6 @@ def hosts(self, _hosts): self._host_clients.pop((i, host), None) self._hosts = _hosts - def __del__(self): - self.disconnect() - - def disconnect(self): - """Disconnect all clients.""" - if not hasattr(self, '_host_clients'): - return - for s_client in self._host_clients.values(): - try: - s_client.disconnect() - except Exception as ex: - logger.debug("Client disconnect failed with %s", ex) - pass - def _check_host_config(self): if self.host_config is None: return @@ -577,7 +569,7 @@ def _load_pkey_data(self, _pkey): if not isinstance(_pkey, str): return _pkey _pkey = _validate_pkey_path(_pkey) - with open(_pkey, 'rb') as fh: + with FileObjectThread(_pkey, 'rb') as fh: _pkey_data = fh.read() return _pkey_data diff --git a/pssh/clients/base/single.py b/pssh/clients/base/single.py index 6229e0f4..1d03eb04 100644 --- a/pssh/clients/base/single.py +++ b/pssh/clients/base/single.py @@ -1,33 +1,37 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA import logging import os from getpass import getuser from socket import gaierror as sock_gaierror, error as sock_error +from warnings import warn -from gevent import sleep, socket, Timeout as GTimeout +from gevent import sleep, socket, Timeout as GTimeout, get_hub +from gevent.fileobject import FileObjectThread from gevent.hub import Hub +from gevent.pool import Pool from gevent.select import poll, POLLIN, POLLOUT +from gevent.socket import SHUT_RDWR from ssh2.exceptions import AgentConnectionError, AgentListIdentitiesError, \ AgentAuthenticationError, AgentGetIdentityError from ssh2.utils import find_eol -from ..common import _validate_pkey +from ..common import _validate_pkey, _validate_api from ..reader import ConcurrentRWBuffer from ...constants import DEFAULT_RETRIES, RETRY_DELAY from ...exceptions import UnknownHostError, AuthenticationError, \ @@ -37,6 +41,62 @@ Hub.NOT_ERROR = (Exception,) host_logger = logging.getLogger('pssh.host_logger') logger = logging.getLogger(__name__) +THREAD_POOL = get_hub().threadpool + + +class PollMixIn(object): + """MixIn for co-operative socket polling functionality. + + """ + __slots__ = ('sock',) + + def __init__(self, sock=None): + self.sock = sock + + def poll(self, timeout=None): + raise NotImplementedError + + def eagain(self, func, *args, **kwargs): + raise NotImplementedError + + def eagain_write(self, write_func, data): + raise NotImplementedError + + def _poll_errcodes(self, directions_func, inbound, outbound): + directions = directions_func() + if directions == 0: + return + events = 0 + if directions & inbound: + events = POLLIN + if directions & outbound: + events |= POLLOUT + self._poll_socket(events) + + def _poll_socket(self, events): + if self.sock is None: + return + poller = poll() + poller.register(self.sock, eventmask=events) + poller.poll(timeout=1) + + def _eagain_errcode(self, func, eagain, *args, **kwargs): + ret = func(*args, **kwargs) + while ret == eagain: + self.poll() + ret = func(*args, **kwargs) + sleep() + return ret + + def _eagain_write_errcode(self, write_func, data, eagain): + data_len = len(data) + total_written = 0 + while total_written < data_len: + rc, bytes_written = write_func(data[total_written:]) + total_written += bytes_written + if rc == eagain: + self.poll() + sleep() class Stdin(object): @@ -64,11 +124,13 @@ def write(self, data): :param data: Data to write. :type data: str """ - return self._client._eagain(self._channel.write, data) + return self._client.eagain(self._channel.write, data) def flush(self): """Flush pending data written to stdin.""" - return self._client._eagain(self._channel.flush) + if not hasattr(self._channel, "flush"): + return + return self._client.eagain(self._channel.flush) class InteractiveShell(object): @@ -98,7 +160,9 @@ def __init__(self, channel, client, encoding='utf-8', read_timeout=None): self._client._shell(self._chan) self._encoding = encoding self.output = self._client._make_host_output( - self._chan, encoding=encoding, read_timeout=read_timeout) + self._chan, encoding=encoding, read_timeout=read_timeout, + fully_qualified_command=None, + ) @property def stdout(self): @@ -130,7 +194,7 @@ def close(self): """Wait for shell to finish executing and close channel.""" if self._chan is None: return - self._client._eagain(self._chan.send_eof) + self._client.eagain(self._chan.send_eof) self._client.wait_finished(self.output) return self @@ -142,10 +206,10 @@ def run(self, cmd): :type cmd: str """ cmd = cmd.encode(self._encoding) + self._EOL - self._client._eagain_write(self._chan.write, cmd) + self._client.eagain_write(self._chan.write, cmd) -class BaseSSHClient(object): +class BaseSSHClient(PollMixIn): IDENTITIES = ( os.path.expanduser('~/.ssh/id_rsa'), @@ -166,15 +230,18 @@ def __init__(self, host, _auth_thread_pool=True, identity_auth=True, ipv6_only=False, + compress=False, + keyboard_interactive=False, ): + super(PollMixIn, self).__init__() self._auth_thread_pool = _auth_thread_pool self.host = host self.alias = alias self.user = user if user else getuser() self.password = password + self.keyboard_interactive = keyboard_interactive self.port = port if port else 22 self.num_retries = num_retries - self.sock = None self.timeout = timeout if timeout else None self.retry_delay = retry_delay self.allow_agent = allow_agent @@ -185,6 +252,10 @@ def __init__(self, host, self.identity_auth = identity_auth self._keepalive_greenlet = None self.ipv6_only = ipv6_only + self.compress = compress + self.keyboard_interactive = keyboard_interactive + _validate_api(self.keyboard_interactive, self.password) + self._pool = Pool() self._init() def _pkey_from_memory(self, pkey_data): @@ -210,11 +281,15 @@ def _auth_retry(self, retries=1): raise AuthenticationError(msg, self.host, self.port, ex, retries, self.num_retries) def disconnect(self): + """Deprecated and a no-op. Disconnections handled by client de-allocation.""" + warn("Deprecated and a no-op - to be removed in future releases.", DeprecationWarning) + + def _disconnect(self): raise NotImplementedError def __del__(self): try: - self.disconnect() + self._disconnect() except Exception: pass @@ -222,7 +297,7 @@ def __enter__(self): return self def __exit__(self, *args): - self.disconnect() + self._disconnect() def open_shell(self, encoding='utf-8', read_timeout=None): """Open interactive shell on new channel. @@ -242,7 +317,8 @@ def _shell(self, channel): raise NotImplementedError def _disconnect_eagain(self): - self._eagain(self.session.disconnect) + if self.session is not None and self.sock is not None and not self.sock.closed: + self.eagain(self.session.disconnect) def _connect_init_session_retry(self, retries): try: @@ -252,9 +328,11 @@ def _connect_init_session_retry(self, retries): self.session = None if not self.sock.closed: try: - self.sock.close() + self.sock.shutdown(SHUT_RDWR) + self.sock.detach() except Exception: pass + self.sock = None sleep(self.retry_delay) self._connect(self._host, self._port, retries=retries) return self._init_session(retries=retries) @@ -323,17 +401,16 @@ def _identity_auth(self): "Trying to authenticate with identity file %s", identity_file) try: - self._pkey_file_auth(identity_file, password=self.password) + self._pkey_file_auth(identity_file) except Exception as ex: logger.debug( "Authentication with identity file %s failed with %s, " "continuing with other identities", identity_file, ex) continue - else: - logger.info("Authentication succeeded with identity file %s", - identity_file) - return + logger.info("Authentication succeeded with identity file %s", + identity_file) + return raise AuthenticationError("No authentication methods succeeded") def _init_session(self, retries=1): @@ -369,7 +446,7 @@ def auth(self): msg = "No remaining authentication methods" logger.error(msg) raise AuthenticationError(msg) - logger.debug("Private key auth failed, trying password") + logger.debug("Private key auth failed or not enabled, trying password") self._password_auth() def _agent_auth(self): @@ -382,14 +459,16 @@ def _pkey_auth(self, pkey): _pkey = pkey if isinstance(pkey, str): logger.debug("Private key is provided as str, loading from private key file path") - with open(pkey, 'rb') as fh: + with FileObjectThread(pkey, 'rb', threadpool=THREAD_POOL) as fh: _pkey = fh.read() elif isinstance(pkey, bytes): logger.debug("Private key is provided in bytes, using as private key data") return self._pkey_from_memory(_pkey) - def _pkey_file_auth(self, pkey_file, password=None): - raise NotImplementedError + def _pkey_file_auth(self, pkey_file): + with FileObjectThread(pkey_file, 'rb', threadpool=THREAD_POOL) as fh: + pkey_data = fh.read() + self._pkey_from_memory(pkey_data) def _open_session(self): raise NotImplementedError @@ -397,7 +476,7 @@ def _open_session(self): def open_session(self): raise NotImplementedError - def _make_host_output(self, channel, encoding, read_timeout): + def _make_host_output(self, channel, encoding, read_timeout, fully_qualified_command=None): _stdout_buffer = ConcurrentRWBuffer() _stderr_buffer = ConcurrentRWBuffer() _stdout_reader, _stderr_reader = self._make_output_readers( @@ -410,7 +489,7 @@ def _make_host_output(self, channel, encoding, read_timeout): host_out = HostOutput( host=self.host, alias=self.alias, channel=channel, stdin=Stdin(channel, self), client=self, encoding=encoding, read_timeout=read_timeout, - buffers=_buffers, + buffers=_buffers, fully_qualified_command=fully_qualified_command, ) return host_out @@ -418,6 +497,13 @@ def _make_output_readers(self, channel, stdout_buffer, stderr_buffer): raise NotImplementedError def execute(self, cmd, use_pty=False, channel=None): + """ + Deprecated - use ``run_command`` instead which returns a ``HostOutput`` object. + """ + warn("Deprecated - use run_command instead.", DeprecationWarning) + return self._execute(cmd, use_pty=use_pty, channel=channel) + + def _execute(self, cmd, use_pty=False, channel=None): raise NotImplementedError def read_stderr(self, stderr_buffer, timeout=None): @@ -552,37 +638,11 @@ def run_command(self, command, sudo=False, user=None, _command += "%s '%s'" % (_shell, command,) _command = _command.encode(encoding) with GTimeout(seconds=self.timeout): - channel = self.execute(_command, use_pty=use_pty) + channel = self._execute(_command, use_pty=use_pty) _timeout = read_timeout if read_timeout else timeout - host_out = self._make_host_output(channel, encoding, _timeout) + host_out = self._make_host_output(channel, encoding, _timeout, fully_qualified_command=_command) return host_out - def _eagain_write_errcode(self, write_func, data, eagain): - data_len = len(data) - total_written = 0 - while total_written < data_len: - rc, bytes_written = write_func(data[total_written:]) - total_written += bytes_written - if rc == eagain: - self.poll() - sleep() - - def _eagain_errcode(self, func, eagain, *args, **kwargs): - timeout = kwargs.pop('timeout', self.timeout) - with GTimeout(seconds=timeout, exception=Timeout): - ret = func(*args, **kwargs) - while ret == eagain: - self.poll() - ret = func(*args, **kwargs) - sleep() - return ret - - def _eagain_write(self, write_func, data): - raise NotImplementedError - - def _eagain(self, func, *args, **kwargs): - raise NotImplementedError - def _make_sftp(self): raise NotImplementedError @@ -690,24 +750,3 @@ def _remote_paths_split(self, file_path): _sep = file_path.rfind('/') if _sep > 0: return file_path[:_sep] - - def poll(self): - raise NotImplementedError - - def _poll_socket(self, events): - if self.sock is None: - return - poller = poll() - poller.register(self.sock, eventmask=events) - poller.poll(timeout=1) - - def _poll_errcodes(self, directions_func, inbound, outbound): - directions = directions_func() - if directions == 0: - return - events = 0 - if directions & inbound: - events = POLLIN - if directions & outbound: - events |= POLLOUT - self._poll_socket(events) diff --git a/pssh/clients/common.py b/pssh/clients/common.py index 585d3875..174a4ea7 100644 --- a/pssh/clients/common.py +++ b/pssh/clients/common.py @@ -1,23 +1,26 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +import logging import os -from ..exceptions import PKeyFileError +from ..exceptions import PKeyFileError, InvalidAPIUseError + +logger = logging.getLogger('pssh') def _validate_pkey_path(pkey): @@ -39,3 +42,10 @@ def _validate_pkey(pkey): if isinstance(pkey, str): return _validate_pkey_path(pkey) return pkey + + +def _validate_api(keyboard_interactive, password): + if keyboard_interactive and not password: + msg = "Keyboard interactive authentication is enabled but no password is provided - cannot continue" + logger.error(msg) + raise InvalidAPIUseError(msg) diff --git a/pssh/clients/native/__init__.py b/pssh/clients/native/__init__.py index 255e9901..5e5f19ad 100644 --- a/pssh/clients/native/__init__.py +++ b/pssh/clients/native/__init__.py @@ -1,19 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA # flake8: noqa: F401 from .parallel import ParallelSSHClient diff --git a/pssh/clients/native/parallel.py b/pssh/clients/native/parallel.py index c8c879c2..2612f548 100644 --- a/pssh/clients/native/parallel.py +++ b/pssh/clients/native/parallel.py @@ -1,19 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA import logging @@ -37,6 +37,8 @@ def __init__(self, hosts, user=None, password=None, port=22, pkey=None, forward_ssh_agent=False, keepalive_seconds=60, identity_auth=True, ipv6_only=False, + compress=False, + keyboard_interactive=False, ): """ :param hosts: Hosts to connect to @@ -115,9 +117,17 @@ def __init__(self, hosts, user=None, password=None, port=22, pkey=None, for the host(s) or raise NoIPv6AddressFoundError otherwise. Note this will disable connecting to an IPv4 address if an IP address is provided instead. :type ipv6_only: bool + :param compress: Enable/Disable compression on the client. Defaults to off. + :type compress: bool + :param keyboard_interactive: Enable/Disable keyboard interactive authentication with provided username and + password. An `InvalidAPIUse` error is raised when keyboard_interactive is enabled without a provided password. + Defaults to off. + :type keyboard_interactive: bool :raises: :py:class:`pssh.exceptions.PKeyFileError` on errors finding provided private key. + :raises: :py:class:`pssh.exceptions.InvalidAPIUseError` when `keyboard_interactive=True` with no password + provided. """ BaseParallelSSHClient.__init__( self, hosts, user=user, password=password, port=port, pkey=pkey, @@ -126,6 +136,8 @@ def __init__(self, hosts, user=None, password=None, port=22, pkey=None, host_config=host_config, retry_delay=retry_delay, identity_auth=identity_auth, ipv6_only=ipv6_only, + compress=compress, + keyboard_interactive=keyboard_interactive, ) self.proxy_host = proxy_host self.proxy_port = proxy_port @@ -232,6 +244,7 @@ def _make_ssh_client(self, host, cfg, _pkey_data): keepalive_seconds=cfg.keepalive_seconds or self.keepalive_seconds, identity_auth=cfg.identity_auth or self.identity_auth, ipv6_only=cfg.ipv6_only or self.ipv6_only, + compress=cfg.compress or self.compress, ) return _client diff --git a/pssh/clients/native/single.py b/pssh/clients/native/single.py index 3a225b55..e181fd51 100644 --- a/pssh/clients/native/single.py +++ b/pssh/clients/native/single.py @@ -1,37 +1,41 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA import logging import os from collections import deque -from gevent import sleep, spawn, get_hub +from gevent import sleep, get_hub +from gevent.fileobject import FileObjectThread from gevent.lock import RLock +from gevent.pool import Pool +from gevent.socket import SHUT_RDWR +from gevent.timeout import Timeout as GTimeout from ssh2.error_codes import LIBSSH2_ERROR_EAGAIN from ssh2.exceptions import SFTPHandleError, SFTPProtocolError, \ Timeout as SSH2Timeout -from ssh2.session import Session, LIBSSH2_SESSION_BLOCK_INBOUND, LIBSSH2_SESSION_BLOCK_OUTBOUND +from ssh2.session import Session, LIBSSH2_SESSION_BLOCK_INBOUND, LIBSSH2_SESSION_BLOCK_OUTBOUND, LIBSSH2_FLAG_COMPRESS from ssh2.sftp import LIBSSH2_FXF_READ, LIBSSH2_FXF_CREAT, LIBSSH2_FXF_WRITE, \ LIBSSH2_FXF_TRUNC, LIBSSH2_SFTP_S_IRUSR, LIBSSH2_SFTP_S_IRGRP, \ LIBSSH2_SFTP_S_IWUSR, LIBSSH2_SFTP_S_IXUSR, LIBSSH2_SFTP_S_IROTH, \ LIBSSH2_SFTP_S_IXGRP, LIBSSH2_SFTP_S_IXOTH from .tunnel import FORWARDER -from ..base.single import BaseSSHClient +from ..base.single import BaseSSHClient, PollMixIn from ...constants import DEFAULT_RETRIES, RETRY_DELAY from ...exceptions import SessionError, SFTPError, \ SFTPIOError, Timeout, SCPError, ProxyError @@ -41,6 +45,51 @@ THREAD_POOL = get_hub().threadpool +class KeepAlive(PollMixIn): + """Class for handling SSHClient keepalive functionality. + + Spawns a greenlet in its own pool for sending keepalives to a given session. + """ + __slots__ = ('sock', 'session', '_let', '_pool') + + def __init__(self, sock, session): + """ + :param sock: The socket session is using to communicate. + :type sock: :py:class:`gevent.socket.socket` + :param session: The session keepalive is configured on. + :type session: :py:class:`ssh2.session.Session` + """ + super(PollMixIn, self).__init__() + self._pool = Pool(1) + self.sock = sock + self.session = session + self._let = self._pool.spawn(self._send_keepalive) + self._let.start() + + def _send_keepalive(self): + while True: + if self.session is None or self.sock is None or self.sock.closed: + return + sleep_for = self.eagain(self.session.keepalive_send) + sleep(sleep_for) + + def poll(self, timeout=None): + """Perform co-operative gevent poll on ssh2 session socket. + + Blocks current greenlet only if socket has pending read or write operations + in the appropriate direction. + :param timeout: Deprecated and unused - to be removed. + """ + self._poll_errcodes( + self.session.block_directions, + LIBSSH2_SESSION_BLOCK_INBOUND, + LIBSSH2_SESSION_BLOCK_OUTBOUND, + ) + + def eagain(self, func, *args, **kwargs): + return self._eagain_errcode(func, LIBSSH2_ERROR_EAGAIN, *args, **kwargs) + + class SSHClient(BaseSSHClient): """ssh2-python (libssh2) based non-blocking SSH client.""" # 2MB buffer @@ -58,9 +107,12 @@ def __init__(self, host, proxy_pkey=None, proxy_user=None, proxy_password=None, - _auth_thread_pool=True, keepalive_seconds=60, + _auth_thread_pool=True, + keepalive_seconds=60, identity_auth=True, ipv6_only=False, + compress=False, + keyboard_interactive=False, ): """ :param host: Host name or IP to connect to. @@ -85,7 +137,9 @@ def __init__(self, host, to :py:class:`pssh.constants.RETRY_DELAY` :type retry_delay: int or float :param timeout: SSH session timeout setting in seconds. This controls - timeout setting of authenticated SSH sessions. + timeout setting of authenticated SSH sessions for each individual SSH operation. + Also currently sets socket as well as per function timeout in some cases, see + function descriptions. :type timeout: int or float :param allow_agent: (Optional) set to False to disable connecting to the system's SSH agent @@ -107,9 +161,17 @@ def __init__(self, host, for the host or raise NoIPv6AddressFoundError otherwise. Note this will disable connecting to an IPv4 address if an IP address is provided instead. :type ipv6_only: bool + :param compress: Enable/Disable compression on the client. Defaults to off. + :type compress: bool + :param keyboard_interactive: Enable/Disable keyboard interactive authentication with provided username and + password. An `InvalidAPIUse` error is raised when keyboard_interactive is enabled without a provided password. + Defaults to off. + :type keyboard_interactive: bool :raises: :py:class:`pssh.exceptions.PKeyFileError` on errors finding provided private key. + :raises: :py:class:`pssh.exceptions.InvalidAPIUseError` when `keyboard_interactive=True` with no password + provided. """ self.forward_ssh_agent = forward_ssh_agent self._forward_requested = False @@ -131,6 +193,8 @@ def __init__(self, host, timeout=timeout, keepalive_seconds=keepalive_seconds, identity_auth=identity_auth, + compress=compress, + keyboard_interactive=keyboard_interactive, ) proxy_host = '127.0.0.1' self._chan_stdout_lock = RLock() @@ -143,10 +207,12 @@ def __init__(self, host, proxy_host=proxy_host, proxy_port=proxy_port, identity_auth=identity_auth, ipv6_only=ipv6_only, + compress=compress, + keyboard_interactive=keyboard_interactive, ) def _shell(self, channel): - return self._eagain(channel.shell) + return self.eagain(channel.shell) def _connect_proxy(self, proxy_host, proxy_port, proxy_pkey, user=None, password=None, alias=None, @@ -155,7 +221,10 @@ def _connect_proxy(self, proxy_host, proxy_port, proxy_pkey, allow_agent=True, timeout=None, forward_ssh_agent=False, keepalive_seconds=60, - identity_auth=True): + identity_auth=True, + compress=False, + keyboard_interactive=False, + ): assert isinstance(self.port, int) try: self._proxy_client = SSHClient( @@ -165,6 +234,8 @@ def _connect_proxy(self, proxy_host, proxy_port, proxy_pkey, timeout=timeout, forward_ssh_agent=forward_ssh_agent, identity_auth=identity_auth, keepalive_seconds=keepalive_seconds, + compress=compress, + keyboard_interactive=keyboard_interactive, _auth_thread_pool=False) except Exception as ex: msg = "Proxy authentication failed. " \ @@ -178,46 +249,43 @@ def _connect_proxy(self, proxy_host, proxy_port, proxy_pkey, proxy_local_port = FORWARDER.out_q.get() return proxy_local_port - def disconnect(self): + def _disconnect(self): """Attempt to disconnect session. Any errors on calling disconnect are suppressed by this function. + + Does not need to be called directly - called when client object is de-allocated. """ self._keepalive_greenlet = None - if self.session is not None: + if self.session is not None and self.sock is not None and not self.sock.closed: try: self._disconnect_eagain() except Exception: pass - self.session = None + self.session = None + # To allow for file descriptor reuse, which is part of gevent, shutdown but do not close socket here. + # Done by gevent when file descriptor is closed. + if self.sock is not None and not self.sock.closed: + try: + self.sock.shutdown(SHUT_RDWR) + self.sock.detach() + except Exception: + pass + self.sock = None + # Notify forwarder that proxy tunnel server can be shutdown if isinstance(self._proxy_client, SSHClient): - # Don't disconnect proxy client here - let the TunnelServer do it at the time that - # _wait_send_receive_lets ends. The cleanup_server call here triggers the TunnelServer - # to stop. FORWARDER.cleanup_server(self._proxy_client) - # I wanted to clean up all the sockets here to avoid a ResourceWarning from unittest, - # but unfortunately closing this socket here causes a segfault, not sure why yet. - # self.sock.close() - else: - self.sock.close() - self.sock = None - - def spawn_send_keepalive(self): - """Spawns a new greenlet that sends keep alive messages every - self.keepalive_seconds""" - return spawn(self._send_keepalive) - - def _send_keepalive(self): - while True: - sleep(self._eagain(self.session.keepalive_send)) - def configure_keepalive(self): """Configures keepalive on the server for `self.keepalive_seconds`.""" + # Configure keepalives without a reply. self.session.keepalive_config(False, self.keepalive_seconds) def _init_session(self, retries=1): self.session = Session() + if self.compress: + self.session.flag(LIBSSH2_FLAG_COMPRESS) + if self.timeout: # libssh2 timeout is in ms self.session.set_timeout(self.timeout * 1000) @@ -233,7 +301,11 @@ def _init_session(self, retries=1): msg = "Error connecting to host %s:%s - %s" logger.error(msg, self.host, self.port, ex) if not self.sock.closed: - self.sock.close() + try: + self.sock.shutdown(SHUT_RDWR) + self.sock.detach() + except Exception: + pass if isinstance(ex, SSH2Timeout): raise Timeout(msg, self.host, self.port, ex) raise @@ -241,17 +313,11 @@ def _init_session(self, retries=1): def _keepalive(self): if self.keepalive_seconds: self.configure_keepalive() - self._keepalive_greenlet = self.spawn_send_keepalive() + self._keepalive_greenlet = KeepAlive(self.sock, self.session) def _agent_auth(self): self.session.agent_auth(self.user) - def _pkey_file_auth(self, pkey_file, password=None): - self.session.userauth_publickey_fromfile( - self.user, - pkey_file, - passphrase=password if password is not None else b'') - def _pkey_from_memory(self, pkey_data): self.session.userauth_publickey_frommemory( self.user, @@ -260,10 +326,12 @@ def _pkey_from_memory(self, pkey_data): ) def _password_auth(self): - self.session.userauth_password(self.user, self.password) + if self.keyboard_interactive: + return self.session.userauth_keyboardinteractive(self.user, self.password) + return self.session.userauth_password(self.user, self.password) def _open_session(self): - chan = self._eagain(self.session.open_session) + chan = self.eagain(self.session.open_session) return chan def open_session(self): @@ -281,14 +349,18 @@ def open_session(self): return chan def _make_output_readers(self, channel, stdout_buffer, stderr_buffer): - _stdout_reader = spawn( + # TODO: These greenlets need to be outside client scope or we create a reader <-> client cyclical reference + _stdout_reader = self._pool.spawn( self._read_output_to_buffer, channel.read, stdout_buffer) - _stderr_reader = spawn( + _stderr_reader = self._pool.spawn( self._read_output_to_buffer, channel.read_stderr, stderr_buffer) return _stdout_reader, _stderr_reader - def execute(self, cmd, use_pty=False, channel=None): - """Execute command on remote server. + def _execute(self, cmd, use_pty=False, channel=None): + """ + Use ``run_command`` which returns a ``HostOutput`` object rather than this function directly. + + Execute command on remote server. :param cmd: Command to execute. :type cmd: str @@ -297,12 +369,14 @@ def execute(self, cmd, use_pty=False, channel=None): :param channel: Use provided channel for execute rather than creating a new one. :type channel: :py:class:`ssh2.channel.Channel` + + :rtype: :py:class:`ssh2.channel.Channel` """ channel = self.open_session() if channel is None else channel if use_pty: - self._eagain(channel.pty) + self.eagain(channel.pty) logger.debug("Executing command '%s'", cmd) - self._eagain(channel.execute, cmd) + self.eagain(channel.execute, cmd) return channel def _read_output_to_buffer(self, read_func, _buffer, is_stderr=False): @@ -340,20 +414,23 @@ def wait_finished(self, host_output, timeout=None): channel = host_output.channel if channel is None: return - self._eagain(channel.wait_eof, timeout=timeout) - # Close channel to indicate no more commands will be sent over it - self.close_channel(channel) + with GTimeout(seconds=timeout, exception=Timeout): + self.eagain(channel.wait_eof) + # Close channel to indicate no more commands will be sent over it + self.close_channel(channel) def close_channel(self, channel): + """Close given channel, handling EAGAIN.""" with self._chan_stdout_lock, self._chan_stderr_lock: logger.debug("Closing channel") - self._eagain(channel.close) + self.eagain(channel.close) - def _eagain(self, func, *args, **kwargs): + def eagain(self, func, *args, **kwargs): + """Handle EAGAIN and call given function with any args, polling for as long as there is data to receive.""" return self._eagain_errcode(func, LIBSSH2_ERROR_EAGAIN, *args, **kwargs) def _make_sftp_eagain(self): - return self._eagain(self.session.sftp_init) + return self.eagain(self.session.sftp_init) def _make_sftp(self): try: @@ -380,7 +457,7 @@ def _mkdir(self, sftp, directory): LIBSSH2_SFTP_S_IXGRP | \ LIBSSH2_SFTP_S_IXOTH try: - self._eagain(sftp.mkdir, directory, mode) + self.eagain(sftp.mkdir, directory, mode) except SFTPProtocolError as error: msg = "Error occured creating directory %s on host %s - %s" logger.error(msg, directory, self.host, error) @@ -418,7 +495,7 @@ def copy_file(self, local_file, remote_file, recurse=False, sftp=None): destination = self._remote_paths_split(remote_file) if destination is not None: try: - self._eagain(sftp.stat, destination) + self.eagain(sftp.stat, destination) except (SFTPHandleError, SFTPProtocolError): self.mkdir(sftp, destination) self.sftp_put(sftp, local_file, remote_file) @@ -426,7 +503,7 @@ def copy_file(self, local_file, remote_file, recurse=False, sftp=None): local_file, self.host, remote_file) def _sftp_put(self, remote_fh, local_file): - with open(local_file, 'rb', self._BUF_SIZE) as local_fh: + with FileObjectThread(local_file, 'rb', self._BUF_SIZE, threadpool=THREAD_POOL) as local_fh: data = local_fh.read(self._BUF_SIZE) while data: self.eagain_write(remote_fh.write, data) @@ -481,7 +558,7 @@ def mkdir(self, sftp, directory): cur_dir = _paths_to_create.popleft() cwd = '/'.join([cwd, cur_dir]) try: - self._eagain(sftp.stat, cwd) + self.eagain(sftp.stat, cwd) except (SFTPHandleError, SFTPProtocolError) as ex: logger.debug("Stat for %s failed with %s", cwd, ex) self._mkdir(sftp, cwd) @@ -513,7 +590,7 @@ def copy_remote_file(self, remote_file, local_file, recurse=False, """ sftp = self._make_sftp() if sftp is None else sftp try: - self._eagain(sftp.stat, remote_file) + self.eagain(sftp.stat, remote_file) except (SFTPHandleError, SFTPProtocolError): msg = "Remote file or directory %s on host %s does not exist" logger.error(msg, remote_file, self.host) @@ -540,7 +617,7 @@ def copy_remote_file(self, remote_file, local_file, recurse=False, def _scp_recv_recursive(self, remote_file, local_file, sftp, encoding='utf-8'): try: - self._eagain(sftp.stat, remote_file) + self.eagain(sftp.stat, remote_file) except (SFTPHandleError, SFTPProtocolError): msg = "Remote file or directory %s does not exist" logger.error(msg, remote_file) @@ -601,13 +678,13 @@ def scp_recv(self, remote_file, local_file, recurse=False, sftp=None, def _scp_recv(self, remote_file, local_file): try: - (file_chan, fileinfo) = self._eagain( + (file_chan, fileinfo) = self.eagain( self.session.scp_recv2, remote_file) except Exception as ex: msg = "Error copying file %s from host %s - %s" logger.error(msg, remote_file, self.host, ex) raise SCPError(msg, remote_file, self.host, ex) - local_fh = open(local_file, 'wb') + local_fh = FileObjectThread(local_file, 'wb', threadpool=THREAD_POOL) try: total = 0 while total < fileinfo.st_size: @@ -660,20 +737,20 @@ def scp_send(self, local_file, remote_file, recurse=False, sftp=None): if destination is not None: sftp = self._make_sftp() if sftp is None else sftp try: - self._eagain(sftp.stat, destination) + self.eagain(sftp.stat, destination) except (SFTPHandleError, SFTPProtocolError): self.mkdir(sftp, destination) elif remote_file.endswith('/'): local_filename = local_file.rsplit('/')[-1] remote_file += local_filename - self._scp_send(local_file, remote_file) logger.info("SCP local file %s to remote destination %s:%s", local_file, self.host, remote_file) + self._scp_send(local_file, remote_file) def _scp_send(self, local_file, remote_file): fileinfo = os.stat(local_file) try: - chan = self._eagain( + chan = self.eagain( self.session.scp_send64, remote_file, fileinfo.st_mode & 0o777, fileinfo.st_size, fileinfo.st_mtime, fileinfo.st_atime) @@ -682,7 +759,7 @@ def _scp_send(self, local_file, remote_file): logger.error(msg, remote_file, self.host, ex) raise SCPError(msg, remote_file, self.host, ex) try: - with open(local_file, 'rb', 2097152) as local_fh: + with FileObjectThread(local_file, 'rb', 2097152, threadpool=THREAD_POOL) as local_fh: data = local_fh.read(self._BUF_SIZE) while data: self.eagain_write(chan.write, data) @@ -692,20 +769,20 @@ def _scp_send(self, local_file, remote_file): logger.error(msg, remote_file, self.host, ex) raise SCPError(msg, remote_file, self.host, ex) finally: - self._eagain(chan.flush) - self._eagain(chan.send_eof) - self._eagain(chan.wait_eof) - self._eagain(chan.wait_closed) + self.eagain(chan.flush) + self.eagain(chan.send_eof) + self.eagain(chan.wait_eof) + self.eagain(chan.wait_closed) def _sftp_openfh(self, open_func, remote_file, *args): try: - fh = self._eagain(open_func, remote_file, *args) + fh = self.eagain(open_func, remote_file, *args) except Exception as ex: raise SFTPError(ex) return fh def _sftp_get(self, remote_fh, local_file): - with open(local_file, 'wb') as local_fh: + with FileObjectThread(local_file, 'wb', threadpool=THREAD_POOL) as local_fh: for size, data in remote_fh: if size == LIBSSH2_ERROR_EAGAIN: self.poll() @@ -757,12 +834,9 @@ def poll(self, timeout=None): LIBSSH2_SESSION_BLOCK_OUTBOUND, ) - def _eagain_write(self, write_func, data): + def eagain_write(self, write_func, data): """Write data with given write_func for an ssh2-python session while handling EAGAIN and resuming writes from last written byte on each call to write_func. """ return self._eagain_write_errcode(write_func, data, LIBSSH2_ERROR_EAGAIN) - - def eagain_write(self, write_func, data): - return self._eagain_write(write_func, data) diff --git a/pssh/clients/native/tunnel.py b/pssh/clients/native/tunnel.py index 30c9ca01..6bea348d 100644 --- a/pssh/clients/native/tunnel.py +++ b/pssh/clients/native/tunnel.py @@ -1,32 +1,31 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +import atexit import logging - -from threading import Thread, Event -from queue import Queue - -from gevent import spawn, joinall, get_hub, sleep +from gevent import joinall, get_hub, sleep +from gevent.pool import Pool from gevent.server import StreamServer +from queue import Queue from ssh2.error_codes import LIBSSH2_ERROR_EAGAIN +from threading import Thread, Event from ...constants import DEFAULT_RETRIES - logger = logging.getLogger(__name__) @@ -41,25 +40,39 @@ def __init__(self): and get port to connect to via ``out_q`` once a target has been put into the input queue. ``SSHClient`` is the client for the SSH host that will be proxying. + + There can be as many LocalForwarder(s) as needed to scale. + + Relationship of clients to forwarders to servers is: + + One client -> One Forwarder -> Many Servers <-> Many proxy hosts -> one target host per proxy host + + A Forwarder starts servers. Servers communicate with clients directly via Forwarder thread. + + Multiple forwarder threads can be used to scale clients to more threads as number of clients increases causing + contention in forwarder threads handling proxy connections. """ - Thread.__init__(self) + Thread.__init__(self, daemon=True) self.in_q = Queue(1) self.out_q = Queue(1) + self._pool = None self._servers = {} self._hub = None self.started = Event() self._cleanup_let = None + self.shutdown_triggered = Event() def _start_server(self): client, host, port = self.in_q.get() + logger.debug("Starting server for %s:%s", host, port) server = TunnelServer(client, host, port) + self._servers[client] = server server.start() - self._get_server_listen_port(client, server) + self._get_server_listen_port(server) - def _get_server_listen_port(self, client, server): + def _get_server_listen_port(self, server): while not server.started: sleep(0.01) - self._servers[client] = server local_port = server.listen_port self.out_q.put(local_port) @@ -76,9 +89,20 @@ def enqueue(self, client, host, port): self.in_q.put((client, host, port)) def shutdown(self): - """Stop all tunnel servers.""" + """Stop all tunnel servers and shutdown LocalForwarder thread. + + This function will join the current thread and wait for it to shutdown if needed. + """ for client, server in self._servers.items(): server.stop() + self._servers = {} + if self.started: + self.shutdown_triggered.set() + try: + self.join() + except RuntimeError: + # Re-entry protection + pass def _cleanup_servers_let(self): while True: @@ -91,19 +115,22 @@ def _cleanup_servers(self): self.cleanup_server(client) def run(self): - """Thread runner ensures a non main hub has been created for all subsequent + """Thread runner ensures a non-main hub has been created for all subsequent greenlets and waits for (client, host, port) tuples to be put into self.in_q. - A server is created once something is in the queue and the port to connect to - is put into self.out_q. + A server is created once something is in the queue and only then is the port to connect to + put into self.out_q. """ self._hub = get_hub() assert self._hub.main_hub is False + self._pool = Pool(1) self.started.set() - self._cleanup_let = spawn(self._cleanup_servers_let) + self._cleanup_let = self._pool.spawn(self._cleanup_servers_let) logger.debug("Hub in server runner is main hub: %s", self._hub.main_hub) try: while True: + if self.shutdown_triggered.is_set(): + return if self.in_q.empty(): sleep(.01) continue @@ -113,8 +140,9 @@ def run(self): self.shutdown() def cleanup_server(self, client): - """The purpose of this function is for a proxied client to notify the LocalForwarder that it - is shutting down and its corresponding server can also be shut down.""" + """ + Stop server for given proxy client and remove client from this forwarder. + """ server = self._servers[client] server.stop() del self._servers[client] @@ -125,16 +153,18 @@ class TunnelServer(StreamServer): Accepts connections on an available bind_address port once started and tunnels data to/from remote SSH host for each connection. + + TunnelServer.listen_port will return listening port for server on given host once TunnelServer.started is True. """ def __init__(self, client, host, port, bind_address='127.0.0.1', num_retries=DEFAULT_RETRIES): - StreamServer.__init__(self, (bind_address, 0), self._read_rw) self.client = client + self._pool = Pool() + StreamServer.__init__(self, (bind_address, 0), self._read_rw, spawn=self._pool) self.host = host self.port = port self.session = client.session - self._client = client self._retries = num_retries self.bind_address = bind_address self.exception = None @@ -156,41 +186,40 @@ def _read_rw(self, socket, address): self.host, self.port, ex) self.exception = ex return - source = spawn(self._read_forward_sock, socket, channel) - dest = spawn(self._read_channel, socket, channel) + # Channel remains alive while this handler function is alive + source = self._pool.spawn(self._read_forward_sock, socket, channel) + dest = self._pool.spawn(self._read_channel, socket, channel) logger.debug("Waiting for read/write greenlets") - self._source_let = source - self._dest_let = dest self._wait_send_receive_lets(source, dest, channel) def _wait_send_receive_lets(self, source, dest, channel): try: joinall((source, dest), raise_error=True) finally: - # Forward socket does not need to be closed here; StreamServer does it in do_close - logger.debug("Closing channel") - self._client.close_channel(channel) - - # Disconnect client here to make sure it happens AFTER close_channel - self._client.disconnect() + logger.debug("Read/Write greenlets for tunnel target %s:%s finished, closing forwarding channel", + self.host, self.port) + self.client.close_channel(channel) def _read_forward_sock(self, forward_sock, channel): while True: if channel is None or channel.eof(): logger.debug("Channel closed, tunnel forward socket reader exiting") return + if not forward_sock or forward_sock.closed: + logger.debug("Forward socket closed, tunnel forward socket reader exiting") + return try: data = forward_sock.recv(1024) except Exception as ex: logger.error("Forward socket read error: %s", ex) raise data_len = len(data) - # logger.debug("Read %s data from forward socket", data_len,) + # logger.debug("Read %s data from forward socket", data_len) if data_len == 0: sleep(.01) continue try: - self._client.eagain_write(channel.write, data) + self.client.eagain_write(channel.write, data) except Exception as ex: logger.error("Error writing data to channel - %s", ex) raise @@ -206,9 +235,9 @@ def _read_channel(self, forward_sock, channel): except Exception as ex: logger.error("Error reading from channel - %s", ex) raise - # logger.debug("Read %s data from channel" % (size,)) + # logger.debug("Read %s data from channel", size) if size == LIBSSH2_ERROR_EAGAIN: - self._client.poll() + self.client.poll() continue elif size == 0: sleep(.01) @@ -226,7 +255,7 @@ def _open_channel(self, fw_host, fw_port, local_port): fw_host, fw_port, self.bind_address, local_port) while channel == LIBSSH2_ERROR_EAGAIN: - self._client.poll() + self.client.poll() channel = self.session.direct_tcpip_ex( fw_host, fw_port, self.bind_address, local_port) @@ -251,4 +280,4 @@ def _open_channel_retries(self, fw_host, fw_port, local_port, FORWARDER = LocalForwarder() -FORWARDER.daemon = True +atexit.register(FORWARDER.shutdown) diff --git a/pssh/clients/reader.py b/pssh/clients/reader.py index c6b69b2a..c472f8a2 100644 --- a/pssh/clients/reader.py +++ b/pssh/clients/reader.py @@ -1,19 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from io import BytesIO @@ -34,11 +34,13 @@ def set(self): class ConcurrentRWBuffer(object): """Concurrent reader/writer of bytes for use from multiple greenlets. - Supports both concurrent reading and writing. + Supports both concurrent reading and writing and combinations there of. Iterate on buffer object to read data, yielding event loop if no data exists until self.eof has been set. + Check if end-of-file without blocking with ``ConcurrentRWBuffer.eof.is_set()``. + Writers should call ``ConcurrentRWBuffer.eof.set()`` when finished writing data via ``write``. Readers can use ``read()`` to get any available data or ``None``. diff --git a/pssh/clients/ssh/__init__.py b/pssh/clients/ssh/__init__.py index c4881707..75d7457d 100644 --- a/pssh/clients/ssh/__init__.py +++ b/pssh/clients/ssh/__init__.py @@ -1,19 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA # flake8: noqa: F401 from .parallel import ParallelSSHClient diff --git a/pssh/clients/ssh/parallel.py b/pssh/clients/ssh/parallel.py index 7ab4aafd..06d40950 100644 --- a/pssh/clients/ssh/parallel.py +++ b/pssh/clients/ssh/parallel.py @@ -1,19 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA import logging @@ -40,6 +40,7 @@ def __init__(self, hosts, user=None, password=None, port=22, pkey=None, gssapi_delegate_credentials=False, identity_auth=True, ipv6_only=False, + compress=False, ): """ :param hosts: Hosts to connect to @@ -114,6 +115,8 @@ def __init__(self, hosts, user=None, password=None, port=22, pkey=None, for the host or raise NoIPv6AddressFoundError otherwise. Note this will disable connecting to an IPv4 address if an IP address is provided instead. :type ipv6_only: bool + :param compress: Enable/Disable compression on the client. Defaults to off. + :type compress: bool :raises: :py:class:`pssh.exceptions.PKeyFileError` on errors finding provided private key. @@ -125,6 +128,7 @@ def __init__(self, hosts, user=None, password=None, port=22, pkey=None, host_config=host_config, retry_delay=retry_delay, identity_auth=identity_auth, ipv6_only=ipv6_only, + compress=compress, ) self.pkey = _validate_pkey(pkey) self.cert_file = _validate_pkey_path(cert_file) @@ -228,5 +232,6 @@ def _make_ssh_client(self, host, cfg, _pkey_data): gssapi_client_identity=self.gssapi_client_identity, gssapi_delegate_credentials=self.gssapi_delegate_credentials, cert_file=cfg.cert_file, + compress=cfg.compress or self.compress, ) return _client diff --git a/pssh/clients/ssh/single.py b/pssh/clients/ssh/single.py index ee3db7e0..40b1c86c 100644 --- a/pssh/clients/ssh/single.py +++ b/pssh/clients/ssh/single.py @@ -1,27 +1,28 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA import logging from gevent import sleep, spawn, Timeout as GTimeout, joinall +from gevent.socket import SHUT_RDWR from ssh import options from ssh.error_codes import SSH_AGAIN from ssh.exceptions import EOF -from ssh.key import import_privkey_file, import_cert_file, copy_cert_to_privkey, \ +from ssh.key import import_cert_file, copy_cert_to_privkey, \ import_privkey_base64 from ssh.session import Session, SSH_READ_PENDING, SSH_WRITE_PENDING @@ -50,6 +51,7 @@ def __init__(self, host, gssapi_client_identity=None, gssapi_delegate_credentials=False, ipv6_only=False, + compress=False, _auth_thread_pool=True): """:param host: Host name or IP to connect to. :type host: str @@ -81,9 +83,11 @@ def __init__(self, host, :type retry_delay: int or float :param timeout: (Optional) If provided, all commands will timeout after number of seconds. + Also currently sets socket as well as per function timeout in some cases, see + function descriptions. :type timeout: int or float :param allow_agent: (Optional) set to False to disable connecting to - the system's SSH agent. Currently unused. + the system's SSH agent. :type allow_agent: bool :param identity_auth: (Optional) set to False to disable attempting to authenticate with default identity files from @@ -105,6 +109,8 @@ def __init__(self, host, for the host or raise NoIPv6AddressFoundError otherwise. Note this will disable connecting to an IPv4 address if an IP address is provided instead. :type ipv6_only: bool + :param compress: Enable/Disable compression on the client. Defaults to off. + :type compress: bool :raises: :py:class:`pssh.exceptions.PKeyFileError` on errors finding provided private key. @@ -122,12 +128,21 @@ def __init__(self, host, timeout=timeout, identity_auth=identity_auth, ipv6_only=ipv6_only, + compress=compress, ) - def disconnect(self): - """Close socket if needed.""" - if self.sock is not None and not self.sock.closed: - self.sock.close() + def _disconnect(self): + """Shutdown socket if needed. + + Does not need to be called directly - called when client object is de-allocated. + """ + if self.session is not None and self.sock is not None and not self.sock.closed: + try: + self.sock.shutdown(SHUT_RDWR) + self.sock.detach() + except Exception: + pass + self.sock = None def _agent_auth(self): self.session.userauth_agent(self.user) @@ -141,6 +156,8 @@ def _init_session(self, retries=1): self.session = Session() self.session.options_set(options.USER, self.user) self.session.options_set(options.HOST, self.host) + if self.compress: + self.session.options_set(options.COMPRESSION, "yes") self.session.options_set_port(self.port) if self.gssapi_server_identity: self.session.options_set( @@ -178,10 +195,6 @@ def auth(self): def _password_auth(self): self.session.userauth_password(self.user, self.password) - def _pkey_file_auth(self, pkey_file, password=None): - pkey = import_privkey_file(pkey_file, passphrase=password if password is not None else '') - return self._pkey_obj_auth(pkey) - def _pkey_obj_auth(self, pkey): if self.cert_file is not None: logger.debug("Certificate file set - trying certificate authentication") @@ -201,12 +214,12 @@ def _import_cert_file(self, pkey): logger.debug("Imported certificate file %s for pkey %s", self.cert_file, self.pkey) def _shell(self, channel): - return self._eagain(channel.request_shell) + return self.eagain(channel.request_shell) def _open_session(self): channel = self.session.channel_new() channel.set_blocking(0) - self._eagain(channel.open_session) + self.eagain(channel.open_session) return channel def open_session(self): @@ -225,7 +238,7 @@ def _make_output_readers(self, channel, stdout_buffer, stderr_buffer): self._read_output_to_buffer, channel, stderr_buffer, is_stderr=True) return _stdout_reader, _stderr_reader - def execute(self, cmd, use_pty=False, channel=None): + def _execute(self, cmd, use_pty=False, channel=None): """Execute command on remote host. :param cmd: The command string to execute. @@ -235,12 +248,13 @@ def execute(self, cmd, use_pty=False, channel=None): :type use_pty: bool :param channel: Channel to use. New channel is created if not provided. :type channel: :py:class:`ssh.channel.Channel`""" - channel = self.open_session() if not channel else channel - if use_pty: - self._eagain(channel.request_pty, timeout=self.timeout) - logger.debug("Executing command '%s'", cmd) - self._eagain(channel.request_exec, cmd) - return channel + with GTimeout(seconds=self.timeout, exception=Timeout): + channel = self.open_session() if not channel else channel + if use_pty: + self.eagain(channel.request_pty) + logger.debug("Executing command '%s'", cmd) + self.eagain(channel.request_exec, cmd) + return channel def _read_output_to_buffer(self, channel, _buffer, is_stderr=False): try: @@ -276,7 +290,7 @@ def wait_finished(self, host_output, timeout=None): if channel is None: return logger.debug("Sending EOF on channel %s", channel) - self._eagain(channel.send_eof, timeout=self.timeout) + self.eagain(channel.send_eof) logger.debug("Waiting for readers, timeout %s", timeout) with GTimeout(seconds=timeout, exception=Timeout): joinall((host_output.buffers.stdout.reader, host_output.buffers.stderr.reader)) @@ -311,7 +325,7 @@ def close_channel(self, channel): :type channel: :py:class:`ssh.channel.Channel` """ logger.debug("Closing channel") - self._eagain(channel.close) + self.eagain(channel.close) def poll(self, timeout=None): """ssh-python based co-operative gevent poll on session socket. @@ -323,9 +337,9 @@ def poll(self, timeout=None): SSH_WRITE_PENDING, ) - def _eagain(self, func, *args, **kwargs): + def eagain(self, func, *args, **kwargs): """Run function given and handle EAGAIN for an ssh-python session""" return self._eagain_errcode(func, SSH_AGAIN, *args, **kwargs) - def _eagain_write(self, write_func, data): + def eagain_write(self, write_func, data): return self._eagain_write_errcode(write_func, data, SSH_AGAIN) diff --git a/pssh/config.py b/pssh/config.py index 935b0d9a..1490f0bc 100644 --- a/pssh/config.py +++ b/pssh/config.py @@ -1,23 +1,25 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA """Host specific configuration.""" +from .exceptions import InvalidAPIUseError + class HostConfig(object): """Host configuration for ParallelSSHClient. @@ -29,7 +31,7 @@ class HostConfig(object): 'proxy_host', 'proxy_port', 'proxy_user', 'proxy_password', 'proxy_pkey', 'keepalive_seconds', 'ipv6_only', 'cert_file', 'auth_thread_pool', 'gssapi_auth', 'gssapi_server_identity', 'gssapi_client_identity', 'gssapi_delegate_credentials', - 'forward_ssh_agent', + 'forward_ssh_agent', 'compress', 'keyboard_interactive', ) def __init__(self, user=None, port=None, password=None, private_key=None, @@ -46,6 +48,8 @@ def __init__(self, user=None, port=None, password=None, private_key=None, gssapi_client_identity=None, gssapi_delegate_credentials=False, forward_ssh_agent=False, + compress=False, + keyboard_interactive=False, ): """ :param user: Username to login as. @@ -99,6 +103,15 @@ def __init__(self, user=None, port=None, password=None, private_key=None, :param gssapi_delegate_credentials: Enable/disable server credentials delegation. (pssh.clients.ssh only) :type gssapi_delegate_credentials: bool + :param compress: Enable/Disable compression on the client. Defaults to off. + :type compress: bool + :param keyboard_interactive: Enable/Disable keyboard interactive authentication with provided username and + password. An `InvalidAPIUse` error is raised when keyboard_interactive is enabled without a provided password. + Defaults to off. + :type keyboard_interactive: bool + + :raises: :py:class:`pssh.exceptions.InvalidAPIUseError` when `keyboard_interactive=True` with no password + provided. """ self.user = user self.port = port @@ -124,6 +137,10 @@ def __init__(self, user=None, port=None, password=None, private_key=None, self.gssapi_server_identity = gssapi_server_identity self.gssapi_client_identity = gssapi_client_identity self.gssapi_delegate_credentials = gssapi_delegate_credentials + self.compress = compress + self.keyboard_interactive = keyboard_interactive + if self.keyboard_interactive and not self.password: + raise InvalidAPIUseError("Keyboard interactive authentication is enabled but no password is provided") self._sanity_checks() def _sanity_checks(self): @@ -181,3 +198,7 @@ def _sanity_checks(self): raise ValueError("GSSAPI client identity %s is not a string", self.gssapi_client_identity) if self.gssapi_delegate_credentials is not None and not isinstance(self.gssapi_delegate_credentials, bool): raise ValueError("GSSAPI delegate credentials %s is not a bool", self.gssapi_delegate_credentials) + if self.compress is not None and not isinstance(self.compress, bool): + raise ValueError("Compress %s is not a bool", self.compress) + if self.keyboard_interactive is not None and not isinstance(self.keyboard_interactive, bool): + raise ValueError("keyboard_interactive %s is not a bool", self.keyboard_interactive) diff --git a/pssh/constants.py b/pssh/constants.py index 5b58aa4c..1fba4ae3 100644 --- a/pssh/constants.py +++ b/pssh/constants.py @@ -1,19 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA """Constants definitions for pssh package""" diff --git a/pssh/exceptions.py b/pssh/exceptions.py index 14fdf35e..b0a3fa5e 100644 --- a/pssh/exceptions.py +++ b/pssh/exceptions.py @@ -1,19 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA """Exceptions raised by parallel-ssh classes.""" @@ -100,3 +100,7 @@ class ShellError(Exception): class HostConfigError(Exception): """Raised on invalid host configuration""" + + +class InvalidAPIUseError(Exception): + """Raised on invalid use of library API""" diff --git a/pssh/output.py b/pssh/output.py index cd9b043c..911e2895 100644 --- a/pssh/output.py +++ b/pssh/output.py @@ -1,19 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA """Output module of ParallelSSH""" @@ -57,11 +57,14 @@ class HostOutput(object): __slots__ = ('host', 'channel', 'stdin', 'client', 'alias', 'exception', 'encoding', 'read_timeout', 'buffers', + 'fully_qualified_command', ) def __init__(self, host, channel, stdin, client, alias=None, exception=None, encoding='utf-8', read_timeout=None, - buffers=None): + buffers=None, + fully_qualified_command=None, + ): """ :param host: Host name output is for :type host: str @@ -79,6 +82,15 @@ def __init__(self, host, channel, stdin, :type read_timeout: float :param buffers: Host buffer data. :type buffers: :py:class:`HostOutputBuffers` + :param fully_qualified_command: The fully qualified command after any per-host argument substitution and + including command string substitution required for executing via sudo or user-switching via 'su -c', using + any specified shell on `run_command` *and* conversion to bytes via provided encoding. + The fully_qualified_command is therefor a bytes object that can be saved or otherwise used anywhere bytes can + be used without conversion. + Use `fully_qualified_command.decode(encoding)` to decode with the encoding used for the equivalent host + output object. + Always `None` on `HostOutput` from interactive shells. + :type fully_qualified_command: bytes """ self.host = host self.channel = channel @@ -89,6 +101,7 @@ def __init__(self, host, channel, stdin, self.encoding = encoding self.read_timeout = read_timeout self.buffers = buffers + self.fully_qualified_command = fully_qualified_command @property def stdout(self): @@ -125,10 +138,12 @@ def __repr__(self): "\tchannel={channel}{linesep}" \ "\texception={exception}{linesep}" \ "\tencoding={encoding}{linesep}" \ - "\tread_timeout={read_timeout}".format( + "\tread_timeout={read_timeout}{linesep}" \ + "\tfully_qualified_command={fully_qualified_command}".format( host=self.host, alias=self.alias, channel=self.channel, exception=self.exception, linesep=linesep, exit_code=self.exit_code, encoding=self.encoding, read_timeout=self.read_timeout, + fully_qualified_command=self.fully_qualified_command, ) def __str__(self): diff --git a/pssh/utils.py b/pssh/utils.py index 3ee6ef2b..a9dd359a 100644 --- a/pssh/utils.py +++ b/pssh/utils.py @@ -1,19 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA """Module containing static utility functions for parallel-ssh.""" diff --git a/requirements.txt b/requirements.txt index 6a7d0069..ea7fed43 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ gevent>=1.3.0 -ssh2-python>=1.0.0 -ssh-python>=0.10.0 +ssh2-python>=1.2.0 +ssh-python>=1.2.0 diff --git a/requirements_dev.txt b/requirements_dev.txt index f3c85c43..93b64d79 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -1,12 +1,11 @@ coverage codecov flake8 -sphinx -sphinx_rtd_theme pytest pytest-cov pytest-rerunfailures jinja2 pre-commit +-r doc/requirements.txt -r requirements.txt -e . diff --git a/setup.cfg b/setup.cfg index 46e264d7..c7d3a5be 100644 --- a/setup.cfg +++ b/setup.cfg @@ -8,6 +8,6 @@ tag_prefix = '' max-line-length = 120 [tool:pytest] -addopts=-v --cov=pssh --cov-append --cov-report=term --cov-report=term-missing --durations=10 --reruns=5 +addopts=-v --cov=pssh --cov-append --cov-report=term --cov-report=term-missing --durations=10 --reruns=5 -r a testpaths = tests diff --git a/setup.py b/setup.py index 3087e9d1..6a799263 100644 --- a/setup.py +++ b/setup.py @@ -1,17 +1,19 @@ -# Copyright (C) 2014-2022 Panos Kittenis. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA from setuptools import setup, find_packages @@ -26,31 +28,35 @@ description='Asynchronous parallel SSH library', long_description=open('README.rst').read(), author='Panos Kittenis', - author_email='zuboci@yandex.com', + author_email='danst@tutanota.com', url="https://github.com/ParallelSSH/parallel-ssh", - license='LGPLv2.1', + license='LGPL-2.1-only', packages=find_packages( '.', exclude=('embedded_server', 'embedded_server.*', 'tests', 'tests.*', '*.tests', '*.tests.*') ), install_requires=[ - 'gevent', 'ssh2-python', 'ssh-python'], + 'gevent>=1.3.0', 'ssh2-python>=1.2.0', 'ssh-python>=1.2.0'], classifiers=[ 'Development Status :: 5 - Production/Stable', - 'License :: OSI Approved :: GNU Lesser General Public License v2 (LGPLv2)', 'Intended Audience :: Developers', 'Operating System :: OS Independent', - 'Programming Language :: Python', 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.6', - 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: 3.10', + 'Programming Language :: Python :: 3.11', + 'Programming Language :: Python :: 3.12', + 'Programming Language :: Python :: 3.13', + 'Programming Language :: Python :: 3.14', + 'Programming Language :: Python :: Implementation :: CPython', + 'Programming Language :: Python :: Implementation :: PyPy', + 'Topic :: System :: Shells', 'Topic :: System :: Networking', 'Topic :: Software Development :: Libraries', 'Topic :: Software Development :: Libraries :: Python Modules', + 'Operating System :: POSIX', 'Operating System :: POSIX :: Linux', 'Operating System :: POSIX :: BSD', 'Operating System :: Microsoft :: Windows', diff --git a/tests/__init__.py b/tests/__init__.py index e69de29b..edc34670 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -0,0 +1,16 @@ +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA diff --git a/tests/embedded_server/__init__.py b/tests/embedded_server/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/tests/native/__init__.py b/tests/native/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/tests/ssh/__init__.py b/tests/ssh/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/tests/test_api_use.py b/tests/test_api_use.py new file mode 100644 index 00000000..92ade040 --- /dev/null +++ b/tests/test_api_use.py @@ -0,0 +1,75 @@ +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + + +import unittest +from unittest.mock import patch, MagicMock + +from pssh.clients import ParallelSSHClient, SSHClient +from pssh.exceptions import InvalidAPIUseError, UnknownHostError + + +class APIUseTest(unittest.TestCase): + + @patch('gevent.socket') + @patch('pssh.clients.native.single.Session') + def test_kbd_interactive_enabled_single_clients(self, mock_sess, mock_sock): + self.assertRaises(UnknownHostError, SSHClient, + 'fakehost', password='fake_pass', keyboard_interactive=True, num_retries=0, + timeout=.1, + retry_delay=.1, + _auth_thread_pool=False, + allow_agent=False, + ) + self.assertRaises(InvalidAPIUseError, SSHClient, 'fakehost', keyboard_interactive=True) + + @patch('gevent.socket') + @patch('pssh.clients.native.single.Session') + def test_kbd_interactive_enabled_parallel_clients(self, mock_sess, mock_sock): + client = ParallelSSHClient( + ['fakehost'], password='fake_pass', keyboard_interactive=True, num_retries=0, + timeout=.1, + retry_delay=.1, + allow_agent=False, + ) + self.assertRaises(UnknownHostError, client.run_command, 'echo me') + self.assertRaises(InvalidAPIUseError, ParallelSSHClient, ['fakehost'], keyboard_interactive=True) + + @patch('gevent.socket.socket') + @patch('pssh.clients.native.single.Session') + def test_kbd_interactive_enabled_and_used(self, mock_sess, mock_sock): + sess = MagicMock() + mock_sess.return_value = sess + kbd_auth = MagicMock() + password_auth = MagicMock() + sess.userauth_keyboardinteractive = kbd_auth + sess.userauth_password = password_auth + my_user = "my_user" + my_pass = "fake_pass" + + client = SSHClient( + '127.0.0.1', port=1234, user=my_user, password=my_pass, keyboard_interactive=True, num_retries=0, + timeout=.1, + retry_delay=.1, + _auth_thread_pool=False, + allow_agent=False, + identity_auth=False, + ) + sess.userauth_keyboardinteractive.assert_called_once_with(my_user, my_pass) + sess.userauth_password.assert_not_called() + self.assertEqual(client.user, my_user) + self.assertEqual(client.password, my_pass) diff --git a/tests/test_exceptions.py b/tests/test_exceptions.py index 3b95c7ed..c0cedce9 100644 --- a/tests/test_exceptions.py +++ b/tests/test_exceptions.py @@ -1,22 +1,21 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA import unittest -from logging import NullHandler from pssh.exceptions import AuthenticationError, AuthenticationException, UnknownHostError, \ UnknownHostException, ConnectionError, ConnectionErrorException, SSHError, SSHException, \ @@ -68,4 +67,3 @@ def test_errors(self): raise HostArgumentError except HostArgumentException: pass - diff --git a/tests/test_host_config.py b/tests/test_host_config.py index 7327fb78..685e3d5f 100644 --- a/tests/test_host_config.py +++ b/tests/test_host_config.py @@ -1,23 +1,24 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA import unittest from pssh.config import HostConfig +from pssh.exceptions import InvalidAPIUseError class TestHostConfig(unittest.TestCase): @@ -43,6 +44,8 @@ def test_host_config_entries(self): gssapi_server_identity = 'some_id' gssapi_client_identity = 'some_id' gssapi_delegate_credentials = True + compress = True + keyboard_interactive = True cfg = HostConfig( user=user, port=port, password=password, alias=alias, private_key=private_key, allow_agent=allow_agent, num_retries=num_retries, retry_delay=retry_delay, @@ -56,6 +59,8 @@ def test_host_config_entries(self): gssapi_server_identity=gssapi_server_identity, gssapi_client_identity=gssapi_client_identity, gssapi_delegate_credentials=gssapi_delegate_credentials, + compress=compress, + keyboard_interactive=keyboard_interactive, ) self.assertEqual(cfg.user, user) self.assertEqual(cfg.port, port) @@ -76,6 +81,8 @@ def test_host_config_entries(self): self.assertEqual(cfg.gssapi_server_identity, gssapi_server_identity) self.assertEqual(cfg.gssapi_client_identity, gssapi_client_identity) self.assertEqual(cfg.gssapi_delegate_credentials, gssapi_delegate_credentials) + self.assertEqual(cfg.compress, compress) + self.assertEqual(cfg.keyboard_interactive, keyboard_interactive) def test_host_config_bad_entries(self): self.assertRaises(ValueError, HostConfig, user=22) @@ -102,3 +109,6 @@ def test_host_config_bad_entries(self): self.assertRaises(ValueError, HostConfig, gssapi_server_identity=1) self.assertRaises(ValueError, HostConfig, gssapi_client_identity=1) self.assertRaises(ValueError, HostConfig, gssapi_delegate_credentials='') + self.assertRaises(ValueError, HostConfig, compress='') + self.assertRaises(ValueError, HostConfig, password='fake', keyboard_interactive='') + self.assertRaises(InvalidAPIUseError, HostConfig, keyboard_interactive=True) diff --git a/tests/test_output.py b/tests/test_output.py index 15ad3dd6..3d460ede 100644 --- a/tests/test_output.py +++ b/tests/test_output.py @@ -1,19 +1,19 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA """Unittests for :mod:`pssh.output.HostOutput` class""" @@ -44,6 +44,7 @@ def test_bad_exit_status(self): def test_excepting_client_exit_code(self): class ChannelError(Exception): pass + class ExcSSHClient(object): def get_exit_status(self, channel): raise ChannelError diff --git a/tests/test_reader.py b/tests/test_reader.py index b353f80c..98804577 100644 --- a/tests/test_reader.py +++ b/tests/test_reader.py @@ -1,27 +1,27 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA import unittest - -from random import random, randint, randrange +from random import randrange from string import ascii_letters -from gevent.queue import Queue from gevent import spawn, sleep +from gevent.queue import Queue + from pssh.clients.reader import ConcurrentRWBuffer @@ -55,24 +55,25 @@ def test_multi_write_read(self): def test_concurrent_rw(self): written_data = Queue() + def _writer(_buffer): while True: - data = b"".join([ascii_letters[m].encode() for m in [randrange(0, 8) for _ in range(8)]]) - _buffer.write(data) - written_data.put(data) + temp_data = b"".join([ascii_letters[m].encode() for m in [randrange(0, 8) for _ in range(8)]]) + _buffer.write(temp_data) + written_data.put(temp_data) sleep(0.2) writer = spawn(_writer, self.buffer) writer.start() sleep(0.5) data = self.buffer.read() _data = b"" - while written_data.qsize() !=0 : + while written_data.qsize() != 0: _data += written_data.get() self.assertEqual(data, _data) sleep(0.5) data = self.buffer.read() _data = b"" - while written_data.qsize() !=0 : + while written_data.qsize() != 0: _data += written_data.get() self.assertEqual(data, _data) writer.kill() diff --git a/tests/test_utils.py b/tests/test_utils.py index 1346e28b..dc0fa7f0 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -1,24 +1,28 @@ -# This file is part of parallel-ssh. +# This file is part of parallel-ssh. +# Copyright (C) 2014-2025 Panos Kittenis. +# Copyright (C) 2014-2025 parallel-ssh Contributors. # -# Copyright (C) 2014-2022 Panos Kittenis and contributors. +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation, version 2.1. # -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation, version 2.1. +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. # -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA import unittest + +from unittest.mock import MagicMock from logging import NullHandler, DEBUG from pssh import utils +from pssh.clients.base.single import PollMixIn + class ParallelSSHUtilsTest(unittest.TestCase): @@ -42,3 +46,11 @@ def test_enabling_pssh_logger(self): utils.enable_debug_logger() self.assertEqual(utils.logger.level, DEBUG) utils.logger.handlers = [NullHandler()] + + def test_poll_mixin(self): + my_sock = MagicMock() + mixin = PollMixIn(my_sock) + directions_func = MagicMock() + directions_func.return_value = 0 + self.assertEqual(mixin.sock, my_sock) + self.assertIsNone(mixin._poll_errcodes(directions_func, 1, 1)) diff --git a/versioneer.py b/versioneer.py index a2870603..1e3753e6 100644 --- a/versioneer.py +++ b/versioneer.py @@ -1,5 +1,5 @@ -# Version: 0.18-1 +# Version: 0.29 """The Versioneer - like a rocketeer, but for versions. @@ -7,18 +7,14 @@ ============== * like a rocketeer, but for versions! -* https://github.com/warner/python-versioneer +* https://github.com/python-versioneer/python-versioneer * Brian Warner -* License: Public Domain -* Compatible With: python2.6, 2.7, 3.2, 3.3, 3.4, 3.5, 3.6, and pypy -* [![Latest Version] -(https://pypip.in/version/versioneer/badge.svg?style=flat) -](https://pypi.python.org/pypi/versioneer/) -* [![Build Status] -(https://travis-ci.org/warner/python-versioneer.png?branch=master) -](https://travis-ci.org/warner/python-versioneer) - -This is a tool for managing a recorded version number in distutils-based +* License: Public Domain (Unlicense) +* Compatible with: Python 3.7, 3.8, 3.9, 3.10, 3.11 and pypy3 +* [![Latest Version][pypi-image]][pypi-url] +* [![Build Status][travis-image]][travis-url] + +This is a tool for managing a recorded version number in setuptools-based python projects. The goal is to remove the tedious and error-prone "update the embedded version string" step from your release process. Making a new release should be as easy as recording a new tag in your version-control @@ -27,9 +23,38 @@ ## Quick Install -* `pip install versioneer` to somewhere to your $PATH -* add a `[versioneer]` section to your setup.cfg (see below) -* run `versioneer install` in your source tree, commit the results +Versioneer provides two installation modes. The "classic" vendored mode installs +a copy of versioneer into your repository. The experimental build-time dependency mode +is intended to allow you to skip this step and simplify the process of upgrading. + +### Vendored mode + +* `pip install versioneer` to somewhere in your $PATH + * A [conda-forge recipe](https://github.com/conda-forge/versioneer-feedstock) is + available, so you can also use `conda install -c conda-forge versioneer` +* add a `[tool.versioneer]` section to your `pyproject.toml` or a + `[versioneer]` section to your `setup.cfg` (see [Install](INSTALL.md)) + * Note that you will need to add `tomli; python_version < "3.11"` to your + build-time dependencies if you use `pyproject.toml` +* run `versioneer install --vendor` in your source tree, commit the results +* verify version information with `python setup.py version` + +### Build-time dependency mode + +* `pip install versioneer` to somewhere in your $PATH + * A [conda-forge recipe](https://github.com/conda-forge/versioneer-feedstock) is + available, so you can also use `conda install -c conda-forge versioneer` +* add a `[tool.versioneer]` section to your `pyproject.toml` or a + `[versioneer]` section to your `setup.cfg` (see [Install](INSTALL.md)) +* add `versioneer` (with `[toml]` extra, if configuring in `pyproject.toml`) + to the `requires` key of the `build-system` table in `pyproject.toml`: + ```toml + [build-system] + requires = ["setuptools", "versioneer[toml]"] + build-backend = "setuptools.build_meta" + ``` +* run `versioneer install --no-vendor` in your source tree, commit the results +* verify version information with `python setup.py version` ## Version Identifiers @@ -61,7 +86,7 @@ for example `git describe --tags --dirty --always` reports things like "0.7-1-g574ab98-dirty" to indicate that the checkout is one revision past the 0.7 tag, has a unique revision id of "574ab98", and is "dirty" (it has -uncommitted changes. +uncommitted changes). The version identifier is used for multiple purposes: @@ -166,7 +191,7 @@ Some situations are known to cause problems for Versioneer. This details the most significant ones. More can be found on Github -[issues page](https://github.com/warner/python-versioneer/issues). +[issues page](https://github.com/python-versioneer/python-versioneer/issues). ### Subprojects @@ -180,7 +205,7 @@ `setup.cfg`, and `tox.ini`. Projects like these produce multiple PyPI distributions (and upload multiple independently-installable tarballs). * Source trees whose main purpose is to contain a C library, but which also - provide bindings to Python (and perhaps other langauges) in subdirectories. + provide bindings to Python (and perhaps other languages) in subdirectories. Versioneer will look for `.git` in parent directories, and most operations should get the right version string. However `pip` and `setuptools` have bugs @@ -194,9 +219,9 @@ Pip-8.1.1 is known to have this problem, but hopefully it will get fixed in some later version. -[Bug #38](https://github.com/warner/python-versioneer/issues/38) is tracking +[Bug #38](https://github.com/python-versioneer/python-versioneer/issues/38) is tracking this issue. The discussion in -[PR #61](https://github.com/warner/python-versioneer/pull/61) describes the +[PR #61](https://github.com/python-versioneer/python-versioneer/pull/61) describes the issue from the Versioneer side in more detail. [pip PR#3176](https://github.com/pypa/pip/pull/3176) and [pip PR#3615](https://github.com/pypa/pip/pull/3615) contain work to improve @@ -224,31 +249,20 @@ cause egg_info to be rebuilt (including `sdist`, `wheel`, and installing into a different virtualenv), so this can be surprising. -[Bug #83](https://github.com/warner/python-versioneer/issues/83) describes +[Bug #83](https://github.com/python-versioneer/python-versioneer/issues/83) describes this one, but upgrading to a newer version of setuptools should probably resolve it. -### Unicode version strings - -While Versioneer works (and is continually tested) with both Python 2 and -Python 3, it is not entirely consistent with bytes-vs-unicode distinctions. -Newer releases probably generate unicode version strings on py2. It's not -clear that this is wrong, but it may be surprising for applications when then -write these strings to a network connection or include them in bytes-oriented -APIs like cryptographic checksums. - -[Bug #71](https://github.com/warner/python-versioneer/issues/71) investigates -this question. - ## Updating Versioneer To upgrade your project to a new release of Versioneer, do the following: * install the new Versioneer (`pip install -U versioneer` or equivalent) -* edit `setup.cfg`, if necessary, to include any new configuration settings - indicated by the release notes. See [UPGRADING](./UPGRADING.md) for details. -* re-run `versioneer install` in your source tree, to replace +* edit `setup.cfg` and `pyproject.toml`, if necessary, + to include any new configuration settings indicated by the release notes. + See [UPGRADING](./UPGRADING.md) for details. +* re-run `versioneer install --[no-]vendor` in your source tree, to replace `SRC/_version.py` * commit any changed files @@ -265,35 +279,70 @@ direction and include code from all supported VCS systems, reducing the number of intermediate scripts. +## Similar projects + +* [setuptools_scm](https://github.com/pypa/setuptools_scm/) - a non-vendored build-time + dependency +* [minver](https://github.com/jbweston/miniver) - a lightweight reimplementation of + versioneer +* [versioningit](https://github.com/jwodder/versioningit) - a PEP 518-based setuptools + plugin ## License To make Versioneer easier to embed, all its code is dedicated to the public domain. The `_version.py` that it creates is also in the public domain. -Specifically, both are released under the Creative Commons "Public Domain -Dedication" license (CC0-1.0), as described in -https://creativecommons.org/publicdomain/zero/1.0/ . +Specifically, both are released under the "Unlicense", as described in +https://unlicense.org/. + +[pypi-image]: https://img.shields.io/pypi/v/versioneer.svg +[pypi-url]: https://pypi.python.org/pypi/versioneer/ +[travis-image]: +https://img.shields.io/travis/com/python-versioneer/python-versioneer.svg +[travis-url]: https://travis-ci.com/github/python-versioneer/python-versioneer """ +# pylint:disable=invalid-name,import-outside-toplevel,missing-function-docstring +# pylint:disable=missing-class-docstring,too-many-branches,too-many-statements +# pylint:disable=raise-missing-from,too-many-lines,too-many-locals,import-error +# pylint:disable=too-few-public-methods,redefined-outer-name,consider-using-with +# pylint:disable=attribute-defined-outside-init,too-many-arguments -from __future__ import print_function -try: - import configparser -except ImportError: - import ConfigParser as configparser +import configparser import errno import json import os import re import subprocess import sys +from pathlib import Path +from typing import Any, Callable, cast, Dict, List, Optional, Tuple, Union +from typing import NoReturn +import functools + +have_tomllib = True +if sys.version_info >= (3, 11): + import tomllib +else: + try: + import tomli as tomllib + except ImportError: + have_tomllib = False class VersioneerConfig: """Container for Versioneer configuration parameters.""" + VCS: str + style: str + tag_prefix: str + versionfile_source: str + versionfile_build: Optional[str] + parentdir_prefix: Optional[str] + verbose: Optional[bool] + -def get_root(): +def get_root() -> str: """Get the project root directory. We require that all commands are run from the project root, i.e. the @@ -301,13 +350,23 @@ def get_root(): """ root = os.path.realpath(os.path.abspath(os.getcwd())) setup_py = os.path.join(root, "setup.py") + pyproject_toml = os.path.join(root, "pyproject.toml") versioneer_py = os.path.join(root, "versioneer.py") - if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): + if not ( + os.path.exists(setup_py) + or os.path.exists(pyproject_toml) + or os.path.exists(versioneer_py) + ): # allow 'python path/to/setup.py COMMAND' root = os.path.dirname(os.path.realpath(os.path.abspath(sys.argv[0]))) setup_py = os.path.join(root, "setup.py") + pyproject_toml = os.path.join(root, "pyproject.toml") versioneer_py = os.path.join(root, "versioneer.py") - if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): + if not ( + os.path.exists(setup_py) + or os.path.exists(pyproject_toml) + or os.path.exists(versioneer_py) + ): err = ("Versioneer was unable to run the project root directory. " "Versioneer requires setup.py to be executed from " "its immediate directory (like 'python setup.py COMMAND'), " @@ -321,43 +380,62 @@ def get_root(): # module-import table will cache the first one. So we can't use # os.path.dirname(__file__), as that will find whichever # versioneer.py was first imported, even in later projects. - me = os.path.realpath(os.path.abspath(__file__)) - me_dir = os.path.normcase(os.path.splitext(me)[0]) + my_path = os.path.realpath(os.path.abspath(__file__)) + me_dir = os.path.normcase(os.path.splitext(my_path)[0]) vsr_dir = os.path.normcase(os.path.splitext(versioneer_py)[0]) - if me_dir != vsr_dir: + if me_dir != vsr_dir and "VERSIONEER_PEP518" not in globals(): print("Warning: build in %s is using versioneer.py from %s" - % (os.path.dirname(me), versioneer_py)) + % (os.path.dirname(my_path), versioneer_py)) except NameError: pass return root -def get_config_from_root(root): +def get_config_from_root(root: str) -> VersioneerConfig: """Read the project setup.cfg file to determine Versioneer config.""" - # This might raise EnvironmentError (if setup.cfg is missing), or + # This might raise OSError (if setup.cfg is missing), or # configparser.NoSectionError (if it lacks a [versioneer] section), or # configparser.NoOptionError (if it lacks "VCS="). See the docstring at # the top of versioneer.py for instructions on writing your setup.cfg . - setup_cfg = os.path.join(root, "setup.cfg") - parser = configparser.SafeConfigParser() - with open(setup_cfg, "r") as f: - parser.readfp(f) - VCS = parser.get("versioneer", "VCS") # mandatory - - def get(parser, name): - if parser.has_option("versioneer", name): - return parser.get("versioneer", name) - return None + root_pth = Path(root) + pyproject_toml = root_pth / "pyproject.toml" + setup_cfg = root_pth / "setup.cfg" + section: Union[Dict[str, Any], configparser.SectionProxy, None] = None + if pyproject_toml.exists() and have_tomllib: + try: + with open(pyproject_toml, 'rb') as fobj: + pp = tomllib.load(fobj) + section = pp['tool']['versioneer'] + except (tomllib.TOMLDecodeError, KeyError) as e: + print(f"Failed to load config from {pyproject_toml}: {e}") + print("Try to load it from setup.cfg") + if not section: + parser = configparser.ConfigParser() + with open(setup_cfg) as cfg_file: + parser.read_file(cfg_file) + parser.get("versioneer", "VCS") # raise error if missing + + section = parser["versioneer"] + + # `cast`` really shouldn't be used, but its simplest for the + # common VersioneerConfig users at the moment. We verify against + # `None` values elsewhere where it matters + cfg = VersioneerConfig() - cfg.VCS = VCS - cfg.style = get(parser, "style") or "" - cfg.versionfile_source = get(parser, "versionfile_source") - cfg.versionfile_build = get(parser, "versionfile_build") - cfg.tag_prefix = get(parser, "tag_prefix") - if cfg.tag_prefix in ("''", '""'): + cfg.VCS = section['VCS'] + cfg.style = section.get("style", "") + cfg.versionfile_source = cast(str, section.get("versionfile_source")) + cfg.versionfile_build = section.get("versionfile_build") + cfg.tag_prefix = cast(str, section.get("tag_prefix")) + if cfg.tag_prefix in ("''", '""', None): cfg.tag_prefix = "" - cfg.parentdir_prefix = get(parser, "parentdir_prefix") - cfg.verbose = get(parser, "verbose") + cfg.parentdir_prefix = section.get("parentdir_prefix") + if isinstance(section, configparser.SectionProxy): + # Make sure configparser translates to bool + cfg.verbose = section.getboolean("verbose") + else: + cfg.verbose = section.get("verbose") + return cfg @@ -366,37 +444,48 @@ class NotThisMethod(Exception): # these dictionaries contain VCS-specific tools -LONG_VERSION_PY = {} -HANDLERS = {} +LONG_VERSION_PY: Dict[str, str] = {} +HANDLERS: Dict[str, Dict[str, Callable]] = {} -def register_vcs_handler(vcs, method): # decorator - """Decorator to mark a method as the handler for a particular VCS.""" - def decorate(f): +def register_vcs_handler(vcs: str, method: str) -> Callable: # decorator + """Create decorator to mark a method as the handler of a VCS.""" + def decorate(f: Callable) -> Callable: """Store f in HANDLERS[vcs][method].""" - if vcs not in HANDLERS: - HANDLERS[vcs] = {} - HANDLERS[vcs][method] = f + HANDLERS.setdefault(vcs, {})[method] = f return f return decorate -def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, - env=None): +def run_command( + commands: List[str], + args: List[str], + cwd: Optional[str] = None, + verbose: bool = False, + hide_stderr: bool = False, + env: Optional[Dict[str, str]] = None, +) -> Tuple[Optional[str], Optional[int]]: """Call the given command(s).""" assert isinstance(commands, list) - p = None - for c in commands: + process = None + + popen_kwargs: Dict[str, Any] = {} + if sys.platform == "win32": + # This hides the console window if pythonw.exe is used + startupinfo = subprocess.STARTUPINFO() + startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW + popen_kwargs["startupinfo"] = startupinfo + + for command in commands: try: - dispcmd = str([c] + args) + dispcmd = str([command] + args) # remember shell=False, so use git.cmd on windows, not just git - p = subprocess.Popen([c] + args, cwd=cwd, env=env, - stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None)) + process = subprocess.Popen([command] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None), **popen_kwargs) break - except EnvironmentError: - e = sys.exc_info()[1] + except OSError as e: if e.errno == errno.ENOENT: continue if verbose: @@ -407,26 +496,25 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, if verbose: print("unable to find command, tried %s" % (commands,)) return None, None - stdout = p.communicate()[0].strip() - if sys.version_info[0] >= 3: - stdout = stdout.decode() - if p.returncode != 0: + stdout = process.communicate()[0].strip().decode() + if process.returncode != 0: if verbose: print("unable to run %s (error)" % dispcmd) print("stdout was %s" % stdout) - return None, p.returncode - return stdout, p.returncode + return None, process.returncode + return stdout, process.returncode -LONG_VERSION_PY['git'] = ''' +LONG_VERSION_PY['git'] = r''' # This file helps to compute a version number in source trees obtained from # git-archive tarball (such as those provided by githubs download-from-tag # feature). Distribution tarballs (built by setup.py sdist) and build # directories (produced by setup.py build) will contain a much shorter file # that just contains the computed version number. -# This file is released into the public domain. Generated by -# versioneer-0.18 (https://github.com/warner/python-versioneer) +# This file is released into the public domain. +# Generated by versioneer-0.29 +# https://github.com/python-versioneer/python-versioneer """Git implementation of _version.py.""" @@ -435,9 +523,11 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, import re import subprocess import sys +from typing import Any, Callable, Dict, List, Optional, Tuple +import functools -def get_keywords(): +def get_keywords() -> Dict[str, str]: """Get the keywords needed to look up the version information.""" # these strings will be replaced by git during git-archive. # setup.py/versioneer.py will grep for the variable names, so they must @@ -453,8 +543,15 @@ def get_keywords(): class VersioneerConfig: """Container for Versioneer configuration parameters.""" + VCS: str + style: str + tag_prefix: str + parentdir_prefix: str + versionfile_source: str + verbose: bool + -def get_config(): +def get_config() -> VersioneerConfig: """Create, populate and return the VersioneerConfig() object.""" # these strings are filled in when 'setup.py versioneer' creates # _version.py @@ -472,13 +569,13 @@ class NotThisMethod(Exception): """Exception raised if a method is not valid for the current scenario.""" -LONG_VERSION_PY = {} -HANDLERS = {} +LONG_VERSION_PY: Dict[str, str] = {} +HANDLERS: Dict[str, Dict[str, Callable]] = {} -def register_vcs_handler(vcs, method): # decorator - """Decorator to mark a method as the handler for a particular VCS.""" - def decorate(f): +def register_vcs_handler(vcs: str, method: str) -> Callable: # decorator + """Create decorator to mark a method as the handler of a VCS.""" + def decorate(f: Callable) -> Callable: """Store f in HANDLERS[vcs][method].""" if vcs not in HANDLERS: HANDLERS[vcs] = {} @@ -487,22 +584,35 @@ def decorate(f): return decorate -def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, - env=None): +def run_command( + commands: List[str], + args: List[str], + cwd: Optional[str] = None, + verbose: bool = False, + hide_stderr: bool = False, + env: Optional[Dict[str, str]] = None, +) -> Tuple[Optional[str], Optional[int]]: """Call the given command(s).""" assert isinstance(commands, list) - p = None - for c in commands: + process = None + + popen_kwargs: Dict[str, Any] = {} + if sys.platform == "win32": + # This hides the console window if pythonw.exe is used + startupinfo = subprocess.STARTUPINFO() + startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW + popen_kwargs["startupinfo"] = startupinfo + + for command in commands: try: - dispcmd = str([c] + args) + dispcmd = str([command] + args) # remember shell=False, so use git.cmd on windows, not just git - p = subprocess.Popen([c] + args, cwd=cwd, env=env, - stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None)) + process = subprocess.Popen([command] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None), **popen_kwargs) break - except EnvironmentError: - e = sys.exc_info()[1] + except OSError as e: if e.errno == errno.ENOENT: continue if verbose: @@ -513,18 +623,20 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, if verbose: print("unable to find command, tried %%s" %% (commands,)) return None, None - stdout = p.communicate()[0].strip() - if sys.version_info[0] >= 3: - stdout = stdout.decode() - if p.returncode != 0: + stdout = process.communicate()[0].strip().decode() + if process.returncode != 0: if verbose: print("unable to run %%s (error)" %% dispcmd) print("stdout was %%s" %% stdout) - return None, p.returncode - return stdout, p.returncode + return None, process.returncode + return stdout, process.returncode -def versions_from_parentdir(parentdir_prefix, root, verbose): +def versions_from_parentdir( + parentdir_prefix: str, + root: str, + verbose: bool, +) -> Dict[str, Any]: """Try to determine the version from the parent directory name. Source tarballs conventionally unpack into a directory that includes both @@ -533,15 +645,14 @@ def versions_from_parentdir(parentdir_prefix, root, verbose): """ rootdirs = [] - for i in range(3): + for _ in range(3): dirname = os.path.basename(root) if dirname.startswith(parentdir_prefix): return {"version": dirname[len(parentdir_prefix):], "full-revisionid": None, "dirty": False, "error": None, "date": None} - else: - rootdirs.append(root) - root = os.path.dirname(root) # up a level + rootdirs.append(root) + root = os.path.dirname(root) # up a level if verbose: print("Tried directories %%s but none started with prefix %%s" %% @@ -550,41 +661,48 @@ def versions_from_parentdir(parentdir_prefix, root, verbose): @register_vcs_handler("git", "get_keywords") -def git_get_keywords(versionfile_abs): +def git_get_keywords(versionfile_abs: str) -> Dict[str, str]: """Extract version information from the given file.""" # the code embedded in _version.py can just fetch the value of these # keywords. When used from setup.py, we don't want to import _version.py, # so we do it with a regexp instead. This function is not used from # _version.py. - keywords = {} + keywords: Dict[str, str] = {} try: - f = open(versionfile_abs, "r") - for line in f.readlines(): - if line.strip().startswith("git_refnames ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["refnames"] = mo.group(1) - if line.strip().startswith("git_full ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["full"] = mo.group(1) - if line.strip().startswith("git_date ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["date"] = mo.group(1) - f.close() - except EnvironmentError: + with open(versionfile_abs, "r") as fobj: + for line in fobj: + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + except OSError: pass return keywords @register_vcs_handler("git", "keywords") -def git_versions_from_keywords(keywords, tag_prefix, verbose): +def git_versions_from_keywords( + keywords: Dict[str, str], + tag_prefix: str, + verbose: bool, +) -> Dict[str, Any]: """Get version information from git keywords.""" - if not keywords: - raise NotThisMethod("no keywords at all, weird") + if "refnames" not in keywords: + raise NotThisMethod("Short version file found") date = keywords.get("date") if date is not None: + # Use only the last line. Previous lines may contain GPG signature + # information. + date = date.splitlines()[-1] + # git-2.2.0 added "%%cI", which expands to an ISO-8601 -compliant # datestamp. However we prefer "%%ci" (which expands to an "ISO-8601 # -like" string, which we must then edit to make compliant), because @@ -597,11 +715,11 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): if verbose: print("keywords are unexpanded, not using") raise NotThisMethod("unexpanded keywords, not a git-archive tarball") - refs = set([r.strip() for r in refnames.strip("()").split(",")]) + refs = {r.strip() for r in refnames.strip("()").split(",")} # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of # just "foo-1.0". If we see a "tag: " prefix, prefer those. TAG = "tag: " - tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + tags = {r[len(TAG):] for r in refs if r.startswith(TAG)} if not tags: # Either we're using git < 1.8.3, or there really are no tags. We use # a heuristic: assume all version tags have a digit. The old git %%d @@ -610,7 +728,7 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): # between branches and tags. By ignoring refnames without digits, we # filter out many common branch names like "release" and # "stabilization", as well as "HEAD" and "master". - tags = set([r for r in refs if re.search(r'\d', r)]) + tags = {r for r in refs if re.search(r'\d', r)} if verbose: print("discarding '%%s', no digits" %% ",".join(refs - tags)) if verbose: @@ -619,6 +737,11 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): # sorting will prefer e.g. "2.0" over "2.0rc1" if ref.startswith(tag_prefix): r = ref[len(tag_prefix):] + # Filter out refs that exactly match prefix or that don't start + # with a number once the prefix is stripped (mostly a concern + # when prefix is '') + if not re.match(r'\d', r): + continue if verbose: print("picking %%s" %% r) return {"version": r, @@ -634,7 +757,12 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): @register_vcs_handler("git", "pieces_from_vcs") -def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): +def git_pieces_from_vcs( + tag_prefix: str, + root: str, + verbose: bool, + runner: Callable = run_command +) -> Dict[str, Any]: """Get version from 'git describe' in the root of the source tree. This only gets called if the git-archive 'subst' keywords were *not* @@ -645,8 +773,15 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] - out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, - hide_stderr=True) + # GIT_DIR can interfere with correct operation of Versioneer. + # It may be intended to be passed to the Versioneer-versioned project, + # but that should not change where we get our version from. + env = os.environ.copy() + env.pop("GIT_DIR", None) + runner = functools.partial(runner, env=env) + + _, rc = runner(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=not verbose) if rc != 0: if verbose: print("Directory %%s not under git control" %% root) @@ -654,24 +789,57 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] # if there isn't one, this yields HEX[-dirty] (no NUM) - describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", - "--match", "%%s*" %% tag_prefix], - cwd=root) + describe_out, rc = runner(GITS, [ + "describe", "--tags", "--dirty", "--always", "--long", + "--match", f"{tag_prefix}[[:digit:]]*" + ], cwd=root) # --long was added in git-1.5.5 if describe_out is None: raise NotThisMethod("'git describe' failed") describe_out = describe_out.strip() - full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + full_out, rc = runner(GITS, ["rev-parse", "HEAD"], cwd=root) if full_out is None: raise NotThisMethod("'git rev-parse' failed") full_out = full_out.strip() - pieces = {} + pieces: Dict[str, Any] = {} pieces["long"] = full_out pieces["short"] = full_out[:7] # maybe improved later pieces["error"] = None + branch_name, rc = runner(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], + cwd=root) + # --abbrev-ref was added in git-1.6.3 + if rc != 0 or branch_name is None: + raise NotThisMethod("'git rev-parse --abbrev-ref' returned error") + branch_name = branch_name.strip() + + if branch_name == "HEAD": + # If we aren't exactly on a branch, pick a branch which represents + # the current commit. If all else fails, we are on a branchless + # commit. + branches, rc = runner(GITS, ["branch", "--contains"], cwd=root) + # --contains was added in git-1.5.4 + if rc != 0 or branches is None: + raise NotThisMethod("'git branch --contains' returned error") + branches = branches.split("\n") + + # Remove the first line if we're running detached + if "(" in branches[0]: + branches.pop(0) + + # Strip off the leading "* " from the list of branches. + branches = [branch[2:] for branch in branches] + if "master" in branches: + branch_name = "master" + elif not branches: + branch_name = None + else: + # Pick the first branch that is returned. Good or bad. + branch_name = branches[0] + + pieces["branch"] = branch_name + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] # TAG might have hyphens. git_describe = describe_out @@ -688,7 +856,7 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): # TAG-NUM-gHEX mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) if not mo: - # unparseable. Maybe git-describe is misbehaving? + # unparsable. Maybe git-describe is misbehaving? pieces["error"] = ("unable to parse git-describe output: '%%s'" %% describe_out) return pieces @@ -713,26 +881,27 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): else: # HEX: no tags pieces["closest-tag"] = None - count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) - pieces["distance"] = int(count_out) # total number of commits + out, rc = runner(GITS, ["rev-list", "HEAD", "--left-right"], cwd=root) + pieces["distance"] = len(out.split()) # total number of commits # commit date: see ISO-8601 comment in git_versions_from_keywords() - date = run_command(GITS, ["show", "-s", "--format=%%ci", "HEAD"], - cwd=root)[0].strip() + date = runner(GITS, ["show", "-s", "--format=%%ci", "HEAD"], cwd=root)[0].strip() + # Use only the last line. Previous lines may contain GPG signature + # information. + date = date.splitlines()[-1] pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) return pieces -def plus_or_dot(pieces): +def plus_or_dot(pieces: Dict[str, Any]) -> str: """Return a + if we don't already have one, else return a .""" if "+" in pieces.get("closest-tag", ""): return "." return "+" -def render_pep440(pieces): +def render_pep440(pieces: Dict[str, Any]) -> str: """Build up version string, with post-release "local version identifier". Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you @@ -757,23 +926,71 @@ def render_pep440(pieces): return rendered -def render_pep440_pre(pieces): - """TAG[.post.devDISTANCE] -- No -dirty. +def render_pep440_branch(pieces: Dict[str, Any]) -> str: + """TAG[[.dev0]+DISTANCE.gHEX[.dirty]] . + + The ".dev0" means not master branch. Note that .dev0 sorts backwards + (a feature branch will appear "older" than the master branch). Exceptions: - 1: no tags. 0.post.devDISTANCE + 1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "%%d.g%%s" %% (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0" + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += "+untagged.%%d.g%%s" %% (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def pep440_split_post(ver: str) -> Tuple[str, Optional[int]]: + """Split pep440 version string at the post-release segment. + + Returns the release segments before the post-release and the + post-release version number (or -1 if no post-release segment is present). + """ + vc = str.split(ver, ".post") + return vc[0], int(vc[1] or 0) if len(vc) == 2 else None + + +def render_pep440_pre(pieces: Dict[str, Any]) -> str: + """TAG[.postN.devDISTANCE] -- No -dirty. + + Exceptions: + 1: no tags. 0.post0.devDISTANCE + """ + if pieces["closest-tag"]: if pieces["distance"]: - rendered += ".post.dev%%d" %% pieces["distance"] + # update the post release segment + tag_version, post_version = pep440_split_post(pieces["closest-tag"]) + rendered = tag_version + if post_version is not None: + rendered += ".post%%d.dev%%d" %% (post_version + 1, pieces["distance"]) + else: + rendered += ".post0.dev%%d" %% (pieces["distance"]) + else: + # no commits, use the tag as the version + rendered = pieces["closest-tag"] else: # exception #1 - rendered = "0.post.dev%%d" %% pieces["distance"] + rendered = "0.post0.dev%%d" %% pieces["distance"] return rendered -def render_pep440_post(pieces): +def render_pep440_post(pieces: Dict[str, Any]) -> str: """TAG[.postDISTANCE[.dev0]+gHEX] . The ".dev0" means dirty. Note that .dev0 sorts backwards @@ -800,12 +1017,41 @@ def render_pep440_post(pieces): return rendered -def render_pep440_old(pieces): +def render_pep440_post_branch(pieces: Dict[str, Any]) -> str: + """TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] . + + The ".dev0" means not master branch. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%%d" %% pieces["distance"] + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%%s" %% pieces["short"] + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0.post%%d" %% pieces["distance"] + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += "+g%%s" %% pieces["short"] + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def render_pep440_old(pieces: Dict[str, Any]) -> str: """TAG[.postDISTANCE[.dev0]] . The ".dev0" means dirty. - Eexceptions: + Exceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: @@ -822,7 +1068,7 @@ def render_pep440_old(pieces): return rendered -def render_git_describe(pieces): +def render_git_describe(pieces: Dict[str, Any]) -> str: """TAG[-DISTANCE-gHEX][-dirty]. Like 'git describe --tags --dirty --always'. @@ -842,7 +1088,7 @@ def render_git_describe(pieces): return rendered -def render_git_describe_long(pieces): +def render_git_describe_long(pieces: Dict[str, Any]) -> str: """TAG-DISTANCE-gHEX[-dirty]. Like 'git describe --tags --dirty --always -long'. @@ -862,7 +1108,7 @@ def render_git_describe_long(pieces): return rendered -def render(pieces, style): +def render(pieces: Dict[str, Any], style: str) -> Dict[str, Any]: """Render the given version pieces into the requested style.""" if pieces["error"]: return {"version": "unknown", @@ -876,10 +1122,14 @@ def render(pieces, style): if style == "pep440": rendered = render_pep440(pieces) + elif style == "pep440-branch": + rendered = render_pep440_branch(pieces) elif style == "pep440-pre": rendered = render_pep440_pre(pieces) elif style == "pep440-post": rendered = render_pep440_post(pieces) + elif style == "pep440-post-branch": + rendered = render_pep440_post_branch(pieces) elif style == "pep440-old": rendered = render_pep440_old(pieces) elif style == "git-describe": @@ -894,7 +1144,7 @@ def render(pieces, style): "date": pieces.get("date")} -def get_versions(): +def get_versions() -> Dict[str, Any]: """Get version information or return default if unable to do so.""" # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have # __file__, we can work backwards from there to the root. Some @@ -915,7 +1165,7 @@ def get_versions(): # versionfile_source is the relative path from the top of the source # tree (where the .git directory might live) to this file. Invert # this to find the root from __file__. - for i in cfg.versionfile_source.split('/'): + for _ in cfg.versionfile_source.split('/'): root = os.path.dirname(root) except NameError: return {"version": "0+unknown", "full-revisionid": None, @@ -942,41 +1192,48 @@ def get_versions(): @register_vcs_handler("git", "get_keywords") -def git_get_keywords(versionfile_abs): +def git_get_keywords(versionfile_abs: str) -> Dict[str, str]: """Extract version information from the given file.""" # the code embedded in _version.py can just fetch the value of these # keywords. When used from setup.py, we don't want to import _version.py, # so we do it with a regexp instead. This function is not used from # _version.py. - keywords = {} + keywords: Dict[str, str] = {} try: - f = open(versionfile_abs, "r") - for line in f.readlines(): - if line.strip().startswith("git_refnames ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["refnames"] = mo.group(1) - if line.strip().startswith("git_full ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["full"] = mo.group(1) - if line.strip().startswith("git_date ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["date"] = mo.group(1) - f.close() - except EnvironmentError: + with open(versionfile_abs, "r") as fobj: + for line in fobj: + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + except OSError: pass return keywords @register_vcs_handler("git", "keywords") -def git_versions_from_keywords(keywords, tag_prefix, verbose): +def git_versions_from_keywords( + keywords: Dict[str, str], + tag_prefix: str, + verbose: bool, +) -> Dict[str, Any]: """Get version information from git keywords.""" - if not keywords: - raise NotThisMethod("no keywords at all, weird") + if "refnames" not in keywords: + raise NotThisMethod("Short version file found") date = keywords.get("date") if date is not None: + # Use only the last line. Previous lines may contain GPG signature + # information. + date = date.splitlines()[-1] + # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 # -like" string, which we must then edit to make compliant), because @@ -989,11 +1246,11 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): if verbose: print("keywords are unexpanded, not using") raise NotThisMethod("unexpanded keywords, not a git-archive tarball") - refs = set([r.strip() for r in refnames.strip("()").split(",")]) + refs = {r.strip() for r in refnames.strip("()").split(",")} # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of # just "foo-1.0". If we see a "tag: " prefix, prefer those. TAG = "tag: " - tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + tags = {r[len(TAG):] for r in refs if r.startswith(TAG)} if not tags: # Either we're using git < 1.8.3, or there really are no tags. We use # a heuristic: assume all version tags have a digit. The old git %d @@ -1002,7 +1259,7 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): # between branches and tags. By ignoring refnames without digits, we # filter out many common branch names like "release" and # "stabilization", as well as "HEAD" and "master". - tags = set([r for r in refs if re.search(r'\d', r)]) + tags = {r for r in refs if re.search(r'\d', r)} if verbose: print("discarding '%s', no digits" % ",".join(refs - tags)) if verbose: @@ -1011,6 +1268,11 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): # sorting will prefer e.g. "2.0" over "2.0rc1" if ref.startswith(tag_prefix): r = ref[len(tag_prefix):] + # Filter out refs that exactly match prefix or that don't start + # with a number once the prefix is stripped (mostly a concern + # when prefix is '') + if not re.match(r'\d', r): + continue if verbose: print("picking %s" % r) return {"version": r, @@ -1026,7 +1288,12 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): @register_vcs_handler("git", "pieces_from_vcs") -def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): +def git_pieces_from_vcs( + tag_prefix: str, + root: str, + verbose: bool, + runner: Callable = run_command +) -> Dict[str, Any]: """Get version from 'git describe' in the root of the source tree. This only gets called if the git-archive 'subst' keywords were *not* @@ -1037,8 +1304,15 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] - out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, - hide_stderr=True) + # GIT_DIR can interfere with correct operation of Versioneer. + # It may be intended to be passed to the Versioneer-versioned project, + # but that should not change where we get our version from. + env = os.environ.copy() + env.pop("GIT_DIR", None) + runner = functools.partial(runner, env=env) + + _, rc = runner(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=not verbose) if rc != 0: if verbose: print("Directory %s not under git control" % root) @@ -1046,24 +1320,57 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] # if there isn't one, this yields HEX[-dirty] (no NUM) - describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", - "--match", "%s*" % tag_prefix], - cwd=root) + describe_out, rc = runner(GITS, [ + "describe", "--tags", "--dirty", "--always", "--long", + "--match", f"{tag_prefix}[[:digit:]]*" + ], cwd=root) # --long was added in git-1.5.5 if describe_out is None: raise NotThisMethod("'git describe' failed") describe_out = describe_out.strip() - full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + full_out, rc = runner(GITS, ["rev-parse", "HEAD"], cwd=root) if full_out is None: raise NotThisMethod("'git rev-parse' failed") full_out = full_out.strip() - pieces = {} + pieces: Dict[str, Any] = {} pieces["long"] = full_out pieces["short"] = full_out[:7] # maybe improved later pieces["error"] = None + branch_name, rc = runner(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], + cwd=root) + # --abbrev-ref was added in git-1.6.3 + if rc != 0 or branch_name is None: + raise NotThisMethod("'git rev-parse --abbrev-ref' returned error") + branch_name = branch_name.strip() + + if branch_name == "HEAD": + # If we aren't exactly on a branch, pick a branch which represents + # the current commit. If all else fails, we are on a branchless + # commit. + branches, rc = runner(GITS, ["branch", "--contains"], cwd=root) + # --contains was added in git-1.5.4 + if rc != 0 or branches is None: + raise NotThisMethod("'git branch --contains' returned error") + branches = branches.split("\n") + + # Remove the first line if we're running detached + if "(" in branches[0]: + branches.pop(0) + + # Strip off the leading "* " from the list of branches. + branches = [branch[2:] for branch in branches] + if "master" in branches: + branch_name = "master" + elif not branches: + branch_name = None + else: + # Pick the first branch that is returned. Good or bad. + branch_name = branches[0] + + pieces["branch"] = branch_name + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] # TAG might have hyphens. git_describe = describe_out @@ -1080,7 +1387,7 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): # TAG-NUM-gHEX mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) if not mo: - # unparseable. Maybe git-describe is misbehaving? + # unparsable. Maybe git-describe is misbehaving? pieces["error"] = ("unable to parse git-describe output: '%s'" % describe_out) return pieces @@ -1105,19 +1412,20 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): else: # HEX: no tags pieces["closest-tag"] = None - count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) - pieces["distance"] = int(count_out) # total number of commits + out, rc = runner(GITS, ["rev-list", "HEAD", "--left-right"], cwd=root) + pieces["distance"] = len(out.split()) # total number of commits # commit date: see ISO-8601 comment in git_versions_from_keywords() - date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], - cwd=root)[0].strip() + date = runner(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[0].strip() + # Use only the last line. Previous lines may contain GPG signature + # information. + date = date.splitlines()[-1] pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) return pieces -def do_vcs_install(manifest_in, versionfile_source, ipy): +def do_vcs_install(versionfile_source: str, ipy: Optional[str]) -> None: """Git-specific installation logic for Versioneer. For Git, this means creating/changing .gitattributes to mark _version.py @@ -1126,36 +1434,40 @@ def do_vcs_install(manifest_in, versionfile_source, ipy): GITS = ["git"] if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] - files = [manifest_in, versionfile_source] + files = [versionfile_source] if ipy: files.append(ipy) - try: - me = __file__ - if me.endswith(".pyc") or me.endswith(".pyo"): - me = os.path.splitext(me)[0] + ".py" - versioneer_file = os.path.relpath(me) - except NameError: - versioneer_file = "versioneer.py" - files.append(versioneer_file) + if "VERSIONEER_PEP518" not in globals(): + try: + my_path = __file__ + if my_path.endswith((".pyc", ".pyo")): + my_path = os.path.splitext(my_path)[0] + ".py" + versioneer_file = os.path.relpath(my_path) + except NameError: + versioneer_file = "versioneer.py" + files.append(versioneer_file) present = False try: - f = open(".gitattributes", "r") - for line in f.readlines(): - if line.strip().startswith(versionfile_source): - if "export-subst" in line.strip().split()[1:]: - present = True - f.close() - except EnvironmentError: + with open(".gitattributes", "r") as fobj: + for line in fobj: + if line.strip().startswith(versionfile_source): + if "export-subst" in line.strip().split()[1:]: + present = True + break + except OSError: pass if not present: - f = open(".gitattributes", "a+") - f.write("%s export-subst\n" % versionfile_source) - f.close() + with open(".gitattributes", "a+") as fobj: + fobj.write(f"{versionfile_source} export-subst\n") files.append(".gitattributes") run_command(GITS, ["add", "--"] + files) -def versions_from_parentdir(parentdir_prefix, root, verbose): +def versions_from_parentdir( + parentdir_prefix: str, + root: str, + verbose: bool, +) -> Dict[str, Any]: """Try to determine the version from the parent directory name. Source tarballs conventionally unpack into a directory that includes both @@ -1164,15 +1476,14 @@ def versions_from_parentdir(parentdir_prefix, root, verbose): """ rootdirs = [] - for i in range(3): + for _ in range(3): dirname = os.path.basename(root) if dirname.startswith(parentdir_prefix): return {"version": dirname[len(parentdir_prefix):], "full-revisionid": None, "dirty": False, "error": None, "date": None} - else: - rootdirs.append(root) - root = os.path.dirname(root) # up a level + rootdirs.append(root) + root = os.path.dirname(root) # up a level if verbose: print("Tried directories %s but none started with prefix %s" % @@ -1181,7 +1492,7 @@ def versions_from_parentdir(parentdir_prefix, root, verbose): SHORT_VERSION_PY = """ -# This file was generated by 'versioneer.py' (0.18) from +# This file was generated by 'versioneer.py' (0.29) from # revision-control system data, or from the parent directory name of an # unpacked source archive. Distribution tarballs contain a pre-generated copy # of this file. @@ -1198,12 +1509,12 @@ def get_versions(): """ -def versions_from_file(filename): +def versions_from_file(filename: str) -> Dict[str, Any]: """Try to determine the version from _version.py if present.""" try: with open(filename) as f: contents = f.read() - except EnvironmentError: + except OSError: raise NotThisMethod("unable to read _version.py") mo = re.search(r"version_json = '''\n(.*)''' # END VERSION_JSON", contents, re.M | re.S) @@ -1215,9 +1526,8 @@ def versions_from_file(filename): return json.loads(mo.group(1)) -def write_to_version_file(filename, versions): +def write_to_version_file(filename: str, versions: Dict[str, Any]) -> None: """Write the given version number to the given _version.py file.""" - os.unlink(filename) contents = json.dumps(versions, sort_keys=True, indent=1, separators=(",", ": ")) with open(filename, "w") as f: @@ -1226,14 +1536,14 @@ def write_to_version_file(filename, versions): print("set %s to '%s'" % (filename, versions["version"])) -def plus_or_dot(pieces): +def plus_or_dot(pieces: Dict[str, Any]) -> str: """Return a + if we don't already have one, else return a .""" if "+" in pieces.get("closest-tag", ""): return "." return "+" -def render_pep440(pieces): +def render_pep440(pieces: Dict[str, Any]) -> str: """Build up version string, with post-release "local version identifier". Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you @@ -1258,23 +1568,71 @@ def render_pep440(pieces): return rendered -def render_pep440_pre(pieces): - """TAG[.post.devDISTANCE] -- No -dirty. +def render_pep440_branch(pieces: Dict[str, Any]) -> str: + """TAG[[.dev0]+DISTANCE.gHEX[.dirty]] . + + The ".dev0" means not master branch. Note that .dev0 sorts backwards + (a feature branch will appear "older" than the master branch). Exceptions: - 1: no tags. 0.post.devDISTANCE + 1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty] """ if pieces["closest-tag"]: rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0" + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += "+untagged.%d.g%s" % (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def pep440_split_post(ver: str) -> Tuple[str, Optional[int]]: + """Split pep440 version string at the post-release segment. + + Returns the release segments before the post-release and the + post-release version number (or -1 if no post-release segment is present). + """ + vc = str.split(ver, ".post") + return vc[0], int(vc[1] or 0) if len(vc) == 2 else None + + +def render_pep440_pre(pieces: Dict[str, Any]) -> str: + """TAG[.postN.devDISTANCE] -- No -dirty. + + Exceptions: + 1: no tags. 0.post0.devDISTANCE + """ + if pieces["closest-tag"]: if pieces["distance"]: - rendered += ".post.dev%d" % pieces["distance"] + # update the post release segment + tag_version, post_version = pep440_split_post(pieces["closest-tag"]) + rendered = tag_version + if post_version is not None: + rendered += ".post%d.dev%d" % (post_version + 1, pieces["distance"]) + else: + rendered += ".post0.dev%d" % (pieces["distance"]) + else: + # no commits, use the tag as the version + rendered = pieces["closest-tag"] else: # exception #1 - rendered = "0.post.dev%d" % pieces["distance"] + rendered = "0.post0.dev%d" % pieces["distance"] return rendered -def render_pep440_post(pieces): +def render_pep440_post(pieces: Dict[str, Any]) -> str: """TAG[.postDISTANCE[.dev0]+gHEX] . The ".dev0" means dirty. Note that .dev0 sorts backwards @@ -1301,12 +1659,41 @@ def render_pep440_post(pieces): return rendered -def render_pep440_old(pieces): +def render_pep440_post_branch(pieces: Dict[str, Any]) -> str: + """TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] . + + The ".dev0" means not master branch. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%s" % pieces["short"] + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += "+g%s" % pieces["short"] + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def render_pep440_old(pieces: Dict[str, Any]) -> str: """TAG[.postDISTANCE[.dev0]] . The ".dev0" means dirty. - Eexceptions: + Exceptions: 1: no tags. 0.postDISTANCE[.dev0] """ if pieces["closest-tag"]: @@ -1323,7 +1710,7 @@ def render_pep440_old(pieces): return rendered -def render_git_describe(pieces): +def render_git_describe(pieces: Dict[str, Any]) -> str: """TAG[-DISTANCE-gHEX][-dirty]. Like 'git describe --tags --dirty --always'. @@ -1343,7 +1730,7 @@ def render_git_describe(pieces): return rendered -def render_git_describe_long(pieces): +def render_git_describe_long(pieces: Dict[str, Any]) -> str: """TAG-DISTANCE-gHEX[-dirty]. Like 'git describe --tags --dirty --always -long'. @@ -1363,7 +1750,7 @@ def render_git_describe_long(pieces): return rendered -def render(pieces, style): +def render(pieces: Dict[str, Any], style: str) -> Dict[str, Any]: """Render the given version pieces into the requested style.""" if pieces["error"]: return {"version": "unknown", @@ -1377,10 +1764,14 @@ def render(pieces, style): if style == "pep440": rendered = render_pep440(pieces) + elif style == "pep440-branch": + rendered = render_pep440_branch(pieces) elif style == "pep440-pre": rendered = render_pep440_pre(pieces) elif style == "pep440-post": rendered = render_pep440_post(pieces) + elif style == "pep440-post-branch": + rendered = render_pep440_post_branch(pieces) elif style == "pep440-old": rendered = render_pep440_old(pieces) elif style == "git-describe": @@ -1399,7 +1790,7 @@ class VersioneerBadRootError(Exception): """The project root directory is unknown or missing key files.""" -def get_versions(verbose=False): +def get_versions(verbose: bool = False) -> Dict[str, Any]: """Get the project version from whatever source is available. Returns dict with two keys: 'version' and 'full'. @@ -1414,7 +1805,7 @@ def get_versions(verbose=False): assert cfg.VCS is not None, "please set [versioneer]VCS= in setup.cfg" handlers = HANDLERS.get(cfg.VCS) assert handlers, "unrecognized VCS '%s'" % cfg.VCS - verbose = verbose or cfg.verbose + verbose = verbose or bool(cfg.verbose) # `bool()` used to avoid `None` assert cfg.versionfile_source is not None, \ "please set versioneer.versionfile_source" assert cfg.tag_prefix is not None, "please set versioneer.tag_prefix" @@ -1475,13 +1866,17 @@ def get_versions(verbose=False): "date": None} -def get_version(): +def get_version() -> str: """Get the short version string for this project.""" return get_versions()["version"] -def get_cmdclass(): - """Get the custom setuptools/distutils subclasses used by Versioneer.""" +def get_cmdclass(cmdclass: Optional[Dict[str, Any]] = None): + """Get the custom setuptools subclasses used by Versioneer. + + If the package uses a different cmdclass (e.g. one from numpy), it + should be provide as an argument. + """ if "versioneer" in sys.modules: del sys.modules["versioneer"] # this fixes the "python setup.py develop" case (also 'install' and @@ -1495,25 +1890,25 @@ def get_cmdclass(): # parent is protected against the child's "import versioneer". By # removing ourselves from sys.modules here, before the child build # happens, we protect the child from the parent's versioneer too. - # Also see https://github.com/warner/python-versioneer/issues/52 + # Also see https://github.com/python-versioneer/python-versioneer/issues/52 - cmds = {} + cmds = {} if cmdclass is None else cmdclass.copy() - # we add "version" to both distutils and setuptools - from distutils.core import Command + # we add "version" to setuptools + from setuptools import Command class cmd_version(Command): description = "report generated version string" - user_options = [] - boolean_options = [] + user_options: List[Tuple[str, str, str]] = [] + boolean_options: List[str] = [] - def initialize_options(self): + def initialize_options(self) -> None: pass - def finalize_options(self): + def finalize_options(self) -> None: pass - def run(self): + def run(self) -> None: vers = get_versions(verbose=True) print("Version: %s" % vers["version"]) print(" full-revisionid: %s" % vers.get("full-revisionid")) @@ -1523,7 +1918,7 @@ def run(self): print(" error: %s" % vers["error"]) cmds["version"] = cmd_version - # we override "build_py" in both distutils and setuptools + # we override "build_py" in setuptools # # most invocation pathways end up running build_py: # distutils/build -> build_py @@ -1538,18 +1933,25 @@ def run(self): # then does setup.py bdist_wheel, or sometimes setup.py install # setup.py egg_info -> ? + # pip install -e . and setuptool/editable_wheel will invoke build_py + # but the build_py command is not expected to copy any files. + # we override different "build_py" commands for both environments - if "setuptools" in sys.modules: - from setuptools.command.build_py import build_py as _build_py + if 'build_py' in cmds: + _build_py: Any = cmds['build_py'] else: - from distutils.command.build_py import build_py as _build_py + from setuptools.command.build_py import build_py as _build_py class cmd_build_py(_build_py): - def run(self): + def run(self) -> None: root = get_root() cfg = get_config_from_root(root) versions = get_versions() _build_py.run(self) + if getattr(self, "editable_mode", False): + # During editable installs `.py` and data files are + # not copied to build_lib + return # now locate _version.py in the new build/ directory and replace # it with an updated value if cfg.versionfile_build: @@ -1559,33 +1961,40 @@ def run(self): write_to_version_file(target_versionfile, versions) cmds["build_py"] = cmd_build_py - if "setuptools" in sys.modules: - from setuptools.command.build_ext import build_ext as _build_ext + if 'build_ext' in cmds: + _build_ext: Any = cmds['build_ext'] else: - from distutils.command.build_ext import build_ext as _build_ext + from setuptools.command.build_ext import build_ext as _build_ext class cmd_build_ext(_build_ext): - def run(self): + def run(self) -> None: root = get_root() cfg = get_config_from_root(root) versions = get_versions() _build_ext.run(self) if self.inplace: - # build_ext --inplace will only build modules in + # build_ext --inplace will only build extensions in # build/lib<..> dir with no _version.py to write to. # As in place builds will already have a _version.py # in the module dir, we do not need to write one. return # now locate _version.py in the new build/ directory and replace # it with an updated value + if not cfg.versionfile_build: + return target_versionfile = os.path.join(self.build_lib, - cfg.versionfile_source) + cfg.versionfile_build) + if not os.path.exists(target_versionfile): + print(f"Warning: {target_versionfile} does not exist, skipping " + "version update. This can happen if you are running build_ext " + "without first running build_py.") + return print("UPDATING %s" % target_versionfile) write_to_version_file(target_versionfile, versions) cmds["build_ext"] = cmd_build_ext if "cx_Freeze" in sys.modules: # cx_freeze enabled? - from cx_Freeze.dist import build_exe as _build_exe + from cx_Freeze.dist import build_exe as _build_exe # type: ignore # nczeczulin reports that py2exe won't like the pep440-style string # as FILEVERSION, but it can be used for PRODUCTVERSION, e.g. # setup(console=[{ @@ -1594,7 +2003,7 @@ def run(self): # ... class cmd_build_exe(_build_exe): - def run(self): + def run(self) -> None: root = get_root() cfg = get_config_from_root(root) versions = get_versions() @@ -1618,12 +2027,12 @@ def run(self): if 'py2exe' in sys.modules: # py2exe enabled? try: - from py2exe.distutils_buildexe import py2exe as _py2exe # py3 + from py2exe.setuptools_buildexe import py2exe as _py2exe # type: ignore except ImportError: - from py2exe.build_exe import py2exe as _py2exe # py2 + from py2exe.distutils_buildexe import py2exe as _py2exe # type: ignore class cmd_py2exe(_py2exe): - def run(self): + def run(self) -> None: root = get_root() cfg = get_config_from_root(root) versions = get_versions() @@ -1644,14 +2053,51 @@ def run(self): }) cmds["py2exe"] = cmd_py2exe + # sdist farms its file list building out to egg_info + if 'egg_info' in cmds: + _egg_info: Any = cmds['egg_info'] + else: + from setuptools.command.egg_info import egg_info as _egg_info + + class cmd_egg_info(_egg_info): + def find_sources(self) -> None: + # egg_info.find_sources builds the manifest list and writes it + # in one shot + super().find_sources() + + # Modify the filelist and normalize it + root = get_root() + cfg = get_config_from_root(root) + self.filelist.append('versioneer.py') + if cfg.versionfile_source: + # There are rare cases where versionfile_source might not be + # included by default, so we must be explicit + self.filelist.append(cfg.versionfile_source) + self.filelist.sort() + self.filelist.remove_duplicates() + + # The write method is hidden in the manifest_maker instance that + # generated the filelist and was thrown away + # We will instead replicate their final normalization (to unicode, + # and POSIX-style paths) + from setuptools import unicode_utils + normalized = [unicode_utils.filesys_decode(f).replace(os.sep, '/') + for f in self.filelist.files] + + manifest_filename = os.path.join(self.egg_info, 'SOURCES.txt') + with open(manifest_filename, 'w') as fobj: + fobj.write('\n'.join(normalized)) + + cmds['egg_info'] = cmd_egg_info + # we override different "sdist" commands for both environments - if "setuptools" in sys.modules: - from setuptools.command.sdist import sdist as _sdist + if 'sdist' in cmds: + _sdist: Any = cmds['sdist'] else: - from distutils.command.sdist import sdist as _sdist + from setuptools.command.sdist import sdist as _sdist class cmd_sdist(_sdist): - def run(self): + def run(self) -> None: versions = get_versions() self._versioneer_generated_versions = versions # unless we update this, the command will keep using the old @@ -1659,7 +2105,7 @@ def run(self): self.distribution.metadata.version = versions["version"] return _sdist.run(self) - def make_release_tree(self, base_dir, files): + def make_release_tree(self, base_dir: str, files: List[str]) -> None: root = get_root() cfg = get_config_from_root(root) _sdist.make_release_tree(self, base_dir, files) @@ -1712,21 +2158,26 @@ def make_release_tree(self, base_dir, files): """ -INIT_PY_SNIPPET = """ +OLD_SNIPPET = """ from ._version import get_versions __version__ = get_versions()['version'] del get_versions """ +INIT_PY_SNIPPET = """ +from . import {0} +__version__ = {0}.get_versions()['version'] +""" -def do_setup(): - """Main VCS-independent setup function for installing Versioneer.""" + +def do_setup() -> int: + """Do main VCS-independent setup function for installing Versioneer.""" root = get_root() try: cfg = get_config_from_root(root) - except (EnvironmentError, configparser.NoSectionError, + except (OSError, configparser.NoSectionError, configparser.NoOptionError) as e: - if isinstance(e, (EnvironmentError, configparser.NoSectionError)): + if isinstance(e, (OSError, configparser.NoSectionError)): print("Adding sample versioneer config to setup.cfg", file=sys.stderr) with open(os.path.join(root, "setup.cfg"), "a") as f: @@ -1746,62 +2197,37 @@ def do_setup(): ipy = os.path.join(os.path.dirname(cfg.versionfile_source), "__init__.py") + maybe_ipy: Optional[str] = ipy if os.path.exists(ipy): try: with open(ipy, "r") as f: old = f.read() - except EnvironmentError: + except OSError: old = "" - if INIT_PY_SNIPPET not in old: + module = os.path.splitext(os.path.basename(cfg.versionfile_source))[0] + snippet = INIT_PY_SNIPPET.format(module) + if OLD_SNIPPET in old: + print(" replacing boilerplate in %s" % ipy) + with open(ipy, "w") as f: + f.write(old.replace(OLD_SNIPPET, snippet)) + elif snippet not in old: print(" appending to %s" % ipy) with open(ipy, "a") as f: - f.write(INIT_PY_SNIPPET) + f.write(snippet) else: print(" %s unmodified" % ipy) else: print(" %s doesn't exist, ok" % ipy) - ipy = None - - # Make sure both the top-level "versioneer.py" and versionfile_source - # (PKG/_version.py, used by runtime code) are in MANIFEST.in, so - # they'll be copied into source distributions. Pip won't be able to - # install the package without this. - manifest_in = os.path.join(root, "MANIFEST.in") - simple_includes = set() - try: - with open(manifest_in, "r") as f: - for line in f: - if line.startswith("include "): - for include in line.split()[1:]: - simple_includes.add(include) - except EnvironmentError: - pass - # That doesn't cover everything MANIFEST.in can do - # (http://docs.python.org/2/distutils/sourcedist.html#commands), so - # it might give some false negatives. Appending redundant 'include' - # lines is safe, though. - if "versioneer.py" not in simple_includes: - print(" appending 'versioneer.py' to MANIFEST.in") - with open(manifest_in, "a") as f: - f.write("include versioneer.py\n") - else: - print(" 'versioneer.py' already in MANIFEST.in") - if cfg.versionfile_source not in simple_includes: - print(" appending versionfile_source ('%s') to MANIFEST.in" % - cfg.versionfile_source) - with open(manifest_in, "a") as f: - f.write("include %s\n" % cfg.versionfile_source) - else: - print(" versionfile_source already in MANIFEST.in") + maybe_ipy = None # Make VCS-specific changes. For git, this means creating/changing # .gitattributes to mark _version.py for export-subst keyword # substitution. - do_vcs_install(manifest_in, cfg.versionfile_source, ipy) + do_vcs_install(cfg.versionfile_source, maybe_ipy) return 0 -def scan_setup_py(): +def scan_setup_py() -> int: """Validate the contents of setup.py against Versioneer's expectations.""" found = set() setters = False @@ -1838,10 +2264,14 @@ def scan_setup_py(): return errors +def setup_command() -> NoReturn: + """Set up Versioneer and exit with appropriate error code.""" + errors = do_setup() + errors += scan_setup_py() + sys.exit(1 if errors else 0) + + if __name__ == "__main__": cmd = sys.argv[1] if cmd == "setup": - errors = do_setup() - errors += scan_setup_py() - if errors: - sys.exit(1) + setup_command()