coverage-sh 0.3.0

A Coverage.py plugin to measure code coverage of shell scripts from python.

Coverage.sh

A Coverage.py plugin to measure code coverage of shell (sh or bash) scripts executed from python.

Installation

pip install coverage-sh

Usage

In your pyproject.toml, set

[tool.coverage.run]
plugins = ["coverage_sh"]

and run

coverage run main.py
coverage combine
coverage html

to measure coverage of all shell scripts executed via the subprocess module, e.g.:

subprocess.run(["bash", "test.sh"])

The resulting coverage is then displayed alongside the coverage of the python files:

Caveats

The plugin works by patching the subprocess.Popen class to set the "ENV" and "BASH_ENV" environment variables before execution to source a helper script which enables tracing. This approach comes with a few caveats:

• It will only cover shell scripts that are executed via the subprocess module.
• Only bash and sh are supported
• Depending on the shell scripts, their trace files may become very large.

License

Licensed under the MIT License.