Close #6.

Author: RKrahl

CHANGES

@@ -1,6 +1,42 @@
                History of changes to pytest-dependency
                =======================================
 
+* Version 0.3 (not yet released)
+
+** Incompatible changes
+
+ + Prepend the class name to the default test name for test class
+   methods.  This fixes a potential name conflict, see Issue #6.
+
+   If your code uses test classes and you reference test methods by
+   their default name, you must add the class name.  E.g. if you have
+   something like:
+
+         class TestClass(object):
+
+             @pytest.mark.dependency()
+             def test_a():
+                 pass
+
+             @pytest.mark.dependency(depends=["test_a"])
+             def test_b():
+                 pass
+
+   you need to change this to:
+
+         class TestClass(object):
+
+             @pytest.mark.dependency()
+             def test_a():
+                 pass
+
+             @pytest.mark.dependency(depends=["TestClass::test_a"])
+             def test_b():
+                 pass
+
+   If you override the test name in the pytest.mark.dependency()
+   marker, nothing need to be changed.
+
 * Version 0.2 (2017-05-28)
 
 ** New features

doc/examples/testclass.py

@@ -0,0 +1,49 @@
+import pytest
+
+
+class TestClass(object):
+
+    @pytest.mark.dependency()
+    @pytest.mark.xfail(reason="deliberate fail")
+    def test_a(self):
+        assert False
+
+    @pytest.mark.dependency()
+    def test_b(self):
+        pass
+
+    @pytest.mark.dependency(depends=["TestClass::test_a"])
+    def test_c(self):
+        pass
+
+    @pytest.mark.dependency(depends=["TestClass::test_b"])
+    def test_d(self):
+        pass
+
+    @pytest.mark.dependency(depends=["TestClass::test_b", "TestClass::test_c"])
+    def test_e(self):
+        pass
+
+
+class TestClassNamed(object):
+
+    @pytest.mark.dependency(name="a")
+    @pytest.mark.xfail(reason="deliberate fail")
+    def test_a(self):
+        assert False
+
+    @pytest.mark.dependency(name="b", depends=["a"])
+    def test_b(self):
+        pass
+
+    @pytest.mark.dependency(name="c")
+    def test_c(self):
+        pass
+
+    @pytest.mark.dependency(name="d", depends=["c"])
+    def test_d(self):
+        pass
+
+    @pytest.mark.dependency(name="e", depends=["b", "c"])
+    def test_e(self):
+        pass

doc/src/usage.rst

@@ -49,6 +49,21 @@ set:
 
 .. _usage-parametrized:
 
+Using test classes
+------------------
+
+Tests may be grouped in classes in pytest.  Marking the dependencies
+of methods in test classes works the same way as for simple test
+functions.  In the following example we define two test classes.  Each
+works in the same manner as the previous examples respectively:
+
+.. literalinclude:: ../examples/testclass.py
+
+In `TestClass` the default names for the tests are used, which is
+build from the name of the class and the respective method in this
+case, while in `TestClassNamed` these names are overridden by an
+explicit name argument to the :func:`pytest.mark.dependency` marker.
+
 Parametrized tests
 ------------------
 

pytest_dependency.py

@@ -52,7 +52,10 @@ def __init__(self):
     def addResult(self, item, marker, rep):
         name = marker.kwargs.get('name')
         if not name:
-            name = item.name
+            if item.cls:
+                name = "%s::%s" % (item.cls.__name__, item.name)
+            else:
+                name = item.name
         status = self.results.setdefault(name, DependencyItemStatus())
         status.addResult(rep)
 

tests/test_03_class.py

@@ -0,0 +1,121 @@
+"""Usage with test classes.
+"""
+
+import pytest
+
+
+def test_class_simple(ctestdir):
+    """Simple dependencies of test methods in a class.
+    test_a() deliberately fails, some other methods depend on it, some don't.
+    """
+    ctestdir.makepyfile("""
+        import pytest
+
+        class TestClass(object):
+
+            @pytest.mark.dependency()
+            def test_a(self):
+                assert False
+
+            @pytest.mark.dependency()
+            def test_b(self):
+                pass
+
+            @pytest.mark.dependency(depends=["TestClass::test_a"])
+            def test_c(self):
+                pass
+
+            @pytest.mark.dependency(depends=["TestClass::test_b"])
+            def test_d(self):
+                pass
+
+            @pytest.mark.dependency(depends=["TestClass::test_b", 
+                                             "TestClass::test_c"])
+            def test_e(self):
+                pass
+    """)
+    result = ctestdir.runpytest("--verbose")
+    result.assert_outcomes(passed=2, skipped=2, failed=1)
+    result.stdout.fnmatch_lines("""
+        *::TestClass::test_a FAILED
+        *::TestClass::test_b PASSED
+        *::TestClass::test_c SKIPPED
+        *::TestClass::test_d PASSED
+        *::TestClass::test_e SKIPPED
+    """)
+
+
+def test_class_simple_named(ctestdir):
+    """Mostly the same as test_class_simple(), but name the test methods
+    now explicitely.
+    """
+    ctestdir.makepyfile("""
+        import pytest
+
+        class TestClassNamed(object):
+
+            @pytest.mark.dependency(name="a")
+            def test_a(self):
+                assert False
+
+            @pytest.mark.dependency(name="b")
+            def test_b(self):
+                pass
+
+            @pytest.mark.dependency(name="c", depends=["a"])
+            def test_c(self):
+                pass
+
+            @pytest.mark.dependency(name="d", depends=["b"])
+            def test_d(self):
+                pass
+
+            @pytest.mark.dependency(name="e", depends=["b", "c"])
+            def test_e(self):
+                pass
+    """)
+    result = ctestdir.runpytest("--verbose")
+    result.assert_outcomes(passed=2, skipped=2, failed=1)
+    result.stdout.fnmatch_lines("""
+        *::TestClassNamed::test_a FAILED
+        *::TestClassNamed::test_b PASSED
+        *::TestClassNamed::test_c SKIPPED
+        *::TestClassNamed::test_d PASSED
+        *::TestClassNamed::test_e SKIPPED
+    """)
+
+
+def test_class_default_name(ctestdir):
+    """Issue #6: for methods of test classes, the default name used to be
+    the method name.  This could have caused conflicts if there is a
+    function having the same name outside the class.  In the following
+    example, before fixing this issue, the method test_a() of class
+    TestClass would have shadowed the failure of function test_a().
+
+    Now the class name is prepended to the default test name, removing
+    this conflict.
+    """
+    ctestdir.makepyfile("""
+        import pytest
+
+        @pytest.mark.dependency()
+        def test_a():
+            assert False
+
+        class TestClass(object):
+
+            @pytest.mark.dependency()
+            def test_a(self):
+                pass
+
+        @pytest.mark.dependency(depends=["test_a"])
+        def test_b():
+            pass
+    """)
+    result = ctestdir.runpytest("--verbose")
+    result.assert_outcomes(passed=1, skipped=1, failed=1)
+    result.stdout.fnmatch_lines("""
+        *::test_a FAILED
+        *::TestClass::test_a PASSED
+        *::test_b SKIPPED
+    """)