tempest/tempest/tests/base.py

63 lines
2.2 KiB
Python

# Copyright 2013 IBM Corp.
#
# 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.
from unittest import mock
from oslotest import base
class TestCase(base.BaseTestCase):
def patch(self, target, *args, **kwargs):
"""Returns a started `mock.patch` object for the supplied target.
The caller may then call the returned patcher to create a mock object.
The caller does not need to call stop() on the returned
patcher object, as this method automatically adds a cleanup
to the test class to stop the patcher.
:param target: string module.class or module.object expression to patch
:param *args: passed as-is to `mock.patch`.
:param **kwargs: passed as-is to `mock.patch`.
See mock documentation for more details:
https://docs.python.org/3.5/library/unittest.mock.html#unittest.mock.patch
"""
p = mock.patch(target, *args, **kwargs)
m = p.start()
self.addCleanup(p.stop)
return m
def patchobject(self, target, attribute, *args, **kwargs):
"""Convenient wrapper around `mock.patch.object`
Returns a started mock that will be automatically stopped after the
test ran.
:param target: object to have the attribute patched
:param attribute: name of the attribute to be patched
:param *args: passed as-is to `mock.patch.object`.
:param **kwargs: passed as-is to `mock.patch.object`.
See mock documentation for more details:
https://docs.python.org/3.5/library/unittest.mock.html#unittest.mock.patch.object
"""
p = mock.patch.object(target, attribute, *args, **kwargs)
m = p.start()
self.addCleanup(p.stop)
return m