Merge lp:~kampka/testtools/issue-726539 into lp:~testtools-committers/testtools/trunk

[Christian Kampka]

* Fixes TestCommand import and reexports it from the testtools package
* Adds a sample setup.cfg configuration for the distutils TestCommand
  to demonstrate the proper usage of the command and so that
  ``python setup.py test`` may actually do something useful by default

[lp:~kampka/testtools/issue-726539]

177. By Christian Kampka on 2011-03-14

* added basic documentation on how to use testtools with distutils

[Jonathan Lange (jml)]

Thanks so much for this patch, especially since it comes with documentation! Very sorry about the delay. I've merged your patch with some minor tweaks (NEWS, removed commented-out lines, changed "You can the run" to "You can then run").

review: Approve

=== modified file 'doc/for-test-authors.rst'
--- doc/for-test-authors.rst	2011-01-22 16:47:31 +0000
+++ doc/for-test-authors.rst	2011-03-14 21:32:18 +0000
@@ -88,6 +88,34 @@
 
 From now on, we'll assume that you know how to run your tests.
 
+Running test with Distutils
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you are using Distutils_ to build your Python project, you can use the testtools
+Distutils_ command to integrate testtools into your Distutils_ workflow::
+
+  from distutils.core import setup
+  from testtools import TestCommand
+  setup(name='foo',
+      version='1.0',
+      py_modules=['foo'],
+      cmdclass={'test': TestCommand}
+  )
+
+You can the run::
+
+  $ python setup.py test -m exampletest
+  Tests running...
+  Ran 2 tests in 0.000s
+
+  OK
+
+For more information about the capabilities of the `TestCommand` command see::
+
+	$ python setup.py test --help
+
+You can use the `setup configuration`_ to specify the default behavior of the
+`TestCommand` command.
 
 Assertions
 ==========
@@ -1098,3 +1126,5 @@
 .. _Deferred: http://twistedmatrix.com/documents/current/core/howto/defer.html
 .. _discover: http://pypi.python.org/pypi/discover
 .. _`testtools API docs`: http://mumak.net/testtools/apidocs/
+.. _Distutils: http://docs.python.org/library/distutils.html
+.. _`setup configuration`: http://docs.python.org/distutils/configfile.html
 
=== added file 'setup.cfg'
--- setup.cfg	1970-01-01 00:00:00 +0000
+++ setup.cfg	2011-03-14 21:32:18 +0000
@@ -0,0 +1,6 @@
+[test]
+test_module = testtools.tests
+;test_suite = testtools.tests.test_suite
+;failfast=1
+buffer=1
+catch=1
 
=== modified file 'testtools/__init__.py'
--- testtools/__init__.py	2011-02-14 14:53:41 +0000
+++ testtools/__init__.py	2011-03-14 21:32:18 +0000
@@ -61,6 +61,9 @@
     ConcurrentTestSuite,
     iterate_tests,
     )
+from testtools.distutilscmd import (
+    TestCommand,
+)
 
 # same format as sys.version_info: "A tuple containing the five components of
 # the version number: major, minor, micro, releaselevel, and serial. All