PYTEST-POP
A pytest plugin to help with testing pop projects
INSTALLATION
Install with pip:
pip install pytest-pop
DEVELOPMENT INSTALLATION
Clone the pytest-pop repo and install with pip:
git clone https://gitlab.com/saltstack/pop/pytest-pop.git pip install -e pytest-pop
Getting the Hub
Extend the hub fixture in your conftest.py so that it includes your subs:
@pytest.fixture(scope="function")
def hub(hub):
# TODO Add dynes that will be used for your tests
for dyne in ("exec", "states"):
hub.pop.sub.add(dyne_name=dyne)
if dyne in ("corn", "exec", "states"):
hub.pop.sub.load_subdirs(getattr(hub, dyne), recurse=True)
args = [
# TODO patch in whatever cli args are necessary to run your test
]
with mock.patch("sys.argv", ["pytest-pop"] + args):
hub.pop.config.load(["pytest_pop"], "pytest_pop")
yield hub
# TODO Hub cleanup
pass
Markers
Make use of pytest markers from pytest-salt-factoroies
root
Marks a test as needing elevated privileges. On UNIX-like systems the test will be skipped if the user running the tests is not root. On Windows systems the test will be skipped if the tests aren’t run with admin privileges.
Example:
@pytest.mark.skip_if_not_root
def test_root(hub):
pass
expensive
Marks a test as being expensive. Run pytest with the ‘–run-expensive’ flag or set the EXPENSIVE_TESTS environment variable to “True” to run these tests. By default they will be skipped
Example:
@pytest.mark.expensive_test
def test_expensive(hub):
pass
destructive
Marks a test as being destructive. Run pytest with the ‘–run-destructive’ flag or set the DESTRUCTIVE_TESTS environment variable to “True” to run these tests. By default they will be skipped
Example:
@pytest.mark.destructive_test
def test_destructive(hub):
pass
Logging
You can use the hub to log without setting up a logger in every single file that uses a hub
Example:
hub.log.debug("debug message")
Be sure to run pytest with ‘–cli-log-level=10’ in order to see debug messages
Mocking
Get access to a fully mocked/autospecced version of the hub with:
mock_hub = hub.pop.testing.mock_hub()
A mock_hub fixture with common substitutions of real plugins is available as a fixture:
def test_thing(mock_hub):
pass
Extend the mock hub in your own fixture:
# Scope the mock_hub to a function so that the autospec gets reset after each use.
@pytest.fixture(scope="function")
def mock_hub(mock_hub, hub):
# replace mocked functions with necessary real ones
# extend this on a per-module or per-function basis if necessary
mock_hub.sub.func = hub.sub.func
yield mock_hub
You can now do autospec assertions on contracted functions:
import project.sub.plugin as plugin
def test_cmd_run(mock_hub):
plugin.func(mock_hub, "arg")
mock_hub.sub.plugin.func.assert_called_with("arg")
ACCT
Some projects, specifically idem-cloud need credentials from idem’s ctx generator. A ctx fixture exists, but it won’t work unless you override the acct_file and acct_profile fixtures:
@pytest.fixture
def acct_subs() -> List[str]:
return ["azurerm", "vultr"]
@pytest.fixture
def acct_profile() -> str:
return "test_development_idem_cloud"
Once these fixtures are overridden, the ctx fixture will become available to your test:
test_cloud_instance_present(hub, ctx):
hub.state.cloud.present(ctx, "instance_name")
Release files for pytest-pop 5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| pytest-pop-5.tar.gz | 9.4 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pytest_pop-5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 14.8 kB
Release files / pytest-pop-5.tar.gz
| Download URL | pytest-pop-5.tar.gz |
|---|---|
| Size | 9.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f3e4a50b2b6c8dfd8d597d752710c2fee5d9280d27b9bbbf698a1cd0f4193e0e
|
|
BLAKE2b-256 checksum How to use checksums |
b2234d21c92274380b4937c6839d5361c9a795dc16e4e346df129d38dcfc99fb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2
|
Release files / pytest_pop-5-py3-none-any.whl
| Download URL | pytest_pop-5-py3-none-any.whl |
|---|---|
| Size | 5.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4d6b4d13b1c8c3995fd28ec1f4d6684e342852f776e98a34ebf6af04763697d9
|
|
BLAKE2b-256 checksum How to use checksums |
45799b9f82d9bd4fc483205317ed87baac77031445685da06b4129c5228e2551
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2
|
Security for pytest-pop 5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
