summaryrefslogtreecommitdiffstats
path: root/docs/testing/developer/devguide/devguide.rst
diff options
context:
space:
mode:
authorRex Lee <limingjiang@huawei.com>2018-10-30 09:04:16 +0000
committerGerrit Code Review <gerrit@opnfv.org>2018-10-30 09:04:16 +0000
commitf64419cc7d16a679ed130dfe7592533b3cf9fdc1 (patch)
treec57d15bc5288385face5500178c5f01dbef4aa16 /docs/testing/developer/devguide/devguide.rst
parent78b5a19e3071cbc080eeae0bdf22f5ab80c03180 (diff)
parente82f965fc6d217f1547ded446ef71b83618f44a3 (diff)
Merge "[docs] Add conventions for writing unit tests."
Diffstat (limited to 'docs/testing/developer/devguide/devguide.rst')
-rwxr-xr-xdocs/testing/developer/devguide/devguide.rst51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/testing/developer/devguide/devguide.rst b/docs/testing/developer/devguide/devguide.rst
index 91f2c2148..447ec445c 100755
--- a/docs/testing/developer/devguide/devguide.rst
+++ b/docs/testing/developer/devguide/devguide.rst
@@ -567,6 +567,57 @@ A backported change needs a ``+1`` and a ``+2`` from a committer who didn’t
propose the change (i.e. minimum 3 people involved).
+Writing unit tests
+~~~~~~~~~~~~~~~~~~
+For each change submitted, a set of unit tests should be submitted, which
+should include both positive and negative testing.
+
+In order to help identify which tests are needed, follow the guidelines below.
+
+* In general, there should be a separate test for each branching point, return
+ value and input set.
+* Negative tests should be written to make sure exceptions are raised and/or
+ handled appropriately.
+
+The following convention should be used for naming tests::
+
+ test_<method_name>_<some_comment>
+
+The comment gives more information on the nature of the test, the side effect
+being checked, or the parameter being modified::
+
+ test_my_method_runtime_error
+ test_my_method_invalid_credentials
+ test_my_method_param1_none
+
+Mocking
++++++++
+The ``mock`` library is used for unit testing to stub out external libraries.
+
+The following conventions are used in Yardstick:
+
+* Use ``mock.patch.object`` instead of ``mock.patch``.
+
+* When naming mocked classes/functions, use ``mock_<class_and_function_name>``
+ e.g. ``mock_subprocess_call``
+
+* Avoid decorating classes with mocks. Apply the mocking in ``setUp()``::
+
+ @mock.patch.object(ssh, 'SSH')
+ class MyClassTestCase(unittest.TestCase):
+
+ should be::
+
+ class MyClassTestCase(unittest.TestCase):
+ def setUp(self):
+ self._mock_ssh = mock.patch.object(ssh, 'SSH')
+ self.mock_ssh = self._mock_ssh.start()
+
+ self.addCleanup(self._stop_mocks)
+
+ def _stop_mocks(self):
+ self._mock_ssh.stop()
+
Plugins
-------