Skip to main content

Library

Project description

Regress

codecov Documentation Status Maintainability

Early draft for regression testing framework in Python 3.4+. Regression testing is useful in unit and module testing when rewriting test data creating is too boring. After you canonized the ideal output result all tests will pass until the data changes moment.

  • Writes data to the local filesystem storage
  • Supports text, json and picklable objects
  • Have different policies for running and resolving test conflicts

Currently integrates best with the PyTest, but other frameworks are also welcomed.

Example

One pytest function is the scope of the result. Newly calculated data compares with the original saved result.

# regress is the function scope helper fixture easy to setup
def test_simple(regress: RegressFixture):
    result = {'a': 1}
    regress.test(result)  # Commit first time

    result2 = {'a': 1}
    regress.test(result2)  # Ok. No object result changes

    result3 = {'a': 3}  # Try commit change. Raised the AssertionError
    with pytest.raises(AssertionError) as e:
        regress.test(result3)

To continue exploring you can visit the quickstart.

Using

pip3 install regress

Documentation

https://regress.readthedocs.io/

Development

Making virtualenv with development requirements:

python3 -m venv venv
venv/bin/pip install --upgrade pip
venv/bin/pip install -r requirements.txt

Testing

venv/bin/pytest -s tests
venv/bin/flake8 regress --show-source --statistics
venv/bin/pytest --cov=regress --cov-report html

Building docs

Using sphinx:

cd docs
make

Further plans

  • Canonization tool with merging tests renames
  • Remote canonization data storages for not storing data in the repository
  • Support for other Python test frameworks

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

regress-0.0.3.tar.gz (7.7 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page