Skip to content

[IMP] src/testing: improve docs #341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[IMP] src/testing: improve docs #341

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 17 additions & 12 deletions src/testing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,16 +150,22 @@ def parametrize(argvalues):
Parametrize a test function.

Decorator for upgrade test functions to parametrize and generate multiple tests from
it.
it. The new test functions are injected in the containing class. Inspired by the
`parameterized <https://pypi.org/project/parameterized/>`_ package.

Usage::
.. example::

.. code-block:: python

@parametrize([(1, 2), (2, 4), (-1, -2), (0, 0)])
def test_double(self, input, expected):
self.assertEqual(input * 2, expected)
@parametrize([(1, 2), (2, 4), (-1, -2), (0, 0)])
def test_double(self, input, expected):
self.assertEqual(input * 2, expected)

Works by injecting test functions in the containing class.
Inspired by the `parameterized <https://pypi.org/project/parameterized/>`_ package.
This will generate four test methods: ``test_double__0``, ``test_double__1``,
``test_double__2``, and ``test_double__3``, each with different argument values.

:param list(tuple) argvalues: Arguments for each test case. Each tuple will be
unpacked and passed as arguments to the test function.
"""

def make_func(func, name, args):
Expand Down Expand Up @@ -521,7 +527,7 @@ def get_previous_major(major, minor):
# pylint: disable=inherit-non-class
class UpgradeCase(UpgradeCommon, _create_meta(10, "upgrade_case")):
"""
Test case to verify that the upgrade scripts correctly upgrade data.
Test case to verify the upgrade flow.

Override:

Expand Down Expand Up @@ -572,16 +578,15 @@ def test_prepare(self):
# pylint: disable=inherit-non-class
class IntegrityCase(UpgradeCommon, _create_meta(20, "integrity_case")):
"""
Test case for validating invariants across upgrades.
Test case for validating upgrade invariants.

Override:

* ``invariant`` to return a JSON-serializable value representing
the invariant to check.

The ``invariant`` method is called both before and after the upgrade,
and the results are compared.

The ``invariant`` method is called both before and after the upgrade, and the results
are compared. If there is any difference the test fails.

.. example::

Expand Down