openstack/deb-python-mistralclient
Code Issues Proposed changes

Replace request mocking in test_httpclient with requests-mock

Browse Source 
Similar to the client functions replace the requests mocking in
test_httpclient file with calls to requests-mock. This means we
test the actual data on the wire instead of the exact calls to
requests so they can change in future.

Change-Id: Id65374e14e3b18dfed46f0c78a95ff10502ce785
This commit is contained in:
Sharat Sharma
2017-05-31 12:18:02 +05:30
parent 7704c5523b
commit 5ed35370b4
1 changed files with 76 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files

213
mistralclient/tests/unit/test_httpclient.py
View File

@@ -16,14 +16,14 @@ import base64
import copy import copy
import mock import mock
from oslotest import base from six.moves.urllib import parse as urlparse
import requests
from oslo_utils import uuidutils from oslo_utils import uuidutils
from osprofiler import _utils as osprofiler_utils from osprofiler import _utils as osprofiler_utils
import osprofiler.profiler import osprofiler.profiler
from mistralclient.api import httpclient from mistralclient.api import httpclient
from mistralclient.tests.unit import base
API_BASE_URL = 'http://localhost:8989/v2' API_BASE_URL = 'http://localhost:8989/v2'
API_URL = '/executions' API_URL = '/executions'
@@ -55,21 +55,7 @@ EXPECTED_BODY = {
} }
class FakeRequest(object): class HTTPClientTest(base.BaseClientTest):
def __init__(self, method):
self.method = method
class FakeResponse(object):
def __init__(self, method, url, status_code):
self.request = FakeRequest(method)
self.url = url
self.status_code = status_code
class HTTPClientTest(base.BaseTestCase):
def setUp(self): def setUp(self):
super(HTTPClientTest, self).setUp() super(HTTPClientTest, self).setUp()
@@ -82,18 +68,33 @@ class HTTPClientTest(base.BaseTestCase):
region_name=REGION_NAME region_name=REGION_NAME
) )
@mock.patch.object( def assertExpectedAuthHeaders(self):
requests, headers = self.requests_mock.last_request.headers
'get',
mock.MagicMock(return_value=FakeResponse('get', EXPECTED_URL, 200)) self.assertEqual(AUTH_TOKEN, headers['X-Auth-Token'])
) self.assertEqual(PROJECT_ID, headers['X-Project-Id'])
self.assertEqual(USER_ID, headers['X-User-Id'])
return headers
def assertExpectedBody(self):
text = self.requests_mock.last_request.text
form = urlparse.parse_qs(text, strict_parsing=True)
self.assertEqual(len(EXPECTED_BODY), len(form))
for k, v in EXPECTED_BODY.items():
self.assertEqual([str(v)], form[k])
return form
def test_get_request_options(self): def test_get_request_options(self):
m = self.requests_mock.get(EXPECTED_URL, text='text')
self.client.get(API_URL) self.client.get(API_URL)
requests.get.assert_called_with( self.assertTrue(m.called_once)
EXPECTED_URL, self.assertExpectedAuthHeaders()
**EXPECTED_REQ_OPTIONS
)
@mock.patch.object( @mock.patch.object(
osprofiler.profiler._Profiler, osprofiler.profiler._Profiler,
@@ -105,12 +106,8 @@ class HTTPClientTest(base.BaseTestCase):
'get_id', 'get_id',
mock.MagicMock(return_value=PROFILER_TRACE_ID) mock.MagicMock(return_value=PROFILER_TRACE_ID)
) )
@mock.patch.object(
requests,
'get',
mock.MagicMock(return_value=FakeResponse('get', EXPECTED_URL, 200))
)
def test_get_request_options_with_profile_enabled(self): def test_get_request_options_with_profile_enabled(self):
m = self.requests_mock.get(EXPECTED_URL, text='text')
osprofiler.profiler.init(PROFILER_HMAC_KEY) osprofiler.profiler.init(PROFILER_HMAC_KEY)
data = {'base_id': PROFILER_TRACE_ID, 'parent_id': PROFILER_TRACE_ID} data = {'base_id': PROFILER_TRACE_ID, 'parent_id': PROFILER_TRACE_ID}
@@ -123,20 +120,13 @@ class HTTPClientTest(base.BaseTestCase):
self.client.get(API_URL) self.client.get(API_URL)
expected_options = copy.deepcopy(EXPECTED_REQ_OPTIONS) self.assertTrue(m.called_once)
expected_options['headers'].update(headers) headers = self.assertExpectedAuthHeaders()
self.assertEqual(signed_data[0], headers['X-Trace-Info'])
self.assertEqual(signed_data[1], headers['X-Trace-HMAC'])
requests.get.assert_called_with(
EXPECTED_URL,
**expected_options
)
@mock.patch.object(
requests,
'get',
mock.MagicMock(return_value=FakeResponse('get', EXPECTED_URL, 200))
)
def test_get_request_options_with_headers_for_get(self): def test_get_request_options_with_headers_for_get(self):
m = self.requests_mock.get(EXPECTED_URL, text='text')
target_auth_url = uuidutils.generate_uuid() target_auth_url = uuidutils.generate_uuid()
target_auth_token = uuidutils.generate_uuid() target_auth_token = uuidutils.generate_uuid()
target_user_id = 'target_user' target_user_id = 'target_user'
@@ -166,116 +156,79 @@ class HTTPClientTest(base.BaseTestCase):
target_client.get(API_URL) target_client.get(API_URL)
expected_options = copy.deepcopy(EXPECTED_REQ_OPTIONS) self.assertTrue(m.called_once)
headers = self.assertExpectedAuthHeaders()
headers = expected_options["headers"] self.assertEqual(target_auth_url, headers['X-Target-Auth-Uri'])
self.assertEqual(target_auth_token, headers['X-Target-Auth-Token'])
headers["X-Target-Auth-Uri"] = target_auth_url self.assertEqual(target_user_id, headers['X-Target-User-Id'])
headers["X-Target-Auth-Token"] = target_auth_token self.assertEqual(target_project_id, headers['X-Target-Project-Id'])
headers["X-Target-Insecure"] = target_insecure self.assertEqual(target_insecure, headers['X-Target-Insecure'])
headers["X-Target-User-Id"] = target_user_id self.assertEqual(target_region, headers['X-Target-Region-Name'])
headers["X-Target-Project-Id"] = target_project_id self.assertEqual(target_user_domain_name,
headers["X-Target-Region-Name"] = target_region headers['X-Target-User-Domain-Name'])
headers["X-Target-User-Domain-Name"] = target_user_domain_name self.assertEqual(target_project_domain_name,
headers["X-Target-Project-Domain-Name"] = target_project_domain_name headers['X-Target-Project-Domain-Name'])
catalog = base64.b64encode(target_service_catalog.encode('utf-8')) catalog = base64.b64encode(target_service_catalog.encode('utf-8'))
headers["X-Target-Service-Catalog"] = catalog self.assertEqual(catalog, headers['X-Target-Service-Catalog'])
requests.get.assert_called_with(EXPECTED_URL, **expected_options)
@mock.patch.object(
requests,
'post',
mock.MagicMock(return_value=FakeResponse('post', EXPECTED_URL, 201))
)
def test_get_request_options_with_headers_for_post(self): def test_get_request_options_with_headers_for_post(self):
m = self.requests_mock.post(EXPECTED_URL, text='text')
headers = {'foo': 'bar'} headers = {'foo': 'bar'}
self.client.post(API_URL, EXPECTED_BODY, headers=headers) self.client.post(API_URL, EXPECTED_BODY, headers=headers)
expected_options = copy.deepcopy(EXPECTED_REQ_OPTIONS) self.assertTrue(m.called_once)
expected_options['headers'].update(headers) headers = self.assertExpectedAuthHeaders()
expected_options['headers']['content-type'] = 'application/json' self.assertEqual('application/json', headers['Content-Type'])
self.assertEqual('bar', headers['foo'])
self.assertExpectedBody()
requests.post.assert_called_with(
EXPECTED_URL,
data=EXPECTED_BODY,
**expected_options
)
@mock.patch.object(
requests,
'put',
mock.MagicMock(return_value=FakeResponse('put', EXPECTED_URL, 200))
)
def test_get_request_options_with_headers_for_put(self): def test_get_request_options_with_headers_for_put(self):
m = self.requests_mock.put(EXPECTED_URL, text='text')
headers = {'foo': 'bar'} headers = {'foo': 'bar'}
self.client.put(API_URL, EXPECTED_BODY, headers=headers) self.client.put(API_URL, EXPECTED_BODY, headers=headers)
expected_options = copy.deepcopy(EXPECTED_REQ_OPTIONS) self.assertTrue(m.called_once)
expected_options['headers'].update(headers) headers = self.assertExpectedAuthHeaders()
expected_options['headers']['content-type'] = 'application/json' self.assertEqual('application/json', headers['Content-Type'])
self.assertEqual('bar', headers['foo'])
self.assertExpectedBody()
requests.put.assert_called_with(
EXPECTED_URL,
data=EXPECTED_BODY,
**expected_options
)
@mock.patch.object(
requests,
'delete',
mock.MagicMock(return_value=FakeResponse('delete', EXPECTED_URL, 200))
)
def test_get_request_options_with_headers_for_delete(self): def test_get_request_options_with_headers_for_delete(self):
m = self.requests_mock.delete(EXPECTED_URL, text='text')
headers = {'foo': 'bar'} headers = {'foo': 'bar'}
self.client.delete(API_URL, headers=headers) self.client.delete(API_URL, headers=headers)
expected_options = copy.deepcopy(EXPECTED_REQ_OPTIONS) self.assertTrue(m.called_once)
expected_options['headers'].update(headers) headers = self.assertExpectedAuthHeaders()
self.assertEqual('bar', headers['foo'])
requests.delete.assert_called_with(
EXPECTED_URL,
**expected_options
)
@mock.patch.object( @mock.patch.object(
httpclient.HTTPClient, httpclient.HTTPClient,
'_get_request_options', '_get_request_options',
mock.MagicMock(return_value=copy.deepcopy(EXPECTED_REQ_OPTIONS)) mock.MagicMock(return_value=copy.deepcopy(EXPECTED_REQ_OPTIONS))
) )
@mock.patch.object(
requests,
'get',
mock.MagicMock(return_value=FakeResponse('get', EXPECTED_URL, 200))
)
def test_http_get(self): def test_http_get(self):
m = self.requests_mock.get(EXPECTED_URL, text='text')
self.client.get(API_URL) self.client.get(API_URL)
httpclient.HTTPClient._get_request_options.assert_called_with( httpclient.HTTPClient._get_request_options.assert_called_with(
'get', 'get',
None None
) )
self.assertTrue(m.called_once)
requests.get.assert_called_with( self.assertExpectedAuthHeaders()
EXPECTED_URL,
**EXPECTED_REQ_OPTIONS
)
@mock.patch.object( @mock.patch.object(
httpclient.HTTPClient, httpclient.HTTPClient,
'_get_request_options', '_get_request_options',
mock.MagicMock(return_value=copy.deepcopy(EXPECTED_REQ_OPTIONS)) mock.MagicMock(return_value=copy.deepcopy(EXPECTED_REQ_OPTIONS))
) )
@mock.patch.object(
requests,
'post',
mock.MagicMock(return_value=FakeResponse('post', EXPECTED_URL, 201))
)
def test_http_post(self): def test_http_post(self):
m = self.requests_mock.post(EXPECTED_URL, status_code=201, text='text')
self.client.post(API_URL, EXPECTED_BODY) self.client.post(API_URL, EXPECTED_BODY)
httpclient.HTTPClient._get_request_options.assert_called_with( httpclient.HTTPClient._get_request_options.assert_called_with(
@@ -283,23 +236,17 @@ class HTTPClientTest(base.BaseTestCase):
None None
) )
requests.post.assert_called_with( self.assertTrue(m.called_once)
EXPECTED_URL, self.assertExpectedAuthHeaders()
data=EXPECTED_BODY, self.assertExpectedBody()
**EXPECTED_REQ_OPTIONS
)
@mock.patch.object( @mock.patch.object(
httpclient.HTTPClient, httpclient.HTTPClient,
'_get_request_options', '_get_request_options',
mock.MagicMock(return_value=copy.deepcopy(EXPECTED_REQ_OPTIONS)) mock.MagicMock(return_value=copy.deepcopy(EXPECTED_REQ_OPTIONS))
) )
@mock.patch.object(
requests,
'put',
mock.MagicMock(return_value=FakeResponse('put', EXPECTED_URL, 200))
)
def test_http_put(self): def test_http_put(self):
m = self.requests_mock.put(EXPECTED_URL, json={})
self.client.put(API_URL, EXPECTED_BODY) self.client.put(API_URL, EXPECTED_BODY)
httpclient.HTTPClient._get_request_options.assert_called_with( httpclient.HTTPClient._get_request_options.assert_called_with(
@@ -307,23 +254,17 @@ class HTTPClientTest(base.BaseTestCase):
None None
) )
requests.put.assert_called_with( self.assertTrue(m.called_once)
EXPECTED_URL, self.assertExpectedAuthHeaders()
data=EXPECTED_BODY, self.assertExpectedBody()
**EXPECTED_REQ_OPTIONS
)
@mock.patch.object( @mock.patch.object(
httpclient.HTTPClient, httpclient.HTTPClient,
'_get_request_options', '_get_request_options',
mock.MagicMock(return_value=copy.deepcopy(EXPECTED_REQ_OPTIONS)) mock.MagicMock(return_value=copy.deepcopy(EXPECTED_REQ_OPTIONS))
) )
@mock.patch.object(
requests,
'delete',
mock.MagicMock(return_value=FakeResponse('delete', EXPECTED_URL, 200))
)
def test_http_delete(self): def test_http_delete(self):
m = self.requests_mock.delete(EXPECTED_URL, text='text')
self.client.delete(API_URL) self.client.delete(API_URL)
httpclient.HTTPClient._get_request_options.assert_called_with( httpclient.HTTPClient._get_request_options.assert_called_with(
@@ -331,7 +272,5 @@ class HTTPClientTest(base.BaseTestCase):
None None
) )
requests.delete.assert_called_with( self.assertTrue(m.called_once)
EXPECTED_URL, self.assertExpectedAuthHeaders()
**EXPECTED_REQ_OPTIONS
)