From 22d0561e72341fa9b8616dde18d457e19b0c441c Mon Sep 17 00:00:00 2001
From: Chris Yeoh <cyeoh@au1.ibm.com>
Date: Thu, 5 Feb 2015 10:02:29 +1030
Subject: [PATCH] Add suggestion to dev docs for debugging odd test failures

Adds information about the -r flag for tox to refresh the venv when
running unitests as when this happens the failures can look odd or valid
failures can be missing when running on a local system but occur when running
in the gate.

Change-Id: Ie6f7f73dfdbd4e55e8ac0b8a66cf9661f5630a09
---
 doc/source/devref/unit_tests.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/source/devref/unit_tests.rst b/doc/source/devref/unit_tests.rst
index 0f6497119484..300c67bb8b06 100644
--- a/doc/source/devref/unit_tests.rst
+++ b/doc/source/devref/unit_tests.rst
@@ -48,6 +48,16 @@ To run the `ValidateIntegerTestCase.test_invalid_inputs` test method in
 
     tox -epy27 test_utils.ValidateIntegerTestCase.test_invalid_inputs
 
+Debugging strange test failures
+-------------------------------
+
+Things to try when there are odd test failures such as failure on
+jenkins but not locally.
+
+The venv can get stale. Force a refresh by adding the -r flag::
+
+    tox -r -e pep8
+
 .. rubric:: Footnotes
 
 .. [#f1] See :doc:`jenkins`.