pytest-super-check 2.0.0

Pytest plugin to check your TestCase classes call super in setUp, tearDown, etc.

Pytest plugin to check your TestCase classes call super in setUp, tearDown, etc.

Features

This plugin checks all TestCase classes in your test suite to ensure that their setUp, tearDown, setUpClass, tearDownClass, and setUpTestData (Django extension) methods all call super(). You might care about this when you have extensions to these methods in your project specific base class that when skipped (by accidentally missing super()), cause subtle bugs.

About

I developed this feature in a closed source Nose plugin whilst working on the big Django project at YPlan. We had some custom enhancements and fixes on top of the Django test classes, but some TestCase classes didn’t call super() in e.g. setUp, which caused the tests to fail, or incorrectly pass, in rather subtle ways. This problem is exacerbated by Django’s setUp etc. doing magic around not requiring super() to be called. Our solution was to just ensure every TestCase always calls super() in those methods. This is a Pytest port of that plugin.

Usage

Install from pip with:

pip install pytest-super-check

Python 3.4+ supported.

Pytest will automatically find and use the plugin. Test discovery will then blow up if any subclasses of unittest.TestCase are found that have setUp etc. methods that don’t call super().

You can disable the plugin by passing the options -p no:super_check to pytest.

Caveats

On Python 2, you’ll need to ensure any decorators you use on your setUp etc. methods set __wrapped__, to allow decorator-unwrapping so the inner source can be inspected. This is the default behaviour of functools.wraps on Python 3 so you’ll be more forwards compatible anyway.

History

Pending Release

2.0.0 (2019-02-28)

• Drop Python 2 support, only Python 3.4+ is supported now.

1.0.0 (2016-04-22)

• First release on PyPI