skippy-cov 0.2.0

Selectively run tests based on the current git diff and the collected data from previous tests runs

skippy-cov

Overview

skippy-cov is a tool that optimizes your Python testing workflow by filtering tests based on code changes. It takes a diff file from git and a .coverage database (generated by coverage.py) to identify and run only the tests relevant to the modified code. This significantly reduces testing time and resources.

Usage

To use this, you first need to generate the following required files:

• Run Coverage Analysis: Generate a .coverage database using coverage.py.

    coverage run -m pytest

You can provide the diff to skippy-cov in two ways:

• Option 1: Use a Git Branch or Ref You can specify a branch or ref to diff against (e.g., the main branch):

      skippy-cov --diff main --coverage-file .coverage
  

• Option 2: Use a Diff File Generate a diff file using Git:

      git diff > changes.diff
  

  Then run:

      skippy-cov --diff changes.diff --coverage-file .coverage
  

• Option 1: Use a Git Branch or Ref
  You can specify a branch or ref to diff against (e.g., the main branch):

      skippy-cov --diff main --coverage-file .coverage
  

  If you omit the --diff argument, it will default to the main branch as determined by your git remote (usually "main" or "master"):

      skippy-cov --coverage-file .coverage
  

But it can also be used as a pytest plugin:

    pytest --skippy-cov --skippy-cov-diff changes.diff --skippy-cov-coverage-file .coverage

which would be the equivalent of doing this:

    pytest $(skippy-cov --diff changes.diff --coverage-file .coverage)

Configuration

skippy-cov can be configured using command-line arguments. See skippy-cov --help for more information.

Diff Argument

• --diff: Path to a diff file, or a git branch/ref to diff against.
  • If the argument is a path to an existing file, its contents are used as the diff.
  • Otherwise, it is passed to git diff <arg> and the output is used.
  • If omitted, defaults to the main branch as determined by git remote show origin.

Example usages:

• skippy-cov --diff changes.diff --coverage-file .coverage
• skippy-cov --diff main --coverage-file .coverage
• skippy-cov --coverage-file .coverage (defaults to main branch)

Contributing

See CONTRIBUTING.md for information on how to contribute to the project.

License

See LICENSE for licensing information.