Remove registering unneeded marks

- also remove support for orderXX marks - only order mark supported
- fix handling of unsupported order attribute
- add information about the difference to pytest-ordering

Author: mrbean-bremen

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+### Fixes
+- fixes the handling of unknown marker attributes (test had been skipped)  
+
 ## [Version 0.7.1](https://pypi.org/project/pytest-order/0.7.1/)
 Update after renaming the repository and the package.
 

README.md

@@ -1,5 +1,5 @@
-pytest-order [![PyPI version](https://badge.fury.io/py/pytest-order.svg)](https://badge.fury.io/py/pytest-order)
-================
+pytest-order [![PyPI version](https://badge.fury.io/py/pytest-order.svg)](https://badge.fury.io/py/pytest-order) [![Build Status](https://travis-ci.org/mrbean-bremen/pytest-order.svg?branch=master)](https://travis-ci.org/mrbean-bremen/pytest-order) [![Python version](https://img.shields.io/pypi/pyversions/pytest-order.svg)](https://img.shields.io/pypi/pyversions/pytest-order.svg)
+============
 This is a fork of [pytest-ordering](https://github.com/ftobia/pytest-ordering).
 That project is not maintained anymore, and there are several helpful PRs
 waiting for merge. Therefore I decided to create this fork that tries to
@@ -9,14 +9,14 @@ organization as outlined in
 [this issue](https://github.com/ftobia/pytest-ordering/issues/32). When this
 happens, this fork will be obsolete. 
 
-_Note:_ ``pytest-order`` is not compatible to ``pytest-ordering`` due to the
-changed marker name (``order`` instead of ``run``). 
+_Note:_ ``pytest-order`` is not compatible with ``pytest-ordering`` due to the
+changed marker name (``order`` instead of ``run``). Only the ``order`` 
+marker is supported, support for all additional markers has been removed for
+consistence (see [this issue](https://github.com/ftobia/pytest-ordering/issues/38)).
 
 
 pytest-order is a pytest plugin to run your tests in a specific order.
 
-[![Build Status](https://travis-ci.org/mrbean-bremen/pytest-order.svg?branch=master)](https://travis-ci.org/mrbean-bremen/pytest-order)
-
 Have you ever wanted to easily run one of your tests before any others run?
 Or run some tests last? Or run this one test before that other test? Or
 make sure that this group of tests runs after this other group of tests?
@@ -27,9 +27,10 @@ Install with:
 
     pip install pytest-order
 
-This defines some pytest markers that you can use in your code.
+This defines the ``order`` marker that you can use in your code with
+different attributes. 
 
-For example, this:
+For example, this code:
 
     import pytest
 
@@ -41,11 +42,11 @@ For example, this:
     def test_bar():
         assert True
 
-Yields this output:
+yields the output:
 
     $ py.test test_foo.py -vv
     ============================= test session starts ==============================
-    platform darwin -- Python 2.7.5 -- py-1.4.20 -- pytest-2.5.2 -- env/bin/python
+    platform darwin -- Python 3.7.1, pytest-5.4.3, py-1.8.1, pluggy-0.13.1 -- env/bin/python
     plugins: order
     collected 2 items
 

docs/source/index.rst

@@ -1,21 +1,53 @@
 pytest-order: run your tests in  order
-==========================================
-
+======================================
 pytest-order is a pytest plugin to run your tests in any order that
 you specify. It provides the marker ``order``, that defines when your tests
 should run in relation to each other. They can be absolute (i.e. first, or
 second-to-last) or relative (i.e. run this test before this other test).
 
+Relationship with pytest-ordering
+---------------------------------
+``pytest-order`` is a fork of
+`pytest-ordering <https://github.com/ftobia/pytest-ordering>`__, which is
+not maintained anymore. The idea and most of the code has been created by
+Frank Tobia, the author of that plugin.
+
+However, ``pytest-order`` is not compatible with ``pytest-ordering`` due to the
+changed marker name (``order`` instead of ``run``) and the removal of all
+other special markers for consistence (see
+`this issue <https://github.com/ftobia/pytest-ordering/issues/38>`__). This
+also avoids clashes between the plugins if they are both installed.
+
+Here are examples for which markers correspond to markers in
+``pytest-ordering``:
+
+- ``pytest.mark.order1``, ``pytest.mark.run(order=1)`` => ``pytest.mark.order(1)``
+- ``pytest.mark.first`` => ``pytest.mark.order("first")``
+
+
 Supported Python and pytest versions
 ------------------------------------
-
 pytest-order supports python 2.7, 3.5 - 3.8, and pypy, and is
-compatible with pytest 3.6.0 or newer.
+compatible with pytest 3.6.0 or newer. Note that support for Python 2 will
+be removed in one of the next versions.
 
+Installation
+------------
+The latest released version can be installed from
+`PyPi <https://pypi.python.org/pypi/pytest-order/>`__:
+
+.. code:: bash
+
+   pip install pytest-order
+
+The latest master can be installed from the GitHub sources:
+
+.. code:: bash
+
+   pip install git+https://github.com/mrbean-bremen/pytest-order
 
 Quickstart
 ----------
-
 Ordinarily pytest will run tests in the order that they appear in a module.
 For example, for the following tests:
 
@@ -33,7 +65,7 @@ Here is the output:
 
     $ py.test test_foo.py -vv
     ============================= test session starts ==============================
-    platform darwin -- Python 2.7.5 -- py-1.4.20 -- pytest-2.5.2 -- env/bin/python
+    platform darwin -- Python 3.7.1, pytest-5.4.3, py-1.8.1, pluggy-0.13.1 -- env/bin/python
     collected 2 items
 
     test_foo.py:2: test_foo PASSED
@@ -59,8 +91,8 @@ With pytest-order, you can change the default ordering as follows:
 
     $ py.test test_foo.py -vv
     ============================= test session starts ==============================
-    platform darwin -- Python 2.7.5 -- py-1.4.20 -- pytest-2.5.2 -- env/bin/python
-    plugins: ordering
+    platform darwin -- Python 3.7.1, pytest-5.4.3, py-1.8.1, pluggy-0.13.1 -- env/bin/python
+    plugins: order
     collected 2 items
 
     test_foo.py:7: test_bar PASSED
@@ -101,8 +133,8 @@ are used in Python lists, e.g. to count from the end:
 
     $ py.test test_foo.py -vv
     ============================= test session starts ==============================
-    platform darwin -- Python 2.7.5 -- py-1.4.20 -- pytest-2.5.2 -- env/bin/python
-    plugins: ordering
+    platform darwin -- Python 3.7.1, pytest-5.4.3, py-1.8.1, pluggy-0.13.1 -- env/bin/python
+    plugins: order
     collected 4 items
 
     test_foo.py:17: test_one PASSED
@@ -144,8 +176,8 @@ as the numbers 1, 2, -1 and -2 that have been shown above:
 
     $ py.test test_foo.py -vv
     ============================= test session starts ==============================
-    platform darwin -- Python 2.7.5 -- py-1.4.20 -- pytest-2.5.2 -- env/bin/python
-    plugins: ordering
+    platform darwin -- Python 3.7.1, pytest-5.4.3, py-1.8.1, pluggy-0.13.1 -- env/bin/python
+    plugins: order
     collected 4 items
 
     test_foo.py:17: test_one PASSED
@@ -180,8 +212,8 @@ by their name:
 
     $ py.test test_foo.py -vv
     ============================= test session starts ==============================
-    platform darwin -- Python 2.7.5 -- py-1.4.20 -- pytest-2.5.2 -- env/bin/python
-    plugins: ordering
+    platform darwin -- Python 3.7.1, pytest-5.4.3, py-1.8.1, pluggy-0.13.1 -- env/bin/python
+    plugins: order
     collected 3 items
 
     test_foo.py:11: test_first PASSED

pytest_order/__init__.py

@@ -43,12 +43,6 @@ def pytest_configure(config):
     )
     config.addinivalue_line('markers', config_line)
 
-    for mark_name in orders_map.keys():
-        config_line = '{}: run test {}. {}'.format(mark_name,
-                                                   mark_name.replace('_', ' '),
-                                                   provided_by_pytest_order)
-        config.addinivalue_line('markers', config_line)
-
     if config.getoption('indulgent-ordering'):
         # We need to dynamically add this `tryfirst` decorator to the plugin:
         # only when the CLI option is present should the decorator be added.
@@ -93,13 +87,7 @@ def get_filename(item):
 
 
 def mark_binning(item, keys, start, end, before, after, unordered):
-    match_order = re.compile(r"order(\d+)(:?,|$)")
-    find_order = match_order.search(",".join(keys))
-    if find_order:
-        order = int(find_order.group(1))
-        start.setdefault(order, []).append(item)
-        return True
-    elif "order" in keys:
+    if "order" in keys:
         mark = item.get_closest_marker('order')
         order = mark.args[0] if mark.args else None
         before_mark = mark.kwargs.get('before')
@@ -111,12 +99,12 @@ def mark_binning(item, keys, start, end, before, after, unordered):
                 order = orders_map[order]
             else:
                 warn("Unknown order attribute:'{}'".format(order))
-                order = None
-            if order is not None:
-                if order < 0:
-                    end.setdefault(order, []).append(item)
-                else:
-                    start.setdefault(order, []).append(item)
+                unordered.append(item)
+                return False
+            if order < 0:
+                end.setdefault(order, []).append(item)
+            else:
+                start.setdefault(order, []).append(item)
         elif before_mark:
             if "." not in before_mark:
                 prefix = get_filename(item)

tests/test_ordering.py

@@ -313,11 +313,11 @@ def test_quickstart2(item_names_for):
     test_content = """
     import pytest
 
-    @pytest.mark.order2
+    @pytest.mark.order(2)
     def test_foo():
         pass
 
-    @pytest.mark.order1
+    @pytest.mark.order(1)
     def test_bar():
         pass
     """
@@ -422,4 +422,20 @@ def test_markers_registered(capsys):
     pytest.main(['--markers'])
     out, err = capsys.readouterr()
     assert '@pytest.mark.order' in out
-    assert out.count('Provided by pytest-order') == 17
+    # only order is supported as marker
+    assert out.count('Provided by pytest-order.') == 1
+
+
+def test_unsupported_order(item_names_for):
+    test_content = """
+    import pytest
+
+    @pytest.mark.order('unknown')
+    def test_1():
+        pass
+
+    def test_2():
+        pass
+    """
+    with pytest.warns(UserWarning, match="Unknown order attribute:'unknown'"):
+        assert item_names_for(test_content) == ['test_1', 'test_2']