assert_called and assert_not_called are not asserting the state of the mock object but considered as mocked calls so mock will never raise exception but always executed successfully This change patches the Mock class during unit test to raise an exception if a function called on a mock object that's name starts with 'assert' and does not one of the supported Mock assert calls. This change also fix the unit test to call only the supported assert function on mock object. Change-Id: I036587f355e42e362ac2b70fb6755cca81d30b75
129 lines
4.3 KiB
Python
129 lines
4.3 KiB
Python
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import os
|
|
|
|
import fixtures
|
|
import mock
|
|
from oslo.serialization import jsonutils
|
|
import requests
|
|
from requests_mock.contrib import fixture as requests_mock_fixture
|
|
import six
|
|
import testscenarios
|
|
import testtools
|
|
|
|
AUTH_URL = "http://localhost:5002/auth_url"
|
|
AUTH_URL_V1 = "http://localhost:5002/auth_url/v1.0"
|
|
AUTH_URL_V2 = "http://localhost:5002/auth_url/v2.0"
|
|
|
|
|
|
def _patch_mock_to_raise_for_invalid_assert_calls():
|
|
def raise_for_invalid_assert_calls(wrapped):
|
|
def wrapper(_self, name):
|
|
valid_asserts = [
|
|
'assert_called_with',
|
|
'assert_called_once_with',
|
|
'assert_has_calls',
|
|
'assert_any_calls']
|
|
|
|
if name.startswith('assert') and name not in valid_asserts:
|
|
raise AttributeError('%s is not a valid mock assert method'
|
|
% name)
|
|
|
|
return wrapped(_self, name)
|
|
return wrapper
|
|
mock.Mock.__getattr__ = raise_for_invalid_assert_calls(
|
|
mock.Mock.__getattr__)
|
|
|
|
# NOTE(gibi): needs to be called only once at import time
|
|
# to patch the mock lib
|
|
_patch_mock_to_raise_for_invalid_assert_calls()
|
|
|
|
|
|
class TestCase(testtools.TestCase):
|
|
TEST_REQUEST_BASE = {
|
|
'verify': True,
|
|
}
|
|
|
|
def setUp(self):
|
|
super(TestCase, self).setUp()
|
|
if (os.environ.get('OS_STDOUT_CAPTURE') == 'True' or
|
|
os.environ.get('OS_STDOUT_CAPTURE') == '1'):
|
|
stdout = self.useFixture(fixtures.StringStream('stdout')).stream
|
|
self.useFixture(fixtures.MonkeyPatch('sys.stdout', stdout))
|
|
if (os.environ.get('OS_STDERR_CAPTURE') == 'True' or
|
|
os.environ.get('OS_STDERR_CAPTURE') == '1'):
|
|
stderr = self.useFixture(fixtures.StringStream('stderr')).stream
|
|
self.useFixture(fixtures.MonkeyPatch('sys.stderr', stderr))
|
|
|
|
|
|
class FixturedTestCase(testscenarios.TestWithScenarios, TestCase):
|
|
|
|
client_fixture_class = None
|
|
data_fixture_class = None
|
|
|
|
def setUp(self):
|
|
super(FixturedTestCase, self).setUp()
|
|
|
|
self.requests = self.useFixture(requests_mock_fixture.Fixture())
|
|
self.data_fixture = None
|
|
self.client_fixture = None
|
|
self.cs = None
|
|
|
|
if self.client_fixture_class:
|
|
fix = self.client_fixture_class(self.requests)
|
|
self.client_fixture = self.useFixture(fix)
|
|
self.cs = self.client_fixture.client
|
|
|
|
if self.data_fixture_class:
|
|
fix = self.data_fixture_class(self.requests)
|
|
self.data_fixture = self.useFixture(fix)
|
|
|
|
def assert_called(self, method, path, body=None):
|
|
self.assertEqual(self.requests.last_request.method, method)
|
|
self.assertEqual(self.requests.last_request.path_url, path)
|
|
|
|
if body:
|
|
req_data = self.requests.last_request.body
|
|
if isinstance(req_data, six.binary_type):
|
|
req_data = req_data.decode('utf-8')
|
|
if not isinstance(body, six.string_types):
|
|
# json load if the input body to match against is not a string
|
|
req_data = jsonutils.loads(req_data)
|
|
self.assertEqual(req_data, body)
|
|
|
|
|
|
class TestResponse(requests.Response):
|
|
"""
|
|
Class used to wrap requests.Response and provide some
|
|
convenience to initialize with a dict
|
|
"""
|
|
|
|
def __init__(self, data):
|
|
super(TestResponse, self).__init__()
|
|
self._text = None
|
|
if isinstance(data, dict):
|
|
self.status_code = data.get('status_code')
|
|
self.headers = data.get('headers')
|
|
# Fake the text attribute to streamline Response creation
|
|
self._text = data.get('text')
|
|
else:
|
|
self.status_code = data
|
|
|
|
def __eq__(self, other):
|
|
return self.__dict__ == other.__dict__
|
|
|
|
@property
|
|
def text(self):
|
|
return self._text
|