Merge document-test-class-names-7032: Document the recommended naming of

test classes in Twisted. Author: eeshangarg Reviewers: khorn Fixes: twisted#7032 Add some documentation to the Testing Standard which specifies the correct way of naming test classes. git-svn-id: svn://svn.twistedmatrix.com/svn/Twisted/trunk@43075 bbbe8e31-12d6-0310-92fd-ac37d47ddeeb
meteozond · Sep 14, 2014 · 800f5d5 · 800f5d5
1 parent cf007f3
commit 800f5d5
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 6 deletions.
diff --git a/docs/core/development/policy/test-standard.rst b/docs/core/development/policy/test-standard.rst
@@ -207,6 +207,29 @@ tests.
 
 
 
+Naming Test Classes
+~~~~~~~~~~~~~~~~~~~
+
+
+
+When writing tests for the Twisted test suite, test classes are named
+``FooTests``, where ``Foo`` is the name of the component being tested.
+Here is an example:
+
+
+
+
+
+.. code-block:: python
+
+
+    class SSHClientTests(unittest.TestCase):
+        def test_sshClient(self):
+            foo() # the actual test
+
+
+
+
 
 Real I/O
 ~~~~~~~~
@@ -284,7 +307,7 @@ inside a conditional which looks for the necessary prerequisites:
 
 .. code-block:: python
 
-    
+
     class SSHClientTests(unittest.TestCase):
         def test_sshClient(self):
             if not ssh_path:
@@ -318,14 +341,14 @@ manipulating the class attributes after they've been defined):
 .. code-block:: python
 
     
-    class MyTestCase(unittest.TestCase):
+    class MyTests(unittest.TestCase):
         def test_one(self):
             ...
         def test_thing(self):
             dotest()
     
     if not haveThing:
-        MyTestCase.test_thing.im_func.skip = "cannot test without Thing"
+        MyTests.test_thing.im_func.skip = "cannot test without Thing"
         # but test_one() will still run
 
 
@@ -343,12 +366,12 @@ be run.
 .. code-block:: python
 
     
-    class TCPTestCase(unittest.TestCase):
+    class TCPTests(unittest.TestCase):
         ...
-    class SSLTestCase(unittest.TestCase):
+    class SSLTests(unittest.TestCase):
         if not haveSSL:
             skip = "cannot test without SSL support"
-        # but TCPTestCase will still run
+        # but TCPTests will still run
         ...
 
 

diff --git a/twisted/topfiles/7032.misc b/twisted/topfiles/7032.misc