deb-heat/heat/tests/common.py
Pavlo Shchelokovskyy 3d65dba163 Improve mocking in HeatTestCase
As the mock lib is going to be used more actively, there is a need
to improve our boilerplate code in respect to mock.

Changes in this patch include:
* `patchobject` now accepts kwargs and passes them to `mock.patch.object`;
* added `patch` method that uses mock.patch (similar to `patchobject`)
  - NOTE: this shadows `testtools.TestCase.patch` method that uses
    simple monkey-patching in favor of mock-based patching,
    relevant comment added in the code;
* test code changed accordingly where needed.

Change-Id: I779cab63249d5eb1962e9ec388cd31f3df4a4189
2014-08-07 11:41:47 +03:00

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 logging
import os
import sys
import time
import fixtures
import mox
from oslo.config import cfg
from oslotest import mockpatch
import testscenarios
import testtools
from heat.common import messaging
from heat.engine.clients.os import keystone
from heat.engine import environment
from heat.engine import resources
from heat.engine import scheduler
from heat.tests import fakes
from heat.tests import utils
TEST_DEFAULT_LOGLEVELS = {'migrate': logging.WARN}
class FakeLogMixin:
def setup_logging(self):
# Assign default logs to self.LOG so we can still
# assert on heat logs.
self.LOG = self.useFixture(
fixtures.FakeLogger(level=logging.DEBUG))
base_list = set([nlog.split('.')[0]
for nlog in logging.Logger.manager.loggerDict])
for base in base_list:
if base in TEST_DEFAULT_LOGLEVELS:
self.useFixture(fixtures.FakeLogger(
level=TEST_DEFAULT_LOGLEVELS[base],
name=base))
elif base != 'heat':
self.useFixture(fixtures.FakeLogger(
name=base))
class HeatTestCase(testscenarios.WithScenarios,
testtools.TestCase, FakeLogMixin):
TIME_STEP = 0.1
def setUp(self):
super(HeatTestCase, self).setUp()
self.m = mox.Mox()
self.addCleanup(self.m.UnsetStubs)
self.setup_logging()
scheduler.ENABLE_SLEEP = False
self.useFixture(fixtures.MonkeyPatch(
'heat.common.exception._FATAL_EXCEPTION_FORMAT_ERRORS',
True))
def enable_sleep():
scheduler.ENABLE_SLEEP = True
self.addCleanup(enable_sleep)
mod_dir = os.path.dirname(sys.modules[__name__].__file__)
project_dir = os.path.abspath(os.path.join(mod_dir, '../../'))
env_dir = os.path.join(project_dir, 'etc', 'heat',
'environment.d')
cfg.CONF.set_default('environment_dir', env_dir)
self.addCleanup(cfg.CONF.reset)
messaging.setup("fake://", optional=True)
self.addCleanup(messaging.cleanup)
tri = resources.global_env().get_resource_info(
'AWS::RDS::DBInstance',
registry_type=environment.TemplateResourceInfo)
if tri is not None:
cur_path = tri.template_name
templ_path = os.path.join(project_dir, 'etc', 'heat', 'templates')
if templ_path not in cur_path:
tri.template_name = cur_path.replace('/etc/heat/templates',
templ_path)
utils.setup_dummy_db()
self.addCleanup(utils.reset_dummy_db)
def stub_wallclock(self):
"""
Overrides scheduler wallclock to speed up tests expecting timeouts.
"""
self._wallclock = time.time()
def fake_wallclock():
self._wallclock += self.TIME_STEP
return self._wallclock
self.m.StubOutWithMock(scheduler, 'wallclock')
scheduler.wallclock = fake_wallclock
def patchobject(self, obj, attr, **kwargs):
mockfixture = self.useFixture(mockpatch.PatchObject(obj, attr,
**kwargs))
return mockfixture.mock
# NOTE(pshchelo): this overrides the testtools.TestCase.patch method
# that does simple monkey-patching in favor of mock's patching
def patch(self, target, **kwargs):
mockfixture = self.useFixture(mockpatch.Patch(target, **kwargs))
return mockfixture.mock
def stub_keystoneclient(self, fake_client=None, **kwargs):
client = self.patchobject(keystone.KeystoneClientPlugin, "_create")
fkc = fake_client or fakes.FakeKeystoneClient(**kwargs)
client.return_value = fkc
return fkc