Merge "Improve error handling when JSON is not returned by agent"

ironic/drivers/modules/agent_client.py

@@ -73,7 +73,16 @@ class AgentClient(object):
                                      headers=headers)
 
         # TODO(russellhaering): real error handling
-        return response.json()
+        try:
+            return response.json()
+        except ValueError:
+            msg = _(
+                'Unable to decode response as JSON.\n'
+                'Request URL: %(url)s\nRequest body: "%(body)s"\n'
+                'Response: "%(response)s"'
+                ) % ({'response': response.text, 'body': body, 'url': url})
+            LOG.error(msg)
+            raise exception.IronicException(msg)
 
     def get_commands_status(self, node):
         url = self._get_command_url(node)

ironic/tests/drivers/test_agent_client.py

@@ -16,6 +16,7 @@ import json
 
 import mock
 import requests
+import six
 
 from ironic.common import exception
 from ironic.drivers.modules import agent_client
@@ -23,12 +24,12 @@ from ironic.tests import base
 
 
 class MockResponse(object):
-    def __init__(self, data):
-        self.data = data
-        self.text = json.dumps(data)
+    def __init__(self, text):
+        assert isinstance(text, six.string_types)
+        self.text = text
 
     def json(self):
-        return self.data
+        return json.loads(self.text)
 
 
 class MockNode(object):
@@ -75,7 +76,8 @@ class TestAgentClient(base.TestCase):
 
     def test__command(self):
         response_data = {'status': 'ok'}
-        self.client.session.post.return_value = MockResponse(response_data)
+        response_text = json.dumps(response_data)
+        self.client.session.post.return_value = MockResponse(response_text)
         method = 'standby.run_image'
         image_info = {'image_id': 'test_image'}
         params = {'image_info': image_info}
@@ -92,6 +94,26 @@ class TestAgentClient(base.TestCase):
             headers=headers,
             params={'wait': 'false'})
 
+    def test__command_fail_json(self):
+        response_text = 'this be not json matey!'
+        self.client.session.post.return_value = MockResponse(response_text)
+        method = 'standby.run_image'
+        image_info = {'image_id': 'test_image'}
+        params = {'image_info': image_info}
+
+        url = self.client._get_command_url(self.node)
+        body = self.client._get_command_body(method, params)
+        headers = {'Content-Type': 'application/json'}
+
+        self.assertRaises(exception.IronicException,
+                          self.client._command,
+                          self.node, method, params)
+        self.client.session.post.assert_called_once_with(
+            url,
+            data=body,
+            headers=headers,
+            params={'wait': 'false'})
+
     def test_get_commands_status(self):
         with mock.patch.object(self.client.session, 'get') as mock_get:
             res = mock.Mock()