2 files changed, 113 insertions, 13 deletions

diff --git a/docs/testing/developer/devguide/devguide.rst b/docs/testing/developer/devguide/devguide.rst
index 43672cbda..4fe01c12b 100755
--- a/docs/testing/developer/devguide/devguide.rst
+++ b/docs/testing/developer/devguide/devguide.rst
@@ -656,6 +656,57 @@ running ``tox``::
    rm -rf .tox/<environment_name>
    rm -rf .tox/py27
 
+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
 -------
 
diff --git a/docs/testing/user/userguide/glossary.rst b/docs/testing/user/userguide/glossary.rst
index be98aa6c0..6a153943c 100644
--- a/docs/testing/user/userguide/glossary.rst
+++ b/docs/testing/user/userguide/glossary.rst
@@ -13,6 +13,11 @@ Glossary
    API
      Application Programming Interface
 
+   Docker
+     Docker provisions and manages containers. Yardstick and many other OPNFV
+     projects are deployed in containers. Docker is required to launch the
+     containerized versions of these projects.
+
    DPI
      Deep Packet Inspection
 
@@ -27,36 +32,80 @@ Glossary
 
    IOPS
      Input/Output Operations Per Second
+     A performance measurement used to benchmark storage devices.
+
+   KPI
+     Key Performance Indicator
+
+   Kubernetes
+     k8s
+     Kubernetes is an open-source container-orchestration system for automating
+     deployment, scaling and management of containerized applications.
+     It is one of the contexts supported in Yardstick.
+
+   NFV
+     Network Function Virtualization
+     NFV is an initiative to take network services which were traditionally run
+     on proprietary, dedicated hardware, and virtualize them to run on general
+     purpose hardware.
+
+   NFVI
+     Network Function Virtualization Infrastructure
+     The servers, routers, switches, etc on which the NFV system runs.
 
    NIC
      Network Interface Controller
 
+   OpenStack
+      OpenStack is a cloud operating system that controls pools of compute,
+      storage, and networking resources. OpenStack is an open source project
+      licensed under the Apache License 2.0.
+
    PBFS
      Packet Based per Flow State
 
+   PROX
+     Packet pROcessing eXecution engine
+
    QoS
      Quality of Service
+     The ability to guarantee certain network or storage requirements to
+     satisfy a Service Level Agreement (SLA) between an application provider
+     and end users.
+     Typically includes performance requirements like networking bandwidth,
+     latency, jitter correction, and reliability as well as storage
+     performance in Input/Output Operations Per Second (IOPS), throttling
+     agreements, and performance expectations at peak load
+
+   SLA
+     Service Level Agreement
+     An SLA is an agreement between a service provider and a customer to
+     provide a certain level of service/performance.
+
+   SR-IOV
+     Single Root IO Virtualization
+     A specification that, when implemented by a physical PCIe
+     device, enables it to appear as multiple separate PCIe devices. This
+     enables multiple virtualized guests to share direct access to the
+     physical device.
+
+   SUT
+     System Under Test
+
+   ToS
+     Type of Service
 
    VLAN
-     Virtual LAN
+     Virtual LAN (Local Area Network)
 
    VM
      Virtual Machine
+     An operating system instance that runs on top of a hypervisor.
+     Multiple VMs can run at the same time on the same physical
+     host.
 
    VNF
      Virtual Network Function
 
    VNFC
      Virtual Network Function Component
-
-   NFVI
-     Network Function Virtualization Infrastructure
-
-   SR-IOV
-     Single Root IO Virtualization
-
-   SUT
-     System Under Test
-
-   ToS
-     Type of Service