Merge lp:~elachuni/piston-mini-client/debug-envvar into lp:piston-mini-client

[Anthony Lenton]

Overview
========
This branch makes APIErrors aware of the PISTON_MINI_CLIENT_DEBUG environment variable.

Details
=======
If set, APIErrors will print out the full server response by default, to make debugging easier.
Brief docs and tests were also added.

[lp:~elachuni/piston-mini-client/debug-envvar]

31. By Anthony Lenton on 2011-03-22

Small doc fix and added a test.

[Ricardo Kirkner (ricardokirkner)]

Very nice work, including the documentation for the change.

review: Approve

=== added file 'doc/envvars.rst'
--- doc/envvars.rst	1970-01-01 00:00:00 +0000
+++ doc/envvars.rst	2011-03-22 16:32:10 +0000
@@ -0,0 +1,6 @@
+Environment variables
+=====================
+
+These environment variables affect the behaviour of ``piston_mini_client``:
+ * ``PISTON_MINI_CLIENT_DEBUG``: If set, all ``APIError`` exceptions will
+   report the full response from the server when printed, not only the headers.

=== modified file 'doc/index.rst'
--- doc/index.rst	2011-01-20 03:39:17 +0000
+++ doc/index.rst	2011-03-22 16:32:10 +0000
@@ -4,7 +4,7 @@
    contain the root `toctree` directive.
 
 Welcome to piston_mini_client's documentation!
-========================================
+==============================================
 
 Contents:
 
@@ -13,6 +13,7 @@
 
    quickstart
    reference
+   envvars
 
 Overview
 ========

=== modified file 'piston_mini_client/failhandlers.py'
--- piston_mini_client/failhandlers.py	2011-01-20 04:56:36 +0000
+++ piston_mini_client/failhandlers.py	2011-03-22 16:32:10 +0000
@@ -17,11 +17,16 @@
     'MultiExceptionFailHandler',
 ]
 
+import os
+
 class APIError(Exception):
     def __init__(self, msg, body=None):
         self.msg = msg
         self.body = body
+        self.debug = os.environ.get('PISTON_MINI_CLIENT_DEBUG', False)
     def __str__(self):
+        if self.debug:
+            return "%s\nReceived body:\n%s" % (self.msg, self.body)
         return self.msg
 
 

=== modified file 'piston_mini_client/tests/test_failhandlers.py'
--- piston_mini_client/tests/test_failhandlers.py	2011-01-12 17:21:36 +0000
+++ piston_mini_client/tests/test_failhandlers.py	2011-03-22 16:32:10 +0000
@@ -41,6 +41,30 @@
         return self._get('/plant')
 
 
+class APIErrorTestCase(TestCase):
+    def test_default_repr(self):
+        """Check that usually only msg is printed out"""
+        err = APIError(msg='foo', body='bar')
+        err.debug = False
+        self.assertEqual('foo', str(err))
+
+    def test_verbose_repr(self):
+        """Check that body is also included if in verbose mode"""
+        err = APIError(msg='foo', body='bar')
+        err.debug = True
+        self.assertTrue('bar' in str(err))
+
+    @patch('os.environ.get')
+    def test_debug_gets_set_from_environment(self, mock_get):
+        """Check that debug is initialized from the environment"""
+        sentinel = object()
+        mock_get.return_value = sentinel
+
+        err = APIError('foo')
+
+        self.assertEqual(err.debug, sentinel)
+        mock_get.assert_called_with('PISTON_MINI_CLIENT_DEBUG', False)
+
 class ExceptionFailHandlerTestCase(TestCase):
     """As this is the default fail handler, we can skip most tests"""
     def test_no_status(self):