Changes between Version 21 and Version 22 of TracDev/UnitTests

Timestamp:

Nov 18, 2016, 5:55:12 PM (7 years ago)

Author:

Ryan J Ollos

Comment:

Add information on how to execute test classes and test cases. Use unittest in example of executing package and module test cases, for consistency.

TracDev/UnitTests

@@ -3 +3 @@
 = Trac Unit Tests
 
-Many of the Trac Python modules are accompanied by unit tests. You should run the tests whenever making changes, to be confident you haven't broken anything. Note though that the coverage of application code by the unit tests is still rather poor, and even if it were better, not having broken the unit tests does not mean you haven't broken the application! Unit tests do not replace manual testing.
+Many of the Trac Python modules are accompanied by unit tests. You should run the tests whenever making changes, to be confident you haven't broken anything. Note though that the coverage of application code by the unit tests is incomplete, so not having broken the unit tests does not mean you haven't broken the application! Unit tests do not replace manual testing.
 
 Ideally, also include new unit tests for a change or enhancement, even if you are just submitting a patch. Patches that break the unit tests are a lot less likely to get integrated than patches that add unit tests for the new or changed functionality.
@@ -11 +11 @@
 You can run the unit tests from the command line by executing:
 {{{#!sh
-python -m trac.test --skip-functional-tests
+$ python -m trac.test --skip-functional-tests
 }}}
 
@@ -28 +28 @@
 Assuming the current working directory is where you checked out the Trac code from the SubversionRepository.
 
-This will run all the unit tests, but you can also run only those tests for a specific package or module. For example, to run the unit tests for the {{{trac.versioncontrol}}} package, execute:
+This will run all the unit tests, but you can also run only the tests for a specific package, module, class or method. For example, to run the unit tests for the `trac.versioncontrol` package, execute:
 {{{#!sh
-python -m trac.versioncontrol.tests.__init__
+$ python -m unittest trac.versioncontrol.tests.__init__
 }}}
 
@@ -38 +38 @@
 }}}
 
-To run the unit tests for the {{{trac.versioncontrol.cache}}} module, execute:
+To run the unit tests for the `trac.versioncontrol.cache` module, execute:
 {{{#!sh
-python -m trac.versioncontrol.tests.cache
+$ python -m unittest trac.versioncontrol.tests.cache
 }}}
 
@@ -46 +46 @@
 {{{#!sh
 $ PYTHONPATH=. trac/versioncontrol/tests/cache.py
+}}}
+
+To run the unit tests for the test class `trac.versioncontrol.tests.cache.CacheTestCase`, execute:
+{{{#!sh
+$ python -m unittest trac.versioncontrol.tests.cache.TestCase
+}}}
+
+To run the test case `trac.versioncontrol.tests.cache.CacheTestCase.test_initial_sync`, execute:
+{{{#!sh
+$ python -m unittest trac.versioncontrol.tests.cache.TestCase.test_initial_sync
 }}}