Allow bucketing of test items by their direct parent or grand-parent (#27)

* Closes #26 - allow limiting randomisation with custom test collections where items don't have module
* Missing dep for Python 2.6

Author: jbasko

docs/index.rst

@@ -50,7 +50,7 @@ Design
 
 pytest-random-order plugin groups tests in buckets, shuffles them within buckets and then shuffles the buckets.
 
-You can choose from four types of buckets:
+You can choose from a few types of buckets:
 
 class
     Tests will be shuffled within a class and classes will be shuffled,
@@ -64,12 +64,21 @@ package
     belong to package ``x.y.z`` do not belong to package ``x.y``, so they will fall in different buckets
     when randomising with ``package`` bucket type.
 
+parent
+    If you are using custom test items which don't belong to any module, you can use this to
+    limit reordering of test items to within the ``parent`` to which they belong. For normal test
+    functions the parent is the module in which they are declared.
+
+grandparent
+    Similar to *parent* above, but use the parent of the parent of the test item as the bucket key instead.
+
 global
     All tests fall in the same bucket, full randomness, tests probably take longer to run.
 
 none
     Disable shuffling.
 
+
 If you have three buckets of tests ``A``, ``B``, and ``C`` with three tests ``1`` and ``2``, and ``3`` in each of them,
 then one of many potential orderings that non-global randomisation can produce could be:
 

pytest_random_order/plugin.py

@@ -12,7 +12,7 @@ def pytest_addoption(parser):
         action='store',
         dest='random_order_bucket',
         default='module',
-        choices=('global', 'package', 'module', 'class', 'none'),
+        choices=('global', 'package', 'module', 'class', 'parent', 'grandparent', 'none'),
         help='Limit reordering of test items across units of code',
     )
     group.addoption(
@@ -72,4 +72,6 @@ def pytest_collection_modifyitems(session, config, items):
     'package': lambda x: x.module.__package__,
     'module': lambda x: x.module.__name__,
     'class': lambda x: (x.module.__name__, x.cls.__name__) if x.cls else x.module.__name__,
+    'parent': lambda x: x.parent,
+    'grandparent': lambda x: x.parent.parent,
 }

setup.py

@@ -13,7 +13,7 @@ def read(fname):
 
 setup(
     name='pytest-random-order',
-    version='0.6.0',
+    version='0.7.0',
     author='Jazeps Basko',
     author_email='[email protected]',
     maintainer='Jazeps Basko',

tests/test_actual_test_runs.py

@@ -142,6 +142,8 @@ def inspect_attr(this_call, prev_call, attr_name):
     ('package', 2, 5),
     ('global', 2, 5),
     ('none', 1, 1),
+    ('parent', 1, 5),
+    ('grandparent', 1, 5),
 ])
 def test_it_works_with_actual_tests(tmp_tree_of_tests, get_test_calls, bucket, min_sequences, max_sequences):
     sequences = set()

tests/test_cli.py

@@ -4,7 +4,7 @@ def test_help_message(testdir):
     )
     result.stdout.fnmatch_lines([
         'random-order:',
-        '*--random-order-bucket={global,package,module,class,none}*',
+        '*--random-order-bucket={global,package,module,class,parent,grandparent,none}*',
         '*--random-order-seed=*',
     ])
 

tox.ini

@@ -13,6 +13,7 @@ deps =
     pytest
     pytest-xdist
     ordereddict
+    pytest-xdist
 
 [testenv:flake8]
 skip_install = true