Skip to main content

Performs extra checks before or after running

Project description

tox-extra

This tox plugin adds a few extra checks like:

Checks Git Dirty Status

It ensures exit code 1 if git reports dirty or untracked files after the run.

Usage example:

$ tox -e py
...
ERROR: Git reported dirty status. Git should never report dirty status at the end of testing, regardless if status is passed, failed or aborted.
On branch devel
Your branch is up to date with 'origin/devel'.

Untracked files:
  (use "git add <file>..." to include in what will be committed)
	some-untracked.txt

nothing added to commit but untracked files present (use "git add" to track)
__________________________________________ summary ___________________________________________
ERROR:   py: failed

The goal of this plugin is to help developers be aware of files modified by tests or untracked files before they commit the code. This plugin also does not take into consideration the global .gitignore, something that can make git miss reporting some untracked files, the goal being to assure that when a new developer clones and runs the tests they do not endup with an unexpected git status.

If you have any cases where you expect to have git report dirty, please add --allow-dirty to the command call to disable this check.

Checks system dependencies using bindep

If a bindep.txt config file is found, tox will run bindep [profiles] to check if dependencies, including test ones, are present. There is no need to install bindep your self.

This plugin will add the following list of bindep profiles:

  • test is always added as tox itself is a test tool
  • exact tox env name
  • tox env name itself split by `-'
  • pythonX.Y and pyXY based on which python current tox env will use

This should allow developers to modify their bindep.txt file to include system dependencies specific to a single tox environment if they wish.

To disable bindep feature, you can define TOX_EXTRA_BINDEP=0 in your environment.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tox_extra-2.1.0.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

tox_extra-2.1.0-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file tox_extra-2.1.0.tar.gz.

File metadata

  • Download URL: tox_extra-2.1.0.tar.gz
  • Upload date:
  • Size: 15.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for tox_extra-2.1.0.tar.gz
Algorithm Hash digest
SHA256 4ff0589cada2a0ca672c4598fd42691605f801358d5e508c2d07d27f9800de29
MD5 e3be750784ca7437f0ec8af28a0f5239
BLAKE2b-256 bc48f41983e7f6fd2163c5abc21b82e33f497d7e138cb52cfa1dd2fb1095a6ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for tox_extra-2.1.0.tar.gz:

Publisher: tox.yml on tox-dev/tox-extra

Attestations:

File details

Details for the file tox_extra-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: tox_extra-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for tox_extra-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 151905212cc2258923901607a7d693b8aa4c45cb33616808c68cc8aff9f6734f
MD5 e3838e5629b72ee92a72c328f2a0fb08
BLAKE2b-256 28d486554b25ef5ec620c8e0d6ca7d7872b854f09f522818567da4532305f549

See more details on using hashes here.

Provenance

The following attestation bundles were made for tox_extra-2.1.0-py3-none-any.whl:

Publisher: tox.yml on tox-dev/tox-extra

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page