pytest-shell-utilities

v1.9.7

Pytest plugin to simplify running shell commands against the system For more information about how to use this package see README

Latest version published 1 month ago

License: Apache-2.0

PyPI

GitHub

Package Health Score

78 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Sustainable

Popularity

Small

GitHub Stars: 15
Forks: 9
Contributors: 4

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package pytest-shell-utilities, we found that it has been starred 15 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Oct 22, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like pytest-shell-utilities is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 1 month ago
Last Commit: 1 month ago

Further analysis of the maintenance status of pytest-shell-utilities based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that pytest-shell-utilities demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 4
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.8

Age: 3 years
Latest Release: 1 month ago
Dependencies: 2 Direct
Versions: 27
Maintainers: 3
Wheels: OS Independent

Readme

PyPI - License

What is Pytest Shell Utilities

"When in doubt, shell out"

-- Thomas S. Hatch

This pytest plugin was extracted from pytest-salt-factories. If provides a basic fixture shell which basically uses subprocess.Popen to run commands against the running system on a shell while providing a nice assert'able return class.

Install

Installing pytest-shell-utilities is as simple as:

python -m pip install pytest-shell-utilities

And, that's honestly it.

Usage

Once installed, you can now use the shell fixture to run some commands and assert against the outcome.

def test_assert_good_exitcode(shell):

    ret = shell.run("exit", "0")
    assert ret.returncode == 0


def test_assert_bad_exitcode(shell):

    ret = shell.run("exit", "1")
    assert ret.returncode == 1

If the command outputs parseable JSON, the shell fixture can attempt loading that output as JSON which allows for asserting against the JSON loaded object.

def test_against_json_output(shell):
    d = {"a": "a", "b": "b"}
    ret = shell.run("echo", json.dumps(d))
    assert ret.data == d

Additionally, the return object's .stdout and .stderr can be line matched using pytest.pytester.LineMatcher:

MARY_HAD_A_LITTLE_LAMB = """\
Mary had a little lamb,
Its fleece was white as snow;
And everywhere that Mary went
The lamb was sure to go.
"""


def test_matcher_attribute(shell):
    ret = shell.run("echo", MARY_HAD_A_LITTLE_LAMB)
    ret.stdout.matcher.fnmatch_lines_random(
        [
            "*had a little*",
            "Its fleece was white*",
            "*Mary went",
            "The lamb was sure to go.",
        ]
    )

Documentation

The full documentation can be seen here.

pytest-shell-utilities dependencies

pytest-helpers-namespace pytest-skip-markers

FAQs

What is pytest-shell-utilities?

Pytest plugin to simplify running shell commands against the system. Visit Snyk Advisor to see a full health score report for pytest-shell-utilities, including popularity, security, maintenance & community analysis.

Is pytest-shell-utilities popular?

The python package pytest-shell-utilities receives a total of 6,983 weekly downloads. As such, pytest-shell-utilities popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is pytest-shell-utilities well maintained?

We found that pytest-shell-utilities demonstrated a healthy version release cadence and project activity. It has a community of 4 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is pytest-shell-utilities safe to use?

The python package pytest-shell-utilities was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 24 November-2024, at 04:34 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP