Refactor ordering scope test

- remove fixtures, make it more readable
- add test for separate files on command line
- add release dates to changelog
- fix coverage badge link

Author: mrbean-bremen

CHANGELOG.md

@@ -2,13 +2,13 @@
 
 ## Unreleased
 
-## [Version 0.8.1](https://pypi.org/project/pytest-order/0.8.1/)
+## [Version 0.8.1](https://pypi.org/project/pytest-order/0.8.1/) (2020-11-02)
 
 ### Added
-- add configuration option for sorting scope,
+- added configuration option for sorting scope,
   see [#2](https://github.com/mrbean-bremen/pytest-order/issues/2)
 
-## [Version 0.8.0](https://pypi.org/project/pytest-order/0.8.0/)
+## [Version 0.8.0](https://pypi.org/project/pytest-order/0.8.0/) (2020-10-30)
 This release is mostly related to the consolidation of infrastructure
 (documentation build and tests in CI build) and documentation.  
 
@@ -22,7 +22,7 @@ This release is mostly related to the consolidation of infrastructure
 - added regression test for ``pytest-xdist`` 
   (imported from [PR #52](https://github.com/ftobia/pytest-ordering/pull/52))
 
-## [Version 0.7.1](https://pypi.org/project/pytest-order/0.7.1/)
+## [Version 0.7.1](https://pypi.org/project/pytest-order/0.7.1/) (2020-10-24)
 Update after renaming the repository and the package.
 
 ### Changes
@@ -33,7 +33,7 @@ Update after renaming the repository and the package.
 ### Documentation
 - use separate documentation pages for release and development versions
 
-## [Version 0.7.0](https://pypi.org/project/pytest-ordering2/0.7.0/)
+## [Version 0.7.0](https://pypi.org/project/pytest-ordering2/0.7.0/) (2020-10-22)
 Imported version from [pytest-ordering](https://github.com/ftobia/pytest-ordering), 
 including some PRs (manually merged).
 

README.md

@@ -1,7 +1,7 @@
 _pytest-order_ - a pytest plugin to order test execution
 ========================================================
 
- [![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) [![Coverage Status](https://img.shields.io/coveralls/github/mrbean-bremen/pytest-order)](https://coveralls.io/github/badges/shields?branch=master) [![Python version](https://img.shields.io/pypi/pyversions/pytest-order.svg)](https://img.shields.io/pypi/pyversions/pytest-order.svg)
+ [![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) [![Coverage Status](https://img.shields.io/coveralls/github/mrbean-bremen/pytest-order)](https://coveralls.io/github/mrbean-bremen/pytest-order) [![Python version](https://img.shields.io/pypi/pyversions/pytest-order.svg)](https://img.shields.io/pypi/pyversions/pytest-order.svg)
 
 `pytest-order` is a pytest plugin that allows you to customize the order in which
 your tests are run. It uses the marker `order` that defines when a specific

fixture/test_classes.py

@@ -71,7 +71,7 @@ def pytest_addoption(parser):
                          "allowing the other sorting to have priority")
     group.addoption("--order-scope", action="store",
                     dest="order-scope",
-                    help="Defines the scope used for ordeing. Possible values"
+                    help="Defines the scope used for ordering. Possible values"
                          "are 'session' (default), 'module', and 'class'")
 
 

fixture/test_functions1.py

@@ -0,0 +1,16 @@
+import pytest
+
+pytest_plugins = ["pytester"]
+
+
+@pytest.fixture
+def item_names_for(testdir):
+    def _item_names_for(tests_content):
+        # some strange code to extract sorted items
+        items = testdir.getitems(tests_content)
+        hook = testdir.config.hook
+        hook.pytest_collection_modifyitems(session=items[0].session,
+                                           config=testdir.config, items=items)
+        return [item.name for item in items]
+
+    return _item_names_for

fixture/test_functions2.py

@@ -4,8 +4,6 @@
 
 import pytest_order
 
-pytest_plugins = ["pytester"]
-
 
 def test_run_marker_registered(capsys, tmpdir):
     testname = str(tmpdir.join("failing.py"))

pytest_order/__init__.py

@@ -1,82 +1,173 @@
 # -*- coding: utf-8 -*-
 import os
+import re
+import shutil
 
 import pytest
 
 import pytest_order
 
 
-def fixture_path():
-    base_path = os.path.split(os.path.dirname(__file__))[0]
-    return os.path.join(base_path, "fixture")
+@pytest.fixture(scope="module")
+def fixture_path(tmpdir_factory):
+    fixture_path = str(tmpdir_factory.mktemp("fixtures"))
+    testname = os.path.join(fixture_path, "test_classes.py")
+    test_class_contents = """
+import pytest
+
+class Test1:
+    @pytest.mark.order("last")
+    def test_two(self):
+        assert True
+
+    @pytest.mark.order("first")
+    def test_one(self):
+        assert True
+
+class Test2:
+    @pytest.mark.order("last")
+    def test_two(self):
+        assert True
+
+    @pytest.mark.order("first")
+    def test_one(self):
+        assert True
+
+@pytest.mark.order("last")
+def test_two():
+    assert True
+
+@pytest.mark.order("first")
+def test_one():
+    assert True
+"""
+    with open(testname, "w") as fi:
+        fi.write(test_class_contents)
+
+    test_function_contents = """
+import pytest
+
+@pytest.mark.order("last")
+def test1_two():
+    assert True
+
+@pytest.mark.order("first")
+def test1_one():
+    assert True
+    """
+    testname = os.path.join(fixture_path, "test_functions1.py")
+    with open(testname, "w") as fi:
+        fi.write(test_function_contents)
+        test_function_contents = """
+import pytest
 
+@pytest.mark.order("last")
+def test2_two():
+    assert True
 
-def test_session_scope(capsys):
-    args = ["-v", fixture_path()]
+@pytest.mark.order("first")
+def test2_one():
+    assert True
+    """
+    testname = os.path.join(fixture_path, "test_functions2.py")
+    with open(testname, "w") as fi:
+        fi.write(test_function_contents)
+    yield fixture_path
+    shutil.rmtree(fixture_path, ignore_errors=True)
+
+
+@pytest.fixture(scope="module")
+def fixture_file_paths(fixture_path):
+    yield [
+        os.path.join(fixture_path, "test_classes.py"),
+        os.path.join(fixture_path, "test_functions1.py"),
+        os.path.join(fixture_path, "test_functions2.py")
+    ]
+
+
+def test_session_scope(fixture_path, capsys):
+    args = ["-v", fixture_path]
+    pytest.main(args, [pytest_order])
+    out, err = capsys.readouterr()
+    expected = (
+        ".*test_classes.py::Test1::test_one"
+        ".*test_classes.py::Test2::test_one"
+        ".*test_classes.py::test_one"
+        ".*test_functions1.py::test1_one"
+        ".*test_functions2.py::test2_one"
+        ".*test_classes.py::Test1::test_two"
+        ".*test_classes.py::Test2::test_two"
+        ".*test_classes.py::test_two"
+        ".*test_functions1.py::test1_two"
+        ".*test_functions2.py::test2_two.*"
+    )
+    assert re.match(expected, out.replace("\n", "")), out
+
+
+def test_session_scope_multiple_files(fixture_file_paths, capsys):
+    """Test that session scope works with multiple files on command line."""
+    args = ["-v"] + fixture_file_paths
     pytest.main(args, [pytest_order])
     out, err = capsys.readouterr()
-    i_class1_one = out.index("test_classes.py::Test1::test_one")
-    i_class2_one = out.index("test_classes.py::Test2::test_one")
-    i_noclass_one = out.index("test_classes.py::test_one")
-    i_func1_one = out.index("test_functions1.py::test_one")
-    i_func2_one = out.index("test_functions2.py::test_one")
-    i_class1_two = out.index("test_classes.py::Test1::test_two")
-    i_class2_two = out.index("test_classes.py::Test2::test_two")
-    i_noclass_two = out.index("test_classes.py::test_two")
-    i_func1_two = out.index("test_functions1.py::test_two")
-    i_func2_two = out.index("test_functions2.py::test_two")
-    assert (i_class1_one < i_class2_one < i_noclass_one
-            < i_func1_one < i_func2_one
-            < i_class1_two < i_class2_two < i_noclass_two
-            < i_func1_two < i_func2_two)
-
-
-def test_module_scope(capsys):
-    args = ["-v", "--order-scope=module", fixture_path()]
+    # under Windows, the module name is not listed in this case,
+    # so do not expect it
+    expected = (
+        ".*::Test1::test_one"
+        ".*::Test2::test_one"
+        ".*::test_one"
+        ".*::test1_one"
+        ".*::test2_one"
+        ".*::Test1::test_two"
+        ".*::Test2::test_two"
+        ".*::test_two"
+        ".*::test1_two"
+        ".*::test2_two.*"
+    )
+    assert re.match(expected, out.replace("\n", "")), out
+
+
+def test_module_scope(fixture_path, capsys):
+    args = ["-v", "--order-scope=module", fixture_path]
     pytest.main(args, [pytest_order])
     out, err = capsys.readouterr()
-    print('module:', out)
-    i_class1_one = out.index("test_classes.py::Test1::test_one")
-    i_class2_one = out.index("test_classes.py::Test2::test_one")
-    i_noclass_one = out.index("test_classes.py::test_one")
-    i_func1_one = out.index("test_functions1.py::test_one")
-    i_func2_one = out.index("test_functions2.py::test_one")
-    i_class1_two = out.index("test_classes.py::Test1::test_two")
-    i_class2_two = out.index("test_classes.py::Test2::test_two")
-    i_noclass_two = out.index("test_classes.py::test_two")
-    i_func1_two = out.index("test_functions1.py::test_two")
-    i_func2_two = out.index("test_functions2.py::test_two")
-    assert (i_class1_one < i_class2_one < i_noclass_one
-            < i_class1_two < i_class2_two < i_noclass_two
-            < i_func1_one < i_func1_two
-            < i_func2_one < i_func2_two)
-
-
-def test_class_scope(capsys):
-    args = ["-v", "--order-scope=class", fixture_path()]
+    expected = (
+        ".*test_classes.py::Test1::test_one"
+        ".*test_classes.py::Test2::test_one"
+        ".*test_classes.py::test_one"
+        ".*test_classes.py::Test1::test_two"
+        ".*test_classes.py::Test2::test_two"
+        ".*test_classes.py::test_two"
+        ".*test_functions1.py::test1_one"
+        ".*test_functions1.py::test1_two"
+        ".*test_functions2.py::test2_one"
+        ".*test_functions2.py::test2_two.*"
+    )
+    assert re.match(expected, out.replace("\n", "")), out
+
+
+def test_class_scope(fixture_path, capsys):
+    args = ["-v", "--order-scope=class", fixture_path]
     pytest.main(args, [pytest_order])
     out, err = capsys.readouterr()
-    print('class:', out)
-    i_class1_one = out.index("test_classes.py::Test1::test_one")
-    i_class2_one = out.index("test_classes.py::Test2::test_one")
-    i_noclass_one = out.index("test_classes.py::test_one")
-    i_func1_one = out.index("test_functions1.py::test_one")
-    i_func2_one = out.index("test_functions2.py::test_one")
-    i_class1_two = out.index("test_classes.py::Test1::test_two")
-    i_class2_two = out.index("test_classes.py::Test2::test_two")
-    i_noclass_two = out.index("test_classes.py::test_two")
-    i_func1_two = out.index("test_functions1.py::test_two")
-    i_func2_two = out.index("test_functions2.py::test_two")
-    assert (i_class1_one < i_class1_two < i_class2_one < i_class2_two
-            < i_noclass_one < i_noclass_two
-            < i_func1_one < i_func1_two
-            < i_func2_one < i_func2_two)
+    expected = (
+        ".*test_classes.py::Test1::test_one"
+        ".*test_classes.py::Test1::test_two"
+        ".*test_classes.py::Test2::test_one"
+        ".*test_classes.py::Test2::test_two"
+        ".*test_classes.py::test_one"
+        ".*test_classes.py::test_two"
+        ".*test_functions1.py::test1_one"
+        ".*test_functions1.py::test1_two"
+        ".*test_functions2.py::test2_one"
+        ".*test_functions2.py::test2_two.*"
+    )
+    assert re.match(expected, out.replace("\n", "")), out
 
 
 @pytest.mark.skipif(pytest.__version__.startswith(("3.6.", "3.7.")),
-                    reason="Warning does  not appear in out in pytest < 3.8")
-def test_invalid_scope(capsys):
-    args = ["-v", "--order-scope=function", fixture_path()]
+                    reason="Warning does not appear in output in pytest < 3.8")
+def test_invalid_scope(fixture_path, capsys):
+    args = ["-v", "--order-scope=function", fixture_path]
     pytest.main(args, [pytest_order])
     out, err = capsys.readouterr()
     assert "UserWarning: Unknown order scope 'function', ignoring it." in out

tests/conftest.py

@@ -2,21 +2,6 @@
 
 import pytest
 
-pytest_plugins = ["pytester"]
-
-
-@pytest.fixture
-def item_names_for(testdir):
-    def _item_names_for(tests_content):
-        # some strange code to extract sorted items
-        items = testdir.getitems(tests_content)
-        hook = testdir.config.hook
-        hook.pytest_collection_modifyitems(session=items[0].session,
-                                           config=testdir.config, items=items)
-        return [item.name for item in items]
-
-    return _item_names_for
-
 
 def test_no_marks(item_names_for):
     tests_content = """