Repository navigation
Conversation
Pepper gives SALTAPI_* environment variables precedence over the config file, and the test suite never cleared them, despite the pepper_cli fixture claiming to run "inside an empty env". A developer with SALTAPI_URL, SALTAPI_USER or SALTAPI_EAUTH exported would have every CLI test log in to that salt-api with the test credentials instead of the salt-api started by the suite, and unit tests such as test_interactive_logins fail. Add an autouse fixture that removes SALTAPI_*, PEPPER* and MASTER_CONFIG from the environment for every test.
The imp module was removed in Python 3.12, so collecting tests/unit/test_init.py fails there. Load the fresh copy of pepper/__init__.py with importlib.util instead. The version is read from the installed package metadata rather than setup.py, so stop renaming setup.py during the test (which left the checkout broken if the test was interrupted), compare against importlib.metadata instead of setuptools_scm, and cover the not-installed fallback explicitly.
- importlib-metadata<5.0.0 cannot be co-installed with current Salt releases and pepper uses the standard library importlib.metadata. - The cryptography and pyzmq pins conflict with what Salt itself requires (cryptography>=48 for 3006.30 on Python 3.10+); let Salt choose them. - mock and setuptools_scm are no longer used by the test suite. - Bump pytest-salt-factories to 1.0.5.
[os.environ.get("X")] or [...] is always a one element list, so without
API_BACKEND and PYTHON_VERSIONS set the tests session ran with
python=None and --salt-api-backend=rest_None. Split the environment
values and fall back to the full lists when they are unset, moving the
default Python versions to 3.10-3.13.
Also make pip quiet outside CI as the comment intends (CI_RUN is a
string or None, never False) and replace the coverage 5.5 pin, which
predates Python 3.12 support.
Test Python 3.10 through 3.13 against the current Salt releases (3006.30, 3007.17, 3008.5) and master, dropping Python 3.8 and 3.9, which are end of life. Pin actions/checkout and actions/setup-python to the same commit SHAs the Salt repository uses and restrict the workflow token to read-only contents access.
CI runs on GitHub Actions. The Travis and Azure Pipelines definitions target Python 2.7 to 3.8 and Salt 2018.3/2019.2, the Makefile drives the removed tox setup, and nothing uploads coverage to Codecov any more. azure-pipelines.yml also contained a Codecov upload token. Replace the Travis and Codecov badges in the README with the GitHub Actions status badge.
The test minion never completes authentication with the master for Salt 3006 on Python 3.12 and 3.13, or Salt 3007 on Python 3.13, so every test that needs a minion errors during setup. Salt 3007 on Python 3.12 usually passes, but in 7 of 50 recent CI jobs the minion failed to start, stopped answering, or took about a minute per call. Five of those jobs failed and the slowest ran for 81 minutes, against 2 to 7 minutes normally, so exclude it as well. Salt 3006 and 3007 declare support up to Python 3.10; both pass on 3.11, so keep those.
On Salt 3008 the netapi ssh client authorizes the request itself and looks the token up in salt.cache, which does not find the token minted through /login or /token, so salt-api answers 401 for both the session and /run paths. Every other client still passes on 3008. Mark the test xfail (non-strict) until the cause is understood instead of letting it hold the rest of the matrix red.
A job normally finishes in 2 to 7 minutes. When the test minion hangs, the job otherwise runs until GitHub's 6 hour limit and holds a runner the whole time.
This was referenced Nov 5, 2026
test_token wrote a real ~/.peppercache, and a developer's ~/.pepperrc could leak into the tests. Point HOME (and USERPROFILE) at an empty directory for every test.
Use the same hook versions and arguments as Salt's master branch: pyupgrade --py310-plus, isort and black at Salt's settings instead of reorder-python-imports and black -l 100, bandit, yamllint and pylint with saltpylint using a copy of Salt's .pylintrc. The saltpylint blacklist plugin is not loaded. It requires Salt's own helpers (salt.utils.files.fopen, tests.support.mock), and pepper does not depend on salt. pylint replaces flake8, so the flake8 workflow and nox session are removed and the pre-commit job in the test workflow is the only lint step.
No functional changes. This is the output of the pre-commit formatting hooks added in the previous commit.
Drop the urllib2, ConfigParser, raw_input and logging.NullHandler fallbacks. The JSONDecodeError fallback looked up json.decode, which does not exist, so it always fell back to ValueError; import json.JSONDecodeError instead.
- Remove unreachable return statements after raise in req_get and req_stream. - Format the 'Cannot open file' message instead of passing the file name as a second exception argument, which printed a tuple. - Set the umask before the try block in login() so the finally clause cannot reference an unset variable. - Open text files as UTF-8 instead of the locale encoding. - Mark the intentional catch-all handlers and the optparse import. The broad handlers around the token cache and the global SSL context are left in place; later changes replace that code.
Use the same towncrier configuration and template as Salt, with fragments named changelog/<issue>.<type>.md. Document the pre-commit hooks, changelog fragments and the develop branch in the README; the master branch it mentioned no longer exists.
Replace setup.py, setup_requires and MANIFEST.in with PEP 621 metadata built by setuptools and setuptools-scm. Declare requires-python >= 3.10, drop the Python 2 and Cython classifiers, and add requests as an extra for req_get(), req_stream() and kerberos logins. Install pepper as a console_scripts entry point instead of shipping scripts/pepper and scripts/pepper.cmd, so pip creates pepper.exe on Windows, and add python -m pepper. black reads the Python 3.10 floor from requires-python and now uses parenthesized context managers in two tests.
Replace the Python 2.5+ claim and the archived salt-api link, describe the extras and the pepper command, and note that cmd.exe passes single quotes through literally.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Depends on #623; only the last 3 commits are new here.
setup.py,setup_requiresandMANIFEST.inwith PEP 621 metadata built by setuptools and setuptools-scm. Declarerequires-python >= 3.10and drop the Python 2 and Cython classifiers. On Python 3.9 (EL9, Debian 11)pip install salt-pepperwill keep installing 0.7.6; that is deliberate, since 3.9 is past end of life and the test matrix starts at 3.10.requestsoptional, as discussed in Modernize packaging #200: onlyreq_get(),req_stream()and kerberos logins use it. It is available as therequestsextra, next tokerberos.pepperas aconsole_scriptsentry point instead ofscripts/pepperandscripts/pepper.cmd, so pip createspepper.exeon Windows, and addpython -m pepper(its help names the programpepper).peppercommand, and a note thatcmd.exepasses single quotes through literally (pepper.cmd wrapper not included in pip package #212).What issues does this PR fix or reference?
Fixes #200
Fixes #212
Previous Behavior
pip install salt-pepperon Windows did not installpepper.cmd, the package declared no Python version, and the README said Python 2.5+.New Behavior
The sdist and wheel build from
pyproject.toml; the wheel installs apeppercommand on every platform.Fork CI: https://github.com/ggiesen/pepper/actions/runs/42174290850
Merge requirements satisfied?
Commits signed with GPG?
No