Document usage with test classes.

Author: RKrahl

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=["test_a"])
+    def test_c(self):
+        pass
+
+    @pytest.mark.dependency(depends=["test_b"])
+    def test_d(self):
+        pass
+
+    @pytest.mark.dependency(depends=["test_b", "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 the
+name of the respective method in this case, while in `TestClassNamed`
+these names are overridden an explicit name argument to the
+:func:`pytest.mark.dependency` marker.
+
 Parametrized tests
 ------------------