From bc59cfce618a974600dec384b6c41ee0b186feed Mon Sep 17 00:00:00 2001
From: Xavier Morel <xmo@openerp.com>
Date: Thu, 9 Oct 2014 15:38:36 +0200
Subject: [IMP] doc: add testing reference and improve docstrings

---
 doc/reference/cmdline.rst |  4 +++
 doc/reference/testing.rst | 73 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 77 insertions(+)
 create mode 100644 doc/reference/testing.rst

(limited to 'doc/reference')

diff --git a/doc/reference/cmdline.rst b/doc/reference/cmdline.rst
index 140405d0037..e3f2952c5d3 100644
--- a/doc/reference/cmdline.rst
+++ b/doc/reference/cmdline.rst
@@ -38,6 +38,10 @@ Running the server
     (:file:`{$HOME}/.openerp_serverrc` by default, overridable using
     :option:`-c`)
 
+.. option:: --test-enable
+
+    runs tests after installing modules
+
 .. _reference/cmdline/scaffold:
 
 Scaffolding
diff --git a/doc/reference/testing.rst b/doc/reference/testing.rst
new file mode 100644
index 00000000000..2676c2b4084
--- /dev/null
+++ b/doc/reference/testing.rst
@@ -0,0 +1,73 @@
+.. _reference/testing:
+
+===============
+Testing Modules
+===============
+
+Odoo provides support for testing modules using unittest2_.
+
+To write tests, simply define a ``tests`` sub-package in your module, it will
+be automatically inspected for test modules. Test modules should have a name
+starting with ``test_`` and should be imported from ``tests/__init__.py``,
+e.g.
+
+.. code-block:: text
+
+    your_module
+    |-- ...
+    `-- tests
+        |-- __init__.py
+        |-- test_bar.py
+        `-- test_foo.py
+
+and ``__init__.py`` contains::
+
+    from . import test_foo, test_bar
+
+.. note:: test modules which are not imported from ``tests/__init__.py`` will
+          not be run
+
+The test runner will simply run any test case, as described in the official
+`unittest documentation`_, but Odoo provides a number of utilities and helpers
+related to testing Odoo content (modules, mainly):
+
+.. autoclass:: openerp.tests.common.TransactionCase
+    :members: browse_ref, ref
+
+.. autoclass:: openerp.tests.common.SingleTransactionCase
+    :members: browse_ref, ref
+
+By default, tests are run once right after the corresponding module has been
+installed. Test cases can also be configured to run after all modules have
+been installed, and not run right after the module installation:
+
+.. autofunction:: openerp.tests.common.at_install
+
+.. autofunction:: openerp.tests.common.post_install
+
+The most common situation is to use
+:class:`~openerp.tests.common.TransactionCase` and test a property of a of a
+model in each method::
+
+    class TestModelA(common.TransactionCase):
+        def test_some_action(self):
+            record = self.env['model.a'].create({'field': 'value'})
+            record.some_action()
+            self.assertEqual(
+                record.field,
+                expected_field_value)
+
+        # other tests...
+
+Running tests
+-------------
+
+Tests are automatically run when installing or updating modules if
+:option:`--test-enable <odoo.py --test-enable>` was enabled when starting the
+Odoo server.
+
+As of Odoo 8, running tests outside of the install/update cycle is not
+
+
+.. _unittest2: http://pypi.python.org/pypi/unittest2
+.. _unittest documentation: https://docs.python.org/2/library/unittest.html
-- 
cgit v1.2.3